Skip to content

Commit

Permalink
docs(review): edits to doc from comments by JS -- 01
Browse files Browse the repository at this point in the history
Signed-off-by: prmellor <[email protected]>
  • Loading branch information
PaulRMellor committed Oct 25, 2024
1 parent 170f200 commit 478c56f
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,14 @@
// security/assembly-security.adoc

[id='assembly-access-operator-{context}']
= Using the Access Operator to manage client connections (early access)
= Using the Access Operator to manage client connections

[role="_abstract"]
The Strimzi Access Operator simplifies how applications connect to a Kafka cluster managed by the Cluster Operator.
The Strimzi Access Operator is an optional feature that simplifies the sharing of Kafka connection information and credentials between namespaces

The Access Operator is deployed separately and manages the distribution of connection details, which are stored as a `Secret` resource.
The secret contains cluster connection details and optional user credentials, and can be referenced by applications across different namespaces.

WARNING: The Access Operator is an early access feature and is not recommended for production environments.

//Procedure for deployment of Access Operator
include::../../modules/deploying/proc-deploy-access-operator.adoc[leveloffset=+1]
//Procedure for running the Access Operator
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
// security/assembly-access-operator.adoc

[id='proc-deploy-access-operator-{context}']
= Deploying the Access Operator (early access)
= Deploying the Access Operator

[role="_abstract"]
This procedure shows how to deploy the Access Operator for access management of a Kafka cluster.
You cannot use the Access Operator with a Kafka cluster that is not managed by the Cluster Operator.

.Prerequisites

* Installation requires a Kubernetes user with `cluster-admin` role, such as `system:admin`.
* The Access Operator installation files must be downloaded and extracted from Strimzi's link:https://github.com/strimzi/kafka-access-operator[`kafka-access-operator` GitHub repository^]. The installation files are contained in the `./install` directory.
* The Access Operator installation files must be downloaded and extracted from the latest release archive (`{ReleaseFile}`) from the {ReleaseDownload}. +
The installation files are contained in the `./install` directory.
* xref:deploying-cluster-operator-str[The Cluster Operator must be deployed.]

By default, the Access Operator is deployed in the `strimzi-access-operator` namespace.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// security/assembly-access-operator.adoc

[id='proc-using-access-operator-{context}']
= Using the Access Operator (early access)
= Using the Access Operator

[role="_abstract"]
This procedure shows how to use the Access Operator to manage access to a Kafka cluster.
Expand All @@ -25,7 +25,7 @@ If no listener is specified it will choose according to these rules:
* A Kafka cluster deployed using a `Kafka` resource and managed by the Cluster Operator.
* `KafkaUser` resources must be created for any users needing authentication to the Kafka cluster.

Example `KafkaAccess` resource specifications are contained in the `./examples` directory of Strimzi's link:https://github.com/strimzi/kafka-access-operator[`kafka-access-operator` GitHub repository^].
Example `KafkaAccess` resource specifications are contained in the `./examples` directory of the latest release archive (`{ReleaseFile}`) from the {ReleaseDownload}.

.Procedure

Expand Down

0 comments on commit 478c56f

Please sign in to comment.