Stories · 14 guides

Stories

Contents

The stories are the guides to the controllers, one task each, with the manifests that do it. Each manifest uses the resource API, and the API reference lists every kind and field.

If you are new to the controllers, start with the quickstart, a tutorial that deploys a NATS cluster with JetStream and creates a stream on it.

The other stories are how-to guides:

Following a story#

  1. Create the namespaces that the manifests use, nats-system and, in some stories, orders, payments or monitoring:

    for ns in nats-system orders payments monitoring; do kubectl create namespace "$ns"; done

    In a story that spans Kubernetes clusters, create them in each one.

  2. Apply each manifest with the kubectl command that follows it on the page. In a story that spans Kubernetes clusters, the command sets the kubeconfig context of its Kubernetes cluster with --context.

  3. Compare what kubectl get -o yaml shows with the status file on the page. A value that differs from one Kubernetes cluster to the next is an example.

Running the stories#

To run the stories end to end on kind clusters from a checkout of the repository, run just e2e. hack/e2e describes what the harness needs.

Esc
↓ ↑ Navigate Enter Select Esc Close