Skip to content

Commit 4d69dba

Browse files
mikhail-klimkomikhail-klimko
committed
upd readme
1 parent ceef8ba commit 4d69dba

File tree

2 files changed

+53
-46
lines changed

2 files changed

+53
-46
lines changed

‎README.md

Lines changed: 44 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -66,48 +66,54 @@ _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documen
6666

6767
### Tags
6868

69-
| Name | Description | Value |
70-
| -------------------- | ----------------------------------------------------- | -------------------------------------------------- |
71-
| `tags.cf-infra` | Enable Codefresh Classic services(charts) | `true` |
72-
| `tags.argo-platform` | (WIP) Enable Codefresh Argo-Platform services(charts) | `false` |
73-
| `firebaseUrl` | Firebase URL for logs streaming | `https://codefresh-on-prem.firebaseio.com/on-prem` |
74-
| `firebaseSecret` | Firebase Secret | `placeholder` |
69+
| Name | Description | Value |
70+
| -------------------- | ----------------------------------------------------- | ------- |
71+
| `tags.cf-infra` | Enable Codefresh Classic services(charts) | `true` |
72+
| `tags.argo-platform` | (WIP) Enable Codefresh Argo-Platform services(charts) | `false` |
73+
74+
75+
### Root
76+
77+
| Name | Description | Value |
78+
| ---------------- | ------------------------------- | -------------------------------------------------- |
79+
| `firebaseUrl` | Firebase URL for logs streaming | `https://codefresh-on-prem.firebaseio.com/on-prem` |
80+
| `firebaseSecret` | Firebase Secret | `placeholder` |
7581

7682

7783
### Global parameters
7884

79-
| Name | Description | Value |
80-
| ----------------------------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
81-
| `global.appUrl` | Application root url | `onprem.codefresh.local` |
82-
| `global.seedJobs` | Instantiate databases with seed data. Used in on-prem environments. `true/false` | `nil` |
83-
| `global.certsJobs` | Generate self-signed certificates for Builder/Runner. Used in on-prem environments. `true/false` | `nil` |
84-
| `global.privateRegistry` | When using private docker registry, enable this flag | `false` |
85-
| `global.dockerRegistry` | Replaces/adds docker registry prefix for images when `privateRegistry` is enabled (has to be with trailing "/") | `""` |
86-
| `global.rabbitService` | Default Internal RabbitMQ service address | `rabbitmq` |
87-
| `global.rabbitmqHostname` | External RabbitMQ service address | `nil` |
88-
| `global.rabbitmqUsername` | Default RabbitMQ username | `user` |
89-
| `global.rabbitmqPassword` | Default RabbitMQ password | `cVz9ZdJKYm7u` |
90-
| `global.mongoURI` | Default Internal MongoDB URI | `mongodb://cfuser:mTiXcU2wafr9@cf-mongodb:27017` |
91-
| `global.mongodbDatabase` | Default MongoDB database name | `codefresh` |
92-
| `global.mongodbRootUser` | Default MongoDB root user | `root` |
93-
| `global.mongodbRootPassword` | Default MongoDB root password | `XT9nmM8dZD` |
94-
| `global.mongodbImage` | Default Image used in seed-jobs | `bitnami/mongodb:4.2` |
95-
| `global.redisService` | Default Internal Redis service address | `redis-master` |
96-
| `global.redisPort` | Default Internal Redis port number | `6379` |
97-
| `global.redisUrl` | Default External Redis service address | `nil` |
98-
| `global.redisPassword` | Default Internal Redis password | `hoC9szf7NtrU` |
99-
| `global.runtimeRedisHost` | Default for OfflineLogging feature | `cf-redis-master` |
100-
| `global.runtimeRedisPassword` | Default for OfflineLogging feature | `hoC9szf7NtrU` |
101-
| `global.runtimeRedisDb` | Default for OfflineLogging feature | `1` |
102-
| `global.runtimeRedisPort` | Default for OfflineLogging feature | `6379` |
103-
| `global.runtimeMongoURI` | Default for OfflineLogging feature | `mongodb://cfuser:mTiXcU2wafr9@cf-mongodb:27017` |
104-
| `global.runtimeMongoDb` | Default for OfflineLogging feature | `codefresh` |
105-
| `global.postgresService` | Default Internal Postgresql service address | `cf-postgresql` |
106-
| `global.postgresHostname` | Default External Postgresql service address | `nil` |
107-
| `global.postgresUser` | Default Internal Postgresql username | `postgres` |
108-
| `global.postgresPassword` | Default Internal Postgresql password | `eC9arYka4ZbH` |
109-
| `global.postgresDatabase` | Default Internal Postgresql database name | `codefresh` |
110-
| `global.postgresPort` | Default Internal Postgresql port number | `5432` |
85+
| Name | Description | Value |
86+
| ----------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
87+
| `global.appUrl` | Application root url | `onprem.codefresh.local` |
88+
| `global.seedJobs` | Instantiate databases with seed data. Used in on-prem environments. `true/false` | `nil` |
89+
| `global.certsJobs` | Generate self-signed certificates for Builder/Runner. Used in on-prem environments. `true/false` | `nil` |
90+
| `global.privateRegistry` | When using private docker registry, enable this flag | `false` |
91+
| `global.dockerRegistry` | Replaces/adds docker registry prefix for images when `privateRegistry` is enabled (has to be with trailing `/`) | `""` |
92+
| `global.rabbitService` | Default Internal RabbitMQ service address | `rabbitmq` |
93+
| `global.rabbitmqHostname` | External RabbitMQ service address | `nil` |
94+
| `global.rabbitmqUsername` | Default RabbitMQ username | `user` |
95+
| `global.rabbitmqPassword` | Default RabbitMQ password | `cVz9ZdJKYm7u` |
96+
| `global.mongoURI` | Default Internal MongoDB URI | `mongodb://cfuser:mTiXcU2wafr9@mongodb:27017` |
97+
| `global.mongodbDatabase` | Default MongoDB database name | `codefresh` |
98+
| `global.mongodbRootUser` | Default MongoDB root user | `root` |
99+
| `global.mongodbRootPassword` | Default MongoDB root password | `XT9nmM8dZD` |
100+
| `global.mongodbImage` | Default Image used in seed-jobs | `bitnami/mongodb:4.2` |
101+
| `global.redisService` | Default Internal Redis service address | `redis-master` |
102+
| `global.redisPort` | Default Redis port number | `6379` |
103+
| `global.redisUrl` | Default External Redis service address | `nil` |
104+
| `global.redisPassword` | Default Redis password | `hoC9szf7NtrU` |
105+
| `global.runtimeRedisHost` | Default for OfflineLogging feature | `cf-redis-master` |
106+
| `global.runtimeRedisPassword` | Default for OfflineLogging feature | `hoC9szf7NtrU` |
107+
| `global.runtimeRedisDb` | Default for OfflineLogging feature | `1` |
108+
| `global.runtimeRedisPort` | Default for OfflineLogging feature | `6379` |
109+
| `global.runtimeMongoURI` | Default for OfflineLogging feature | `mongodb://cfuser:mTiXcU2wafr9@mongodb:27017` |
110+
| `global.runtimeMongoDb` | Default for OfflineLogging feature | `codefresh` |
111+
| `global.postgresService` | Default Internal Postgresql service address | `postgresql` |
112+
| `global.postgresHostname` | Default External Postgresql service address | `nil` |
113+
| `global.postgresUser` | Default Postgresql username | `postgres` |
114+
| `global.postgresPassword` | Default Postgresql password | `eC9arYka4ZbH` |
115+
| `global.postgresDatabase` | Default Postgresql database name | `codefresh` |
116+
| `global.postgresPort` | Default Postgresql port number | `5432` |
111117

112118

113119
## Additional Documentation

‎codefresh/values.yaml

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,10 @@ dockerconfigjson:
1212
auths:
1313
gcr.io:
1414
auth: placeholder
15+
## @section Root
1516
## @param firebaseUrl Firebase URL for logs streaming
16-
## @param firebaseSecret Firebase Secret
1717
firebaseUrl: "https://codefresh-on-prem.firebaseio.com/on-prem"
18+
## @param firebaseSecret Firebase Secret
1819
firebaseSecret: placeholder
1920
###
2021
### TLS certificate for Ingress object
@@ -40,7 +41,7 @@ global:
4041
certsJobs: null
4142
## @param global.privateRegistry When using private docker registry, enable this flag
4243
privateRegistry: false
43-
## @param global.dockerRegistry Replaces/adds docker registry prefix for images when `privateRegistry` is enabled (has to be with trailing "/")
44+
## @param global.dockerRegistry Replaces/adds docker registry prefix for images when `privateRegistry` is enabled (has to be with trailing `/`)
4445
dockerRegistry: "" ## e.g. `dockerRegistry: my-registry.artifactory.com/`
4546
## @skip global.codefresh
4647
## Global codefresh chart name; all subcharts use this name to access secrets and configmaps
@@ -81,9 +82,9 @@ global:
8182
mongodbRootPassword: XT9nmM8dZD
8283
mongodbImage: bitnami/mongodb:4.2
8384
## @param global.redisService Default Internal Redis service address
84-
## @param global.redisPort Default Internal Redis port number
85+
## @param global.redisPort Default Redis port number
8586
## @param global.redisUrl Default External Redis service address
86-
## @param global.redisPassword Default Internal Redis password
87+
## @param global.redisPassword Default Redis password
8788
redisService: redis-master
8889
redisPort: 6379
8990
redisUrl: null
@@ -102,10 +103,10 @@ global:
102103
runtimeMongoDb: codefresh
103104
## @param global.postgresService Default Internal Postgresql service address
104105
## @param global.postgresHostname Default External Postgresql service address
105-
## @param global.postgresUser Default Internal Postgresql username
106-
## @param global.postgresPassword Default Internal Postgresql password
107-
## @param global.postgresDatabase Default Internal Postgresql database name
108-
## @param global.postgresPort Default Internal Postgresql port number
106+
## @param global.postgresUser Default Postgresql username
107+
## @param global.postgresPassword Default Postgresql password
108+
## @param global.postgresDatabase Default Postgresql database name
109+
## @param global.postgresPort Default Postgresql port number
109110
## @skip global.postgresSeedJob
110111
postgresService: postgresql
111112
postgresHostname: null

0 commit comments

Comments
 (0)