Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add note that command only supported in Serverless #868

Merged
merged 1 commit into from
Nov 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc
Original file line number Diff line number Diff line change
@@ -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=<host:ports>`] flag to pass a specific Admin API address.

endif::[]

== Examples

* Generate an app with interactive prompts:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 9 additions & 1 deletion modules/reference/pages/rpk/rpk-security/rpk-security.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down