1- ### How to build CF onprem chart locally
1+ # Codefresh On-Premises
22
3- ``` shell
4- # Optionally: update runtime images from SAAS system/default-plan runtime first
5- ./update_re_images.sh
3+ ## Prerequisites
64
7- helm dependency update codefresh --debug
8- helm package codefresh
9- ```
5+ - Kubernetes 1.19+
6+ - Helm 3.2.0+
7+ - PV provisioner support in the underlying infrastructure
8+ - GCR Service Account JSON ` sa.json ` (provided by Codefresh)
9+ - Firebase secret (provided by Codefresh)
10+
11+ ## Get Repo Info
1012
11- ### How to install CF onprem chart locally
13+ ``` console
14+ helm repo add codefresh-onprem https://chartmuseum.codefresh.io/codefresh
15+ helm repo update
16+ ```
1217
13- See [ kcfi README.md ] ( https://github.com/codefresh-io/kcfi#example---codefresh-onprem-installation )
18+ ## Install Chart
1419
15- or with HELM:
20+ ** Important: ** only helm3 is supported
1621
1722- obtain GCR Service Account JSON and Firebase secret from Codefresh:
23+
1824``` shell
25+ GCR_SA_KEY_B64=$( cat sa.json | base64)
1926DOCKER_CFG_VAR=$( echo -n " _json_key:$( echo ${GCR_SA_KEY_B64} | base64 -d) " | base64 | tr -d ' \n' )
20- REGISTRY= " gcr.io "
21- VALUES_MAIN=" values-main .yaml"
22- CF_APP_HOST=" myonprem.local "
27+ FIREBASE_SECRET= " <token> "
28+ VALUES_MAIN=" cf-values .yaml"
29+ CF_APP_HOST=" onprem.example.com "
2330```
2431
25- - feed them into ` values-main .yaml ` :
32+ - Edit default ` values.yaml ` or create empty ` cf-values .yaml`
2633
2734``` shell
2835cat << EOF > ${VALUES_MAIN}
@@ -36,16 +43,72 @@ firebaseSecret: ${FIREBASE_SECRET}
3643
3744dockerconfigjson:
3845 auths:
39- ${REGISTRY} :
46+ gcr.io :
4047 auth: ${DOCKER_CFG_VAR}
4148EOF
4249```
4350
44- ``` shell
45- helm repo add codefresh-onprem https://chartmuseum.codefresh.io/codefresh
46- helm pull codefresh-onprem/codefresh
47- helm upgrade --install cf codefresh-onprem/codefresh -f values-main.yaml --create-namespace --namespace codefresh --debug
51+ - Install Chart
52+ ``` console
53+ helm upgrade --install cf codefresh-onprem/codefresh -f cf-values.yaml --create-namespace --namespace codefresh --debug
4854```
4955
50- ### Additional docs
56+ The command deploys Codefresh On-Premises on the Kubernetes cluster in the default configuration.
57+
58+ _ See [ configuration] ( #configuration ) below._
59+
60+ _ See [ helm upgrade] ( https://helm.sh/docs/helm/helm_upgrade/ ) for command documentation._
61+
62+ ## Configuration
63+
64+
65+ ## Parameters
66+
67+ ### Tags
68+
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 ` |
75+
76+
77+ ### Global parameters
78+
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 ` |
111+
112+
113+ ## Additional Documentation
51114[ Codefresh On-Premises] ( https://codefresh.io/docs/docs/administration/codefresh-on-prem/ )
0 commit comments