Skip to content

Commit 902a430

Browse files
update README.md
1 parent 7548966 commit 902a430

File tree

2 files changed

+43
-6
lines changed

2 files changed

+43
-6
lines changed

charts/gitops-runtime/README.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,26 @@ argo-cd:
9393
enabled: false
9494
```
9595
96+
## Installation with External Argo Rollouts
97+
98+
If you want to use an existing Argo Rollouts installation, you can disable the built-in Argo Rollouts and configure the GitOps Runtime to use the external Argo Rollouts.
99+
See the `values.yaml` example below:
100+
101+
```yaml
102+
global:
103+
# -- Configuration for external Argo Rollouts
104+
external-argo-rollouts:
105+
# -- Rollout reporter settings
106+
rollout-reporter:
107+
# -- Enable rollout reporter
108+
# Configuration is defined at .Values.event-reporters.rollout
109+
enabled: true
110+
111+
argo-rollouts:
112+
# -- Disable built-in Argo Rollouts
113+
enabled: false
114+
```
115+
96116
## Using with private registries - Helper utility
97117
The GitOps Runtime comprises multiple subcharts and container images. Subcharts also vary in values structure, making it difficult to override image specific values to use private registries.
98118
We have created a helper utility to resolve this issue:
@@ -230,6 +250,7 @@ sealed-secrets:
230250
| argo-cd.applicationVersioning.useApplicationConfiguration | bool | `true` | Extract application version based on ApplicationConfiguration CRD |
231251
| argo-cd.configs.cm."accounts.admin" | string | `"apiKey,login"` | |
232252
| argo-cd.configs.cm."application.resourceTrackingMethod" | string | `"annotation+label"` | |
253+
| argo-cd.configs.cm."resource.customizations.actions.argoproj.io_Rollout" | string | `"mergeBuiltinActions: true\ndiscovery.lua: |\n actions = {}\n local fullyPromoted = obj.status.currentPodHash == obj.status.stableRS\n actions[\"pause\"] = {[\"disabled\"] = fullyPromoted or obj.spec.paused == true}\n actions[\"skip-current-step\"] = {[\"disabled\"] = obj.spec.strategy.canary == nil or obj.spec.strategy.canary.steps == nil or obj.status.currentStepIndex == table.getn(obj.spec.strategy.canary.steps)}\n return actions\ndefinitions:\n- name: pause\n action.lua: |\n obj.spec.paused = true\n return obj\n- name: skip-current-step\n action.lua: |\n if obj.status ~= nil then\n if obj.spec.strategy.canary ~= nil and obj.spec.strategy.canary.steps ~= nil and obj.status.currentStepIndex < table.getn(obj.spec.strategy.canary.steps) then\n if obj.status.pauseConditions ~= nil and table.getn(obj.status.pauseConditions) > 0 then\n obj.status.pauseConditions = nil\n end\n obj.status.currentStepIndex = obj.status.currentStepIndex + 1\n end\n end\n return obj\n"` | |
233254
| argo-cd.configs.cm."timeout.reconciliation" | string | `"20s"` | |
234255
| argo-cd.configs.params."application.namespaces" | string | `"cf-*"` | |
235256
| argo-cd.configs.params."server.insecure" | bool | `true` | |
@@ -326,12 +347,6 @@ sealed-secrets:
326347
| gitops-operator.resources.limits | object | `{}` | |
327348
| gitops-operator.resources.requests.cpu | string | `"100m"` | |
328349
| gitops-operator.resources.requests.memory | string | `"128Mi"` | |
329-
| gitops-operator.resources.resources.limits.cpu | string | `"500m"` | |
330-
| gitops-operator.resources.resources.limits.memory | string | `"128Mi"` | |
331-
| gitops-operator.resources.resources.requests.cpu | string | `"100m"` | |
332-
| gitops-operator.resources.resources.requests.memory | string | `"64Mi"` | |
333-
| gitops-operator.resources.securityContext.allowPrivilegeEscalation | bool | `false` | |
334-
| gitops-operator.resources.securityContext.capabilities.drop[0] | string | `"ALL"` | |
335350
| gitops-operator.serviceAccount.annotations | object | `{}` | |
336351
| gitops-operator.serviceAccount.create | bool | `true` | |
337352
| gitops-operator.serviceAccount.name | string | `"gitops-operator-controller-manager"` | |
@@ -366,6 +381,9 @@ sealed-secrets:
366381
| global.external-argo-cd.server.port | int | `80` | Port of the ArgoCD server |
367382
| global.external-argo-cd.server.rootpath | string | `""` | Set if Argo CD is running behind reverse proxy under subpath different from / e.g. rootpath: '/argocd' |
368383
| global.external-argo-cd.server.svc | string | `"argocd-server"` | Service name of the ArgoCD server |
384+
| global.external-argo-rollouts | object | `{"rollout-reporter":{"enabled":false}}` | Configuration for external Argo Rollouts |
385+
| global.external-argo-rollouts.rollout-reporter | object | `{"enabled":false}` | Rollout reporter settings |
386+
| global.external-argo-rollouts.rollout-reporter.enabled | bool | `false` | Enable or disable rollout reporter Configuration is defined at .Values.event-reporters.rollout |
369387
| global.runtime | object | `{"cluster":"https://kubernetes.default.svc","codefreshHosted":false,"eventBus":{"annotations":{},"name":"codefresh-eventbus","nats":{"native":{"auth":"token","containerTemplate":{"resources":{"limits":{"cpu":"500m","ephemeral-storage":"2Gi","memory":"4Gi"},"requests":{"cpu":"200m","ephemeral-storage":"2Gi","memory":"1Gi"}}},"maxPayload":"4MB","replicas":3}},"pdb":{"enabled":true,"minAvailable":2}},"gitCredentials":{"password":{"secretKeyRef":{},"value":null},"username":"username"},"ingress":{"annotations":{},"className":"nginx","enabled":false,"hosts":[],"protocol":"https","skipValidation":false,"tls":[]},"ingressUrl":"","isConfigurationRuntime":false,"name":null}` | Runtime level settings |
370388
| global.runtime.cluster | string | `"https://kubernetes.default.svc"` | Runtime cluster. Should not be changed. |
371389
| global.runtime.codefreshHosted | bool | `false` | Defines whether this is a Codefresh hosted runtime. Should not be changed. |

charts/gitops-runtime/README.md.gotmpl

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,25 @@ argo-cd:
9494
enabled: false
9595
```
9696

97+
## Installation with External Argo Rollouts
98+
99+
If you want to use an existing Argo Rollouts installation, you can disable the built-in Argo Rollouts and configure the GitOps Runtime to use the external Argo Rollouts.
100+
See the `values.yaml` example below:
101+
102+
```yaml
103+
global:
104+
# -- Configuration for external Argo Rollouts
105+
external-argo-rollouts:
106+
# -- Rollout reporter settings
107+
rollout-reporter:
108+
# -- Enable rollout reporter
109+
# Configuration is defined at .Values.event-reporters.rollout
110+
enabled: true
111+
112+
argo-rollouts:
113+
# -- Disable built-in Argo Rollouts
114+
enabled: false
115+
```
97116

98117
## Using with private registries - Helper utility
99118
The GitOps Runtime comprises multiple subcharts and container images. Subcharts also vary in values structure, making it difficult to override image specific values to use private registries.

0 commit comments

Comments
 (0)