Skip to content

Commit bdf8f58

Browse files
mikhail-klimkomikhail-klimko
committed
update README.md
1 parent 28a9091 commit bdf8f58

File tree

2 files changed

+41
-38
lines changed

2 files changed

+41
-38
lines changed

‎charts/gitops-runtime/README.md

Lines changed: 23 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,24 @@ argo-cd:
101101
enabled: false
102102
```
103103
104+
⚠️ If `auth.type=password` is set, ArgoCD user must have `apiKey` capability enabled.
105+
106+
`argocd-cm` ConfigMap
107+
108+
```yaml
109+
apiVersion: v1
110+
kind: ConfigMap
111+
metadata:
112+
name: argocd-cm
113+
namespace: argocd
114+
labels:
115+
app.kubernetes.io/name: argocd-cm
116+
app.kubernetes.io/part-of: argocd
117+
data:
118+
accounts.admin: apiKey, login
119+
admin.enabled: "true"
120+
```
121+
104122
## Installation with External Argo Rollouts
105123

106124
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.
@@ -212,14 +230,14 @@ sealed-secrets:
212230
| app-proxy.image-enrichment.serviceAccount.name | string | `"codefresh-image-enrichment-sa"` | Name of the service account to create or the name of the existing one to use |
213231
| app-proxy.image.pullPolicy | string | `"IfNotPresent"` | |
214232
| app-proxy.image.repository | string | `"quay.io/codefresh/cap-app-proxy"` | |
215-
| app-proxy.image.tag | string | `"1.3514.0"` | |
233+
| app-proxy.image.tag | string | `"1.3534.0"` | |
216234
| app-proxy.imagePullSecrets | list | `[]` | |
217235
| app-proxy.initContainer.command[0] | string | `"./init.sh"` | |
218236
| app-proxy.initContainer.env | object | `{}` | |
219237
| app-proxy.initContainer.extraVolumeMounts | list | `[]` | Extra volume mounts for init container |
220238
| app-proxy.initContainer.image.pullPolicy | string | `"IfNotPresent"` | |
221239
| app-proxy.initContainer.image.repository | string | `"quay.io/codefresh/cap-app-proxy-init"` | |
222-
| app-proxy.initContainer.image.tag | string | `"1.3514.0"` | |
240+
| app-proxy.initContainer.image.tag | string | `"1.3534.0"` | |
223241
| app-proxy.initContainer.resources.limits | object | `{}` | |
224242
| app-proxy.initContainer.resources.requests.cpu | string | `"0.2"` | |
225243
| app-proxy.initContainer.resources.requests.memory | string | `"256Mi"` | |
@@ -297,42 +315,9 @@ sealed-secrets:
297315
| cf-argocd-extras.sourcesServer | object | `{"affinity":{},"enabled":true,"hpa":{"enabled":true},"nodeSelector":{},"tolerations":[]}` | Sources server configuration |
298316
| cf-argocd-extras.sourcesServer.hpa.enabled | bool | `true` | Enable HPA for sources server |
299317
| codefreshWorkflowLogStoreCM | object | `{"enabled":true,"endpoint":"gitops-workflow-logs.codefresh.io","insecure":false}` | Argo workflows logs storage on Codefresh platform settings. Don't change unless instructed by Codefresh support. |
300-
| event-reporters.rollout.eventSource.affinity | object | `{}` | |
301-
| event-reporters.rollout.eventSource.nodeSelector | object | `{}` | |
302-
| event-reporters.rollout.eventSource.replicas | int | `1` | |
303-
| event-reporters.rollout.eventSource.resources | object | `{}` | |
304-
| event-reporters.rollout.eventSource.tolerations | list | `[]` | |
305-
| event-reporters.rollout.sensor.affinity | object | `{}` | |
306-
| event-reporters.rollout.sensor.env | object | `{}` | Environment variables for sensor pods - add DEBUG_LOG: "true" to add debug level logs |
307-
| event-reporters.rollout.sensor.logging | object | `{"enabled":false,"intervalSeconds":0}` | Set to true to enable logging. Set intervalSeconds to add logging interval to moderate log flow. |
308-
| event-reporters.rollout.sensor.nodeSelector | object | `{}` | |
309-
| event-reporters.rollout.sensor.replicas | int | `1` | |
310-
| event-reporters.rollout.sensor.resources | object | `{}` | |
311-
| event-reporters.rollout.sensor.retryStrategy | object | `{"duration":0,"factor":1,"jitter":1,"steps":3}` | Retry strategy for events sent to Codefresh |
312-
| event-reporters.rollout.sensor.retryStrategy.duration | int | `0` | The initial duration, use strings like "2s", "1m" |
313-
| event-reporters.rollout.sensor.retryStrategy.factor | float | `1` | Duration is multiplied by factor each retry, if factor is not zero and steps limit has not been reached. Should not be negative |
314-
| event-reporters.rollout.sensor.retryStrategy.jitter | int | `1` | The sleep between each retry is the duration plus an additional amount chosen uniformly at random from the interval between zero and `jitter * duration`. |
315-
| event-reporters.rollout.sensor.retryStrategy.steps | int | `3` | Number of retries |
316-
| event-reporters.rollout.sensor.tolerations | list | `[]` | |
317-
| event-reporters.rollout.serviceAccount.create | bool | `true` | |
318-
| event-reporters.workflow.eventSource.affinity | object | `{}` | |
319-
| event-reporters.workflow.eventSource.nodeSelector | object | `{}` | |
320-
| event-reporters.workflow.eventSource.replicas | int | `1` | |
321-
| event-reporters.workflow.eventSource.resources | object | `{}` | |
322-
| event-reporters.workflow.eventSource.tolerations | list | `[]` | |
323-
| event-reporters.workflow.sensor.affinity | object | `{}` | |
324-
| event-reporters.workflow.sensor.env | object | `{}` | Environment variables for sensor pods - add DEBUG_LOG: "true" to add debug level logs |
325-
| event-reporters.workflow.sensor.logging | object | `{"enabled":false,"intervalSeconds":0}` | Set to true to enable logging. Set intervalSeconds to add logging interval to moderate log flow. |
326-
| event-reporters.workflow.sensor.nodeSelector | object | `{}` | |
327-
| event-reporters.workflow.sensor.replicas | int | `1` | |
328-
| event-reporters.workflow.sensor.resources | object | `{}` | |
329-
| event-reporters.workflow.sensor.retryStrategy | object | `{"duration":0,"factor":1,"jitter":1,"steps":3}` | Retry strategy for events sent to Codefresh |
330-
| event-reporters.workflow.sensor.retryStrategy.duration | int | `0` | The initial duration, use strings like "2s", "1m" |
331-
| event-reporters.workflow.sensor.retryStrategy.factor | float | `1` | Duration is multiplied by factor each retry, if factor is not zero and steps limit has not been reached. Should not be negative |
332-
| event-reporters.workflow.sensor.retryStrategy.jitter | int | `1` | The sleep between each retry is the duration plus an additional amount chosen uniformly at random from the interval between zero and `jitter * duration`. |
333-
| event-reporters.workflow.sensor.retryStrategy.steps | int | `3` | Number of retries |
334-
| event-reporters.workflow.sensor.tolerations | list | `[]` | |
335-
| event-reporters.workflow.serviceAccount.create | bool | `true` | |
318+
| event-reporters | object | `{"workflow":{"serviceAccount":{"create":true,"name":""}}}` | Event reporters configuration for backward compatibility |
319+
| event-reporters.workflow.serviceAccount.create | bool | `true` | Create service account for workflow reporter |
320+
| event-reporters.workflow.serviceAccount.name | string | `""` | Service account name (defaults to codefresh-sa if not specified) |
336321
| gitops-operator.affinity | object | `{}` | |
337322
| gitops-operator.config.commitStatusPollingInterval | string | `"10s"` | Commit status polling interval |
338323
| gitops-operator.config.maxConcurrentReleases | int | `100` | Maximum number of concurrent releases being processed by the operator (this will not affect the number of releases being processed by the gitops runtime) |

‎charts/gitops-runtime/README.md.gotmpl

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,24 @@ argo-cd:
103103
enabled: false
104104
```
105105

106+
⚠️ If `auth.type=password` is set, ArgoCd user must have `apiKey` capability enabled.
107+
108+
`argocd-cm` ConfigMap
109+
110+
```yaml
111+
apiVersion: v1
112+
kind: ConfigMap
113+
metadata:
114+
name: argocd-cm
115+
namespace: argocd
116+
labels:
117+
app.kubernetes.io/name: argocd-cm
118+
app.kubernetes.io/part-of: argocd
119+
data:
120+
accounts.admin: apiKey, login
121+
admin.enabled: "true"
122+
```
123+
106124
## Installation with External Argo Rollouts
107125

108126
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.

0 commit comments

Comments
 (0)