From 9e120c6ac3f3c15493aae219657e4fe11ba09972 Mon Sep 17 00:00:00 2001 From: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com> Date: Wed, 23 Oct 2024 12:33:01 +0100 Subject: [PATCH] Apply suggestions from code review --- .../security/authentication/k-user-controller.adoc | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/modules/manage/pages/kubernetes/security/authentication/k-user-controller.adoc b/modules/manage/pages/kubernetes/security/authentication/k-user-controller.adoc index f4e956c23..6b1b6c98a 100644 --- a/modules/manage/pages/kubernetes/security/authentication/k-user-controller.adoc +++ b/modules/manage/pages/kubernetes/security/authentication/k-user-controller.adoc @@ -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] ---- @@ -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 .yaml --namespace ---- @@ -212,7 +212,7 @@ kubectl apply -f .yaml --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 ---- @@ -245,7 +245,7 @@ Example output: To update a user, edit the User resource configuration and apply the changes. -[bash] +[,bash] ---- kubectl apply -f .yaml --namespace ---- @@ -254,7 +254,7 @@ kubectl apply -f .yaml --namespace To delete a user, delete the User resource: -[bash] +[,bash] ---- kubectl delete -f example-user.yaml --namespace ----