From 00bfdaf5e1e7332b863efec20fb0ce1e2a0f9e78 Mon Sep 17 00:00:00 2001 From: Anatolii Bazko Date: Tue, 21 Nov 2023 14:04:28 +0100 Subject: [PATCH] chore: Avoid Base64 encoding steps in documentation (#2664) * chore: Avoid Base64 encoding steps in documentation Signed-off-by: Anatolii Bazko --------- Signed-off-by: Anatolii Bazko --- ...-link-secret-for-the-bitbucket-server.adoc | 28 +++++-------------- ...-link-secret-for-the-bitbucket-server.adoc | 12 ++++---- ...nsumer-secret-for-the-bitbucket-cloud.adoc | 12 ++++---- ..._applying-the-github-oauth-app-secret.adoc | 12 ++++---- ...-gitlab-authorized-application-secret.adoc | 12 ++++---- ...zure-devops-services-oauth-app-secret.adoc | 12 ++++---- ...environment-variable-into-a-container.adoc | 6 ++-- ...lication-link-on-the-bitbucket-server.adoc | 3 +- ...lication-link-on-the-bitbucket-server.adoc | 16 ++--------- ...oauth-consumer-in-the-bitbucket-cloud.adoc | 17 ++--------- .../proc_setting-up-the-github-oauth-app.adoc | 17 ++--------- ...-up-the-gitlab-authorized-application.adoc | 17 ++--------- ...osoft-azure-devops-services-oauth-app.adoc | 16 ++--------- .../using-a-git-provider-access-token.adoc | 13 ++------- 14 files changed, 56 insertions(+), 137 deletions(-) diff --git a/modules/administration-guide/partials/proc_applying-an-application-link-secret-for-the-bitbucket-server.adoc b/modules/administration-guide/partials/proc_applying-an-application-link-secret-for-the-bitbucket-server.adoc index aac52199aa..b7a6d01f72 100644 --- a/modules/administration-guide/partials/proc_applying-an-application-link-secret-for-the-bitbucket-server.adoc +++ b/modules/administration-guide/partials/proc_applying-an-application-link-secret-for-the-bitbucket-server.adoc @@ -22,20 +22,6 @@ Prepare and apply the application link Secret for the Bitbucket Server. .Procedure -. Encode the content of the `bitbucket-consumer-key` file to Base64: -+ -[subs="+quotes,+attributes,+macros"] ----- -$ echo -n '____' | base64 ----- - -. Encode the content of the `bitbucket-shared-secret` file to Base64: -+ -[subs="+quotes,+attributes,+macros"] ----- -$ echo -n '____' | base64 ----- - . Prepare the Secret: + [source,yaml,subs="+quotes,+attributes,+macros"] @@ -52,16 +38,16 @@ metadata: che.eclipse.org/oauth-scm-server: bitbucket che.eclipse.org/scm-server-endpoint: ____ <2> type: Opaque -data: - private.key: ____ <3> - consumer.key: ____ <4> - shared_secret: ____ <5> +stringData: + private.key: ____ <3> + consumer.key: ____ <4> + shared_secret: ____ <5> ---- <1> The {prod-short} namespace. The default is `{prod-namespace}`. <2> The URL of the Bitbucket Server. -<3> The content of the `privatepkcs8-stripped.pem` file, which was Base64-encoded when the file was generated. -<4> The content of the `bitbucket-consumer-key` file that you manually encoded to Base64 in step 1. -<5> The content of the `bitbucket-shared-secret` file that you manually encoded to Base64 in step 2. +<3> The content of the `privatepkcs8-stripped.pem` file. +<4> The content of the `bitbucket-consumer-key` file. +<5> The content of the `bitbucket-shared-secret` file. . Apply the Secret: + diff --git a/modules/administration-guide/partials/proc_applying-an-oauth-2-application-link-secret-for-the-bitbucket-server.adoc b/modules/administration-guide/partials/proc_applying-an-oauth-2-application-link-secret-for-the-bitbucket-server.adoc index 7fdd4a95d5..d451547114 100644 --- a/modules/administration-guide/partials/proc_applying-an-oauth-2-application-link-secret-for-the-bitbucket-server.adoc +++ b/modules/administration-guide/partials/proc_applying-an-oauth-2-application-link-secret-for-the-bitbucket-server.adoc @@ -13,7 +13,7 @@ Prepare and apply the OAuth 2.0 application link Secret for the Bitbucket Server * The application link is set up on the Bitbucket Server. -* The Base64-encoded values, which were generated when setting up the Bitbucket application link, are prepared: +* The following values, which were generated when setting up the Bitbucket application link, are prepared: ** Bitbucket *Client ID* ** Bitbucket *Client secret* @@ -37,14 +37,14 @@ metadata: che.eclipse.org/oauth-scm-server: bitbucket che.eclipse.org/scm-server-endpoint: ____ <2> type: Opaque -data: - id: ____ <3> - secret: ____ <4> +stringData: + id: ____ <3> + secret: ____ <4> ---- <1> The {prod-short} namespace. The default is `{prod-namespace}`. <2> The URL of the Bitbucket Server. -<3> The Base64-encoded Bitbucket *Client ID*. -<4> The Base64-encoded Bitbucket *Client secret*. +<3> The Bitbucket *Client ID*. +<4> The Bitbucket *Client secret*. . Apply the Secret: + diff --git a/modules/administration-guide/partials/proc_applying-an-oauth-consumer-secret-for-the-bitbucket-cloud.adoc b/modules/administration-guide/partials/proc_applying-an-oauth-consumer-secret-for-the-bitbucket-cloud.adoc index af0afc930c..e2356c99d5 100644 --- a/modules/administration-guide/partials/proc_applying-an-oauth-consumer-secret-for-the-bitbucket-cloud.adoc +++ b/modules/administration-guide/partials/proc_applying-an-oauth-consumer-secret-for-the-bitbucket-cloud.adoc @@ -13,7 +13,7 @@ Prepare and apply an OAuth consumer Secret for the Bitbucket Cloud. * The OAuth consumer is set up in the Bitbucket Cloud. -* The Base64-encoded values, which were generated when setting up the Bitbucket OAuth consumer, are prepared: +* The following values, which were generated when setting up the Bitbucket OAuth consumer, are prepared: ** Bitbucket OAuth consumer Key ** Bitbucket OAuth consumer Secret @@ -36,13 +36,13 @@ metadata: annotations: che.eclipse.org/oauth-scm-server: bitbucket type: Opaque -data: - id: ____ <2> - secret: ____ <3> +stringData: + id: ____ <2> + secret: ____ <3> ---- <1> The {prod-short} namespace. The default is `{prod-namespace}`. -<2> The Base64-encoded *Bitbucket OAuth consumer Key*. -<3> The Base64-encoded *Bitbucket OAuth consumer Secret*. +<2> The *Bitbucket OAuth consumer Key*. +<3> The *Bitbucket OAuth consumer Secret*. . Apply the Secret: + diff --git a/modules/administration-guide/partials/proc_applying-the-github-oauth-app-secret.adoc b/modules/administration-guide/partials/proc_applying-the-github-oauth-app-secret.adoc index 3395458fbc..1ab3aa5388 100644 --- a/modules/administration-guide/partials/proc_applying-the-github-oauth-app-secret.adoc +++ b/modules/administration-guide/partials/proc_applying-the-github-oauth-app-secret.adoc @@ -13,7 +13,7 @@ Prepare and apply the GitHub OAuth App Secret. * Setting up the GitHub OAuth App is completed. -* The Base64-encoded values, which were generated when setting up the GitHub OAuth App, are prepared: +* The following values, which were generated when setting up the GitHub OAuth App, are prepared: ** *GitHub OAuth Client ID* ** *GitHub OAuth Client Secret* @@ -38,15 +38,15 @@ metadata: che.eclipse.org/scm-server-endpoint: ____ <2> che.eclipse.org/scm-github-disable-subdomain-isolation: "____" <3> type: Opaque -data: - id: ____ <4> - secret: ____ <5> +stringData: + id: ____ <4> + secret: ____ <5> ---- <1> The {prod-short} namespace. The default is `{prod-namespace}`. <2> This depends on the GitHub product your organization is using: When hosting repositories on GitHub.com or GitHub Enterprise Cloud, omit this line or enter the default `https://github.com`. When hosting repositories on GitHub Enterprise Server, enter the GitHub Enterprise Server URL. <3> This line is only added for GitHub Enterprise Server. To disable subdomain isolation, set this to `"true"`. To enable subdomain isolation, set this to `"false"`. -<4> The Base64-encoded *GitHub OAuth Client ID*. -<5> The Base64-encoded *GitHub OAuth Client Secret*. +<4> The *GitHub OAuth Client ID*. +<5> The *GitHub OAuth Client Secret*. . Apply the Secret: + diff --git a/modules/administration-guide/partials/proc_applying-the-gitlab-authorized-application-secret.adoc b/modules/administration-guide/partials/proc_applying-the-gitlab-authorized-application-secret.adoc index 6eb236422b..6a08c35e22 100644 --- a/modules/administration-guide/partials/proc_applying-the-gitlab-authorized-application-secret.adoc +++ b/modules/administration-guide/partials/proc_applying-the-gitlab-authorized-application-secret.adoc @@ -13,7 +13,7 @@ Prepare and apply the GitLab-authorized application Secret. * Setting up the GitLab authorized application is completed. -* The Base64-encoded values, which were generated when setting up the GitLab authorized application, are prepared: +* The following values, which were generated when setting up the GitLab authorized application, are prepared: ** *GitLab Application ID* ** *GitLab Client Secret* @@ -37,14 +37,14 @@ metadata: che.eclipse.org/oauth-scm-server: gitlab che.eclipse.org/scm-server-endpoint: ____ <2> type: Opaque -data: - id: ____ <3> - secret: ____ <4> +stringData: + id: ____ <3> + secret: ____ <4> ---- <1> The {prod-short} namespace. The default is `{prod-namespace}`. <2> The *GitLab server URL*. Use `https://gitlab.com` for the `SAAS` version. -<3> The Base64-encoded *GitLab Application ID*. -<4> The Base64-encoded *GitLab Client Secret*. +<3> The *GitLab Application ID*. +<4> The *GitLab Client Secret*. . Apply the Secret: + diff --git a/modules/administration-guide/partials/proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc b/modules/administration-guide/partials/proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc index aa87969454..5c71f1bd02 100644 --- a/modules/administration-guide/partials/proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc +++ b/modules/administration-guide/partials/proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc @@ -13,7 +13,7 @@ Prepare and apply the Microsoft Azure DevOps Services Secret. * Setting up the Microsoft Azure DevOps Services OAuth App is completed. -* The Base64-encoded values, which were generated when setting up the Microsoft Azure DevOps Services OAuth App, are prepared: +* The following values, which were generated when setting up the Microsoft Azure DevOps Services OAuth App, are prepared: ** *App ID* ** *Client Secret* @@ -36,13 +36,13 @@ metadata: annotations: che.eclipse.org/oauth-scm-server: azure-devops type: Opaque -data: - id: ____# <2> - secret: ____# <3> +stringData: + id: ____# <2> + secret: ____# <3> ---- <1> The {prod-short} namespace. The default is `{prod-namespace}`. -<2> The Base64-encoded Microsoft Azure DevOps Services OAuth *App ID*. -<3> The Base64-encoded Microsoft Azure DevOps Services OAuth *Client Secret*. +<2> The Microsoft Azure DevOps Services OAuth *App ID*. +<3> The Microsoft Azure DevOps Services OAuth *Client Secret*. . Apply the Secret: + diff --git a/modules/administration-guide/partials/proc_mounting-a-secret-or-a-configmap-as-an-environment-variable-into-a-container.adoc b/modules/administration-guide/partials/proc_mounting-a-secret-or-a-configmap-as-an-environment-variable-into-a-container.adoc index 9ac329ed39..d02ab37ea5 100644 --- a/modules/administration-guide/partials/proc_mounting-a-secret-or-a-configmap-as-an-environment-variable-into-a-container.adoc +++ b/modules/administration-guide/partials/proc_mounting-a-secret-or-a-configmap-as-an-environment-variable-into-a-container.adoc @@ -79,9 +79,9 @@ metadata: che.eclipse.org/otherkey_env-name: OTHER_ENV labels: ... -data: - mykey: ____ - otherkey: ____ +stringData: + mykey: ____ + otherkey: ____ ---- or [source,yaml] diff --git a/modules/administration-guide/partials/proc_setting-up-an-application-link-on-the-bitbucket-server.adoc b/modules/administration-guide/partials/proc_setting-up-an-application-link-on-the-bitbucket-server.adoc index 7a77f50edb..2eeed403a7 100644 --- a/modules/administration-guide/partials/proc_setting-up-an-application-link-on-the-bitbucket-server.adoc +++ b/modules/administration-guide/partials/proc_setting-up-an-application-link-on-the-bitbucket-server.adoc @@ -13,7 +13,6 @@ Set up an application link for OAuth 1.0 on the Bitbucket Server. * You are logged in to the Bitbucket Server. * link:https://www.openssl.org/[`openssl`] is installed in the operating system you are using. -* link:https://www.gnu.org/software/coreutils/base64[`base64`] is installed in the operating system you are using. .Procedure @@ -23,7 +22,7 @@ Set up an application link for OAuth 1.0 on the Bitbucket Server. ---- $ openssl genrsa -out private.pem 2048 && \ openssl pkcs8 -topk8 -inform pem -outform pem -nocrypt -in private.pem -out privatepkcs8.pem && \ -cat privatepkcs8.pem | sed 's/-----BEGIN PRIVATE KEY-----//g' | sed 's/-----END PRIVATE KEY-----//g' | tr -d '\n' | base64 | tr -d '\n' > privatepkcs8-stripped.pem && \ +cat privatepkcs8.pem | sed 's/-----BEGIN PRIVATE KEY-----//g' | sed 's/-----END PRIVATE KEY-----//g' | tr -d '\n' > privatepkcs8-stripped.pem && \ openssl rsa -in private.pem -pubout > public.pub && \ cat public.pub | sed 's/-----BEGIN PUBLIC KEY-----//g' | sed 's/-----END PUBLIC KEY-----//g' | tr -d '\n' > public-stripped.pub && \ openssl rand -base64 24 > bitbucket-consumer-key && \ diff --git a/modules/administration-guide/partials/proc_setting-up-an-oauth-2-application-link-on-the-bitbucket-server.adoc b/modules/administration-guide/partials/proc_setting-up-an-oauth-2-application-link-on-the-bitbucket-server.adoc index 6238a41dc5..0090bc0eb5 100644 --- a/modules/administration-guide/partials/proc_setting-up-an-oauth-2-application-link-on-the-bitbucket-server.adoc +++ b/modules/administration-guide/partials/proc_setting-up-an-oauth-2-application-link-on-the-bitbucket-server.adoc @@ -12,7 +12,6 @@ Set up an OAuth 2.0 application link on the Bitbucket Server. .Prerequisites * You are logged in to the Bitbucket Server. -* link:https://www.gnu.org/software/coreutils/base64[`base64`] is installed in the operating system you are using. .Procedure @@ -22,19 +21,8 @@ Set up an OAuth 2.0 application link on the Bitbucket Server. . Enter `pass:c,a,q[{prod-url}]/api/oauth/callback` to the *Redirect URL* field. . Select the *Admin - Write* checkbox in *Application permissions*. . Click *Save*. -. Copy the *Client ID* and encode it to Base64 for use when applying the Bitbucket application link Secret: -+ -[subs="+quotes,+attributes,+macros"] ----- -$ echo -n '____' | base64 ----- - -. Copy the *Client secret* and encode it to Base64 for use when applying the Bitbucket application link Secret: -+ -[subs="+quotes,+attributes,+macros"] ----- -$ echo -n '____' | base64 ----- +. Copy and save the *Client ID* for use when applying the Bitbucket application link Secret. +. Copy and save the *Client secret* for use when applying the Bitbucket application link Secret. .Additional resources diff --git a/modules/administration-guide/partials/proc_setting-up-an-oauth-consumer-in-the-bitbucket-cloud.adoc b/modules/administration-guide/partials/proc_setting-up-an-oauth-consumer-in-the-bitbucket-cloud.adoc index acbcf2dbe0..ef2c9fd48f 100644 --- a/modules/administration-guide/partials/proc_setting-up-an-oauth-consumer-in-the-bitbucket-cloud.adoc +++ b/modules/administration-guide/partials/proc_setting-up-an-oauth-consumer-in-the-bitbucket-cloud.adoc @@ -12,7 +12,6 @@ Set up an OAuth consumer for OAuth 2.0 in the Bitbucket Cloud. .Prerequisites * You are logged in to the Bitbucket Cloud. -* link:https://www.gnu.org/software/coreutils/base64[`base64`] is installed in the operating system you are using. .Procedure @@ -28,19 +27,9 @@ Set up an OAuth consumer for OAuth 2.0 in the Bitbucket Cloud. . Under *Permissions*, check all of the *Account* and *Repositories* checkboxes, and click *Save*. -. Expand the added consumer and then copy the *Key* value and encode it to Base64 for use when applying the Bitbucket OAuth consumer Secret: -+ -[subs="+quotes,+attributes,+macros"] ----- -$ echo -n '____' | base64 ----- - -. Copy the *Secret* value and encode it to Base64 for use when applying the Bitbucket OAuth consumer Secret: -+ -[subs="+quotes,+attributes,+macros"] ----- -$ echo -n '____' | base64 ----- +. Expand the added consumer and then copy and save the *Key* value for use when applying the Bitbucket OAuth consumer Secret: + +. Copy and save the *Secret* value for use when applying the Bitbucket OAuth consumer Secret. .Additional resources diff --git a/modules/administration-guide/partials/proc_setting-up-the-github-oauth-app.adoc b/modules/administration-guide/partials/proc_setting-up-the-github-oauth-app.adoc index 54ffa1ee3d..9c5bd0204b 100644 --- a/modules/administration-guide/partials/proc_setting-up-the-github-oauth-app.adoc +++ b/modules/administration-guide/partials/proc_setting-up-the-github-oauth-app.adoc @@ -12,7 +12,6 @@ Set up a GitHub OAuth App using OAuth 2.0. .Prerequisites * You are logged in to GitHub. -* link:https://www.gnu.org/software/coreutils/base64[`base64`] is installed in the operating system you are using. .Procedure @@ -29,19 +28,9 @@ Set up a GitHub OAuth App using OAuth 2.0. . Click *Generate new client secret*. -. Copy the *GitHub OAuth Client ID* and encode it to Base64 for use when applying the GitHub OAuth App Secret: -+ -[subs="+quotes,+attributes,+macros"] ----- -$ echo -n '____' | base64 ----- - -. Copy the *GitHub OAuth Client Secret* and encode it to Base64 for use when applying the GitHub OAuth App Secret: -+ -[subs="+quotes,+attributes,+macros"] ----- -$ echo -n '____' | base64 ----- +. Copy and save the *GitHub OAuth Client ID* for use when applying the GitHub OAuth App Secret. + +. Copy and save the *GitHub OAuth Client Secret* for use when applying the GitHub OAuth App Secret. .Additional resources diff --git a/modules/administration-guide/partials/proc_setting-up-the-gitlab-authorized-application.adoc b/modules/administration-guide/partials/proc_setting-up-the-gitlab-authorized-application.adoc index a643d909e9..ef52a4b2fd 100644 --- a/modules/administration-guide/partials/proc_setting-up-the-gitlab-authorized-application.adoc +++ b/modules/administration-guide/partials/proc_setting-up-the-gitlab-authorized-application.adoc @@ -12,7 +12,6 @@ Set up a GitLab authorized application using OAuth 2.0. .Prerequisites * You are logged in to GitLab. -* link:https://www.gnu.org/software/coreutils/base64[`base64`] is installed in the operating system you are using. .Procedure @@ -28,19 +27,9 @@ Set up a GitLab authorized application using OAuth 2.0. . Click *Save application*. -. Copy the *GitLab Application ID* and encode it to Base64 for use when applying the GitLab-authorized application Secret: -+ -[subs="+quotes,+attributes,+macros"] ----- -$ echo -n '____' | base64 ----- - -. Copy the *GitLab Client Secret* and encode it to Base64 for use when applying the GitLab-authorized application Secret: -+ -[subs="+quotes,+attributes,+macros"] ----- -$ echo -n '____' | base64 ----- +. Copy and save the *GitLab Application ID* for use when applying the GitLab-authorized application Secret. + +. Copy and save the *GitLab Client Secret* for use when applying the GitLab-authorized application Secret. .Additional resources diff --git a/modules/administration-guide/partials/proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc b/modules/administration-guide/partials/proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc index dea1cce033..ea28d0b897 100644 --- a/modules/administration-guide/partials/proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc +++ b/modules/administration-guide/partials/proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc @@ -21,8 +21,6 @@ Set up a Microsoft Azure DevOps Services OAuth App using OAuth 2.0. ==== + -* link:https://www.gnu.org/software/coreutils/base64[`base64`] is installed in the operating system you are using. - .Procedure . Visit link:https://app.vsaex.visualstudio.com/app/register/[]. @@ -38,21 +36,11 @@ Set up a Microsoft Azure DevOps Services OAuth App using OAuth 2.0. . Click *Create application*. -. Copy the *App ID* and encode it to Base64 for use when applying the Microsoft Azure DevOps Services OAuth App Secret: -+ -[subs="+quotes,+attributes,+macros"] ----- -$ echo -n '____' | base64 ----- +. Copy and save the *App ID* for use when applying the Microsoft Azure DevOps Services OAuth App Secret. . Click *Show* to display the *Client Secret*. -. Copy the *Client Secret* and encode it to Base64 for use when applying the Microsoft Azure DevOps Services OAuth App Secret: -+ -[subs="+quotes,+attributes,+macros"] ----- -$ echo -n '____' | base64 -w 0 ----- +. Copy and save the *Client Secret* for use when applying the Microsoft Azure DevOps Services OAuth App Secret. pass:[] diff --git a/modules/end-user-guide/pages/using-a-git-provider-access-token.adoc b/modules/end-user-guide/pages/using-a-git-provider-access-token.adoc index 27ee1ee869..5284e34700 100644 --- a/modules/end-user-guide/pages/using-a-git-provider-access-token.adoc +++ b/modules/end-user-guide/pages/using-a-git-provider-access-token.adoc @@ -63,15 +63,6 @@ If the token is valid and has the necessary permissions, the cloning process sho For GitHub Enterprise Cloud, verify that the token is link:https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on[authorized for use within the organization]. ==== -. Encode your access token to Base64. -+ -[TIP] -==== -If you have the link:https://www.gnu.org/software/coreutils/base64[base64] command-line tools installed in the operating system, you can use the command line: - -`$ echo -n '____' | base64` - -==== . Go to `pass:c,a,q[{prod-url}]/api/user/id` in the web browser to get your {prod-short} user ID. @@ -91,8 +82,8 @@ metadata: che.eclipse.org/scm-personal-access-token-name: __# <2> che.eclipse.org/scm-url: ____# <3> che.eclipse.org/scm-organization: ____# <4> -data: - token: ____ +stringData: + token: ____ type: Opaque ---- +