Skip to content

Commit c12981a

Browse files
authored
Update the README now we have our first release (#63)
Signed-off-by: Katherine Stanley <[email protected]>
1 parent d4db64f commit c12981a

File tree

2 files changed

+72
-55
lines changed

2 files changed

+72
-55
lines changed

README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,39 @@ The operator is built using the [Java Operator SDK](https://github.com/java-oper
1414

1515
## Running the Access Operator
1616

17-
The Access Operator is still in early stages of development so to run it you need to build it from source.
18-
The [dev guide](https://github.com/strimzi/kafka-access-operator/blob/main/development-docs/DEV_GUIDE.md) describes how to build and run the Access Operator.
17+
The latest release of the Access Operator can be started using the manifests in the `install` directory.
18+
The [dev guide](https://github.com/strimzi/kafka-access-operator/blob/main/development-docs/DEV_GUIDE.md) describes how to build and run the Access Operator from source.
1919

20-
To start the operator you need the Strimzi `Kafka` and `KafkaUser` custom resource definitions installed in your Kubernetes cluster.
21-
You can get these from the Strimzi [GitHub repository](https://github.com/strimzi/strimzi-kafka-operator/tree/main/packaging/install/cluster-operator),
20+
For the operator to start successfully you need the Strimzi `Kafka` and `KafkaUser` custom resource definitions installed in your Kubernetes cluster.
21+
You can get these from the Strimzi [GitHub repository](https://github.com/strimzi/strimzi-kafka-operator/tree/main/install/cluster-operator),
2222
or use the [Strimzi quickstart guide](https://strimzi.io/quickstarts/) to also deploy the Strimzi cluster operator and a Kafka instance at the same time.
2323

24+
### Deploying the Access Operator
25+
26+
To deploy the Access Operator in the `strimzi-access-operator` namespace:
27+
28+
```bash
29+
kubectl apply -f install
30+
```
31+
32+
The command deploys the Strimzi Access Operator on the Kubernetes cluster.
33+
34+
### Removing the Access Operator
35+
36+
To delete the `strimzi-access-operator` deployment:
37+
38+
```bash
39+
kubectl delete -f install
40+
```
41+
42+
The command removes all the Kubernetes components associated with the Strimzi Access Operator utility and deletes the deployment.
43+
2444
## Using the Access Operator
2545

2646
To make use of the Access Operator, create a `KafkaAccess` custom resource (CR).
2747
You must specify the name of the `Kafka` CR you want to connect to.
2848
You can optionally also specify the name of the listener in the `Kafka` CR and a `KafkaUser`.
29-
See the [examples folder](https://github.com/strimzi/kafka-access-operator/tree/main/packaging/examples) for some valid `KafkaAccess` specifications.
49+
See the [examples folder](https://github.com/strimzi/kafka-access-operator/tree/main/examples) for some valid `KafkaAccess` specifications.
3050

3151
If you do not specify which listener you want to connect to, the operator uses the following rules to choose a listener:
3252
1. If there is only one listener configured in the `Kafka` CR, that listener is chosen.

packaging/helm-charts/helm3/strimzi-access-operator/README.md

Lines changed: 47 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,60 @@ The operator is built using the [Java Operator SDK](https://github.com/java-oper
1010

1111
## Running the Access Operator
1212

13-
The Access Operator is still in early stages of development so to run it you need to build it from source.
14-
The [dev guide](https://github.com/strimzi/kafka-access-operator/blob/main/development-docs/DEV_GUIDE.md) describes how to build and run the Access Operator.
15-
16-
To start the operator you need the Strimzi `Kafka` and `KafkaUser` custom resource definitions installed in your Kubernetes cluster.
17-
You can get these from the Strimzi [GitHub repository](https://github.com/strimzi/strimzi-kafka-operator/tree/main/packaging/install/cluster-operator),
13+
For the operator to start successfully you need the Strimzi `Kafka` and `KafkaUser` custom resource definitions installed in your Kubernetes cluster.
14+
You can get these from the Strimzi [GitHub repository](https://github.com/strimzi/strimzi-kafka-operator/tree/main/install/cluster-operator),
1815
or use the [Strimzi quickstart guide](https://strimzi.io/quickstarts/) to also deploy the Strimzi cluster operator and a Kafka instance at the same time.
1916

17+
### Installing the Chart
18+
19+
To install the chart with the release name `my-strimzi-access-operator`:
20+
21+
```bash
22+
$ helm install my-strimzi-access-operator oci://quay.io/strimzi-helm/strimzi-access-operator
23+
```
24+
25+
The command deploys the Strimzi Access Operator on the Kubernetes cluster with the default configuration.
26+
27+
### Uninstalling the Chart
28+
29+
To uninstall/delete the `my-strimzi-access-operator` deployment:
30+
31+
```bash
32+
$ helm delete my-strimzi-access-operator
33+
```
34+
35+
The command removes all the Kubernetes components associated with the Strimzi Access Operator utility and deletes the release.
36+
37+
### Configuration
38+
39+
The following table lists some available configurable parameters of the Strimzi chart and their default values.
40+
For a full list of supported options, check the [`values.yaml` file](./values.yaml).
41+
42+
| Parameter | Description | Default |
43+
|--------------------------------------|-----------------------------------------------------------|----------|
44+
| `image.tag` | Override default Drain Cleaner image tag | `latest` |
45+
| `image.imagePullPolicy` | Image pull policy for all pods deployed by Drain Cleaner | `nil` |
46+
| `resources.limits.cpu` | Configures the CPU limit for the Access Operator Pod | `256Mi` |
47+
| `resources.limits.memory` | Configures the memory limit for the Access Operator Pod | `500m` |
48+
| `resources.requests.cpu` | Configures the CPU request for the Access Operator Pod | `256Mi` |
49+
| `resources.requests.memory` | Configures the memory request for the Access Operator Pod | `100m` |
50+
| `livenessProbe.initialDelaySeconds` | Liveness probe initial delay (in seconds) | `10` |
51+
| `livenessProbe.periodSeconds` | Liveness probe period (in seconds) | `30` |
52+
| `readinessProbe.initialDelaySeconds` | Readiness probe initial delay (in seconds) | `10` |
53+
| `readinessProbe.periodSeconds` | Readiness probe period (in seconds) | `30` |
54+
55+
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
56+
57+
```bash
58+
$ helm install my-strimzi-access-operator --set replicaCount=2 oci://quay.io/strimzi-helm/strimzi-access-operator
59+
```
60+
2061
## Using the Access Operator
2162

2263
To make use of the Access Operator, create a `KafkaAccess` custom resource (CR).
2364
You must specify the name of the `Kafka` CR you want to connect to.
2465
You can optionally also specify the name of the listener in the `Kafka` CR and a `KafkaUser`.
25-
See the [examples folder](https://github.com/strimzi/kafka-access-operator/tree/main/packaging/examples) for some valid `KafkaAccess` specifications.
66+
See the [examples folder](https://github.com/strimzi/kafka-access-operator/tree/main/examples) for some valid `KafkaAccess` specifications.
2667

2768
If you do not specify which listener you want to connect to, the operator uses the following rules to choose a listener:
2869
1. If there is only one listener configured in the `Kafka` CR, that listener is chosen.
@@ -105,47 +146,3 @@ Learn more on how you can contribute on our [Join Us](https://strimzi.io/join-us
105146
## License
106147

107148
Strimzi Access Operator is licensed under the [Apache License](./LICENSE), Version 2.0
108-
109-
## Installing the Chart
110-
111-
To install the chart with the release name `my-strimzi-drain-cleaner`:
112-
113-
```bash
114-
$ helm install my-strimzi-access-operator oci://quay.io/strimzi-helm/strimzi-access-operator
115-
```
116-
117-
The command deploys the Strimzi Access Operator on the Kubernetes cluster with the default configuration.
118-
119-
## Uninstalling the Chart
120-
121-
To uninstall/delete the `my-strimzi-access-operator` deployment:
122-
123-
```bash
124-
$ helm delete my-strimzi-access-operator
125-
```
126-
127-
The command removes all the Kubernetes components associated with the Strimzi Access Operator utility and deletes the release.
128-
129-
## Configuration
130-
131-
The following table lists some available configurable parameters of the Strimzi chart and their default values.
132-
For a full list of supported options, check the [`values.yaml` file](./values.yaml).
133-
134-
| Parameter | Description | Default |
135-
|--------------------------------------|-----------------------------------------------------------|----------|
136-
| `image.tag` | Override default Drain Cleaner image tag | `latest` |
137-
| `image.imagePullPolicy` | Image pull policy for all pods deployed by Drain Cleaner | `nil` |
138-
| `resources.limits.cpu` | Configures the CPU limit for the Access Operator Pod | `256Mi` |
139-
| `resources.limits.memory` | Configures the memory limit for the Access Operator Pod | `500m` |
140-
| `resources.requests.cpu` | Configures the CPU request for the Access Operator Pod | `256Mi` |
141-
| `resources.requests.memory` | Configures the memory request for the Access Operator Pod | `100m` |
142-
| `livenessProbe.initialDelaySeconds` | Liveness probe initial delay (in seconds) | `10` |
143-
| `livenessProbe.periodSeconds` | Liveness probe period (in seconds) | `30` |
144-
| `readinessProbe.initialDelaySeconds` | Readiness probe initial delay (in seconds) | `10` |
145-
| `readinessProbe.periodSeconds` | Readiness probe period (in seconds) | `30` |
146-
147-
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
148-
149-
```bash
150-
$ helm install my-strimzi-access-operator --set replicaCount=2 oci://quay.io/strimzi-helm/strimzi-access-operator
151-
```

0 commit comments

Comments
 (0)