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

Jump to bottom

Update NACK readme #931

Merged
merged 2 commits into from
Sep 26, 2024
Merged

Update NACK readme #931

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f28cd8
Update NACK readme
MauriceVanVeen Sep 12, 2024
5e21c71
Using nats req over pub
MauriceVanVeen Sep 12, 2024
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
21 changes: 12 additions & 9 deletions helm/charts/nack/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,17 @@ using a NATS client with JetStream support for management or the `nats` utility.

### Getting started

First, we'll need to NATS cluster that has enabled JetStream. You can install
First, we'll need to install the CRDs.
```bash
kubectl apply -f https://github.com/nats-io/nack/releases/latest/download/crds.yml
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we skip the TL;DR we should first install the CRDs here.

```

Then, we'll need a NATS cluster that has enabled JetStream. You can install
one as follows:

```yaml
natsBox:
enabled: false
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was natsBox.enabled: false before and we'd add it later on with:

kubectl apply -f https://nats-io.github.io/k8s/tools/nats-box.yml

That file has been removed in the mean time, so instead just enable nats-box as part of our NATS installation.

enabled: true

config:
jetstream:
Expand Down Expand Up @@ -81,10 +86,12 @@ NAME STATE STREAM NAME SUBJECTS
mystream Created mystream [orders.*]

# Create a push-based consumer
$ kubectl apply -f https://raw.githubusercontent.com/nats-io/nack/main/deploy/examples/consumer_push.yml
$ wget -q https://raw.githubusercontent.com/nats-io/nack/main/deploy/examples/consumer_push.yml
$ kubectl apply -f consumer_push.yml

# Create a pull based consumer
$ kubectl apply -f https://raw.githubusercontent.com/nats-io/nack/main/deploy/examples/consumer_pull.yml
$ wget -q https://raw.githubusercontent.com/nats-io/nack/main/deploy/examples/consumer_pull.yml
$ kubectl apply -f consumer_pull.yml
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Later on there are descriptions about:

First, we'll read the data using a pull-based consumer. In consumer_pull.yml
we set:

filterSubject: orders.received

so that's the subject my-pull-consumer will pull messages from.

Saving it into a file makes it easier for people to inspect the contents when they get to this bit.


# Check if they were successfully created.
$ kubectl get consumers
Expand All @@ -102,13 +109,9 @@ data into `mystream`.

```sh
# Run nats-box that includes the NATS management utilities.
$ kubectl apply -f https://nats-io.github.io/k8s/tools/nats-box.yml
$ kubectl exec -it nats-box -- /bin/sh -l
kubectl exec -it deploy/nats-box -- /bin/sh -l
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that nats-box is pre-installed, no need to install here and we need to refer to it by its deployment.


# Publish a couple of messages
$ nats context save jetstream -s nats://nats:4222
$ nats context select jetstream
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These would fail as by default (by now) the file system is read-only. Because we now enable nats-box above it's pre-configured and doesn't need a context to be set.


$ nats pub orders.received "order 1"
$ nats pub orders.received "order 2"
```
Expand Down