You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _docs/deployment/create-application.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,8 +50,9 @@ General configuration settings define the source, destination, and sync policies
50
50
%}
51
51
52
52
#### Source
53
-
The Git repository to be tracked for changes to the application's source code.
54
-
{::nomarkdown}<ul> <li><b>ArgoCD Project</b>: The project group to which the application belongs. A project is useful to enforce restrictions on permitted sources and targets for applications, and roles. If not defined, the application is automatically assigned to the <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">default</span> project, which is created automatically by Argo CD and has no restrictions. </br>For more information, see Argo CD's documentation on <a href="https://argo-cd.readthedocs.io/en/stable/user-guide/projects/#projects" target="\_blank">Projects</a>.</li> <li><b>Repository URL</b>: The Git repo or the Helm package repo with the application source code, to be tracked for changes. If the Argo CD project is not the <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">default</span> project, make sure that the repo has the correct access roles for your application.<ul><li><b>Revision and Path</b>: Applies to Git repositories. </li><li><b>Chart</b>: Applies to Helm repositories. The name of the Helm package with all the resource definitions for the application, and the version. </li></ul>For more information, see <a href="https://argo-cd.readthedocs.io/en/stable/user-guide/tracking_strategies/" target="\_blank">Tracking and Deployment Strategies</a>.</li></ul> {:/}
53
+
The Git repository to be tracked for changes to the application's source code.
54
+
55
+
{::nomarkdown}<ul> <li><b>ArgoCD Project</b>: The project group to which the application belongs. A project is useful to enforce restrictions on permitted sources and targets for applications, and roles. If not defined, the application is automatically assigned to the <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">default</span> project, which is created automatically by Argo CD and has no restrictions. </br>For more information, see Argo CD's documentation on <a href="https://argo-cd.readthedocs.io/en/stable/user-guide/projects/#projects" target="\_blank">Projects</a>.</li> <li><b>Repository URL</b>: The Git repo or the Helm package repo with the application source code, to be tracked for changes. If SSH is configured for the runtime, you can connect to the repo with either HTTPS or SSH. On selecting the repository, Codefresh automatically updates the URL format. See <a href="https://codefresh.io/csdp-docs/docs/runtime/monitor-manage-runtimes/#configure-ssh-for-runtimes">Configure SSH for runtimes</a>.<br>If the Argo CD project is not the <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">default</span> project, make sure that the repo has the correct access roles for your application.<ul><li><b>Revision and Path</b>: Applies to Git repositories. </li><li><b>Chart</b>: Applies to Helm repositories. The name of the Helm package with all the resource definitions for the application, and the version. </li></ul>For more information, see <a href="https://argo-cd.readthedocs.io/en/stable/user-guide/tracking_strategies/" target="\_blank">Tracking and Deployment Strategies</a>.</li></ul> {:/}
@@ -100,6 +102,114 @@ Here is a description of the information in the Topology view.
100
102
|**Health/Sync status**|The health and sync status of the runtime or cluster. {::nomarkdown}<ul><li><imgsrc="../../../images/icons/error.png"display="inline-block"> indicates health or sync errors in the runtime, or a managed cluster if one was added to the runtime.</br> The runtime or cluster node is bordered in red and the name is colored red.</li> <li><imgsrc="../../../images/icons/cf-sync-status.png"display=inline-block/> indicates that the runtime is being synced to the cluster on which it is provisioned.</li></ul> {:/} |
101
103
|**Search and View options**| {::nomarkdown}<ul><li>Find a runtime or its clusters by typing part of the runtime/cluster name, and then navigate to the entries found. </li> <li>Topology view options: Resize to window, zoom in, zoom out, full screen view.</li></ul> {:/}|
102
104
105
+
### Update Git tokens for runtimes
106
+
107
+
Provisioned runtimes require valid Git tokens at all times to authenticate Git actions by you as a user.
108
+
>These tokens are specific to the user, and the same token can be used for multiple runtimes.
109
+
110
+
There are two different situations when you need to update Git tokens:
111
+
* 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.
112
+
* 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.
113
+
114
+
The methods for updating any Git token are the same regardless of the reason for the update:
115
+
* OAuth2 authorization, if your admin has registered an OAuth Application for Codefresh
116
+
* Git access token authentication, by generating a personal access token in your Git provider account with the correct scopes
117
+
118
+
**Before you begin**
119
+
* To authenticate through a Git access token, make sure your token is valid and has [the required scopes]({{site.baseurl}}/docs/reference/git-tokens)
120
+
121
+
**How to**
122
+
1. Do one of the following:
123
+
* If you see a notification in the Codefresh UI about invalid runtime tokens, click **[Update Token]**.
124
+
The Runtimes page shows runtimes with invalid tokens prefixed by the key icon. Mouse over shows invalid token.
125
+
* To update an existing token, go to [Runtimes](https://g.codefresh.io/2.0/account-settings/runtimes){:target="\_blank"}.
126
+
1. From the List view, select the runtime for which to update the Git token.
127
+
1. From the context menu with the additional actions at the top-right, select **Update Git Runtime Credentials**.
1. For Git token authentication, expand **Advanced authorization options**, and then paste the generated token in the **Git runtime token** field.
162
+
163
+
1. Click **Update Credentials**.
164
+
165
+
166
+
### Configure SSH for runtimes
167
+
By default, Git repositories use the HTTPS protocol. You can also use SSH to connect Git repositories by entering the SSH private key.
168
+
169
+
>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).
170
+
171
+
**SSH keys**
172
+
For more information on generating SSH private keys, see the official documentation:
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.
105
215
@@ -308,67 +418,6 @@ Pass the mandatory flags in the uninstall command:
308
418
309
419
310
420
311
-
### Update Git tokens for runtimes
312
-
313
-
Provisioned runtimes require valid Git tokens at all times to authenticate Git actions by you as a user.
314
-
>These tokens are specific to the user, and the same token can be used for multiple runtimes.
315
-
316
-
There are two different situations when you need to update Git tokens:
317
-
* 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.
318
-
* 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.
319
-
320
-
The methods for updating any Git token are the same regardless of the reason for the update:
321
-
* OAuth2 authorization, if your admin has registered an OAuth Application for Codefresh
322
-
* Git access token authentication, by generating a personal access token in your Git provider account with the correct scopes
323
-
324
-
**Before you begin**
325
-
* To authenticate through a Git access token, make sure your token is valid and has [the required scopes]({{site.baseurl}}/docs/reference/git-tokens)
326
-
327
-
**How to**
328
-
1. Do one of the following:
329
-
* If you see a notification in the Codefresh UI about invalid runtime tokens, click **[Update Token]**.
330
-
The Runtimes page shows runtimes with invalid tokens prefixed by the key icon. Mouse over shows invalid token.
331
-
* To update an existing token, go to [Runtimes](https://g.codefresh.io/2.0/account-settings/runtimes){:target="\_blank"}.
332
-
1. Select the runtime for which to update the Git token.
333
-
1. From the context menu with the additional actions at the top-right, select **Update Git Runtime token**.
0 commit comments