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

Commit3401c7e

Browse files
authored
Add optional runtime config to byoa (#1285)
* Add optional runtime config to byoaAdded optional runtime configuration for private registries and custom repo certificates to install with existing argo* Create runtime-troubleshooting.md* Minor fixes
1 parent1db7098 commit3401c7e

File tree

3 files changed

+271
-44
lines changed

3 files changed

+271
-44
lines changed

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

Lines changed: 36 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,10 @@ helm upgrade --install <helm-release-name> \
121121
##Step 4: Completing Installation
122122
After installation, you can:
123123
* Continue with the Configuration & Management steps in the installation wizard. See[Configure GitOps Runtime]({{site.baseurl}}/docs/installation/gitops/runtime-configuration/#configure-gitops-runtime).
124-
* View the installed Runtime in the Runtimes page, and complete the configuration at a later time.
124+
* View the installed Runtime in the Runtimes page.
125+
* Depending on your setup, complete the post-installation configuration:
126+
* For private registries, you need to[override specific image values](#image-overrides-for-private-registries).
127+
* If your Git servers are on-premises,[add custom repository certificates](#custom-repository-certificates).
125128

126129
#####View installed Runtime
127130
After installation, go to**GitOps Runtimes > List View**:
@@ -144,13 +147,36 @@ After installation, go to **GitOps Runtimes > List View**:
144147
%}
145148

146149

150+
##Optional GitOps Runtime configuration
147151

148-
{% if page.collection != site.gitops_collection %}
149-
###(Optional) Post-installation configuration
150-
After completing the installation, you may need to perform additional configuration depending on your setup.
151-
* For private registries, you need to[override specific image values](#image-overrides-for-private-registries).
152-
* If your Git servers are on-premises,[add custom repository certificates](#custom-repository-certificates).
153-
{% endif %}
152+
###Image overrides for private registries
153+
If you use private registries, you must override specific image values for the different subcharts and container images.
154+
Our utility helps override image values for GitOps Runtimes by creating`values` files that match the structure of the subcharts, allowing you to easily replace image registries. During chart installation, you can provide these`values` files to override the images, as needed.
155+
For more details, see[ArtifactHub](https://artifacthub.io/packages/helm/codefresh-gitops-runtime/gitops-runtime#using-with-private-registries---helper-utility){:target="\_blank"}.
156+
157+
###Custom repository certificates
158+
159+
Repository certificates are required to authenticate users to on-premises Git servers.
160+
161+
If your Git servers are on-premises, add the repository certificates to your Codefresh`values` file, in`.values.argo-cd`. These values are used by the Argo CD that Codefresh deploys. For details on adding repository certificates, see this[section](https://github.com/codefresh-io/argo-helm/blob/argo-cd-5.29.2-cap-CR-18430/charts/argo-cd/values.yaml#LL336C7-L336C7){:target="\_blank"}.
162+
163+
{% highlight yaml %}
164+
global:
165+
codefresh:
166+
tls:
167+
caCerts:
168+
# optional - use an existing secret that contains the cert
169+
# secretKeyRef:
170+
# name: my-certificate-secret
171+
# key: ca-bundle.crt
172+
# or create "codefresh-tls-certs" secret
173+
secret:
174+
create: true
175+
content: |
176+
-----BEGIN CERTIFICATE-----
177+
...
178+
-----END CERTIFICATE-----
179+
{% endhighlight yaml %}
154180

155181

156182

@@ -189,52 +215,20 @@ resource "helm_release" "my_gitops_runtime" {
189215
}
190216
```
191217

192-
Feel free to use a different chart version and a unique name for the Runtime.You can get the values for both the Codefresh API token and account ID from the Codefresh UI as explained in the previous section.
218+
You can get the values for both the Codefresh API token and account ID from the Codefresh UI as explained in the previous section.
193219

194220
The example is valid for the tunnel-based access mode. For ingress-based or service-mesh-based access modes, add the required arguments and values, as described in[GitOps Runtimes with ingress controllers/service meshes]({{site.baseurl}}/docs/installation/gitops/runtime-install-ingress-service-mesh-access-mode/).
195221

196-
Depending on your configuration:
197-
* If you have private registries, you need to override specific image values, and if your Git servers are on-premises, you need to add custom repository certificates. See[Optional GitOps Runtime configuration](#optional-gitops-runtime-configuration) in this article.
198-
* If you installed the GitOps Runtime on a cluster with Argo CD, you can[migrate Community Argo CD Applications](#migrate-argo-cd-applications-to-codefresh-gitops-runtime) to GitOps applications.
222+
Depending on your configuration, if you have private registries, you need to override specific image values, and if your Git servers are on-premises, you need to add custom repository certificates. See[Optional GitOps Runtime configuration](#optional-gitops-runtime-configuration) in this article.
199223

200224

201-
By default, the GitOps Runtime can deploy to the cluster it is installed on. You can add[Git Sources]({{site.baseurl}}/docs/installation/gitops/git-sources/), use[Terraform to connect external clusters]({{site.baseurl}}/docs/installation/gitops/managed-cluster/#add-a-managed-cluster-with-terraform), and[create and deployGitOps applications]({{site.baseurl}}/docs/deployments/gitops/create-application/).
225+
By default, the GitOps Runtime can deploy to the cluster it is installed on. You can add[Git Sources]({{site.baseurl}}/docs/installation/gitops/git-sources/), use[Terraform to connect external clusters]({{site.baseurl}}/docs/installation/gitops/managed-cluster/#add-a-managed-cluster-with-terraform), and[create and deployArgo CD applications]({{site.baseurl}}/docs/deployments/gitops/create-application/).
202226

203227

204228

205-
{% if page.collection != site.gitops_collection %}
206-
##Optional GitOps Runtime configuration
207-
208-
###Image overrides for private registries
209-
If you use private registries, you must override specific image values for the different subcharts and container images.
210-
Our utility helps override image values for GitOps Runtimes by creating`values` files that match the structure of the subcharts, allowing you to easily replace image registries. During chart installation, you can provide these`values` files to override the images, as needed.
211-
For more details, see[ArtifactHub](https://artifacthub.io/packages/helm/codefresh-gitops-runtime/gitops-runtime#using-with-private-registries---helper-utility){:target="\_blank"}.
212229

213-
###Custom repository certificates
214230

215-
Repository certificates are required to authenticate users to on-premises Git servers.
216231

217-
If your Git servers are on-premises, add the repository certificates to your Codefresh`values` file, in`.values.argo-cd`. These values are used by the Argo CD that Codefresh deploys. For details on adding repository certificates, see this[section](https://github.com/codefresh-io/argo-helm/blob/argo-cd-5.29.2-cap-CR-18430/charts/argo-cd/values.yaml#LL336C7-L336C7){:target="\_blank"}.
218-
219-
{% highlight yaml %}
220-
global:
221-
codefresh:
222-
tls:
223-
caCerts:
224-
# optional - use an existing secret that contains the cert
225-
# secretKeyRef:
226-
# name: my-certificate-secret
227-
# key: ca-bundle.crt
228-
# or create "codefresh-tls-certs" secret
229-
secret:
230-
create: true
231-
content: |
232-
-----BEGIN CERTIFICATE-----
233-
...
234-
-----END CERTIFICATE-----
235-
{% endhighlight yaml %}
236-
237-
{% endif %}
238232

239233

240234
##Related articles

‎_docs/installation/gitops/runtime-install-with-existing-argo-cd.md‎

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,10 @@ helm upgrade --install <helm-release-name> \
137137
##Step 4: Completing Installation
138138
After installation, you can:
139139
* Continue with the Configuration & Management steps in the installation wizard. See[Configure GitOps Runtime]({{site.baseurl}}/docs/installation/gitops/runtime-configuration/#configure-gitops-runtime).
140-
OR
141-
* View the installed Runtime in the Runtimes page, and complete the configuration at a later time.
140+
* View the installed Runtime in the Runtimes page.
141+
* Depending on your setup, complete the post-installation configuration:
142+
* For private registries, you need to[override specific image values](#image-overrides-for-private-registries).
143+
* If your Git servers are on-premises,[add custom repository certificates](#custom-repository-certificates).
142144

143145
#####View installed Runtime
144146
After installation, go to**GitOps Runtimes > List View**:
@@ -161,6 +163,38 @@ After installation, go to **GitOps Runtimes > List View**:
161163
%}
162164

163165

166+
##Optional GitOps Runtime configuration
167+
168+
###Image overrides for private registries
169+
If you use private registries, you must override specific image values for the different subcharts and container images.
170+
Our utility helps override image values for GitOps Runtimes by creating`values` files that match the structure of the subcharts, allowing you to easily replace image registries. During chart installation, you can provide these`values` files to override the images, as needed.
171+
For more details, see[ArtifactHub](https://artifacthub.io/packages/helm/codefresh-gitops-runtime/gitops-runtime#using-with-private-registries---helper-utility){:target="\_blank"}.
172+
173+
###Custom repository certificates
174+
175+
Repository certificates are required to authenticate users to on-premises Git servers.
176+
177+
If your Git servers are on-premises, add the repository certificates to your Codefresh`values` file, in`.values.argo-cd`. These values are used by the Argo CD that Codefresh deploys. For details on adding repository certificates, see this[section](https://github.com/codefresh-io/argo-helm/blob/argo-cd-5.29.2-cap-CR-18430/charts/argo-cd/values.yaml#LL336C7-L336C7){:target="\_blank"}.
178+
179+
{% highlight yaml %}
180+
global:
181+
codefresh:
182+
tls:
183+
caCerts:
184+
# optional - use an existing secret that contains the cert
185+
# secretKeyRef:
186+
# name: my-certificate-secret
187+
# key: ca-bundle.crt
188+
# or create "codefresh-tls-certs" secret
189+
secret:
190+
create: true
191+
content: |
192+
-----BEGIN CERTIFICATE-----
193+
...
194+
-----END CERTIFICATE-----
195+
{% endhighlight yaml %}
196+
197+
164198
##Install GitOps Runtime via Terraform
165199

166200
You can also use Terraform to install additional GitOps Runtimes with the[Helm provider](https://registry.terraform.io/providers/hashicorp/helm/latest/docs){:target="\_blank"}.
@@ -196,6 +230,16 @@ resource "helm_release" "my_gitops_runtime" {
196230
```
197231

198232

233+
You can get the values for both the Codefresh API token and account ID from the Codefresh UI as explained in the previous section.
234+
235+
The example is valid for the tunnel-based access mode. For ingress-based or service-mesh-based access modes, add the required arguments and values, as described in[GitOps Runtimes with ingress controllers/service meshes]({{site.baseurl}}/docs/installation/gitops/runtime-install-ingress-service-mesh-access-mode/).
236+
237+
Depending on your configuration, if you have private registries, you need to override specific image values, and if your Git servers are on-premises, you need to add custom repository certificates. See[Optional GitOps Runtime configuration](#optional-gitops-runtime-configuration) in this article.
238+
239+
240+
By default, the GitOps Runtime can deploy to the cluster it is installed on. You can add[Git Sources]({{site.baseurl}}/docs/installation/gitops/git-sources/), use[Terraform to connect external clusters]({{site.baseurl}}/docs/installation/gitops/managed-cluster/#add-a-managed-cluster-with-terraform), and[create and deploy Argo CD applications]({{site.baseurl}}/docs/deployments/gitops/create-application/).
241+
242+
199243
##Related articles
200244
[Configuring GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/runtime-configuration/)
201245
[Upgrading GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/manage-runtimes/#upgrade-gitops-runtimes/)

0 commit comments

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