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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
@@ -73,7 +73,8 @@ Here is a description of the information in the List View.
|**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) |
|**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.|
|**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> {:/} |
|**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> {:/}|
|**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> {:/}|
## (Hybrid GitOps) Configure Runtime as Argo CD application
Configure the Hybrid GitOps Runtime as an Argo CD Application.
This is usually done when installing the Runtime. If you haven
Configuring the Runtime as an Argo CD application, allows you to:
* View the Runtime components, monitor health and sync statuses, and ensure that GitOps is the single source of truth for the Runtime.
* View and its resources, services, and deployment history in the GitOps Apps dashboard through the **Runtime Application** option in the Runtime's context menu
##### How to
1. In the Codefresh UI, on the toolbar, click the **Settings** icon.
1. From the sidebar, select [**GitOps Runtimes**](https://g.codefresh.io/2.0/account-settings/runtimes){:target="\_blank"}.
1. Switch to the **List View**.
1. Select the Hybrid GitOps Runtime to configure as an Argo CD application.
1. In the Runtime Component tab, in **3: Configure runtime as an Argo Application**, click **Configure**.
alt="Configuring GitOps Runtime as an Argo CD Application"
caption="Configuring GitOps Runtime as an Argo CD Application"
max-width="60%"
%}
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.
alt="Runtime Application option to view and monitor resources"
caption="Runtime Application option to view and monitor resources"
max-width="60%"
%}
## (Hybrid GitOps) View changelogs for GitOps Runtimes
Each version of a GitOps Runtime includes a changelog detailing the changes in that release.
Changelogs are available in ArtifactHub and GitHub
Expand DownExpand Up
@@ -379,7 +424,7 @@ The methods for updating any Git token are the same regardless of the reason for
**How to**
1. In the Codefresh UI, on the toolbar, click the **Settings** icon.
1. From the sidebar, select [**GitOps Runtimes**](https://g.codefresh.io/2.0/account-settings/runtimes){:target="\_blank"}.
1. Switch toeitherthe **List View**.
1. Switch to the **List View**.
1. Do one of the following:
* To the right of the row with the Runtime to update, click the context menu and select **Update Git Runtime Credentials**.
* Click the Runtime name, click the context-menu on the top-right, and then select **Update Git Runtime Credentials**.
Expand DownExpand Up
@@ -548,14 +593,16 @@ Online logs show up to 1000 of the most recent events (lines), updated in real t
The file is downloaded as `<component-name>.log`.
## Reset Shared Configuration Repository for GitOps Runtimes
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.
Reset the Shared Configuration Repository if needed for your GitOps Runtime.
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.
The Shared Configuration Repo is created in your Git provider account. Youcan reset the repo defined for your accountunder thefollowing conditions:
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:
* **Incorrect/missing URL**
* **Incorrect/missing URL**
Mandatory when Codefresh notifies you through the UI that the Shared Configuration Repo URL is either incorrect or missing.
* Incorrect URL
* Incorrect URL<br>
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.
* Undefined URL<br>
You installed the GitOps Runtime through a script or an automated mechanism without providing the URL to the Shared Configuration Repository.
Expand All
@@ -571,7 +618,7 @@ The Shared Configuration Repo is created in your Git provider account. You can r
max-width="100%"
%}
* **No active Runtimes**
* **No active Runtimes**
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.
To do so, you must contact Codefresh Support.
Expand DownExpand Up
@@ -603,8 +650,8 @@ You can reset the Shared Configuration Repo via the CLI when:
**How to**
1. Run `cf config update-gitops-settings --shared-config-repo <shared_repo_url>`
where:
1. Run `cf config update-gitops-settings --shared-config-repo <shared_repo_url>`
where:
`<shared_repo_url>` is the new URL for the Shared Configuration Repository.
1. When prompted, select the Git provider.
1. Confirm to create the Shared Configuration Repo.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
@@ -12,8 +12,8 @@ A Codefresh account with a Hosted or a Hybrid GitOps runtime can store configura
{{site.data.callout.callout_warning}}
**IMPORTANT**
OnlyCodefresh account administrators should haveaccess to the Shared Configuration Repository. Its content is automatically generated and maintained by Codefresh.
While it is useful to understand its structure, we recommend using it for reference only, andNOT for making commits or manual changes.
Only_Codefresh account administrators should haveaccess_ to the Shared Configuration Repository. Its content is automatically generated and maintained by Codefresh.
While it is useful to understand its structure, we recommend using it for reference only, and_NOT_ for making commits or manual changes.
@@ -45,6 +45,20 @@ Here are a few types of configuration definitions stored in the Shared Configura
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).
-->
## Location of the Shared Configuration Repo
You can see the URL of the Shared Configuration Repo for your Runtime in the **Organization Information** page.
Below is a representation of the structure of the repository with the shared configuration.
See a [sample repo](https://github.com/codefresh-contrib/example-shared-config-repo){:target="\_blank"}.
Expand DownExpand Up
@@ -125,6 +139,27 @@ In addition to the application manifests for GitOps Runtimes in the Shared Confi
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.
## Shared Configuration Repo as Runtime application
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.
Select the **Runtime ISC Application** option from the Runtime's context menu.
alt="ISC (Shared Runtime Configuration repo) as Application"
caption="ISC (Shared Runtime Configuration repo) as Application"
max-width="70%"
%}
## Reset the Shared Configuration Repo
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.
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).
## Use case: Integration resources for Runtimes
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.
Expand All
@@ -144,6 +179,8 @@ You can then monitor these applications in the GitOps Overview Dashboard, and dr
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
