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
Once you authorize access, Codefresh creates two Git repositories, one to store the configuration settings for GitOps Runtimes, and the other to store the Runtime's application settings as a Git Source:
Once you authorize access, Codefresh creates two Git repositories, one to store the configuration settings for GitOps Runtimes in the account, and the other to store the Runtime's application settings as a Git Source:
* Shared Configuration Repository
The Shared Configuration Repository is a centralized Git repository that stores configuration settings for the Hosted GitOps Runtime. Additional Hybrid runtimes provisioned for the account can point to this repo to retrieve and reuse the configuration.
Read about [Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/).
When you define the repository URL, you can also add the path, reference a branch, or both:
`<repo_url>.git[/<path>][?ref=<branch>]`
where:
* `<repo_url>.git` is required and is the repository URL. This is the standard URL format which references the root of the default branch in the repository. The `.git` suffix is recommended.
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
@@ -253,10 +253,25 @@ As a one-time action, define the Shared Configuration Repository and the Git pro
The Git provider you select for the first GitOps Runtime in your account is used for all the other Runtimes installed in the same account.
**Shared Configuration Repository**
####Shared Configuration Repository
The [Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/) is a Git repository with configuration manifests shared between all the Hybrid GitOps Runtimes within the same account. Codefresh identifies the Git provider from the URL of the Shared Configuration Repo, and for cloud providers, automatically populates the Git Provider and the API URL fields.
**Git provider**
You can specify only the repository URL, or add the path, reference a branch, or both:
`<repo_url>.git[/<path>][?ref=<branch>]`
where:
* `<repo_url>.git` is required and is the repository URL. This is the standard URL format which references the root of the default branch in the repository. The `.git` suffix is recommended.
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
@@ -593,68 +593,11 @@ 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
Resetthe Shared Configuration Repository if neededforyour GitOpsRuntime.
When you installthefirst Hybrid or Hosted GitOps Runtime for your account, as part of the setup, Codefresh creates the [Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/) in your Git provider account and validates the URL. The Shared Configuration Repo is usedforall GitOpsRuntimes you add to the same account.
Codefreshcreates the [Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/) in your Git provider accountand validate it when you install the first HybridorHosted GitOps Runtime for your account. The Shared Configuration Repo is used for allGitOps Runtimes you add to the same account.
As aCodefreshadmin, you can reset the repo defined for your accountif the URL is either incorrect or missing,orif there are no activeGitOps Runtimes. See [Reset Shared Configuration Repo]({{site.baseurl}}/docs/installation/shared-configuration/#reset-shared-configuration-repo).
As a Codefresh admin, you can reset the repo defined for your account if the URL is either incorrect or missing, or if there are no active GitOps Runtimes:
* **Incorrect/missing URL**
Mandatory when Codefresh notifies you through the UI that the Shared Configuration Repo URL is either incorrect or missing.
* 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.
alt="Notification for missing/incorrect Shared Configuration Repository"
caption="Notification for missing/incorrect Shared Configuration Repository"
max-width="100%"
%}
* **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.
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.
<!--- ### Reset Shared Config Repo via UI
You can reset the Shared Config Repo via the Codefresh UI when you see the notification that the URL is either incorrect or missing.
**Before you begin**
Verify that you have [authorized access to the Codefresh app's organizations]({{site.baseurl}}/docs/administration/account-user-management/hosted-authorize-orgs/)
1. Click **Update**.
1. In **Add Shared Configuration Repo**, enter your Git username and the URL at which to create the repo.
1. From the list of **Git Organizations**, select the Git organization for the Codefresh application.
### Reset Shared Config Repo via CLI
You can reset the Shared Configuration Repo via the CLI when:
* You receive the notification that the URL is incorrect or missing
* There are no active GitOps Runtimes in your account.
To reset the URL for an account with existing GitOps Runtimes, you must [uninstall](#uninstall-gitops-runtimes) all the Runtimes.
-->
**Before you begin**
* Make sure you have no active GitOps Runtimes in your account
**How to**
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.
## (Hybrid GitOps) Configure Deep Links to applications & resources
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
A Codefresh account with a Hosted or a Hybrid GitOps runtime can store configuration manifests for account-level resources in a Git repository. This repository, the Shared Configuration Repository, can be shared with other GitOps Runtimes in the same account, avoiding the need to create and maintain different configuration manifests for every GitOps Runtime. At the same time, you also have the flexibility to store resources unique to specific Runtimes without affecting other Runtimes.
##### When is it created?
The Shared Configuration Repository (internally ISO/iso) is created on installing the first Hosted or Hybrid GitOps Runtime in the account. See [GitOps Runtimes & Shared Configuration Repos](#gitops-runtimes--shared-configuration-repos).
{{site.data.callout.callout_warning}}
**IMPORTANT**
Only _Codefresh account administrators should have access_ 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.
With the Shared Configuration Repository, you can store configuration manifests for account-level resources in a centralized location. The Git repository is accessible to all GitOps Runtimes within the same Codefresh account, ensuring that account-level resources are consistently deployed and managed across all environments.
* **Runtime-specific configuration**
With the Shared Configuration Repository, you can create subdirectories for different GitOps Runtimes, and place configuration manifests that are only applied to specific GitOps Runtimes. You have fine-grained control over the configuration of individual Runtimes without affecting others.
## Examples of configuration definitions in Shared Repo
Here are a few types of configuration definitions stored in the Shared Configuration Repository:
* In-cluster and [managed clusters]({{site.baseurl}}/docs/installation/gitops/managed-cluster/)
See [Shared Configuration Repo structure](#shared-configuration-repo-structure)
## GitOps Runtimes & Shared Configuration Repos
* Hosted GitOps Runtimes
As part of the setup for a Hosted GitOps runtime, Codefresh creates the Shared Configuration Repository in the selected organization, together with the default Git Source repo. See [Connect Git provider]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/#step-2-connect-git-provider) in Hosted GitOps setup.
* Hybrid GitOps Runtimes
When you install the first Hybrid GitOps runtime for an account, you are required to define the Shared Configuration Repo as part of setting up your Git account. See [Installing Hybrid GitOps Helm Runtime installation]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/#step-3-set-up-gitops-git-account).
When you install the first Hybrid GitOps runtime for an account, you are required to define the Shared Configuration Repo as part of setting up your Git account. See [Installing Hybrid GitOps Helm Runtime installation: Set up Git provider]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/#step-2-set-up-gitops-git-provider).
<!---
>>**NOTE**
Currently, Codefresh supports a single Shared Configuration Repo per account.
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).
-->
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). -->
### Shared Configuration Repo URL formats
When defining the Shared Configuration Repository for the account, you have the option to specify a path, a branch, or both, within the repository URL.
This allows for flexibility in targeting specific directories or branches in the repository.
`<repo_url>.git[/<path>][?ref=<branch>]`
where:
* `<repo_url>.git` is required and is the repository URL. This is the standard URL format which references the root of the default branch in the repository.
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
@@ -155,10 +184,70 @@ Select the **Runtime ISC Application** option from the Runtime's context menu.
%}
## Reset the Shared Configuration Repo
## Reset Shared Configuration Repo
As a Codefresh admin, you can reset the repo defined for your account if the URL is either incorrect or missing, or if there are no active GitOps Runtimes.
### Conditions for reset of Shared Repo
* **Incorrect/missing URL**
Mandatory when Codefresh notifies you through the UI that the Shared Configuration Repo URL is either incorrect or missing.
* 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.
alt="Notification for missing/incorrect Shared Configuration Repository"
caption="Notification for missing/incorrect Shared Configuration Repository"
max-width="100%"
%}
* **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.
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.
<!--- ### Reset Shared Config Repo via UI
You can reset the Shared Config Repo via the Codefresh UI when you see the notification that the URL is either incorrect or missing.
**Before you begin**
Verify that you have [authorized access to the Codefresh app's organizations]({{site.baseurl}}/docs/administration/account-user-management/hosted-authorize-orgs/)
1. Click **Update**.
1. In **Add Shared Configuration Repo**, enter your Git username and the URL at which to create the repo.
1. From the list of **Git Organizations**, select the Git organization for the Codefresh application.
You can reset the Shared Configuration Repo via the CLI when:
* You receive the notification that the URL is incorrect or missing
* There are no active GitOps Runtimes in your account.
To reset the URL for an account with existing GitOps Runtimes, you must [uninstall](#uninstall-gitops-runtimes) all the Runtimes.
-->
### Reset Shared Config Repo via CLI
##### Before you begin
* Make sure you have no active GitOps Runtimes in your account
##### How to
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, optionally including a path, branch or both.
1. When prompted, select the Git provider.
1. Confirm to create 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
Expand Down
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.