Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #233

Merged
merged 1 commit into from
Feb 21, 2025
Merged

Update README #233

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 14 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,15 @@ Install with Helm:

```
helm repo add nats https://nats-io.github.io/k8s/helm/charts/
helm upgrade --install nats nats/nats --set config.jetstream.enabled=true --set config.cluster.enabled=true
helm upgrade --install nack nats/nack --set jetstream.nats.url=nats://nats.default.svc.cluster.local:4222
helm repo update

helm upgrade --install nats nats/nats \
--set config.jetstream.enabled=true \
--set config.jetstream.memoryStore.enabled=true \
--set config.cluster.enabled=true --wait

helm upgrade --install nack nats/nack \
--set jetstream.nats.url=nats://nats.default.svc.cluster.local:4222 --wait
```

#### (Optional) Enable Experimental `controller-runtime` Controllers
Expand All @@ -32,7 +39,9 @@ helm upgrade --install nack nats/nack --set jetstream.nats.url=nats://nats.defau
> The `jetstream-controller` logs will contain a diff of any changes the controller has made.

```
helm upgrade nack nats/nack --set jetstream.additionalArgs={--control-loop=true}
helm upgrade nack nats/nack \
--set jetstream.nats.url=nats://nats.default.svc.cluster.local:4222 \
--set jetstream.additionalArgs={--control-loop} --wait
```

#### Creating Streams and Consumers
Expand Down Expand Up @@ -129,13 +138,9 @@ data into `mystream`.

```sh
# Run nats-box that includes the NATS management utilities, and exec into it.
$ kubectl apply -f https://nats-io.github.io/k8s/tools/nats-box.yml
$ kubectl exec -it nats-box -- /bin/sh -l
$ kubectl exec -it deployment/nats-box -- /bin/sh -l

# Publish a couple of messages from nats-box
nats-box:~$ nats context save jetstream -s nats://nats:4222
nats-box:~$ nats context select jetstream

nats-box:~$ nats pub orders.received "order 1"
nats-box:~$ nats pub orders.received "order 2"
```
Expand Down Expand Up @@ -283,7 +288,7 @@ container to run the management CLI.

```sh
# Get container shell
kubectl exec -it deployment/nats-box -- /bin/sh
kubectl exec -it deployment/nats-box -- /bin/sh -l
```

There should now be some Streams available, verify with `nats` command.
Expand Down