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

docs: Switch preposition, IN a cluster not ON a cluster #337

Merged
merged 1 commit into from
Feb 21, 2024
Merged

docs: Switch preposition, IN a cluster not ON a cluster #337

Show file tree
Hide file tree
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
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ NATS Manager is a standard Kubernetes operator that observes the state of NATS J

This project aims to follow the [Kubernetes Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/).

It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/), which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.
It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/), which provide a reconcile function responsible for synchronizing resources until the desired state is reached in the cluster.

This project is scaffolded using [Kubebuilder](https://book.kubebuilder.io), and all the Kubebuilder [`makefile` helpers](https://book.kubebuilder.io/reference/makefile-helpers.html) can be used.

## Installation

1. To install the latest version of the NATS manager on your cluster, run:
1. To install the latest version of the NATS manager in your cluster, run:

```bash
kubectl apply -f https://github.com/kyma-project/nats-manager/releases/latest/download/nats-manager.yaml
```

2. To install the latest version of the default NATS CR on your cluster, run:
2. To install the latest version of the default NATS CR in your cluster, run:

```bash
kubectl apply -f https://github.com/kyma-project/nats-manager/releases/latest/download/nats-default-cr.yaml
Expand Down Expand Up @@ -118,7 +118,7 @@ You’ll need a Kubernetes cluster to run against. You can use [k3d](https://k3d

> **NOTE:** Your NATS Manager automatically uses the current context in your kubeconfig file, that is, whatever cluster `kubectl cluster-info` shows.

### Deploy on the Cluster
### Deploy in the Cluster

1. Download Go packages:

Expand Down Expand Up @@ -176,7 +176,7 @@ For the E2E tests, provide a Kubernetes cluster and run:
make e2e IMG=<container-registry>/nats-manager:<tag>
```

If you already have deployed the NATS-Manager on your cluster, you can simply run:
If you already have deployed the NATS-Manager in your cluster, you can simply run:

```shell
make e2e-only
Expand Down
2 changes: 1 addition & 1 deletion docs/contributor/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ For information about the prerequisites, refer to [Development](./development.md
make uninstall
```

## Run the NATS Manager on a Cluster Using the Go Runtime Environment
## Run the NATS Manager in a Cluster Using the Go Runtime Environment

### Installation

Expand Down
2 changes: 1 addition & 1 deletion docs/contributor/testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Because E2E tests need a Kubernetes cluster to run on, they are separate from th

2. Execute the E2E test.

If NATS Manager has not yet been deployed on the cluster, run:
If NATS Manager has not yet been deployed in the cluster, run:

```sh
make e2e IMG=<container-registry>/nats-manager:<tag>
Expand Down