Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit02be798

Browse files
authored
Update monitor-manage-runtimes.md (#796)
* Update monitor-manage-runtimes.md* Add download logs for HelmAdded separate procedure for download logs for helm runtime* Update monitor-manage-runtimes.md* Update monitor-manage-runtimes.md* Update monitor-manage-runtimes.md
1 parenta6174fe commit02be798

File tree

2 files changed

+44
-25
lines changed

2 files changed

+44
-25
lines changed

‎_docs/installation/gitops/monitor-manage-runtimes.md‎

Lines changed: 44 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -184,31 +184,31 @@ dependencies:
184184

185185
## Update Git credentials for GitOps Runtimes
186186

187-
Provisioned GitOps Runtimes require valid Git tokens at all times to authenticateGit actions by you as a user.
188-
These Gittokens arepersonal accesstokens, specific to each user. As such, you can use the same Gituser token for multiple Runtimes.
187+
Provisioned GitOps Runtimes require valid GitRuntimetokens at all times to authenticateand authorize the Runtime.
188+
The GitRuntime token differs from the Git user token which is apersonal accesstoken unique to each user. As such, you can use the same GitRuntime token for multiple Runtimes.
189189

190190
>**TIP**:
191191
Git credentials are synced to the Shared Configuration Repository defined during installation. If you change your Git credentials, the Git account must match that of the Shared repo. For example, if the Shared repo is defined as `http://github.com/my-org/isc.git` and the Git provider is defined as `bitbucket`, the update will fail.
192192

193193
**When to update**
194-
If your Git token is valid, you can update it at any time by deleting the existing token and replacing it with a new token.
194+
If your GitRuntimetoken is valid, you can update it at any time by deleting the existing token and replacing it with a new token.
195195

196196
Otherwise, you have to update Git tokens in the following situations:
197-
* **Complete Installation** status displayed in Sync column for Runtime
197+
* **Complete Installation** status displayed in Sync column for Runtime<br>
198198
You have installed the Runtime but need to update the Git credentials to complete the installation.
199-
* Invalid, revoked, or expired tokens
199+
* Invalid, revoked, or expired tokens<br>
200200
Codefresh automatically flags Runtimes with such tokens. It is mandatory to update the Git tokens to continue working with the platform.
201201

202-
**Update methods**
202+
**Update methods**<br>
203203
The methods for updating any Git token are the same regardless of the reason for the update:
204204
* OAuth2 authorization, if your admin has registered an OAuth Application for Codefresh.
205-
* Git access token authentication, by generating a Gituser token in your Git provider account with the correct scopes.
206-
You can update your Gituser token in the UI or through the CLI.
205+
* Git access token authentication, by generating a GitRuntime token in your Git provider account with the correct scopes.
206+
You can update your GitRuntime token in the UI or through the CLI.
207207

208-
### Update Git credentials in Codefresh UI
208+
### Update GitRuntimecredentials in Codefresh UI
209209

210210
**Before you begin**
211-
* To authenticate through a Gituser token, make sure your token is valid and has [the required scopes]({{site.baseurl}}/docs/reference/git-tokens/#git-user-access-token-scopes)
211+
* To authenticate through a GitRuntime token, make sure your token is valid and has [the required scopes]({{site.baseurl}}//docs/reference/git-tokens/#git-runtime-token-scopes)
212212

213213
**How to**
214214
1. In the Codefresh UI, on the toolbar, click the **Settings** icon.
@@ -255,8 +255,8 @@ The methods for updating any Git token are the same regardless of the reason for
255255
1. For Git token authentication, paste the generated token in the **Git runtime token** field.
256256
1. Click **Update Credentials**.
257257

258-
### Update Gituser token through CLI
259-
If you are using Gituser tokens for authentication, you can also update them through the Codefresh CLI.
258+
### Update GitRuntime token through CLI
259+
If you are using GitRuntime tokens for authentication, you can also update them through the Codefresh CLI.
260260

261261
* Run:
262262
`cf config update-gitops-settings --shared-config-repo <repo_url> [--git-provider <git-provider>] [--git-api-url <git-api-url>]`
@@ -325,15 +325,15 @@ Copy the SSH private key for your Git provider
325325
## Reset Shared Configuration Repository for GitOps Runtimes
326326
Codefresh creates and validates the [Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration) when you install the first Hybrid or Hosted GitOps Runtime for your account, and uses it for all GitOps Runtimes you add to the same account.
327327

328-
Oncecreated, youcan reset theShared Configuration Repo defined for your account under the following conditions:
328+
The Shared Configuration Repo iscreated in your Git provider account. Youcan reset therepo defined for your account under the following conditions:
329329

330-
* **Incorrect/missing URL**
331-
Mandatory when Codefresh notifies you through the UIif the Shared Configuration Repo URL is either incorrect or missing.
330+
* **Incorrect/missing URL**
331+
Mandatory when Codefresh notifies you through the UIthat the Shared Configuration Repo URL is either incorrect or missing.
332332

333-
* Incorrect URL
333+
* Incorrect URL
334334
The Shared Config Repo details provided during installation in Account Setup are incorrect. Codefresh could not connect to the Shared Repo with the details provided.
335-
* Undefined URL
336-
You installed the GitOps Runtime through a script oranother automated mechanism without providing the URL to the Shared Configuration Repository.
335+
* Undefined URL<br>
336+
You installed the GitOps Runtime through a script oran automated mechanism without providing the URL to the Shared Configuration Repository.
337337

338338

339339
{% include
@@ -346,13 +346,13 @@ Once created, you can reset the Shared Configuration Repo defined for your accou
346346
max-width="100%"
347347
%}
348348

349-
* **No active Runtimes**
349+
* **No active Runtimes**
350350
If Codefresh has already validated the existing Shared Configuration Repository, meaning that at least one GitOps Runtime successfully connected to it, you _cannot change_ the Shared Configuration Repo URL.
351351
To do so, you must contact Codefresh Support.
352352

353-
Otherwise, you can reset the Shared Config Repo URL only _after uninstalling all the GitOps Runtimes in your account_. This option is useful when moving from a temporary account, for example, a POV account, to your organization's official account. Codefresh allows you to reset the URL.
353+
Otherwise, you can reset the Shared Config Repo URL only _after uninstalling all the GitOps Runtimes in your account_. This option is useful when moving from a temporary account, for example, a POV account, to your organization's official account to reset the URL.
354354

355-
### Reset Shared Config Repo via UI
355+
<!---### Reset Shared Config Repo via UI
356356
You can reset the Shared Config Repo via the Codefresh UI when you see the notification that the URL is either incorrect or missing.
357357

358358
**Before you begin**
@@ -364,21 +364,25 @@ Verify that you have [authorized access to the Codefresh app's organizations]({{
364364
1. In **Add Shared Configuration Repo**, enter your Git username and the URL at which to create the repo.
365365
1. From the list of **Git Organizations**, select the Git organization for the Codefresh application.
366366

367-
### Reset Shared Config Repo via CLI
367+
### Reset Shared Config Repo via CLI
368368
You can reset the Shared Configuration Repo via the CLI when:
369369
* You receive the notification that the URL is incorrect or missing
370370
* There are no active GitOps Runtimes in your account.
371371
To reset the URL for an account with existing GitOps Runtimes, you must [uninstall](#uninstall-gitops-runtimes) all the Runtimes.
372372

373+
-->
373374

374375
**Before you begin**
375-
* Make sure you havehaveno active Runtimes in your account
376+
* Make sure you have no active GitOps Runtimes in your account
376377

377378
**How to**
378379

379-
* Run `cf config update-gitops-settings --shared-config-repo <shared_repo_url>`
380+
381+
1. Run `cf config update-gitops-settings --shared-config-repo <shared_repo_url>`
380382
where:
381383
`<shared_repo_url>`is the new URL for the Shared Configuration Repository.
384+
1. When prompted, select the Git provider.
385+
1. Confirm to create the Shared Configuration Repo.
382386

383387
## (Hybrid GitOps) Configure Deep Links to applications & resources
384388

@@ -521,10 +525,25 @@ Uninstalling a GitOps Runtime permanently removes:
521525

522526

523527

528+
## (Helm GitOps) Download logs for GitOps Runtimes
524529

530+
Download the logs for a completed GitOps Runtime installation.<br>
531+
The Runtime log is downloaded as a `.tar.gz` file, which contains the individual log files for each runtime component.
525532

533+
1. In the Codefresh UI, on the toolbar, click the **Settings** icon, expand Runtimes in the sidebar, and select [**GitOps Runtimes**](https://g.codefresh.io/2.0/account-settings/runtimes){:target="\_blank"}.
534+
1. If needed, switch to **List View**, and then select the runtime for which to download logs.
535+
1. From the context menu, select **Download All Logs**.
536+
The log file is downloaded to the Downloads folder or the folder designated for downloads, with the filename, `<runtime-name>.tar.gz`. For example, `codefreshv2-production2.tar.gz`.
526537

527-
538+
{% include
539+
image.html
540+
lightbox="true"
541+
file="/images/runtime/helm-download-all-logs.png"
542+
url="/images/runtime/helm-download-all-logs.png"
543+
alt="Download all logs for installed GitOps Runtime"
544+
caption="Download all logs for installed GitOps Runtime"
545+
max-width="60%"
546+
%}
528547

529548
## (Legacy CLI Hybrid GitOps) View/download logs for GitOps Runtimes
530549
Logs are available for completed Runtimes, both for the runtime and for individual runtime components. Download log files for offline viewing and analysis, or view online logs for a Runtime component, and download if needed for offline analysis. Online logs support free-text search, search-result navigation, and line-wrap for enhanced readability.
54.5 KB
Loading

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp