Skip to content

Commit 84ab8c3

Browse files
Update documentation
1 parent f0f5e77 commit 84ab8c3

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# slack-operator
2+
23
Kubernetes operator for Slack
34

45
## About
@@ -35,17 +36,20 @@ data:
3536
3637
- Make sure that [certman](https://cert-manager.io/) is deployed in your cluster since webhooks require certman to generate valid certs since webhooks serve using HTTPS
3738
- To install certman
39+
3840
```terminal
3941
$ kubectl apply --validate=false -f https://github.com/jetstack/cert-manager/releases/download/v0.16.1/cert-manager.yaml
4042
```
43+
4144
- Deploy operator
45+
4246
```terminal
4347
$ oc apply -f bundle/manifests
4448
```
4549

4650
## Local Development
4751

48-
[Operator-sdk v1.0.0](https://github.com/operator-framework/operator-sdk/releases/tag/v1.0.0) is required for local development.
52+
[Operator-sdk v1.0.1](https://github.com/operator-framework/operator-sdk/releases/tag/v1.0.1) is required for local development.
4953

5054
1. Create `slack-secret` secret
5155
2. Run `make run ENABLE_WEBHOOKS=false WATCH_NAMESPACE=default OPERATOR_NAMESPACE=default` where `WATCH_NAMESPACE` denotes the namespaces that the operator is supposed to watch and `OPERATOR_NAMESPACE` is the namespace in which it's supposed to be deployed.
@@ -56,9 +60,11 @@ $ oc apply -f bundle/manifests
5660
## Running Tests
5761

5862
### Pre-requisites:
63+
5964
1. Create a namespace with the name `test`
6065
2. Create `slack-secret` secret in test namespace
6166

6267
### To run tests:
68+
6369
Use the following command to run tests:
6470
`make test OPERATOR_NAMESPACE=test USE_EXISTING_CLUSTER=true`

0 commit comments

Comments
 (0)