From d6789b55653bb074f5ab553af229811af58d9bfe Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Tue, 19 Nov 2024 13:08:23 -0700 Subject: [PATCH] add note that command only supported in Serverless --- .../pages/rpk/rpk-generate/rpk-generate-app.adoc | 16 ++++++++++++---- .../rpk-security/rpk-security-user-create.adoc | 5 +++++ .../rpk-security/rpk-security-user-delete.adoc | 5 +++++ .../rpk/rpk-security/rpk-security-user-list.adoc | 5 +++++ .../rpk-security/rpk-security-user-update.adoc | 5 +++++ .../rpk/rpk-security/rpk-security-user.adoc | 5 +++++ .../pages/rpk/rpk-security/rpk-security.adoc | 10 +++++++++- 7 files changed, 46 insertions(+), 5 deletions(-) diff --git a/modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc b/modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc index d5af03afa..f475e6f70 100644 --- a/modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc +++ b/modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc @@ -1,24 +1,32 @@ = rpk generate app // tag::single-source[] +ifdef::env-cloud[] +NOTE: This command is only supported in Serverless clusters. + +endif::[] + Generate a sample application to connect with Redpanda. This command generates a starter application to produce and consume from the settings defined in the `rpk profile`. Its goal is to get you producing and consuming quickly with Redpanda in a language that is familiar to you. -By default, this will run interactively, prompting you to select a language and +By default, this runs interactively, prompting you to select a language and a user with which to create your application. To use this without interactivity, -specify how you would like your application to be created using flags. +specify how you want your application to be created using flags. -The `--language` option allows you to specify the language. There is no default. +The `--language` flag lets you specify the language. There is no default. -The `--new-sasl--user` flag allows you to generate a new SASL user +The `--new-sasl--user` flag lets you generate a new SASL user with admin ACLs. If you don't want to use your current profile user or don't want to create a new one, you can use the `--no-user` flag to generate the starter app without the user. +ifndef::env-cloud[] If you are having trouble connecting to your cluster, you can use the common xref:reference:rpk/rpk-x-options.adoc#adminhosts[`-X admin.hosts=`] flag to pass a specific Admin API address. +endif::[] + == Examples * Generate an app with interactive prompts: diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-user-create.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-user-create.adoc index eb3c2b2f7..1a64d92ca 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-user-create.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-user-create.adoc @@ -2,6 +2,11 @@ :page-aliases: reference:rpk/rpk-acl/rpk-acl-user-create.adoc, reference:rpk/rpk-security/rpk-security-acl-user-create.adoc // tag::single-source[] +ifdef::env-cloud[] +NOTE: This command is only supported in Serverless clusters. + +endif::[] + Create a SASL user. This command creates a single SASL user with the given password, optionally diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-user-delete.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-user-delete.adoc index e936cdcc9..6cfd15413 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-user-delete.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-user-delete.adoc @@ -2,6 +2,11 @@ :page-aliases: reference:rpk/rpk-acl/rpk-acl-user-delete.adoc, reference:rpk/rpk-security/rpk-security-acl-user-delete.adoc // tag::single-source[] +ifdef::env-cloud[] +NOTE: This command is only supported in Serverless clusters. + +endif::[] + Delete a SASL user. This command deletes the specified SASL account from Redpanda. This does not diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-user-list.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-user-list.adoc index 4ef1c741a..67c8d7752 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-user-list.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-user-list.adoc @@ -2,6 +2,11 @@ :page-aliases: reference:rpk/rpk-acl/rpk-acl-user-list.adoc, reference:rpk/rpk-security/rpk-security-acl-user-list.adoc // tag::single-source[] +ifdef::env-cloud[] +NOTE: This command is only supported in Serverless clusters. + +endif::[] + List SASL users. == Usage diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-user-update.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-user-update.adoc index 0a13daa77..97bb5432b 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-user-update.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-user-update.adoc @@ -2,6 +2,11 @@ :page-aliases: reference:rpk/rpk-acl/rpk-acl-user-update.adoc, reference:rpk/rpk-security/rpk-security-acl-user-update.adoc // tag::single-source[] +ifdef::env-cloud[] +NOTE: This command is only supported in Serverless clusters. + +endif::[] + Update SASL user credentials CAUTION: The default value for the `--mechanism` flag is `SCRAM-SHA-256`. Set the flag when using a different mechanism to avoid unexpected changes. diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-user.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-user.adoc index 71aabc343..4d02a2a18 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-user.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-user.adoc @@ -2,6 +2,11 @@ :page-aliases: reference:rpk/rpk-acl/rpk-acl-user.adoc, reference:rpk/rpk-security/rpk-security-acl-user.adoc // tag::single-source[] +ifdef::env-cloud[] +NOTE: This command is only supported in Serverless clusters. + +endif::[] + Manage SCRAM users. If SCRAM is enabled, a SCRAM user is what you use to talk to Redpanda, and ACLs diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security.adoc index db5330eda..52c9bbf96 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security.adoc @@ -2,7 +2,15 @@ // tag::single-source[] :description: These commands let you create SASL users and create, list, and delete ACLs and RBAC. -Manage Redpanda security. +ifdef::env-cloud[] +NOTE: This command is only supported in Serverless clusters. + +endif::[] + +ifdef::env-cloud[] +NOTE: This command is only supported in Serverless clusters. + +endif::[] == Usage