Skip to content

Commit c98fd28

Browse files
update README.md
1 parent 910bcb4 commit c98fd28

File tree

2 files changed

+43
-6
lines changed

2 files changed

+43
-6
lines changed

charts/gitops-runtime/README.md

+24-6
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,26 @@ argo-cd:
8181
enabled: false
8282
```
8383
84+
## Installation with External Argo Rollouts
85+
86+
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.
87+
See the `values.yaml` example below:
88+
89+
```yaml
90+
global:
91+
# -- Configuration for external Argo Rollouts
92+
external-argo-rollouts:
93+
# -- Rollout reporter settings
94+
rollout-reporter:
95+
# -- Enable rollout reporter
96+
# Configuration is defined at .Values.event-reporters.rollout
97+
enabled: true
98+
99+
argo-rollouts:
100+
# -- Disable built-in Argo Rollouts
101+
enabled: false
102+
```
103+
84104
## Using with private registries - Helper utility
85105
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.
86106
We have created a helper utility to resolve this issue:
@@ -218,6 +238,7 @@ sealed-secrets:
218238
| argo-cd.applicationVersioning.useApplicationConfiguration | bool | `true` | Extract application version based on ApplicationConfiguration CRD |
219239
| argo-cd.configs.cm."accounts.admin" | string | `"apiKey,login"` | |
220240
| argo-cd.configs.cm."application.resourceTrackingMethod" | string | `"annotation+label"` | |
241+
| 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"` | |
221242
| argo-cd.configs.cm."timeout.reconciliation" | string | `"20s"` | |
222243
| argo-cd.configs.params."application.namespaces" | string | `"cf-*"` | |
223244
| argo-cd.configs.params."server.insecure" | bool | `true` | |
@@ -319,12 +340,6 @@ sealed-secrets:
319340
| gitops-operator.resources.limits | object | `{}` | |
320341
| gitops-operator.resources.requests.cpu | string | `"100m"` | |
321342
| gitops-operator.resources.requests.memory | string | `"128Mi"` | |
322-
| gitops-operator.resources.resources.limits.cpu | string | `"500m"` | |
323-
| gitops-operator.resources.resources.limits.memory | string | `"128Mi"` | |
324-
| gitops-operator.resources.resources.requests.cpu | string | `"100m"` | |
325-
| gitops-operator.resources.resources.requests.memory | string | `"64Mi"` | |
326-
| gitops-operator.resources.securityContext.allowPrivilegeEscalation | bool | `false` | |
327-
| gitops-operator.resources.securityContext.capabilities.drop[0] | string | `"ALL"` | |
328343
| gitops-operator.serviceAccount.annotations | object | `{}` | |
329344
| gitops-operator.serviceAccount.create | bool | `true` | |
330345
| gitops-operator.serviceAccount.name | string | `"gitops-operator-controller-manager"` | |
@@ -359,6 +374,9 @@ sealed-secrets:
359374
| global.external-argo-cd.server.port | int | `80` | Port of the ArgoCD server |
360375
| global.external-argo-cd.server.rootpath | string | `""` | Set if Argo CD is running behind reverse proxy under subpath different from / e.g. rootpath: '/argocd' |
361376
| global.external-argo-cd.server.svc | string | `"argocd-server"` | Service name of the ArgoCD server |
377+
| global.external-argo-rollouts | object | `{"rollout-reporter":{"enabled":false}}` | Configuration for external Argo Rollouts |
378+
| global.external-argo-rollouts.rollout-reporter | object | `{"enabled":false}` | Rollout reporter settings |
379+
| global.external-argo-rollouts.rollout-reporter.enabled | bool | `false` | Enable or disable rollout reporter Configuration is defined at .Values.event-reporters.rollout |
362380
| 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 |
363381
| global.runtime.cluster | string | `"https://kubernetes.default.svc"` | Runtime cluster. Should not be changed. |
364382
| global.runtime.codefreshHosted | bool | `false` | Defines whether this is a Codefresh hosted runtime. Should not be changed. |

charts/gitops-runtime/README.md.gotmpl

+19
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,25 @@ argo-cd:
8181
enabled: false
8282
```
8383

84+
## Installation with External Argo Rollouts
85+
86+
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.
87+
See the `values.yaml` example below:
88+
89+
```yaml
90+
global:
91+
# -- Configuration for external Argo Rollouts
92+
external-argo-rollouts:
93+
# -- Rollout reporter settings
94+
rollout-reporter:
95+
# -- Enable rollout reporter
96+
# Configuration is defined at .Values.event-reporters.rollout
97+
enabled: true
98+
99+
argo-rollouts:
100+
# -- Disable built-in Argo Rollouts
101+
enabled: false
102+
```
84103

85104
## Using with private registries - Helper utility
86105
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)