From e0011e93152ebe1c7ace6d532709eb9fe6c37f46 Mon Sep 17 00:00:00 2001 From: Kat Batuigas Date: Fri, 29 May 2026 10:14:47 -0700 Subject: [PATCH 1/3] Add rpk cloud auth token reference page and xrefs from SQL docs Co-Authored-By: Claude Opus 4.6 --- modules/ROOT/nav.adoc | 1 + .../reference/pages/rpk/rpk-cloud/rpk-cloud-auth-token.adoc | 3 +++ modules/sql/pages/connect-to-sql/authenticate.adoc | 2 +- modules/sql/pages/get-started/deploy-sql-cluster.adoc | 2 +- modules/sql/pages/get-started/sql-quickstart.adoc | 2 +- 5 files changed, 7 insertions(+), 3 deletions(-) create mode 100644 modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-token.adoc diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 582ce22d4..43b5a6697 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -793,6 +793,7 @@ **** xref:reference:rpk/rpk-cloud/rpk-cloud-auth.adoc[] ***** xref:reference:rpk/rpk-cloud/rpk-cloud-auth-delete.adoc[] ***** xref:reference:rpk/rpk-cloud/rpk-cloud-auth-list.adoc[] +***** xref:reference:rpk/rpk-cloud/rpk-cloud-auth-token.adoc[] ***** xref:reference:rpk/rpk-cloud/rpk-cloud-auth-use.adoc[] **** xref:reference:rpk/rpk-cloud/rpk-cloud-byoc.adoc[] ***** xref:reference:rpk/rpk-cloud/rpk-cloud-byoc-install.adoc[] diff --git a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-token.adoc b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-token.adoc new file mode 100644 index 000000000..5bb86759a --- /dev/null +++ b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-token.adoc @@ -0,0 +1,3 @@ += rpk cloud auth token + +include::streaming:reference:partial$rpk-cloud/rpk-cloud-auth-token.adoc[tag=single-source] diff --git a/modules/sql/pages/connect-to-sql/authenticate.adoc b/modules/sql/pages/connect-to-sql/authenticate.adoc index 8a26675e1..99b6a2019 100644 --- a/modules/sql/pages/connect-to-sql/authenticate.adoc +++ b/modules/sql/pages/connect-to-sql/authenticate.adoc @@ -28,7 +28,7 @@ Redpanda SQL supports three authentication modes, selected by the connection-str |Bearer token |`auth_method=bearer` -|You already hold a JSON Web Token (JWT) issued by Redpanda Cloud (for example, returned by `rpk cloud auth token`). +|You already hold a JSON Web Token (JWT) issued by Redpanda Cloud (for example, returned by xref:reference:rpk/rpk-cloud/rpk-cloud-auth-token.adoc[`rpk cloud auth token`]). |Client credentials |`auth_method=client_secret` diff --git a/modules/sql/pages/get-started/deploy-sql-cluster.adoc b/modules/sql/pages/get-started/deploy-sql-cluster.adoc index f929bdd27..b5ba16a9f 100644 --- a/modules/sql/pages/get-started/deploy-sql-cluster.adoc +++ b/modules/sql/pages/get-started/deploy-sql-cluster.adoc @@ -170,7 +170,7 @@ To connect using a bearer token (xref:manage:rpk/rpk-install.adoc[`rpk` v26.1.6+ rpk cloud login ---- -. Retrieve a temporary authentication token for the SQL engine: +. Retrieve a temporary authentication token for the SQL engine using xref:reference:rpk/rpk-cloud/rpk-cloud-auth-token.adoc[`rpk cloud auth token`]: + [,bash] ---- diff --git a/modules/sql/pages/get-started/sql-quickstart.adoc b/modules/sql/pages/get-started/sql-quickstart.adoc index 43799567a..6e69af8d8 100644 --- a/modules/sql/pages/get-started/sql-quickstart.adoc +++ b/modules/sql/pages/get-started/sql-quickstart.adoc @@ -109,7 +109,7 @@ SQL connection details are available on your cluster's *SQL* tab in the https:// rpk cloud login ---- -. Retrieve a temporary authentication token for the SQL engine: +. Retrieve a temporary authentication token for the SQL engine using xref:reference:rpk/rpk-cloud/rpk-cloud-auth-token.adoc[`rpk cloud auth token`]: + [,bash] ---- From a94f05f0b37889c5d9a546ad3329c640a6fd4a63 Mon Sep 17 00:00:00 2001 From: Kat Batuigas Date: Fri, 29 May 2026 10:16:14 -0700 Subject: [PATCH 2/3] Temporarily use docs feature branch to import partial --- local-antora-playbook.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/local-antora-playbook.yml b/local-antora-playbook.yml index 42d2f4a1e..22f6443b7 100644 --- a/local-antora-playbook.yml +++ b/local-antora-playbook.yml @@ -15,7 +15,7 @@ content: - url: . branches: HEAD - url: https://github.com/redpanda-data/documentation - branches: [main, v/*, shared, site-search] + branches: ['DOC-2218-add-reference-for-rpk-cloud-auth-token', v/*, shared, site-search] - url: https://github.com/redpanda-data/docs-site branches: [main] start_paths: [home, data-platform, self-managed] From 9bdc7fd4100c4ec1845808ea921a5a730ccd6f78 Mon Sep 17 00:00:00 2001 From: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com> Date: Fri, 29 May 2026 11:55:54 -0700 Subject: [PATCH 3/3] Update local-antora-playbook.yml --- local-antora-playbook.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/local-antora-playbook.yml b/local-antora-playbook.yml index 22f6443b7..42d2f4a1e 100644 --- a/local-antora-playbook.yml +++ b/local-antora-playbook.yml @@ -15,7 +15,7 @@ content: - url: . branches: HEAD - url: https://github.com/redpanda-data/documentation - branches: ['DOC-2218-add-reference-for-rpk-cloud-auth-token', v/*, shared, site-search] + branches: [main, v/*, shared, site-search] - url: https://github.com/redpanda-data/docs-site branches: [main] start_paths: [home, data-platform, self-managed]