diff --git a/_docs/deployment/create-application.md b/_docs/deployment/create-application.md index b9d9df8e8..a53535e2e 100644 --- a/_docs/deployment/create-application.md +++ b/_docs/deployment/create-application.md @@ -50,8 +50,9 @@ General configuration settings define the source, destination, and sync policies %} #### Source -The Git repository to be tracked for changes to the application's source code. -{::nomarkdown} {:/} +The Git repository to be tracked for changes to the application's source code. + +{::nomarkdown} {:/} {::nomarkdown}
diff --git a/_docs/runtime/monitor-manage-runtimes.md b/_docs/runtime/monitor-manage-runtimes.md index d985199ca..a2a547035 100644 --- a/_docs/runtime/monitor-manage-runtimes.md +++ b/_docs/runtime/monitor-manage-runtimes.md @@ -27,6 +27,8 @@ Select the view mode to view runtime components and information, and manage prov Manage provisioned runtimes: +* [Update Git tokens for runtimes](#update-git-tokens-for-runtimes) +* [Configure SSH for runtimes](#configure-ssh-for-runtimes) * [Add managed clusters to hybrid or hosted runtimes]({{site.baseurl}}/docs/runtime/managed-cluster/) * [Add and manage Git Sources associated with hybrid or hosted runtimes]({{site.baseurl}}/docs/runtime/git-sources/) * [Reset shared configuration repository](#reset-shared-configuration-repository) @@ -100,6 +102,114 @@ Here is a description of the information in the Topology view. |**Health/Sync status** |The health and sync status of the runtime or cluster. {::nomarkdown} {:/} | |**Search and View options** | {::nomarkdown} {:/}| +### Update Git tokens for runtimes + +Provisioned runtimes require valid Git tokens at all times to authenticate Git actions by you as a user. +>These tokens are specific to the user, and the same token can be used for multiple runtimes. + +There are two different situations when you need to update Git tokens: +* Update invalid, revoked, or expired tokens: Codefresh automatically flags runtimes with such tokens. It is mandatory to update the Git tokens to continue working with the platform. +* Update valid tokens: Optional. You may want to update Git tokens, even valid ones, by deleting the existing token and replacing it with a new token. + +The methods for updating any Git token are the same regardless of the reason for the update: +* OAuth2 authorization, if your admin has registered an OAuth Application for Codefresh +* Git access token authentication, by generating a personal access token in your Git provider account with the correct scopes + +**Before you begin** +* To authenticate through a Git access token, make sure your token is valid and has [the required scopes]({{site.baseurl}}/docs/reference/git-tokens) + +**How to** +1. Do one of the following: + * If you see a notification in the Codefresh UI about invalid runtime tokens, click **[Update Token]**. + The Runtimes page shows runtimes with invalid tokens prefixed by the key icon. Mouse over shows invalid token. + * To update an existing token, go to [Runtimes](https://g.codefresh.io/2.0/account-settings/runtimes){:target="\_blank"}. +1. From the List view, select the runtime for which to update the Git token. +1. From the context menu with the additional actions at the top-right, select **Update Git Runtime Credentials**. + + {% include + image.html + lightbox="true" + file="/images/runtime/update-git-runtime-token.png" + url="/images/runtime/update-git-runtime-token.png" + alt="Update Git runtime credentials" + caption="Update Git runtime credentials" + max-width="60%" +%} + +{:start="4"} +1. Do one of the following: + * If your admin has set up OAuth access, click **Authorize Access to Git Provider**. Go to _step 5_. + * Alternatively, authenticate with an access token from your Git provider. Go to _step 6_. + +{:start="5"} +1. For OAuth2 authorization: + > If the application is not registered, you get an error. Contact your admin for help. + * Enter your credentials, and select **Sign In**. + * If required, as for example if two-factor authentication is configured, complete the verification. + + {% include + image.html + lightbox="true" + file="/images/administration/user-settings/oauth-user-authentication.png" + url="/images/administration/user-settings/oauth-user-authentication.png" + alt="Authorizing access with OAuth2" + caption="Authorizing access with OAuth2" + max-width="30%" + %} + +{:start="6"} +1. For Git token authentication, expand **Advanced authorization options**, and then paste the generated token in the **Git runtime token** field. + +1. Click **Update Credentials**. + + +### Configure SSH for runtimes +By default, Git repositories use the HTTPS protocol. You can also use SSH to connect Git repositories by entering the SSH private key. + +>When SSH is configured for a runtime, when creating/editing Git-Source applications, you can select HTTPS OR SSH as the protocol to connect to the Git repository. See [Repository URL in Application Source definitions]({{site.baseurl}}/docs/deployment/create-application/#source). + +**SSH keys** +For more information on generating SSH private keys, see the official documentation: +* [GitHub](https://help.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent){:target="\_blank"} +* [GitLab](https://docs.gitlab.com/ee/ssh/#generating-a-new-ssh-key-pair){:target="\_blank"} +* [Bitbucket](https://confluence.atlassian.com/bitbucket/set-up-an-ssh-key-728138079.html){:target="\_blank"} +* [Azure](https://docs.microsoft.com/en-us/azure/devops/repos/git/use-ssh-keys-to-authenticate?view=azure-devops&tabs=current-page){:target="\_blank"} + +**Before you begin** +Copy the SSH private key for your Git provider + + +**How to** +1. In the Codefresh UI, make sure you are in [Runtimes](https://g.codefresh.io/2.0/account-settings/runtimes){:target="\_blank"}. +1. From the **List View**, select the runtime for which to configure SSH. +1. From the context menu with the additional actions at the top-right, select **Update Git Runtime Credentials**. + + {% include + image.html + lightbox="true" + file="/images/runtime/update-git-runtime-token.png" + url="/images/runtime/update-git-runtime-token.png" + alt="Update Git runtime credentials" + caption="Update Git runtime credentials" + max-width="60%" +%} + +{:start="4"} +1. Expand **Connect Repo using SSH**, and then paste the raw SSH private key into the field. + +{% include + image.html + lightbox="true" + file="/images/runtime/configure-ssh-for-runtimes.png" + url="/images/runtime/configure-ssh-for-runtimes.png" + alt="Update Git runtime credentials" + caption="Update Git runtime credentials" + max-width="40%" +%} + +{:start="5"} +1. Click **Update Credentials**. + ### Reset shared configuration repository Codefresh creates the [shared configuration repository]({{site.baseurl}}/docs/reference/shared-configuration) when you install the first hybrid or hosted GitOps runtime for your account, and uses it for all runtimes you add to the same account. @@ -308,67 +418,6 @@ Pass the mandatory flags in the uninstall command: -### Update Git tokens for runtimes - -Provisioned runtimes require valid Git tokens at all times to authenticate Git actions by you as a user. ->These tokens are specific to the user, and the same token can be used for multiple runtimes. - -There are two different situations when you need to update Git tokens: -* Update invalid, revoked, or expired tokens: Codefresh automatically flags runtimes with such tokens. It is mandatory to update the Git tokens to continue working with the platform. -* Update valid tokens: Optional. You may want to update Git tokens, even valid ones, by deleting the existing token and replacing it with a new token. - -The methods for updating any Git token are the same regardless of the reason for the update: -* OAuth2 authorization, if your admin has registered an OAuth Application for Codefresh -* Git access token authentication, by generating a personal access token in your Git provider account with the correct scopes - -**Before you begin** -* To authenticate through a Git access token, make sure your token is valid and has [the required scopes]({{site.baseurl}}/docs/reference/git-tokens) - -**How to** -1. Do one of the following: - * If you see a notification in the Codefresh UI about invalid runtime tokens, click **[Update Token]**. - The Runtimes page shows runtimes with invalid tokens prefixed by the key icon. Mouse over shows invalid token. - * To update an existing token, go to [Runtimes](https://g.codefresh.io/2.0/account-settings/runtimes){:target="\_blank"}. -1. Select the runtime for which to update the Git token. -1. From the context menu with the additional actions at the top-right, select **Update Git Runtime token**. - - {% include - image.html - lightbox="true" - file="/images/runtime/update-git-runtime-token.png" - url="/images/runtime/update-git-runtime-token.png" - alt="Update Git runtime token option" - caption="Update Git runtime token option" - max-width="40%" -%} - -{:start="4"} -1. Do one of the following: - * If your admin has set up OAuth access, click **Authorize Access to Git Provider**. Go to _step 5_. - * Alternatively, authenticate with an access token from your Git provider. Go to _step 6_. - -{:start="5"} -1. For OAuth2 authorization: - > If the application is not registered, you get an error. Contact your admin for help. - * Enter your credentials, and select **Sign In**. - * If required, as for example if two-factor authentication is configured, complete the verification. - - {% include - image.html - lightbox="true" - file="/images/administration/user-settings/oauth-user-authentication.png" - url="/images/administration/user-settings/oauth-user-authentication.png" - alt="Authorizing access with OAuth2" - caption="Authorizing access with OAuth2" - max-width="30%" - %} - -{:start="6"} -1. For Git token authentication, expand **Advanced authorization options**, and then paste the generated token in the **Git runtime token** field. - -1. Click **Update Token**. - - ### Related articles diff --git a/images/runtime/configure-ssh-for-runtimes.png b/images/runtime/configure-ssh-for-runtimes.png new file mode 100644 index 000000000..1c7029136 Binary files /dev/null and b/images/runtime/configure-ssh-for-runtimes.png differ diff --git a/images/runtime/update-git-runtime-token.png b/images/runtime/update-git-runtime-token.png index dc3e1e67f..fe7d59f2f 100644 Binary files a/images/runtime/update-git-runtime-token.png and b/images/runtime/update-git-runtime-token.png differ