nats-io / nack

NATS Controllers for Kubernetes (NACK)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Number of issues with ReadMe manual

MDullak opened this issue · comments

What version were you using?

0.14.1

What environment was the server running in?

Clean K3S install + kubernetes dashboards

Is this defect reproducible?

Yes it is reproducable

  1. in the ReadMe the storage for Stream is memory, in the file that is mentioned (https://raw.githubusercontent.com/nats-io/nack/main/deploy/examples/stream.yml) the type is file
  2. installing nats via helm installs nats-box already, the ReadMe asks to deploy file: https://nats-io.github.io/k8s/tools/nats-box.yml which is nats-box, but the file does not exists
  3. using nats-box deployed by helm install nats, makes it impossible to add context as per manual /etc/nats-context is mounted RO and can not be remounted to RW (premission denied although I am root)

Given the capability you are leveraging, describe your expectation?

As a beginer I would expect that the ReadMe is up to date so that I can try out nats and nack by following the ReadMe.
Looks like ReadMe might be outdated. This makes it hard for NATS noob like myself to give it a try.

Given the expectation, what is the defect you are observing?

I can not send and recieve messages by following the ReadMe. I would love to see that it works before I start creating my own usage scenarios.

Hey!
Thanks for filling the issue.
We updates some of the readme recently, but it seems - not everywhere.
We will fix it.

Are you interested in contributions with issues you already found?