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

Commit03f6f29

Browse files
authored
Update managed runtime and shared repo (#1066)
* Update managed runtime and shared repoAdded runtime as application options to List view table; added Configuring runtime as argo cd app.Updated shared repo with location, application, and reset info* Update contentMinor content edits
1 parenta752b4f commit03f6f29

File tree

6 files changed

+95
-11
lines changed

6 files changed

+95
-11
lines changed

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

Lines changed: 56 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,8 @@ Here is a description of the information in the List View.
7373
|**Version**| The version of the Runtime currently installed, and the version of the Helm chart in parentheses. <br><br>**Update Available!** indicates there are newer versions of the Runtime, Helm chart, or both. <br>To see all the commits and changes for the version, mouse over**Update Available!**, and select**View Complete Change Log**. <br> See:<br>[Upgrade GitOps Runtimes](#hybrid-gitops-upgrade-gitops-runtimes)<br>[View changelogs for GitOps Runtimes](#changelog-for-all-runtime-releases)<br>[Rollback GitOps Runtimes](#hybrid-gitops-rollback-gitops-runtimes)|
7474
|**Last Updated**| The most recent update information from the runtime to the Codefresh platform. Updates are sent to the platform typically every few minutes. Longer update intervals may indicate networking issues.|
7575
|**Sync Status**| The sync status of the GitOps Runtime. The sync status is displayed only when you have completed installation and configured the GitOps Runtime as an Argo Application. {::nomarkdown}<ul><li> <img src="../../../../images/icons/runtime-synced.png" display=inline-block> <b>Synced</b></li> <li><img src="../../../../images/icons/runtime-syncing.png" display=inline-block> <b>Syncing</b>.</li><li><img src="../../../../images/icons/runtime-out-of-sync.png" display=inline-block> <b>Out-of-sync</b>.</li><li><b>N/A</b>: Codefresh could not get the sync status. This could be because the Runtime is not configured as an Argo application.</li><li><b>Complete Installation</b>: Git credentials are not configured for the Runtime. Click the three-dot context menu and select <b>Update Git Runtime Credentials</b>. See <a href="https://codefresh.io/docs/docs/installation/gitops/monitor-manage-runtimes/#update-git-credentials-for-gitops-runtimes">Update Git credentials for GitOps Runtimes</a>.</li> </ul> {:/} |
76-
|**Actions** | The possible actions to manage the selected runtime.{::nomarkdown}<ul><li> <b>Set as Configuration Runtime</b>: Designate the selected Runtime to store platform resources which are runtime-agnostic. See <a href="https://codefresh.io/docs/docs/installation/gitops/monitor-manage-runtimes/#designating-configuration-runtimes">Designating Configuration Runtimes</a>.</li><li><b>Upgrade</b>: Upgrade to the latest version. See <a href="https://codefresh.io/docs/docs/installation/gitops/monitor-manage-runtimes/#hybrid-gitops-upgrade-gitops-runtimes">Upgrade GitOps Runtimes</a>.</li><li><b>Download All Logs</b>:Download logs for the Runtime or for its components. See <a href="https://codefresh.io/docs/docs/installation/gitops/monitor-manage-runtimes/#viewdownload-logs-to-troubleshoot-gitops-runtimes">View/download logs for GitOps Runtimes</a>.</li><li><b>Update Git Runtime Credentials</b>: Update Git token for Runtime. See <a href="https://codefresh.io/docs/docs/installation/gitops/monitor-manage-runtimes/#update-git-credentials-for-gitops-runtimes">Update Git credentials for GitOps Runtimes</a>.</li><li><b>Delete Runtime</b>: Available only when the Hybrid GitOps Runtime is Offline. <br>Delete the GitOps Runtime from the Codefresh platform, retaining it on the cluster. See <a href="https://codefresh.io/docs/docs/installation/gitops/monitor-manage-runtimes/#hybrid-gitops-delete-gitops-runtimes">Delete GitOps Runtimes</a>. </li><li><b>Uninstall Runtime</b>: Uninstall the runtime from the cluster on which it is provisioned. See <a href="https://codefresh.io/docs/docs/installation/gitops/monitor-manage-runtimes/#uninstall-gitops-runtimes">Uninstall GitOps Runtimes</a>.</li> </ul> {:/}|
76+
|**Actions** | The possible actions to manage the selected runtime.{::nomarkdown}<ul><li> <b>Set as Configuration Runtime</b>: Designate the selected Runtime to store platform resources which are runtime-agnostic. See <a href="https://codefresh.io/docs/docs/installation/gitops/monitor-manage-runtimes/#designating-configuration-runtimes">Designating Configuration Runtimes</a>.</li><li><b>Upgrade</b>: Upgrade to the latest version. See <a href="https://codefresh.io/docs/docs/installation/gitops/monitor-manage-runtimes/#hybrid-gitops-upgrade-gitops-runtimes">Upgrade GitOps Runtimes</a>.</li><li><b>Download All Logs</b>:Download logs for the Runtime or for its components. See <a href="https://codefresh.io/docs/docs/installation/gitops/monitor-manage-runtimes/#viewdownload-logs-to-troubleshoot-gitops-runtimes">View/download logs for GitOps Runtimes</a>.</li><li><b>Update Git Runtime Credentials</b>: Update Git token for Runtime. See <a href="https://codefresh.io/docs/docs/installation/gitops/monitor-manage-runtimes/#update-git-credentials-for-gitops-runtimes">Update Git credentials for GitOps Runtimes</a>.</li><li><b>Runtimes as applications</b>: Options to view and monitor GitOps Runtimes as applications in the Current State tab of the GitOps Apps dashboard. For details on monitoring appplication resources, see <a href="https://codefresh.io/docs/docs/deployments/gitops/applications-dashboard/#monitoring-resources-for-selected-argo-cd-application">Monitoring resources for Argo CD applications</a>.<ul><li><b>Runtime Application</b>: Available only when the GitOps Runtime is configured as an Argo CD application. For configuration steps, see <a href="https://codefresh.io/docs/docs/installation/gitops/monitor-manage-runtimes/#hybrid-gitops-configure-runtime-as-argo-cd-application">Configuring GitOps Runtime as an Argo CD application</a>.</li><li><b>Runtime ISC Application</b>: Available when a Hybrid GitOps Runtime is installed. Displays the resources of the Shared Configuration Repository (referred to internally as <code class="highlighter-rouge">ISC/isc</code>).</li><li><b>Runtime Resources Application</b>: Available when a Hybrid GitOps Runtime is installed. Displays the resources in the local cluster (in-cluster).</li></ul></li><li><b>Delete Runtime</b>: Available only when the Hybrid GitOps Runtime is Offline. <br>Delete the GitOps Runtime from the Codefresh platform, retaining it on the cluster. See <a href="https://codefresh.io/docs/docs/installation/gitops/monitor-manage-runtimes/#hybrid-gitops-delete-gitops-runtimes">Delete GitOps Runtimes</a>. </li><li><b>Uninstall Runtime</b>: Uninstall the runtime from the cluster on which it is provisioned. See <a href="https://codefresh.io/docs/docs/installation/gitops/monitor-manage-runtimes/#uninstall-gitops-runtimes">Uninstall GitOps Runtimes</a>.</li> </ul> {:/}|
77+
7778

7879

7980
###Topology view
@@ -284,6 +285,50 @@ dependencies:
284285
`RELEASE_NAME=$(helm ls -n codefresh-gitops-runtime -q) && helm upgrade ${RELEASE_NAME} -n codefresh-gitops-runtime`
285286
1. To exit the upgrade panel, click**Close**.
286287

288+
289+
##(Hybrid GitOps) Configure Runtime as Argo CD application
290+
291+
Configure the Hybrid GitOps Runtime as an Argo CD Application.
292+
This is usually done when installing the Runtime. If you haven
293+
294+
Configuring the Runtime as an Argo CD application, allows you to:
295+
* View the Runtime components, monitor health and sync statuses, and ensure that GitOps is the single source of truth for the Runtime.
296+
* View and its resources, services, and deployment history in the GitOps Apps dashboard through the**Runtime Application** option in the Runtime's context menu
297+
298+
299+
300+
#####How to
301+
302+
1. In the Codefresh UI, on the toolbar, click the**Settings** icon.
303+
1. From the sidebar, select[**GitOps Runtimes**](https://g.codefresh.io/2.0/account-settings/runtimes){:target="\_blank"}.
304+
1. Switch to the**List View**.
305+
1. Select the Hybrid GitOps Runtime to configure as an Argo CD application.
306+
1. In the Runtime Component tab, in**3: Configure runtime as an Argo Application**, click**Configure**.
307+
308+
309+
{% include
310+
image.html
311+
lightbox="true"
312+
file="/images/runtime/helm/config-as-argo-app-post-install.png"
313+
url="/images/runtime/helm/config-as-argo-app-post-install.png"
314+
alt="Configuring GitOps Runtime as an Argo CD Application"
315+
caption="Configuring GitOps Runtime as an Argo CD Application"
316+
max-width="60%"
317+
%}
318+
319+
The Runtime's context menu now includes the**Runtime Application** option, which when selected takes you to the Current State tab in the GitOps Apps dashboard.
320+
321+
{% include
322+
image.html
323+
lightbox="true"
324+
file="/images/runtime/helm/runtime-application-option-context-menu.png"
325+
url="/images/runtime/helm/runtime-application-option-context-menu.png"
326+
alt="Runtime Application option to view and monitor resources"
327+
caption="Runtime Application option to view and monitor resources"
328+
max-width="60%"
329+
%}
330+
331+
287332
##(Hybrid GitOps) View changelogs for GitOps Runtimes
288333
Each version of a GitOps Runtime includes a changelog detailing the changes in that release.
289334
Changelogs are available in ArtifactHub and GitHub
@@ -379,7 +424,7 @@ The methods for updating any Git token are the same regardless of the reason for
379424
**How to**
380425
1. In the Codefresh UI, on the toolbar, click the**Settings** icon.
381426
1. From the sidebar, select[**GitOps Runtimes**](https://g.codefresh.io/2.0/account-settings/runtimes){:target="\_blank"}.
382-
1. Switch toeitherthe**List View**.
427+
1. Switch to the**List View**.
383428
1. Do one of the following:
384429
* To the right of the row with the Runtime to update, click the context menu and select**Update Git Runtime Credentials**.
385430
* Click the Runtime name, click the context-menu on the top-right, and then select**Update Git Runtime Credentials**.
@@ -548,14 +593,16 @@ Online logs show up to 1000 of the most recent events (lines), updated in real t
548593
The file is downloaded as`<component-name>.log`.
549594

550595
##Reset Shared Configuration Repository for GitOps Runtimes
551-
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.
596+
Reset the Shared Configuration Repository if needed for your GitOps Runtime.
597+
598+
Codefresh creates the[Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/) in your Git provider account and validate it when you install the first Hybrid or Hosted GitOps Runtime for your account. The Shared Configuration Repo is used for all GitOps Runtimes you add to the same account.
552599

553-
The Shared Configuration Repo is created in your Git provider account. Youcan reset the repo defined for your accountunder thefollowing conditions:
600+
As a Codefresh admin, youcan reset the repo defined for your accountif theURL is either incorrect or missing, or if there are no active GitOps Runtimes:
554601

555-
***Incorrect/missing URL**
602+
***Incorrect/missing URL**
556603
Mandatory when Codefresh notifies you through the UI that the Shared Configuration Repo URL is either incorrect or missing.
557604

558-
* Incorrect URL
605+
* Incorrect URL<br>
559606
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.
560607
* Undefined URL<br>
561608
You installed the GitOps Runtime through a script or an automated mechanism without providing the URL to the Shared Configuration Repository.
@@ -571,7 +618,7 @@ The Shared Configuration Repo is created in your Git provider account. You can r
571618
max-width="100%"
572619
%}
573620

574-
***No active Runtimes**
621+
***No active Runtimes**
575622
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.
576623
To do so, you must contact Codefresh Support.
577624

@@ -603,8 +650,8 @@ You can reset the Shared Configuration Repo via the CLI when:
603650
**How to**
604651

605652

606-
1. Run`cf config update-gitops-settings --shared-config-repo <shared_repo_url>`
607-
where:
653+
1. Run`cf config update-gitops-settings --shared-config-repo <shared_repo_url>`
654+
where:
608655
`<shared_repo_url>` is the new URL for the Shared Configuration Repository.
609656
1. When prompted, select the Git provider.
610657
1. Confirm to create the Shared Configuration Repo.

‎_docs/installation/gitops/shared-configuration.md‎

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ A Codefresh account with a Hosted or a Hybrid GitOps runtime can store configura
1212

1313
{{site.data.callout.callout_warning}}
1414
**IMPORTANT**
15-
OnlyCodefresh account administrators should haveaccess to the Shared Configuration Repository. Its content is automatically generated and maintained by Codefresh.
16-
While it is useful to understand its structure, we recommend using it for reference only, andNOT for making commits or manual changes.
15+
Only_Codefresh account administrators should haveaccess_ to the Shared Configuration Repository. Its content is automatically generated and maintained by Codefresh.
16+
While it is useful to understand its structure, we recommend using it for reference only, and_NOT_ for making commits or manual changes.
1717
{{site.data.callout.end}}
1818

1919
***Centralized Runtime configuration management**
@@ -45,6 +45,20 @@ Here are a few types of configuration definitions stored in the Shared Configura
4545
You may need to reset the Shared Configuration Repo after creating it. See [Reset Shared Configuration Repository for GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#reset-shared-configuration-repository-for-gitops-runtimes).
4646
-->
4747

48+
##Location of the Shared Configuration Repo
49+
50+
You can see the URL of the Shared Configuration Repo for your Runtime in the**Organization Information** page.
51+
52+
{% include
53+
image.html
54+
lightbox="true"
55+
file="/images/runtime/shared-isc-repo/shared-isc-location.png"
56+
url="/images/runtime/shared-isc-repo/shared-isc-location.png"
57+
alt="Shared Configuration Repo URL"
58+
caption="Shared Configuration Repo URL"
59+
max-width="60%"
60+
%}
61+
4862
##Shared Configuration Repo structure
4963
Below is a representation of the structure of the repository with the shared configuration.
5064
See a[sample repo](https://github.com/codefresh-contrib/example-shared-config-repo){:target="\_blank"}.
@@ -125,6 +139,27 @@ In addition to the application manifests for GitOps Runtimes in the Shared Confi
125139

126140
This Git Source application creates an application manifest with the `<cluster-name>` for every cluster managed by the GitOps Runtime. The `include` field in the `<cluster-name>` application manifest determines which subdirectories in the `resources` directory are synced to the target cluster.
127141

142+
## Shared Configuration Repo as Runtime application
143+
You can view and monitor all resources in the Shared Configuration Repo as any other Argo CD application in the GitOps Apps dashboard's Current State tab.
144+
145+
Select the **Runtime ISC Application** option from the Runtime's context menu.
146+
147+
{% include
148+
image.html
149+
lightbox="true"
150+
file="/images/runtime/shared-isc-repo/isc-runtime-app-context-menu.png"
151+
url="/images/runtime/shared-isc-repo/isc-runtime-app-context-menu.png"
152+
alt="ISC (Shared Runtime Configuration repo) as Application"
153+
caption="ISC (Shared Runtime Configuration repo) as Application"
154+
max-width="70%"
155+
%}
156+
157+
158+
## Reset the Shared Configuration Repo
159+
160+
Currently, Codefresh supports a single Shared Configuration Repo per account. You may need to reset the Shared Configuration Repo in specific scenarios, such as a missing or incorrect URL.
161+
For more information, see [Reset Shared Configuration Repo for GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#reset-shared-configuration-repository-for-gitops-runtimes).
162+
128163

129164
## Use case: Integration resources for Runtimes
130165
When creating a new GitOps Integration resource, such as a container registry integration for example in the Codefresh UI, you can define the GitOps Runtimes to which to apply that resource. The `app-proxy` saves the resource in the correct location in the Shared Configuration Repo, and updates the relevant Argo CD Applications to include it.
@@ -144,6 +179,8 @@ You can then monitor these applications in the GitOps Overview Dashboard, and dr
144179
{{site.data.callout.end}}
145180

146181

182+
183+
147184
## Related articles
148185
[Hosted GitOps Runtime installation]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/)
149186
[Hybrid GitOps Runtime installation]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/)
61 KB
Loading
85.9 KB
Loading
86.5 KB
Loading
43.6 KB
Loading

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp