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

Commit7206b8c

Browse files
authored
Shared repo isc updates (#1072)
* Add isc URL options to install stepAdded ISC URL format options to Shared Repo topic and to Step 2 in Hybrid install topicMoved Reset task from Runtime management to Shared Repo topic* Update shared-configuration.mdAdded missing backticks in command* Add isc url format to hosted step
1 parentbab8040 commit7206b8c

File tree

4 files changed

+137
-75
lines changed

4 files changed

+137
-75
lines changed

‎_docs/installation/gitops/hosted-runtime.md‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,11 +150,26 @@ max-width="80%"
150150
%}
151151

152152

153-
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:
153+
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:
154154
* Shared Configuration Repository
155155
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.
156156
Read about[Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/).
157157

158+
When you define the repository URL, you can also add the path, reference a branch, or both:
159+
160+
`<repo_url>.git[/<path>][?ref=<branch>]`
161+
162+
where:
163+
*`<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.
164+
Example:`https://github.com/codefresh-io/our-isc.git`
165+
166+
*`<path>` is optional, and points to a specific path within the repository.
167+
Use`<path>` if you want your configuration files within a subdirectory.
168+
Example:`https://github.com/codefresh-io/our-isc.git/some/path`
169+
170+
*`<branch>` is optional, and references a specific branch in the repository.
171+
Example:`https://github.com/codefresh-io/our-isc.git?ref=isc-branch`
172+
158173

159174
* Git Source application repo
160175
Codefresh creates a Git Source application repo for every Hosted GitOps Runtime.

‎_docs/installation/gitops/hybrid-gitops-helm-installation.md‎

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,10 +253,25 @@ As a one-time action, define the Shared Configuration Repository and the Git pro
253253

254254
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.
255255

256-
**Shared Configuration Repository**
256+
####Shared Configuration Repository
257257
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.
258258

259-
**Git provider**
259+
You can specify only the repository URL, or add the path, reference a branch, or both:
260+
261+
`<repo_url>.git[/<path>][?ref=<branch>]`
262+
263+
where:
264+
*`<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.
265+
Example:`https://github.com/codefresh-io/our-isc.git`
266+
267+
*`<path>` is optional, and points to a specific path within the repository.
268+
Use`<path>` if you want your configuration files within a subdirectory.
269+
Example:`https://github.com/codefresh-io/our-isc.git/some/path`
270+
271+
*`<branch>` is optional, and references a specific branch in the repository.
272+
Example:`https://github.com/codefresh-io/our-isc.git?ref=isc-branch`
273+
274+
####Git providers
260275
On-premises Git providers require you to define the API URL:
261276
* GitHub Enterprise:`https://<server-url>/api/v3`
262277
* GitLab Server:`<server-url>/api/v4`

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

Lines changed: 2 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -593,68 +593,11 @@ Online logs show up to 1000 of the most recent events (lines), updated in real t
593593
The file is downloaded as`<component-name>.log`.
594594

595595
##Reset Shared Configuration Repository for GitOps Runtimes
596-
Resetthe Shared Configuration Repository if neededforyour GitOpsRuntime.
596+
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.
597597

598-
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.
598+
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).
599599

600-
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:
601600

602-
***Incorrect/missing URL**
603-
Mandatory when Codefresh notifies you through the UI that the Shared Configuration Repo URL is either incorrect or missing.
604-
605-
* Incorrect URL<br>
606-
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.
607-
* Undefined URL<br>
608-
You installed the GitOps Runtime through a script or an automated mechanism without providing the URL to the Shared Configuration Repository.
609-
610-
611-
{% include
612-
image.html
613-
lightbox="true"
614-
file="/images/runtime/shared-config-repo-missing.png"
615-
url="/images/runtime/shared-config-repo-missing.png"
616-
alt="Notification for missing/incorrect Shared Configuration Repository"
617-
caption="Notification for missing/incorrect Shared Configuration Repository"
618-
max-width="100%"
619-
%}
620-
621-
***No active Runtimes**
622-
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.
623-
To do so, you must contact Codefresh Support.
624-
625-
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.
626-
627-
<!--- ### Reset Shared Config Repo via UI
628-
You can reset the Shared Config Repo via the Codefresh UI when you see the notification that the URL is either incorrect or missing.
629-
630-
**Before you begin**
631-
632-
Verify that you have [authorized access to the Codefresh app's organizations]({{site.baseurl}}/docs/administration/account-user-management/hosted-authorize-orgs/)
633-
634-
635-
1. Click **Update**.
636-
1. In **Add Shared Configuration Repo**, enter your Git username and the URL at which to create the repo.
637-
1. From the list of **Git Organizations**, select the Git organization for the Codefresh application.
638-
639-
### Reset Shared Config Repo via CLI
640-
You can reset the Shared Configuration Repo via the CLI when:
641-
* You receive the notification that the URL is incorrect or missing
642-
* There are no active GitOps Runtimes in your account.
643-
To reset the URL for an account with existing GitOps Runtimes, you must [uninstall](#uninstall-gitops-runtimes) all the Runtimes.
644-
645-
-->
646-
647-
**Before you begin**
648-
* Make sure you have no active GitOps Runtimes in your account
649-
650-
**How to**
651-
652-
653-
1. Run`cf config update-gitops-settings --shared-config-repo <shared_repo_url>`
654-
where:
655-
`<shared_repo_url>` is the new URL for the Shared Configuration Repository.
656-
1. When prompted, select the Git provider.
657-
1. Confirm to create the Shared Configuration Repo.
658601

659602
##(Hybrid GitOps) Configure Deep Links to applications & resources
660603

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

Lines changed: 102 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,40 +10,61 @@ toc: true
1010

1111
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.
1212

13+
#####When is it created?
14+
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).
15+
1316
{{site.data.callout.callout_warning}}
1417
**IMPORTANT**
1518
Only_Codefresh account administrators should have access_ to the Shared Configuration Repository. Its content is automatically generated and maintained by Codefresh.
1619
While it is useful to understand its structure, we recommend using it for reference only, and_NOT_ for making commits or manual changes.
1720
{{site.data.callout.end}}
1821

22+
#####Benefits
23+
1924
***Centralized Runtime configuration management**
2025
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.
2126

2227
***Runtime-specific configuration**
2328
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.
2429

25-
##Examples of configuration definitions in Shared Repo
26-
27-
Here are a few types of configuration definitions stored in the Shared Configuration Repository:
28-
* In-cluster and[managed clusters]({{site.baseurl}}/docs/installation/gitops/managed-cluster/)
29-
*[Git Sources]({{site.baseurl}}/docs/installation/gitops/git-sources/)
30-
*[Integrations]({{site.baseurl}}/docs/gitops-integrations/image-enrichment-overview/) between Codefresh and third-parties for GitOps
31-
*[OAuth2]({{site.baseurl}}/docs/administration/account-user-management/oauth-setup/) authentication applications
30+
See[Shared Configuration Repo structure](#shared-configuration-repo-structure)
3231

3332
##GitOps Runtimes & Shared Configuration Repos
3433

3534
* Hosted GitOps Runtimes
3635
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.
3736

3837
* Hybrid GitOps Runtimes
39-
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).
38+
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).
4039

4140

4241
<!---
4342
>>**NOTE**
4443
Currently, Codefresh supports a single Shared Configuration Repo per account.
45-
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).
46-
-->
44+
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).-->
45+
46+
###Shared Configuration Repo URL formats
47+
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.
48+
This allows for flexibility in targeting specific directories or branches in the repository.
49+
50+
`<repo_url>.git[/<path>][?ref=<branch>]`
51+
52+
where:
53+
*`<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.
54+
Example:`https://github.com/codefresh-io/our-isc.git`
55+
56+
*`<path>` is optional, and points to a specific path within the repository. Use`<path>` if you want your configuration files within a subdirectory.
57+
Example:`https://github.com/codefresh-io/our-isc.git/some/path`
58+
59+
*`<branch>` is optional, and references a specific branch in the repository.
60+
Example:`https://github.com/codefresh-io/our-isc.git?ref=isc-branch`
61+
62+
Combining both a path and a branch allows more granular control.
63+
Example:`https://github.com/codefresh-io/our-isc.git/some/path?ref=isc-branch`.
64+
65+
66+
67+
4768

4869
##Location of the Shared Configuration Repo
4970

@@ -59,6 +80,14 @@ You can see the URL of the Shared Configuration Repo for your Runtime in the **O
5980
max-width="60%"
6081
%}
6182

83+
##Examples of configuration definitions in Shared Repo
84+
85+
Here are a few types of configuration definitions stored in the Shared Configuration Repository:
86+
* In-cluster and[managed clusters]({{site.baseurl}}/docs/installation/gitops/managed-cluster/)
87+
*[Git Sources]({{site.baseurl}}/docs/installation/gitops/git-sources/)
88+
*[Integrations]({{site.baseurl}}/docs/gitops-integrations/image-enrichment-overview/) between Codefresh and third-parties for GitOps
89+
*[OAuth2]({{site.baseurl}}/docs/administration/account-user-management/oauth-setup/) authentication applications
90+
6291
##Shared Configuration Repo structure
6392
Below is a representation of the structure of the repository with the shared configuration.
6493
See a[sample repo](https://github.com/codefresh-contrib/example-shared-config-repo){:target="\_blank"}.
@@ -155,10 +184,70 @@ Select the **Runtime ISC Application** option from the Runtime's context menu.
155184
%}
156185

157186

158-
## Reset the Shared Configuration Repo
187+
## Reset Shared Configuration Repo
188+
189+
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.
190+
191+
### Conditions for reset of Shared Repo
192+
193+
* **Incorrect/missing URL**
194+
Mandatory when Codefresh notifies you through the UI that the Shared Configuration Repo URL is either incorrect or missing.
195+
196+
* Incorrect URL<br>
197+
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.
198+
* Undefined URL<br>
199+
You installed the GitOps Runtime through a script or an automated mechanism without providing the URL to the Shared Configuration Repository.
200+
201+
202+
{% include
203+
image.html
204+
lightbox="true"
205+
file="/images/runtime/shared-config-repo-missing.png"
206+
url="/images/runtime/shared-config-repo-missing.png"
207+
alt="Notification for missing/incorrect Shared Configuration Repository"
208+
caption="Notification for missing/incorrect Shared Configuration Repository"
209+
max-width="100%"
210+
%}
211+
212+
* **No active Runtimes**
213+
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.
214+
To do so, you must contact Codefresh Support.
215+
216+
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.
217+
218+
<!---### Reset Shared Config Repo via UI
219+
You can reset the Shared Config Repo via the Codefresh UI when you see the notification that the URL is either incorrect or missing.
220+
221+
**Before you begin**
222+
223+
Verify that you have [authorized access to the Codefresh app's organizations]({{site.baseurl}}/docs/administration/account-user-management/hosted-authorize-orgs/)
224+
225+
226+
1. Click **Update**.
227+
1. In **Add Shared Configuration Repo**, enter your Git username and the URL at which to create the repo.
228+
1. From the list of **Git Organizations**, select the Git organization for the Codefresh application.
229+
230+
231+
You can reset the Shared Configuration Repo via the CLI when:
232+
* You receive the notification that the URL is incorrect or missing
233+
* There are no active GitOps Runtimes in your account.
234+
To reset the URL for an account with existing GitOps Runtimes, you must [uninstall](#uninstall-gitops-runtimes) all the Runtimes.
235+
236+
-->
237+
### Reset Shared Config Repo via CLI
238+
239+
##### Before you begin
240+
* Make sure you have no active GitOps Runtimes in your account
241+
242+
##### How to
243+
244+
245+
1. Run `cf config update-gitops-settings --shared-config-repo <shared_repo_url>`
246+
where:
247+
`<shared_repo_url>`is the new URL for the Shared Configuration Repository, optionally including a path, branch or both.
248+
1. When prompted, select the Git provider.
249+
1. Confirm to create the Shared Configuration Repo.
159250

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).
162251

163252

164253
## Use case: Integration resources for Runtimes

0 commit comments

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