Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Armand Leopold committed Mar 23, 2021
1 parent a690270 commit 6860b98
Show file tree
Hide file tree
Showing 10 changed files with 154 additions and 82 deletions.
2 changes: 1 addition & 1 deletion charts/job-orchestrator/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: job-orchestrator
description: Helm Chart for Job Orchestrator, Help Manages jobs by connecting Gitlab Runners / Nexus Ressources with Kubernetes.
type: application
appVersion: 2.7.1
version: 1.9.4
version: 1.9.5
home: https://github.com/curie-data-factory/helm-charts/tree/master/charts/job-orchestrator
icon: https://i.ibb.co/2sGpDKj/favicon.png
sources:
Expand Down
31 changes: 24 additions & 7 deletions charts/job-orchestrator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,27 @@ helm upgrade --install --namespace default --values ./my-values.yaml my-release

The following table lists the configurable parameters of the _job-orchestrator_ chart and their default values.

| Parameter | Description | Default |
|-------------------- |------------------------------ |------------------------------------------ |
| `replicaCount` | Number of replicas to create | `1` |
| `image.repository` | Image repository. | `registry.compagny.com/job-orchestrator` |
| `image.tag` | Image Tag. | `1.3.0` |
| `image.pullPolicy` | Image pull policy. | `IfNotPresent` |
| `image.name` | Image name | `job-orchestrator` |
| Parameter | Description | Default |
|----------------------------------|--------------------------------------------------|---------------------------------------------------------------------|
| `image.replicaCount` | Number of replicas to create | `1` |
| `image.repository` | Image repository. | `registry.compagny.com/job-orchestrator` |
| `image.tag` | Image Tag. | `1.3.0` |
| `image.pullPolicy` | Image pull policy. | `IfNotPresent` |
| `image.name` | Image name | `job-orchestrator` |
| `image.deployRegistry` | If the image is stored in a private registry | `false` |
| `image.imagePullSecrets` | Docker registry credentials Secret name | `registrysecret` |
| `image.dataSecret` | Secret storing docker image registry credentials | `{"auths":{"registry.compagny.com":{"password":"","username":""}}}` |
| `service.type` | Service Type | `ClusterIP` |
| `service.targetPort` | Service Port | `80` |
| `service.protocol` | Service Protocol | `TCP` |
| `ingress.enabled` | Expose application with ingress | `true` |
| `ingress.hostnames` | Urls of exposed application | `['job-orchestrator.company.com']` |
| `ingress.tls[hosts]` | Array of TLS Hosts | `[]` |
| `ingress.tls[hosts[]]` | Host name | `['job-orchestrator.company.com']` |
| `ingress.tls[hosts[secretName]]` | Secret for the current host name | `job-orchestrator` |
| `configMap.mountPath` | Mount Path of configmaps on the container | `/var/www/html/conf/` |
| `configMap.data` | Application Configmap data | `nil` |
| `configMap.cifs` | Cifs credentials configmap data | `nil` |
| `ldapConf.mountPath` | Mount Path of ldap configmap on the container | `/var/www/html/ldapconf/` |
| `ldapConf.key` | Name of ldap config file | `conf.php` |
| `ldapConf.data` | Ldap credentials data | `nil` |
4 changes: 3 additions & 1 deletion charts/job-orchestrator/templates/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ kind: Deployment
metadata:
name: {{ .Release.Name }}-web
spec:
replicas: {{ .Values.replicaCount }}
replicas: {{ .Values.image.replicaCount }}
selector:
matchLabels:
app.kubernetes.io/name: {{ .Values.image.name }}
Expand Down Expand Up @@ -31,8 +31,10 @@ spec:
name: ldapconf
- mountPath: /var/www/html/version/
name: version
{{- if .Values.image.deployRegistry }}
imagePullSecrets:
- name: {{ .Values.image.imagePullSecrets }}
{{- end }}
volumes:
- name: configmap
secret:
Expand Down
33 changes: 19 additions & 14 deletions charts/job-orchestrator/templates/ingress.yaml
Original file line number Diff line number Diff line change
@@ -1,28 +1,33 @@
{{- if .Values.ingress.enabled -}}
{{- $serviceName := print .Release.Name "-" .Values.image.name "-" .Values.service.type | lower -}}
{{- $servicePort := print .Values.service.targetPort .Values.service.protocol | lower -}}

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
name: {{ .Values.image.name }}
labels:
app: {{ .Values.image.name }}
chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
heritage: {{ .Release.Service }}
release: {{ .Release.Name }}
name: {{ .Values.image.name }}
{{- if .Values.ingress.annotations }}
annotations:
{{- range $key, $value := .Values.ingress.annotations }}
{{ $key }}: {{ $value | quote }}
{{- end }}
{{ toYaml .Values.ingress.annotations | indent 4 }}
{{- end }}
spec:
rules:
- host: "{{ .Values.ingress.url }}"
http:
paths:
- path: /
backend:
serviceName: {{ .Release.Name }}-{{ .Values.service.type | lower }}
servicePort: {{ .Values.service.targetPort }}{{ .Values.service.protocol | lower }}
{{- if .Values.ingress.tls }}
{{- if .Values.ingress.tls }}
tls:
{{ toYaml .Values.ingress.tls | indent 4 }}
{{- end -}}
{{- end }}
rules:
{{- range .Values.ingress.hostnames }}
- host: "{{ . }}"
http:
paths:
- path: /
backend:
serviceName: {{ $serviceName }}
servicePort: {{ $servicePort }}
{{- end }}
{{- end -}}
26 changes: 10 additions & 16 deletions charts/job-orchestrator/values.yaml
Original file line number Diff line number Diff line change
@@ -1,44 +1,38 @@
# Replica count for script runner & website
replicaCount: 1

# Images
image:
repository: registry.compagny.com/job-orchestrator
replicaCount: 1
repository: registry.company.com/job-orchestrator
tag: "1.3.0"
pullPolicy: IfNotPresent
name: job-orchestrator
# Image Pull Registry Secret
imagePullSecrets: registrysecret
deployRegistry: false
imagePullSecrets: registrysecret
dataSecret: |-
{"auths":{"registry.compagny.com":{"password":"","username":""}}}
{"auths":{"registry.company.com":{"password":"","username":""}}}
# Service discovery for Website
service:
type: ClusterIP
targetPort: 80
protocol: TCP

# Load Balancer
ingress:
enabled: true
url: job-orchestrator.compagny.com
hostnames:
- job-orchestrator.company.com
tls:
- hosts:
- job-orchestrator.compagny.com
- job-orchestrator.company.com
secretName: job-orchestrator

# ConfigMap
configMap:
mountPath: /var/www/html/conf/
data: |-
"conf"
""
cifs: |-
"conf"
""
ldapConf:
key: conf.php
mountPath: /var/www/html/ldapconf/
data: |-
"conf"
""
2 changes: 1 addition & 1 deletion charts/redcap/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: redcap
description: Helm chart for RedCap, A CRF Application for survey research.
type: application
appVersion: 10.6.12
version: 1.9.9
version: 1.9.10
home: https://github.com/curie-data-factory/helm-charts/tree/master/charts/redcap
icon: https://www.redcapbrasil.com.br/wp-content/uploads/2018/02/rbone.png
sources:
Expand Down
60 changes: 58 additions & 2 deletions charts/redcap/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,59 @@
# Redcap Helm chart :
# Redcap

This repository contains the Helm chart for Redcap.
[Redcap](https://www.project-redcap.org/) REDCap is a secure web application for building and managing online surveys and databases.

## Installing the Chart

Before you can install the chart you will need to add the `curiedfcharts` repo to [Helm](https://helm.sh/).

```shell
helm repo add curiedfcharts https://curie-data-factory.github.io/helm-charts
helm repo update
```

After you've installed the repo you can install the chart.

```shell
helm upgrade --install --namespace default --values ./my-values.yaml my-release curiedfcharts/redcap
```

| Parameter | Description | Default |
|----------------------------------|--------------------------------------------------|---------------------------------------------------------------------|
| `image.replicaCount` | Number of replicas to create | `1` |
| `image.repository` | Image repository. | `registry.compagny.com/job-orchestrator` |
| `image.tag` | Image Tag. | `1.3.0` |
| `image.pullPolicy` | Image pull policy. | `IfNotPresent` |
| `image.name` | Image name | `job-orchestrator` |
| `image.deployRegistry` | If the image is stored in a private registry | `false` |
| `image.imagePullSecrets` | Docker registry credentials Secret name | `registrysecret` |
| `image.dataSecret` | Secret storing docker image registry credentials | `{"auths":{"registry.compagny.com":{"password":"","username":""}}}` |
| `livenesscheck` | Enable Liveness check | `true` |
| `service.type` | Service Type | `ClusterIP` |
| `service.targetPort` | Service Port | `80` |
| `service.protocol` | Service Protocol | `TCP` |
| `ingress.enabled` | Expose application with ingress | `true` |
| `ingress.hostnames` | Urls of exposed application | `['job-orchestrator.company.com']` |
| `ingress.tls` | Array of TLS Hosts | `[]` |
| `ingress.tls[hosts]` | Host name | `['job-orchestrator.company.com']` |
| `ingress.tls[hosts[secretName]]` | Secret for the current host name | `job-orchestrator` |
| `persistence.enabled` | Enable persisting data on PVC | `false` |
| `persistence.existingClaim` | Does PVC already exist ? | `false` |
| `persistence.size` | PVC Size | `50Gi` |
| `persistence.storageClass` | PVC storage class | `nil` |
| `persistence.accessMode` | PVC Access Mode | `ReadWriteOnce` |
| `persistence.replicas` | PVC storage class replicas (if possible) | `1` |
| `persistence.volumeName` | Directory name | `edocs` |
| `persistence.mountPath` | Directory mount path | `/var/www/site/edocs` |
| `CRON_TASK_SCHEDULE` | Redcap CRON Task Schedule | `0 * * * *` |
| `DB_HOSTNAME` | Redcap DB Hostname | `nil` |
| `DB_NAME` | Redcap DB Name | `nil` |
| `DB_USERNAME` | Redcap DB Username | `nil` |
| `DB_PASSWORD` | Redcap DB Password | `nil` |
| `SMB_MOUNT_ENABLED` | Redcap Mount docs directory to Network Share | `true` |
| `SMB_USER` | Network Share Username | `nil` |
| `SMB_PASSWORD` | Network Share Password | `nil` |
| `SMB_SOURCEPATH` | Network Share Source Path | `nil` |
| `SMB_DESTPATH` | Network Share Destination Path | `nil` |
| `SMB_DOMAIN` | Network Share Domain | `nil` |
| `SALT` | Network Share SALT | `nil` |
| `LDAP` | Redcap LDAP Auth configuration data | `nil` |
4 changes: 3 additions & 1 deletion charts/redcap/templates/redcap-deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,10 @@ spec:
- mountPath: /persistentedocs
name: persistentedocs
{{- end }}
{{- if .Values.image.deployRegistry }}
imagePullSecrets:
- name: {{ .Values.imagePullSecrets }}
- name: {{ .Values.image.imagePullSecrets }}
{{- end }}
volumes:
- name: ldap-config
secret:
Expand Down
6 changes: 3 additions & 3 deletions charts/redcap/templates/registry.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{{- if .Values.deployRegistry -}}
{{- if .Values.image.deployRegistry -}}
apiVersion: v1
kind: Secret
type: kubernetes.io/dockerconfigjson
metadata:
name: {{ .Values.imagePullSecrets }}
name: {{ .Values.image.imagePullSecrets }}
namespace: {{ .Release.Namespace }}
data:
.dockerconfigjson: {{ .Values.dataSecret }}
.dockerconfigjson: {{ .Values.image.dataSecret }}
{{- end -}}
68 changes: 32 additions & 36 deletions charts/redcap/values.yaml
Original file line number Diff line number Diff line change
@@ -1,46 +1,29 @@
image:
repository: registry.compagny.com/job-orchestrator
replicaCount: 1
repository: registry.company.com/redcap
tag: "1.3.0"
pullPolicy: Always
pullPolicy: IfNotPresent
name: redcap
replicaCount: 1
deployRegistry: false
imagePullSecrets: registrysecret
dataSecret: |-
{"auths":{"registry.company.com":{"password":"","username":""}}}
livenesscheck: true

CRON_TASK_SCHEDULE: "0 * * * *"

DB_HOSTNAME: ""
DB_NAME: ""
DB_USERNAME: ""
DB_PASSWORD: ""

SMB_MOUNT_ENABLED: true
SMB_PASSWORD: ""
SMB_USER: ""
SMB_SOURCEPATH: ""
SMB_DESTPATH: ""
SMB_DOMAIN: ""

SALT: ""

LDAP: |
""
# Image Pull Registry Secret
deployRegistry: false
imagePullSecrets: registrysecret
dataSecret: |-
{"auths":{"registry.compagny.com":{"password":"","username":""}}}
# Ingress / Service discovery for Website
service:
type: ClusterIP
targetPort: 80
protocol: TCP

# Load Balancer
ingress:
enabled: true
hostnames:
- redcap.company.com
tls:
- hosts:
- redcap.company.com
secretName: redcap

annotations:
nginx.ingress.kubernetes.io/client_max_body_size: "5000m"
Expand All @@ -52,12 +35,6 @@ ingress:
nginx.ingress.kubernetes.io/session-cookie-expires: "86400"
nginx.ingress.kubernetes.io/session-cookie-max-age: "86400"

hostnames:
- redcap.compagny.com
tls:
- hosts:
- redcap.compagny.com
secretName: redcap

## Persist data to a persistent volume
persistence:
Expand All @@ -69,3 +46,22 @@ persistence:
replicas: "1"
volumeName: "edocs"
mountPath: /var/www/site/edocs

CRON_TASK_SCHEDULE: "0 * * * *"

DB_HOSTNAME: ""
DB_NAME: ""
DB_USERNAME: ""
DB_PASSWORD: ""

SMB_MOUNT_ENABLED: true
SMB_PASSWORD: ""
SMB_USER: ""
SMB_SOURCEPATH: ""
SMB_DESTPATH: ""
SMB_DOMAIN: ""

SALT: ""

LDAP: |
""

0 comments on commit 6860b98

Please sign in to comment.