Skip to content

Commit

Permalink
Update README.md (#302)
Browse files Browse the repository at this point in the history
* Update README.md

Remove installation with KLM

* Update README.md

Fix link to default CR

* Update CODE_OF_CONDUCT.md

Fix link
  • Loading branch information
pbochynski authored Jan 30, 2024
1 parent a8ec07b commit 49a6149
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 73 deletions.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Code of conduct

Each contributor and maintainer of this project agrees to follow the [community Code of Conduct](https://github.com/kyma-project/community/blob/main/contributing/01-code-of-conduct.md) that relies on the CNCF Code of Conduct. Read it to learn about the agreed standards of behavior, shared values that govern our community, and details on how to report any suspected Code of Conduct violations.
Each contributor and maintainer of this project agrees to follow the [community Code of Conduct](https://github.com/kyma-project/community/blob/main/docs/contributing/01-code-of-conduct.md) that relies on the CNCF Code of Conduct. Read it to learn about the agreed standards of behavior, shared values that govern our community, and details on how to report any suspected Code of Conduct violations.
73 changes: 1 addition & 72 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This project is scaffolded using [Kubebuilder](https://book.kubebuilder.io), and
2. To install the latest version of the default NATS CR on your cluster, run:

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

## Development
Expand Down Expand Up @@ -166,77 +166,6 @@ To delete the CRDs from the cluster:
make uninstall
```

### Deploy NATS Manager Module With [Kyma Lifecycle Manager](https://github.com/kyma-project/lifecycle-manager/tree/main)

1. Deploy the Lifecycle Manager to the Kubernetes cluster:

```shell
kyma alpha deploy
```

2. Apply the NATS module template to the Kubernetes cluster:

> **NOTE:** You can get the latest released [module template](https://github.com/kyma-project/nats-manager/releases/latest/download/module-template.yaml), or you can use the module template from the artifacts of `nats-module-build` job either from the `main` branch or from your pull request.

```sh
kubectl apply -f module-template.yaml
```

3. Enable the NATS module:

```sh
kyma alpha enable module nats -c fast -n kyma-system
```

4. If you want to verify whether your NATS module is deployed properly, perform the following checks:

- Check if the NATS resource has the ready state:

```shell
kubectl get -n kyma-system nats
```

- Check if the Kyma resource has the ready state:

```shell
kubectl get -n kyma-system kyma
```

### Uninstall NATS Manager Module With [Kyma Lifecycle Manager](https://github.com/kyma-project/lifecycle-manager/tree/main)

1. Delete NATS Custom Resource (CR) from the Kubernetes cluster (if exists):

```sh
kubectl delete -n kyma-system nats eventing-nats
```

2. Disable the NATS module:

```sh
kyma alpha disable module nats
```

3. Delete the NATS module template:

```sh
kubectl get moduletemplates -A
kubectl delete moduletemplate -n <NAMESPACE> <NAME>
```

4. Check whether your NATS module is uninstalled properly:

- Make sure that the NATS Custom Resource (CR) does not exist. If it exists, then check the status of NATS CR:

```shell
kubectl get -n kyma-system nats eventing-nats -o yaml
```

- Check if the Kyma resource has the ready state:

```shell
kubectl get -n kyma-system kyma
```

## E2E Tests

> **NOTE:** Because the E2E tests need a Kubernetes cluster to run on, they are separated from the remaining tests and are only executed if the `e2e` build tags are passed.
Expand Down

0 comments on commit 49a6149

Please sign in to comment.