You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-5Lines changed: 25 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,19 +14,39 @@ The operator is built using the [Java Operator SDK](https://github.com/java-oper
14
14
15
15
## Running the Access Operator
16
16
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.
19
19
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),
22
22
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.
23
23
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
+
24
44
## Using the Access Operator
25
45
26
46
To make use of the Access Operator, create a `KafkaAccess` custom resource (CR).
27
47
You must specify the name of the `Kafka` CR you want to connect to.
28
48
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.
30
50
31
51
If you do not specify which listener you want to connect to, the operator uses the following rules to choose a listener:
32
52
1. If there is only one listener configured in the `Kafka` CR, that listener is chosen.
Copy file name to clipboardExpand all lines: packaging/helm-charts/helm3/strimzi-access-operator/README.md
+47-50Lines changed: 47 additions & 50 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,19 +10,60 @@ The operator is built using the [Java Operator SDK](https://github.com/java-oper
10
10
11
11
## Running the Access Operator
12
12
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),
18
15
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.
19
16
17
+
### Installing the Chart
18
+
19
+
To install the chart with the release name `my-strimzi-access-operator`:
0 commit comments