mirror of
https://github.com/helm/charts.git
synced 2026-08-23 22:37:45 +00:00
Eldad Assis
d908e03c09
* Deprecate JFrog charts (moved to https://github.com/jfrog/charts) Signed-off-by: Eldad Assis <eldada@jfrog.com> * Add note on where to find and get the new charts Signed-off-by: Eldad Assis <eldada@jfrog.com>
214 lines
13 KiB
Markdown
214 lines
13 KiB
Markdown
# JFrog Distribution Helm Chart - DEPRECATED
|
|
**This chart is deprecated! You can find the new chart in:**
|
|
- **Sources:** https://github.com/jfrog/charts
|
|
- **Charts repository:** https://charts.jfrog.io
|
|
```bash
|
|
helm repo add jfrog https://charts.jfrog.io
|
|
```
|
|
|
|
## Prerequisites Details
|
|
|
|
* Kubernetes 1.8+
|
|
|
|
## Chart Details
|
|
This chart will do the following:
|
|
|
|
* Deploy Mongodb database.
|
|
* Deploy a Redis.
|
|
* Deploy a distributor.
|
|
* Deploy a distribution.
|
|
|
|
## Requirements
|
|
- A running Kubernetes cluster
|
|
- Dynamic storage provisioning enabled
|
|
- Default StorageClass set to allow services using the default StorageClass for persistent storage
|
|
- A running Artifactory Enterprise Plus
|
|
- [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) installed and setup to use the cluster
|
|
- [Helm](https://helm.sh/) installed and setup to use the cluster (helm init)
|
|
|
|
## Installing the Chart
|
|
To install the chart with the release name `distribution`:
|
|
```
|
|
helm install --name distribution stable/distribution
|
|
```
|
|
|
|
### Accessing Distribution
|
|
**NOTE:** It might take a few minutes for Distribution's public IP to become available, and the nodes to complete initial setup.
|
|
Follow the instructions outputted by the install command to get the Distribution IP and URL to access it.
|
|
|
|
### Updating Distribution
|
|
Once you have a new chart version, you can update your deployment with
|
|
```
|
|
helm upgrade distribution stable/distribution
|
|
```
|
|
|
|
### Create a unique Master Key
|
|
JFrog Distribution requires a unique master key to be used by all micro-services in the same cluster. By default the chart has one set in values.yaml (`distribution.masterKey`).
|
|
|
|
**This key is for demo purpose and should not be used in a production environment!**
|
|
|
|
You should generate a unique one and pass it to the template at install/upgrade time.
|
|
```bash
|
|
# Create a key
|
|
$ export MASTER_KEY=$(openssl rand -hex 32)
|
|
$ echo ${MASTER_KEY}
|
|
|
|
# Pass the created master key to helm
|
|
$ helm install --set distribution.masterKey=${MASTER_KEY} -n distribution stable/distribution
|
|
```
|
|
**NOTE:** Make sure to pass the same master key with `--set distribution.masterKey=${MASTER_KEY}` on all future calls to `helm install` and `helm upgrade`!
|
|
|
|
|
|
### External Databases
|
|
There is an option to use external database services (MongoDB or PostgreSQL) for your Distribution.
|
|
|
|
#### MongoDB
|
|
To use an external **MongoDB**, You need to set Distribution **MongoDB** connection URL.
|
|
|
|
For this, pass the parameter: `mongodb.enabled=false,global.mongoUrl=${DISTRIBUTION_MONGODB_CONN_URL},global.mongoAuditUrl=${DISTRIBUTION_MONGODB_AUDIT_URL}`.
|
|
|
|
**IMPORTANT:** Make sure the DB is already created before deploying Distribution services
|
|
```bash
|
|
# Passing a custom MongoDB to Distribution
|
|
|
|
# Example
|
|
# MongoDB host: custom-mongodb.local
|
|
# MongoDB port: 27017
|
|
# MongoDB user: distribution
|
|
# MongoDB password: password1_X
|
|
|
|
$ export DISTRIBUTION_MONGODB_CONN_URL='mongodb://${MONGODB_USER}:${MONGODB_PASSWORD}@custom-mongodb.local:27017/${MONGODB_DATABSE}'
|
|
$ export DISTRIBUTION_MONGODB_AUDIT_URL='mongodb://${MONGODB_USER}:${MONGODB_PASSWORD}@custom-mongodb.local:27017/audit?maxpoolsize=500'
|
|
$ helm install -n distribution --set global.mongoUrl=${DISTRIBUTION_MONGODB_CONN_URL},global.mongoAuditUrl=${DISTRIBUTION_MONGODB_AUDIT_URL} stable/distribution
|
|
```
|
|
|
|
#### External Redis
|
|
To use an external **Redis**, You need to disable the use of the bundled **Redis** and set a custom **Redis** connection URL.
|
|
|
|
For this, pass the parameters: `redis.enabled=false` and `global.redisUrl=${DISTRIBUTION_REDIS_CONN_URL}`.
|
|
|
|
**IMPORTANT:** Make sure the DB is already created before deploying Distribution services
|
|
```bash
|
|
# Passing a custom Redis to Distribution
|
|
|
|
# Example
|
|
# Redis host: custom-redis.local
|
|
# Redis port: 6379
|
|
# Redis password: password2_X
|
|
|
|
$ export DISTRIBUTION_REDIS_CONN_URL='redis://:${REDIS_PASSWORD}@custom-redis.local:6379'
|
|
$ helm install -n distribution --set redis.enabled=false,global.redisUrl=${DISTRIBUTION_REDIS_CONN_URL} stable/distribution
|
|
```
|
|
|
|
## Configuration
|
|
|
|
The following table lists the configurable parameters of the distribution chart and their default values.
|
|
|
|
| Parameter | Description | Default |
|
|
|----------------------------------------------|--------------------------------------------|------------------------------------|
|
|
| `imagePullSecrets` | Docker registry pull secret | |
|
|
| `serviceAccount.create` | Specifies whether a ServiceAccount should be created | `true` |
|
|
| `serviceAccount.name` | The name of the ServiceAccount to create | Generated using the fullname template |
|
|
| `rbac.create` | Specifies whether RBAC resources should be created | `true` |
|
|
| `rbac.role.rules` | Rules to create | `[]` |
|
|
| `ingress.enabled` | If true, distribution Ingress will be created | `false` |
|
|
| `ingress.annotations` | distribution Ingress annotations | `{}` |
|
|
| `ingress.hosts` | distribution Ingress hostnames | `[]` |
|
|
| `ingress.tls` | distribution Ingress TLS configuration (YAML) | `[]` |
|
|
| `mongodb.enabled` | Enable Mongodb | `true` |
|
|
| `mongodb.image.tag` | Mongodb docker image tag | `3.6.3` |
|
|
| `mongodb.image.pullPolicy` | Mongodb Container pull policy | `IfNotPresent` |
|
|
| `mongodb.persistence.enabled` | Mongodb persistence volume enabled | `true` |
|
|
| `mongodb.persistence.existingClaim` | Use an existing PVC to persist data | `nil` |
|
|
| `mongodb.persistence.storageClass` | Storage class of backing PVC | `generic` |
|
|
| `mongodb.persistence.size` | Mongodb persistence volume size | `10Gi` |
|
|
| `mongodb.livenessProbe.initialDelaySeconds` | Mongodb delay before liveness probe is initiated | `40` |
|
|
| `mongodb.readinessProbe.initialDelaySeconds` | Mongodb delay before readiness probe is initiated | `30` |
|
|
| `mongodb.mongodbExtraFlags` | MongoDB additional command line flags | `["--wiredTigerCacheSizeGB=1"]` |
|
|
| `mongodb.usePassword` | Enable password authentication | `false` |
|
|
| `mongodb.mongodbDatabase` | Mongodb Database for distribution | `bintray` |
|
|
| `mongodb.mongodbRootPassword` | Mongodb Database Password for root user | ` ` |
|
|
| `mongodb.mongodbUsername` | Mongodb Database Mission Control User | `distribution` |
|
|
| `mongodb.mongodbPassword` | Mongodb Database Password for Mission Control user | ` ` |
|
|
| `redis.enabled` | Enable Redis | `true` |
|
|
| `redis.redisPassword` | Redis password | ` ` |
|
|
| `redis.master.port` | Redis Port | `6379` |
|
|
| `redis.persistence.enabled` | Use a PVC to persist data | `true` |
|
|
| `redis.persistence.existingClaim` | Use an existing PVC to persist data | `nil` |
|
|
| `redis.persistence.storageClass` | Storage class of backing PVC | `generic` |
|
|
| `redis.persistence.size` | Size of data volume | `10Gi` |
|
|
| `distribution.name` | Distribution name | `distribution` |
|
|
| `distribution.image.pullPolicy` | Container pull policy | `IfNotPresent` |
|
|
| `distribution.image.repository` | Container image | `docker.jfrog.io/jf-distribution` |
|
|
| `distribution.image.version` | Container image tag | `1.1.0` |
|
|
| `distribution.service.type` | Distribution service type | `LoadBalancer` |
|
|
| `distribution.externalPort` | Distribution service external port | `80` |
|
|
| `distribution.internalPort` | Distribution service internal port | `8080` |
|
|
| `distribution.env.artifactoryUrl` | Distribution Environment Artifactory URL | ` ` |
|
|
| `distribution.persistence.mountPath` | Distribution persistence volume mount path | `"/jf-distribution"` |
|
|
| `distribution.persistence.enabled` | Distribution persistence volume enabled | `true` |
|
|
| `distribution.persistence.storageClass` | Storage class of backing PVC | `nil` |
|
|
| `distribution.persistence.existingClaim` | Provide an existing PersistentVolumeClaim | `nil` |
|
|
| `distribution.persistence.accessMode` | Distribution persistence volume access mode| `ReadWriteOnce` |
|
|
| `distribution.persistence.size` | Distribution persistence volume size | `50Gi` |
|
|
| `distributor.name` | Distribution name | `distribution` |
|
|
| `distributor.image.pullPolicy` | Container pull policy | `IfNotPresent` |
|
|
| `distributor.image.repository` | Container image | `docker.jfrog.io/jf-distribution` |
|
|
| `distributor.image.version` | Container image tag | `1.1.0` |
|
|
| `distributor.token` | Distributor token | ` ` |
|
|
| `distributor.persistence.mountPath` | Distributor persistence volume mount path | `"/bt-distributor"` |
|
|
| `distributor.persistence.existingClaim` | Provide an existing PersistentVolumeClaim | `nil` |
|
|
| `distributor.persistence.storageClass` | Storage class of backing PVC | `nil (uses alpha storage class annotation)` |
|
|
| `distributor.persistence.enabled` | Distributor persistence volume enabled | `true` |
|
|
| `distributor.persistence.accessMode` | Distributor persistence volume access mode | `ReadWriteOnce` |
|
|
| `distributor.persistence.size` | Distributor persistence volume size | `50Gi` |
|
|
|
|
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
|
|
### Ingress and TLS
|
|
To get Helm to create an ingress object with a hostname, add these two lines to your Helm command:
|
|
```
|
|
helm install --name distribution \
|
|
--set ingress.enabled=true \
|
|
--set ingress.hosts[0]="distribution.company.com" \
|
|
--set distribution.service.type=NodePort \
|
|
stable/distribution
|
|
```
|
|
|
|
If your cluster allows automatic creation/retrieval of TLS certificates (e.g. [cert-manager](https://github.com/jetstack/cert-manager)), please refer to the documentation for that mechanism.
|
|
|
|
To manually configure TLS, first create/retrieve a key & certificate pair for the address(es) you wish to protect. Then create a TLS secret in the namespace:
|
|
|
|
```console
|
|
kubectl create secret tls distribution-tls --cert=path/to/tls.cert --key=path/to/tls.key
|
|
```
|
|
|
|
Include the secret's name, along with the desired hostnames, in the Distribution Ingress TLS section of your custom `values.yaml` file:
|
|
|
|
```
|
|
ingress:
|
|
## If true, Distribution Ingress will be created
|
|
##
|
|
enabled: true
|
|
|
|
## Distribution Ingress hostnames
|
|
## Must be provided if Ingress is enabled
|
|
##
|
|
hosts:
|
|
- distribution.domain.com
|
|
annotations:
|
|
kubernetes.io/tls-acme: "true"
|
|
## Distribution Ingress TLS configuration
|
|
## Secrets must be manually created in the namespace
|
|
##
|
|
tls:
|
|
- secretName: distribution-tls
|
|
hosts:
|
|
- distribution.domain.com
|
|
```
|
|
|
|
## Useful links
|
|
- https://www.jfrog.com/confluence/display/EP/Getting+Started
|
|
- https://www.jfrog.com/confluence/display/DIST/Installing+Distribution
|
|
- https://www.jfrog.com/confluence/
|