Skip to content

Commit

Permalink
doc: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
katallaxie authored Nov 30, 2024
1 parent f5eb9fc commit 73c9e62
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,27 @@ statefulSet:
secretName: "natsoperator-sample-server-config"
```
## Development
You can use [minikube](https://minikube.sigs.k8s.io/docs/) to test the operator.
```shell
minikube start
```

The operator can be built and tested using the following commands.

```shell
make generate
make install
```

Then you can start the operator using the following command.

```shell
make up
```

## License

[Apache 2.0](/LICENSE)
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ require (
k8s.io/api v0.31.3
k8s.io/apimachinery v0.31.3
k8s.io/client-go v0.31.3
k8s.io/utils v0.0.0-20240711033017-18e509b52bc8
sigs.k8s.io/controller-runtime v0.19.2
sigs.k8s.io/controller-tools v0.16.5
)
Expand Down Expand Up @@ -89,6 +88,7 @@ require (
k8s.io/helm v2.17.0+incompatible // indirect
k8s.io/klog/v2 v2.130.1 // indirect
k8s.io/kube-openapi v0.0.0-20240228011516-70dd3763d340 // indirect
k8s.io/utils v0.0.0-20240711033017-18e509b52bc8 // indirect
sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
sigs.k8s.io/structured-merge-diff/v4 v4.4.1 // indirect
sigs.k8s.io/yaml v1.4.0 // indirect
Expand Down

0 comments on commit 73c9e62

Please sign in to comment.