Skip to content

Commit fe194fd

Browse files
vitalii-codefreshvitalii-codefresh
committed
upd docs
1 parent 285cfda commit fe194fd

File tree

1 file changed

+189
-0
lines changed

1 file changed

+189
-0
lines changed

‎charts/codefresh-gitops/README.md‎

Lines changed: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,189 @@
1+
# codefresh-gitops
2+
3+
![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![AppVersion: 0.1.0](https://img.shields.io/badge/AppVersion-0.1.0-informational?style=flat-square)
4+
5+
Helm Chart for Codefresh GitOps On-Prem
6+
7+
**Homepage:** <https://codefresh.io/>
8+
9+
## Maintainers
10+
11+
| Name | Email | Url |
12+
| ---- | ------ | --- |
13+
| codefresh | | <https://codefresh-io.github.io/> |
14+
15+
## Source Code
16+
17+
* <https://github.com/codefresh-io/codefresh-onprem-helm>
18+
19+
## Requirements
20+
21+
| Repository | Name | Version |
22+
|------------|------|---------|
23+
| https://charts.bitnami.com/bitnami | mongodb | 15.6.26 |
24+
| https://charts.bitnami.com/bitnami | postgresql | 16.7.4 |
25+
| https://charts.bitnami.com/bitnami | rabbitmq | 15.5.3 |
26+
| https://charts.bitnami.com/bitnami | redis | 20.13.4 |
27+
| oci://quay.io/codefresh/charts | argo-hub-platform | * |
28+
| oci://quay.io/codefresh/charts | argo-platform | * |
29+
| oci://quay.io/codefresh/charts | cf-common | 0.27.0 |
30+
| oci://quay.io/codefresh/charts | cf-platform-analytics-platform(cf-platform-analytics) | * |
31+
| oci://quay.io/codefresh/charts | cf-platform-analytics-etlstarter(cf-platform-analytics) | * |
32+
| oci://quay.io/codefresh/charts | cfapi(cfapi) | * |
33+
| oci://quay.io/codefresh/charts | cfui | * |
34+
| oci://quay.io/codefresh/charts | internal-gateway | 0.10.4 |
35+
| oci://quay.io/codefresh/charts | runtime-environment-manager | * |
36+
37+
## Values
38+
39+
| Key | Type | Default | Description |
40+
|-----|------|---------|-------------|
41+
| argo-hub-platform | object | See below | argo-hub-platform |
42+
| argo-platform | object | See below | argo-platform |
43+
| argo-platform.abac | object | See below | abac |
44+
| argo-platform.analytics-reporter | object | See below | analytics-reporter |
45+
| argo-platform.anchors | object | See below | Anchors |
46+
| argo-platform.api-events | object | See below | api-events |
47+
| argo-platform.api-graphql | object | See below | api-graphql All other services under `.Values.argo-platform` follows the same values structure. |
48+
| argo-platform.api-graphql.affinity | object | `{}` | Set pod's affinity |
49+
| argo-platform.api-graphql.env | object | See below | Env vars |
50+
| argo-platform.api-graphql.hpa | object | `{"enabled":false}` | HPA |
51+
| argo-platform.api-graphql.hpa.enabled | bool | `false` | Enable autoscaler |
52+
| argo-platform.api-graphql.image | object | `{"registry":"us-docker.pkg.dev/codefresh-enterprise/gcr.io","repository":"codefresh-io/argo-platform-api-graphql"}` | Image |
53+
| argo-platform.api-graphql.image.registry | string | `"us-docker.pkg.dev/codefresh-enterprise/gcr.io"` | Registry |
54+
| argo-platform.api-graphql.image.repository | string | `"codefresh-io/argo-platform-api-graphql"` | Repository |
55+
| argo-platform.api-graphql.kind | string | `"Deployment"` | Controller kind. Currently, only `Deployment` is supported |
56+
| argo-platform.api-graphql.pdb | object | `{"enabled":false}` | PDB |
57+
| argo-platform.api-graphql.pdb.enabled | bool | `false` | Enable pod disruption budget |
58+
| argo-platform.api-graphql.podAnnotations | object | `{"checksum/secret":"{{ include (print $.Template.BasePath \"/api-graphql/secret.yaml\") . | sha256sum }}"}` | Set pod's annotations |
59+
| argo-platform.api-graphql.resources | object | See below | Resource limits and requests |
60+
| argo-platform.api-graphql.secrets | object | See below | Secrets |
61+
| argo-platform.api-graphql.tolerations | list | `[]` | Set pod's tolerations |
62+
| argo-platform.argocd-hooks | object | See below | argocd-hooks Don't enable! Not used in onprem! |
63+
| argo-platform.audit | object | See below | audit |
64+
| argo-platform.broadcaster | object | See below | broadcaster |
65+
| argo-platform.cron-executor | object | See below | cron-executor |
66+
| argo-platform.event-handler | object | See below | event-handler |
67+
| argo-platform.promotion-orchestrator | object | See below | promotion-orchestrator |
68+
| argo-platform.runtime-manager | object | See below | runtime-manager Don't enable! Not used in onprem! |
69+
| argo-platform.runtime-monitor | object | See below | runtime-monitor Don't enable! Not used in onprem! |
70+
| argo-platform.ui | object | See below | ui |
71+
| argo-platform.useExternalSecret | bool | `false` | Use regular k8s secret object. Keep `false`! |
72+
| cf-platform-analytics-etlstarter | object | See below | etl-starter |
73+
| cf-platform-analytics-etlstarter.redis.enabled | bool | `false` | Disable redis subchart |
74+
| cf-platform-analytics-etlstarter.system-etl-postgres | object | `{"container":{"env":{"BLUE_GREEN_ENABLED":true}},"controller":{"cronjob":{"ttlSecondsAfterFinished":300}},"enabled":true,"fullnameOverride":"system-etl-postgres"}` | Only postgres ETL should be running in onprem |
75+
| cf-platform-analytics-platform | object | See below | platform-analytics |
76+
| cfapi | object | `{"affinity":{},"container":{"env":{"API_URI":"cfapi","AUDIT_AUTO_CREATE_DB":true,"DEFAULT_SYSTEM_TYPE":"GITOPS","LOGGER_LEVEL":"debug","ON_PREMISE":true,"PIPELINE_MANAGER_URI":"pipeline-manager","PLATFORM_ANALYTICS_URI":"platform-analytics","RUNTIME_ENVIRONMENT_MANAGER_URI":"runtime-environment-manager"},"image":{"digest":"","registry":"us-docker.pkg.dev/codefresh-inc/gcr.io","repository":"codefresh/dev/cf-api","tag":"21.283.0-test-gitops-system-type"}},"controller":{"replicas":2},"enabled":true,"fullnameOverride":"cfapi","hpa":{"enabled":false,"maxReplicas":10,"minReplicas":2,"targetCPUUtilizationPercentage":70},"imagePullSecrets":[],"nodeSelector":{},"pdb":{"enabled":false,"minAvailable":"50%"},"podSecurityContext":{},"resources":{"limits":{},"requests":{"cpu":"200m","memory":"256Mi"}},"tolerations":[]}` | cf-api |
77+
| cfapi.affinity | object | `{}` | Affinity configuration |
78+
| cfapi.container | object | `{"env":{"API_URI":"cfapi","AUDIT_AUTO_CREATE_DB":true,"DEFAULT_SYSTEM_TYPE":"GITOPS","LOGGER_LEVEL":"debug","ON_PREMISE":true,"PIPELINE_MANAGER_URI":"pipeline-manager","PLATFORM_ANALYTICS_URI":"platform-analytics","RUNTIME_ENVIRONMENT_MANAGER_URI":"runtime-environment-manager"},"image":{"digest":"","registry":"us-docker.pkg.dev/codefresh-inc/gcr.io","repository":"codefresh/dev/cf-api","tag":"21.283.0-test-gitops-system-type"}}` | Container configuration |
79+
| cfapi.container.env | object | See below | Env vars |
80+
| cfapi.container.image | object | `{"digest":"","registry":"us-docker.pkg.dev/codefresh-inc/gcr.io","repository":"codefresh/dev/cf-api","tag":"21.283.0-test-gitops-system-type"}` | Image |
81+
| cfapi.container.image.digest | string | `""` | Digest |
82+
| cfapi.container.image.registry | string | `"us-docker.pkg.dev/codefresh-inc/gcr.io"` | Registry prefix |
83+
| cfapi.container.image.repository | string | `"codefresh/dev/cf-api"` | Repository |
84+
| cfapi.container.image.tag | string | `"21.283.0-test-gitops-system-type"` | Tag |
85+
| cfapi.controller | object | `{"replicas":2}` | Controller configuration |
86+
| cfapi.controller.replicas | int | `2` | Replicas number |
87+
| cfapi.enabled | bool | `true` | Enable cf-api |
88+
| cfapi.fullnameOverride | string | `"cfapi"` | Override name |
89+
| cfapi.hpa | object | `{"enabled":false,"maxReplicas":10,"minReplicas":2,"targetCPUUtilizationPercentage":70}` | Autoscaler configuration |
90+
| cfapi.hpa.enabled | bool | `false` | Enable HPA |
91+
| cfapi.hpa.maxReplicas | int | `10` | Maximum number of replicas |
92+
| cfapi.hpa.minReplicas | int | `2` | Minimum number of replicas |
93+
| cfapi.hpa.targetCPUUtilizationPercentage | int | `70` | Average CPU utilization percentage |
94+
| cfapi.imagePullSecrets | list | `[]` | Image pull secrets |
95+
| cfapi.nodeSelector | object | `{}` | Node selector configuration |
96+
| cfapi.pdb | object | `{"enabled":false,"minAvailable":"50%"}` | Pod disruption budget configuration |
97+
| cfapi.pdb.enabled | bool | `false` | Enable PDB |
98+
| cfapi.pdb.minAvailable | string | `"50%"` | Minimum number of replicas in percentage |
99+
| cfapi.podSecurityContext | object | `{}` | Pod security context configuration |
100+
| cfapi.resources | object | `{"limits":{},"requests":{"cpu":"200m","memory":"256Mi"}}` | Resource requests and limits |
101+
| cfapi.tolerations | list | `[]` | Tolerations configuration |
102+
| cfui | object | See below | cf-ui |
103+
| global | object | See below | Global parameters |
104+
| global.affinity | object | `{}` | Global affinity constraints Apply affinity to all Codefresh subcharts. Will not be applied on Bitnami subcharts. |
105+
| global.appProtocol | string | `"https"` | Application protocol. |
106+
| global.appUrl | string | `"onprem.codefresh.local"` | Application root url. Will be used in Ingress objects as hostname |
107+
| global.cfapiEndpointsService | string | `"cfapi"` | Default API endpoints service name |
108+
| global.cfapiInternalPort | int | `3000` | Default API service port. |
109+
| global.cfapiService | string | `"cfapi"` | Default API service name. |
110+
| global.dnsService | string | `"kube-dns"` | Definitions for internal-gateway nginx resolver |
111+
| global.env | object | `{}` | Global Env vars |
112+
| global.imagePullSecrets | list | `["codefresh-registry"]` | Global Docker registry secret names as array |
113+
| global.imageRegistry | string | `""` | Global Docker image registry |
114+
| global.mongoURI | string | `""` | Legacy MongoDB connection string. Keep empty! |
115+
| global.mongodbDatabase | string | `"codefresh"` | Default MongoDB database name. Don't change! |
116+
| global.mongodbHost | string | `"mongodb"` | Set mongodb host in plain text |
117+
| global.mongodbHostSecretKeyRef | object | `{}` | Set mongodb host from existing secret |
118+
| global.mongodbOptions | string | `"retryWrites=true"` | Set mongodb connection string options Ref: https://www.mongodb.com/docs/manual/reference/connection-string/#connection-string-options |
119+
| global.mongodbPassword | string | `"password"` | Set mongodb password in plain text |
120+
| global.mongodbPasswordSecretKeyRef | object | `{}` | Set mongodb password from existing secret |
121+
| global.mongodbProtocol | string | `"mongodb"` | Set mongodb protocol (`mongodb` / `mongodb+srv`) |
122+
| global.mongodbUser | string | `"user"` | Set mongodb user in plain text |
123+
| global.mongodbUserSecretKeyRef | object | `{}` | Set mongodb user from existing secret |
124+
| global.newrelicLicenseKey | string | `""` | New Relic Key |
125+
| global.nodeSelector | object | `{}` | Global nodeSelector constraints Apply nodeSelector to all Codefresh subcharts. Will not be applied on Bitnami subcharts. |
126+
| global.platformAnalyticsPort | int | `80` | Default platform-analytics service port. |
127+
| global.platformAnalyticsService | string | `"platform-analytics"` | Default platform-analytics service name. |
128+
| global.postgresDatabase | string | `"codefresh"` | Set postgres database name |
129+
| global.postgresHostname | string | `"postgresql"` | Set postgres service address in plain text. Takes precedence over `global.postgresService`! |
130+
| global.postgresHostnameSecretKeyRef | object | `{}` | Set postgres service from existing secret |
131+
| global.postgresPassword | string | `"postgres"` | Set postgres password in plain text |
132+
| global.postgresPasswordSecretKeyRef | object | `{}` | Set postgres password from existing secret |
133+
| global.postgresPort | int | `5432` | Set postgres port number |
134+
| global.postgresService | string | `"postgresql"` | Default internal postgresql service address from bitnami/postgresql subchart |
135+
| global.postgresUser | string | `"postgres"` | Set postgres user in plain text |
136+
| global.postgresUserSecretKeyRef | object | `{}` | Set postgres user from existing secret |
137+
| global.rabbitService | string | `"rabbitmq:5672"` | Default internal rabbitmq service address from bitnami/rabbitmq subchart. |
138+
| global.rabbitmqHostname | string | `"rabbitmq:5672"` | Set rabbitmq service address in plain text. Takes precedence over `global.rabbitService`! |
139+
| global.rabbitmqHostnameSecretKeyRef | object | `{}` | Set rabbitmq service address from existing secret. |
140+
| global.rabbitmqPassword | string | `"rabbitmq"` | Set rabbitmq password in plain text |
141+
| global.rabbitmqPasswordSecretKeyRef | object | `{}` | Set rabbitmq password from existing secret |
142+
| global.rabbitmqProtocol | string | `"amqp"` | Set rabbitmq protocol (`amqp/amqps`) |
143+
| global.rabbitmqUsername | string | `"user"` | Set rabbitmq username in plain text |
144+
| global.rabbitmqUsernameSecretKeyRef | object | `{}` | Set rabbitmq username from existing secret |
145+
| global.redisPassword | string | `"redis"` | Set redis password in plain text |
146+
| global.redisPasswordSecretKeyRef | object | `{}` | Set redis password from existing secret |
147+
| global.redisPort | int | `6379` | Set redis service port |
148+
| global.redisService | string | `"redis-master"` | Default internal redis service address from bitnami/redis subchart |
149+
| global.redisUrl | string | `"redis-master"` | Set redis hostname in plain text. Takes precedence over `global.redisService`! |
150+
| global.redisUrlSecretKeyRef | object | `{}` | Set redis hostname from existing secret. |
151+
| global.security | object | `{"allowInsecureImages":true}` | Bitnami |
152+
| global.storageClass | string | `""` | Global StorageClass for Persistent Volume(s) |
153+
| global.tolerations | list | `[]` | Global tolerations constraints Apply toleratons to all Codefresh subcharts. Will not be applied on Bitnami subcharts. |
154+
| hooks | object | See below | Pre/post-upgrade Job hooks. |
155+
| hooks.mongodb | object | `{"affinity":{},"enabled":true,"image":{"registry":"us-docker.pkg.dev/codefresh-inc/public-gcr-io","repository":"codefresh/mongosh","tag":"2.5.0"},"nodeSelector":{},"podSecurityContext":{},"resources":{},"tolerations":[]}` | Sets feature compatibility version |
156+
| imageCredentials | object | `{}` | Credentials for Image Pull Secret object |
157+
| ingress | object | `{"annotations":{"nginx.ingress.kubernetes.io/service-upstream":"true","nginx.ingress.kubernetes.io/ssl-redirect":"false","nginx.org/redirect-to-https":"false"},"enabled":true,"ingressClassName":"","labels":{},"nameOverride":"","services":{"internal-gateway":["/"]},"tls":{"cert":"","enabled":false,"existingSecret":"","key":"","secretName":"star.codefresh.io"}}` | Ingress |
158+
| ingress.annotations | object | See below | Set annotations for ingress. |
159+
| ingress.enabled | bool | `true` | Enable the Ingress |
160+
| ingress.ingressClassName | string | `""` | Set the ingressClass that is used for the ingress. Default `nginx-codefresh` is created from `ingress-nginx` controller subchart |
161+
| ingress.labels | object | `{}` | Set labels for ingress |
162+
| ingress.nameOverride | string | `""` | Override Ingress resource name |
163+
| ingress.services | object | See below | Default services and corresponding paths |
164+
| ingress.tls.cert | string | `""` | Certificate (base64 encoded) |
165+
| ingress.tls.enabled | bool | `false` | Enable TLS |
166+
| ingress.tls.existingSecret | string | `""` | Existing `kubernetes.io/tls` type secret with TLS certificates (keys: `tls.crt`, `tls.key`) |
167+
| ingress.tls.key | string | `""` | Private key (base64 encoded) |
168+
| ingress.tls.secretName | string | `"star.codefresh.io"` | Default secret name to be created with provided `cert` and `key` below |
169+
| internal-gateway | object | See below | internal-gateway |
170+
| mongodb | object | See below | mongodb Ref: https://github.com/bitnami/charts/blob/main/bitnami/mongodb/values.yaml |
171+
| postgresql | object | See below | postgresql Ref: https://github.com/bitnami/charts/blob/main/bitnami/postgresql/values.yaml |
172+
| rabbitmq | object | See below | rabbitmq Ref: https://github.com/bitnami/charts/blob/main/bitnami/rabbitmq/values.yaml |
173+
| redis | object | See below | redis Ref: https://github.com/bitnami/charts/blob/main/bitnami/redis/values.yaml |
174+
| runtime-environment-manager | object | See below | runtime-environment-manager |
175+
| seed | object | See below | Seed jobs |
176+
| seed.enabled | bool | `true` | Enable all seed jobs |
177+
| seed.mongoSeedJob | object | See below | Mongo Seed Job. Required at first install. Seeds the required data (default idp/user/account), creates cfuser and required databases. |
178+
| seed.mongoSeedJob.mongodbRootPassword | string | `"password"` | Root password in plain text (required ONLY for seed job!). |
179+
| seed.mongoSeedJob.mongodbRootPasswordSecretKeyRef | object | `{}` | Root password from existing secret |
180+
| seed.mongoSeedJob.mongodbRootUser | string | `"root"` | Root user in plain text (required ONLY for seed job!). |
181+
| seed.mongoSeedJob.mongodbRootUserSecretKeyRef | object | `{}` | Root user from existing secret |
182+
| seed.postgresSeedJob | object | See below | Postgres Seed Job. Required at first install. Creates required user and databases. |
183+
| seed.postgresSeedJob.postgresPassword | optional | `""` | Password for "postgres" admin user (required ONLY for seed job!) |
184+
| seed.postgresSeedJob.postgresPasswordSecretKeyRef | optional | `{}` | Password for "postgres" admin user from existing secret |
185+
| seed.postgresSeedJob.postgresUser | optional | `""` | "postgres" admin user in plain text (required ONLY for seed job!) Must be a privileged user allowed to create databases and grant roles. If omitted, username and password from `.Values.global.postgresUser/postgresPassword` will be used. |
186+
| seed.postgresSeedJob.postgresUserSecretKeyRef | optional | `{}` | "postgres" admin user from exising secret |
187+
188+
----------------------------------------------
189+
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

0 commit comments

Comments
 (0)