Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
JakeSCahill authored Oct 23, 2024
1 parent 9942852 commit 9e120c6
Showing 1 changed file with 7 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,9 @@ You can find all configuration options for the User resource in the xref:referen

The `metadata.name` field in the User resource is used to specify the username. Keep in mind the following best practices when choosing a username:

- Uniqueness: Ensure that each user has a unique name to avoid conflicts. The username must be unique within the Redpanda cluster.
- Descriptive: Choose a name that identifies the purpose or role of the user. For example, use names like `app-consumer` or `admin-user`.
- Stable: Avoid changing usernames frequently. Usernames are tied to authentication and authorization rules (ACLs). Renaming a user involves deleting and recreating the user.
- *Unique*: Ensure each user has a unique name to avoid conflicts. The username must be unique within the Redpanda cluster.
- *Descriptive*: Choose a name that identifies the purpose or role of the user. For example, use names like `app-consumer` or `admin-user`.
- *Stable*: Avoid changing usernames frequently. Usernames are tied to authentication and authorization rules (ACLs). Renaming a user involves deleting and recreating the user.

[,yaml]
----
Expand Down Expand Up @@ -200,7 +200,7 @@ For more details about ACLs, including supported operations and resources in Red

To deploy a User resource, apply the manifest to the same namespace as your Redpanda cluster:

[bash]
[,bash]
----
kubectl apply -f <manifest-filename>.yaml --namespace <namespace>
----
Expand All @@ -212,7 +212,7 @@ kubectl apply -f <manifest-filename>.yaml --namespace <namespace>

After deploying a User resource, verify that the Redpanda Operator reconciled it:

[bash]
[,bash]
----
kubectl logs -l app.kubernetes.io/name=operator -c manager --namespace <namespace>
----
Expand Down Expand Up @@ -245,7 +245,7 @@ Example output:

To update a user, edit the User resource configuration and apply the changes.

[bash]
[,bash]
----
kubectl apply -f <manifest-filename>.yaml --namespace <namespace>
----
Expand All @@ -254,7 +254,7 @@ kubectl apply -f <manifest-filename>.yaml --namespace <namespace>

To delete a user, delete the User resource:

[bash]
[,bash]
----
kubectl delete -f example-user.yaml --namespace <namespace>
----
Expand Down

0 comments on commit 9e120c6

Please sign in to comment.