STARTX helm repository
helm charts for various infrastructure configuration and services running under an Openshift Container Platform (or OKD).
Helm repository content
This repository host various helm chart targeting the Openshift Container Platform environment. Charts could be divided into 4 main category (basic charts, cluster charts, chaos charts and examples charts)
Cluster Helm charts
Helm chart prefixed with cluster- are Cluster chart. Cluster charts configure cluster configuration or enable cluster service.
| Chart | Source | Description |
|---|---|---|
| cluster-config | source | global configuration of an openshift cluster |
| cluster-rbac | source | configure various RBAC aspects |
| cluster-auth | source | configure Auth at the cluster level |
| cluster-console | source | configure the openshift console at the cluster level |
| cluster-storage | source | enable StoragesClass at the cluster level |
| cluster-localstorage | source | enable local storage at the cluster level |
| cluster-logging | source | deploy a EFK (puit de log) at the cluster level |
| cluster-pipeline | source | enable tekton pipeline at the cluster level |
| cluster-istio | source | enable ServiceMesh at the cluster level |
| cluster-knative | source | enable Serverless (knative) at the cluster level |
| cluster-ocs | source | enable Openshift Container Storage at the cluster level |
| cluster-kubevirt | source | enable kubevirt at the cluster level |
| cluster-vault | source | enable hashicorp vault service at the cluster level |
| cluster-vault-config | source | enable hashicorp vault configuration service at the cluster level |
| cluster-quay | source | enable Quay.io private repository at the cluster level |
| cluster-ansible | source | enable Ansible automation at the cluster level |
| cluster-3scale | source | deploy a 3Scale infrastructure at the cluster level |
| cluster-vpa | source | enable VerticalPodAutoscaler at the cluster level |
| cluster-sso | source | enable Redhat-SSO at the cluster level |
| cluster-ptp | source | enable Precision Time Protocol at the cluster level |
| cluster-nexus | source | enable Nexus at the cluster level |
| cluster-keycloak | source | enable Keycloak at the cluster level |
| cluster-gitlab | source | enable Gitlab at the cluster level |
| cluster-compliance | source | enable Compliance at the cluster level |
| cluster-machine | source | enable Machine management at the cluster level |
| cluster-router | source | enable Router management at the cluster level |
| cluster-certmanager | source | enable CertManager at the cluster level |
| cluster-oadp | source | enable Application Data Protection (Backup) at the cluster level |
| cluster-router | source | configure router(s) at the cluster level |
| cluster-couchbase | source | configure couchbase at the cluster level |
| cluster-crunchy | source | configure crunchyDatabase at the cluster level |
| cluster-mustgather | source | configure mustgather at the cluster level |
| cluster-nfd | source | configure Node Feature Discovery at the cluster level |
| cluster-gpu | source | configure GPU Drivers (NVidia) at the cluster level |
| cluster-descheduler | source | configure KubeDescheduler to optimize pod distribution |
| cluster-mtv | source | configure Migration toolkit for virtualisation |
| cluster-mtc | source | configure Migration toolkit for Containers |
| cluster-mtr | source | configure Migration toolkit for Runtimes |
| cluster-devworkspaces | source | enable Dev workspace at the cluster level |
| cluster-costs | source | configure the costs management features |
| cluster-maintenance | source | configure the node maintenance feature |
| cluster-mongo | source | configure MongoDB at the cluster level |
Use Cluster charts
# Add the STARTX helm repository
helm repo add startx https://helm-repository.readthedocs.io/en/latest/repos/stable/
# Add individual charts
helm install startx/cluster-config
helm install startx/cluster-rbac
helm install startx/cluster-auth
helm install startx/cluster-console
helm install startx/cluster-storage
helm install startx/cluster-logging
helm install startx/cluster-pipeline
helm install startx/cluster-istio
helm install startx/cluster-knative
helm install startx/cluster-ocs
helm install startx/cluster-kubevirt
helm install startx/cluster-vault
helm install startx/cluster-quay
helm install startx/cluster-3scale
helm install startx/cluster-vpa
helm install startx/cluster-sso
helm install startx/cluster-ptp
helm install startx/cluster-nexus
helm install startx/cluster-keycloak
helm install startx/cluster-gitlab
helm install startx/cluster-compliance
helm install startx/cluster-machine
helm install startx/cluster-maintenance
helm install startx/cluster-certmanager
helm install startx/cluster-oadp
helm install startx/cluster-router
helm install startx/cluster-couchbase
helm install startx/cluster-mustgather
helm install startx/cluster-mongo
helm install startx/cluster-nfd
helm install startx/cluster-gpu
helm install startx/cluster-descheduler
helm install startx/cluster-mtv
helm install startx/cluster-mtc
helm install startx/cluster-mtr
helm install startx/cluster-devworkspaces
Deprecated Helm charts
List of the deprecated helm charts.
| Chart | Source | Description | ||||
|---|---|---|---|---|---|---|
| cluster-metering | source | REPLACED by costManagement | ||||
| cluster-jenkins | source | NOT used anymore | cluster-workspace | source | REPLACED by cluster-devworkspaces chart |
Basic Helm charts
Helm chart without prefix are basic chart. Basic charts configure basic element and are mainly used as a dependency of more complex chart.
| Chart | Source | Description |
|---|---|---|
| project | source | create a project with limits, quotas, networkpolicy and rbac set |
| operator | source | create an operator with subscription (openshift) or CRD (k8s) |
| sxapi | source | deploy a small micro-service endpoint |
Use Basic charts
# Add the STARTX helm repository
helm repo add startx https://helm-repository.readthedocs.io/en/latest/repos/stable/
# Add individual charts
helm install startx/project
helm install startx/operator
helm install startx/sxapi
Chaos Helm charts
Helm chart prefixed with chaos- are part of the chaos suite.
You can deploy various tools used for chaos-testing openshift and kubernetes clusters.
| Chart | Source | Description |
|---|---|---|
| chaos | source | Deploy a full chaos test suite |
| chaos-cerberus | source | Deploy Cerberus component as part of a chaos environment |
| chaos-kraken | source | Deploy Kraken component as part of a chaos environment |
| chaos-mesh | source | Deploy Chaos-mesh component as part of a chaos environment |
| chaos-litmus | source | Deploy Litmus component as part of a chaos environment |
| chaos-monkey | source | Deploy Kubemonkey component as part of a chaos environment |
Use Chaos charts
# Add the STARTX helm repository
helm repo add startx https://helm-repository.readthedocs.io/en/latest/repos/stable/
# Add individual charts
helm install startx/chaos
helm install startx/chaos-cerberus
helm install startx/chaos-kraken
helm install startx/chaos-mesh
helm install startx/chaos-litmmus
helm install startx/chaos-monkey
Examples Helm charts
Helm chart prefixed with example- are Example chart. Example are used in demo and various workshop to show how to use helm as part of a gitops toolchain.
| Chart | Source | Description |
|---|---|---|
| example-imagestreams | source | An example on how to deploy multiple image streams using helm |
| example-knative | source | An example on how to deploy application using serverless |
| example-deployment | source | An example on how to deploy simple applications using helm and a deployment |
| example-html | source | An example on how to deploy webserver using helm and a deployment |
| example-php | source | An example on how to deploy PHP application |
| example-pod | source | An example on how to deploy simple applications using helm and a pod |
| example-sxapi | source | An example on how to deploy simple micro-applications using helm and an sxapi toolkit |
| example-catalog | source | Various demo examples |
| example-chaos | source | An example for deploying a choas test suite |
| example-fruitapp-project | source | Deploy fruitapp CI/CD demo with common and project structure (like namespaces) |
| example-fruitapp-shared | source | Deploy shared component like database and secrets |
| example-fruitapp-app | source | Deploy application stack into an environment |
Use Examples charts
# Add the STARTX helm repository
helm repo add startx https://helm-repository.readthedocs.io/en/latest/repos/stable/
# Add individual charts
helm install startx/example-deployment
helm install startx/example-html
helm install startx/example-imagestreams
helm install startx/example-knative
helm install startx/example-php
helm install startx/example-pod
helm install startx/example-sxapi
helm install startx/example-chaos
helm install startx/example-fruitapp-project
helm install startx/example-fruitapp-shared
helm install startx/example-fruitapp-app
Helm repositories
| Repository | Command | Description |
|---|---|---|
| stable | helm repo add startx https://helm-repository.readthedocs.io/en/latest/repos/stable |
The default repository with latest stable release for 16,15,14,13,12,11,10,9,8 and 7 releases |
| noschema | helm repo add startx-noschema https://helm-repository.readthedocs.io/en/latest/repos/noschema |
Archive repository without schema definition |
| 16 | helm repo add startx https://helm-repository.readthedocs.io/en/latest/repos/16 |
Archive repository for the 16.x packages (Compatible with OCP 4.16.x) |
| 15 | helm repo add startx https://helm-repository.readthedocs.io/en/latest/repos/15 |
Archive repository for the 15.x packages (Compatible with OCP 4.15.x) |
| 14 | helm repo add startx https://helm-repository.readthedocs.io/en/latest/repos/14 |
Archive repository for the 14.x packages (Compatible with OCP 4.14.x) |
| 13 | helm repo add startx https://helm-repository.readthedocs.io/en/latest/repos/13 |
Archive repository for the 13.x packages (Compatible with OCP 4.13.x) |
| 12 | helm repo add startx https://helm-repository.readthedocs.io/en/latest/repos/12 |
Archive repository for the 12.x packages (Compatible with OCP 4.12.x) |
| 11 | helm repo add startx https://helm-repository.readthedocs.io/en/latest/repos/11 |
Archive repository for the 11.x packages (Compatible with OCP 4.11.x) |
| 10 | helm repo add startx https://helm-repository.readthedocs.io/en/latest/repos/10 |
Archive repository for the 10.x packages (Compatible with OCP 4.10.x) |
| 9 | helm repo add startx https://helm-repository.readthedocs.io/en/latest/repos/9 |
Archive repository for the 9.x packages (Compatible with OCP 4.9.x) |
| 8 | helm repo add startx https://helm-repository.readthedocs.io/en/latest/repos/8 |
Archive repository for the 8.x packages (Compatible with OCP 4.8.x) |
| 7 | helm repo add startx https://helm-repository.readthedocs.io/en/latest/repos/7 |
Archive repository for the 7.x packages (Compatible with OCP 4.7.x) |
| 6x | helm repo add startx https://helm-repository.readthedocs.io/en/latest/repos/6x |
Archive repository for the 6.x and previous packages (Compatible with OCP 4.6.x and before) |
Install STARTX repository
1. Using Helm
1.1. install cli dependencies
yum install yq helm -y
1.2. Connect to an openshift cluster
oc login -t <my-token> <my-openshift-api>
If you don’t have access to an openshift cluster, consider using codeready-container to run locally a simulated cluster.
1.3. Add the startx helm repository
helm repo add startx https://helm-repository.readthedocs.io/en/latest/repos/stable
2. Using Openshift
2.1. Deploy via HelmChartRepository
cat <<EOF | oc apply -f -
apiVersion: helm.openshift.io/v1beta1
kind: HelmChartRepository
metadata:
name: "startx"
labels:
app.kubernetes.io/name: "startx-chart"
spec:
name: "startx"
connectionConfig:
url: "https://helm-repository.readthedocs.io/en/latest/repos/stable"
EOF
2.2. Deploy via HelmChartRepository (archive)
If you need to run your in an older version of Openshift, or access to archived version of helm chart, you can load one of the archive repository.
This example show how to load charts from the v13 archive repository.
cat <<EOF | oc apply -f -
apiVersion: helm.openshift.io/v1beta1
kind: HelmChartRepository
metadata:
name: "startx-v13"
labels:
app.kubernetes.io/name: "startx-v13-charts"
spec:
name: "startx-v13"
connectionConfig:
url: "https://helm-repository.readthedocs.io/en/latest/repos/13"
EOF
2.3. List all charts
You can use the Openshift developper perspective of your console
3. Install local helm
3.1. Clonning this repository
git clone https://startxfr.github.io/helm-repository.git
cd helm-repository
3.2. List all charts
# Add the STARTX helm repository
helm repo add startx .
# List all charts in the STARTX repository
helm list startx
3.3 Install a local chart
# Add the STARTX helm repository
helm repo add startx .
# Install the STARTX available chart
helm install <chart-name>
Install using ArgoCD
If you whan to deploy theses charts using ArgoCD, you can follow the install using ArgoCD guide
Install building environment
In order to contribute to this repository, you must get the full developement environment by following the install build environment guide
History and releases
Read history traceback for more information on change and released version. Complementary information could be found in the release convention Notice that every chart in this repository follow it’s own release lifecycle. You can refer to it by reading every chart documentation page.