Chaos - Cerberus
This helm chart used to deploy cerberus on Openshift or Kubernetes cluster. Cerberus is as a watchdog who act as a global cluster healthcheck.
This chart is part of the chaos startx helm chart series focused on deploying various kind of chaos tools for cluster infrastructure or applications chaos-testing. chaos-xxx charts.
Requirements and guidelines
Read the startx helm-repository homepage for more information on how to use theses resources.
Deploy this helm chart on openshift
1. Connect to your Openshift cluster
oc login -t <token> <cluster-url>
2. Install the repository
helm repo add startx https://helm-repository.readthedocs.io/en/latest/packages/
3. Get information about this chart
helm show chart startx/chaos-cerberus
4. Install this component
# Install the cerberus project
helm install --set project.enabled=true chaos-cerberus-project startx/chaos-cerberus
# Deploy the cerberus instance
helm install --set cerberus.enabled=true chaos-cerberus-instance startx/chaos-cerberus
Values dictionary
context values dictionary
| Key | Default | Description |
|---|---|---|
| context.scope | default | Name of the global scope for this application (organisational tenant) |
| context.cluster | localhost | Name of the cluster running this application (plateform tenant) |
| context.environment | dev | Name of the environement for this application (ex: dev, factory, preprod or prod) |
| context.component | demo | Component name of this application (logical tenant) |
| context.app | sxapi | Application name (functionnal tenant, default use Chart name) |
| context.version | 0.0.1 | Version name of this application (default use Chart appVersion) |
chaos-cerberus values dictionary
| Key | Default | Description |
|---|---|---|
| project | {…} | Configuration of the project (or namespace). Inherit from the project chart (see chart options for more options) |
| project.enable | false | Enable creation of the namespace |
| cerberus | {…} | Configuration of the cerberus deployment |
| cerberus.enable | false | Enable deploying the cerberus watchdog |
| cerberus.expose | true | Enable exposition for this application (route based) |
| cerberus.kraken_allowed | true | Enable kraken pod to query the cerberus healthcheck (networkpolicy) |
| cerberus.kraken_ns | chaos-kraken | Namespace of the kraken pod that would be allowed |
| cerberus.watch_url_routes | [] | Url list of endpoint to watch as part of the global healthcheck (double array) |
| cerberus.kubeconfig | {…} | Kubeconfig of the supervised tested cluster (mandatory) |
| cerberus.kubeconfig.mode | token | Connection mode to use for the cluster (could be token or file) |
| cerberus.kubeconfig.token | {…} | If mode is token, this section must be filled |
| cerberus.kubeconfig.token.server | https://localhost:6443 | The server URL to the target cluster API |
| cerberus.kubeconfig.token.token | sha256~XXX | The token to use to get access. This token must have full cluster admin access to perform some chaos scenarios |
| cerberus.kubeconfig.file | ”“ | If mode is token, this property must be set with a full kubeconfig content |
Values files
Default values file (values.yaml)
Simple cerberus with default configuration :
- 1 project named chaos-cerberus
- 1 scc with privileged context for cerberus deployment
- 1 configmap with cerberus server configuration
- 1 configmap with kubeconfig of the targeted cluster
- 2 networkpolicy allowing route and kraken pods in chaos-kraken namespace, to get cerberus signal
- 1 deployment named cerberus
- watching the cluster https://localhost:6443
- using token sha256~XXXXXXXXXX_PUT_YOUR_TOKEN_HERE_XXXXXXXXXXXX
- watching no particular routes (as part of the watchdog)
- 1 service to the cerberus pods
- 1 route to the cerberus service
# Install the cerberus project
helm install --set project.enable=true chaos-cerberus-project startx/chaos-cerberus
# Deploy the cerberus instance
helm install --set cerberus.enable=true -n chaos-cerberus chaos-cerberus-instance startx/chaos-cerberus
STARTX values file (values-startx-xxx.yaml)
Same as the default configuration but with namespace prefixed with startx-
# Configuration running demo example configuration
helm install chaos-cerberus-project startx/chaos-cerberus -f https://raw.githubusercontent.com/startxfr/helm-repository/master/charts/chaos-cerberus/values-startx-project.yaml
helm install chaos-cerberus-deploy startx/chaos-cerberus -f https://raw.githubusercontent.com/startxfr/helm-repository/master/charts/chaos-cerberus/values-startx-deploy.yaml
History
| Release | Date | Description |
|---|---|---|
| 10.12.5 | 2022-06-03 | Initial commit of the example and poc chart example-chaos |
| 10.12.8 | 2022-06-11 | Initial commit for this helm chart as part of the chaos suite |
| 10.12.26 | 2022-06-17 | Create the chaos-mesh chart as part of the startx chaos chart suite |
| 10.12.28 | 2022-06-17 | Upgrade the chaos-cerberus helm chart schema with full option support. Link to upstream project release latest (no stable release) |
| 10.12.29 | 2022-06-17 | Align all charts to version 10.12.29 |
| 10.12.29 | 2022-06-17 | publish stable update for the full repository |
| 10.12.30 | 2022-06-17 | Improved logo and global documentation |
| 10.12.33 | 2022-06-17 | version all dependencies charts |
| 10.12.33 | 2022-06-17 | publish stable update for the full repository |
| 10.12.34 | 2022-06-17 | Align all dependencies charts to 10.12.31 |
| 10.12.35 | 2022-06-18 | Improve icon |
| 10.12.39 | 2022-06-18 | Align all chart to revision 10.12.39 |
| 10.12.41 | 2022-06-18 | Align all charts to version 10.12.41 |
| 10.12.42 | 2022-06-18 | Improve schema default values, notes and polish helm deployment documentation |
| 10.12.43 | 2022-06-18 | Improve doc for helm deployment |
| 10.12.46 | 2022-06-18 | publish stable update for the full repository |
| 10.12.47 | 2022-06-18 | Minor improvment in doc and sample values |
| 10.12.49 | 2022-06-18 | publish stable update for the full repository |
| 10.12.53 | 2022-06-18 | publish stable update for the full repository |
| 10.12.71 | 2022-06-28 | Debug the appVersion in all charts |
| 10.12.72 | 2022-07-02 | Common release |
| 10.12.77 | 2022-07-02 | Stable for clients |
| 10.12.81 | 2022-07-02 | publish stable update for the full repository |
| 10.12.97 | 2022-07-03 | publish stable update for the full repository |
| 10.12.99 | 2022-09-16 | Initialize OCP 4.11 upgrade on all chart |
| 11.5.3 | 2022-09-17 | Align all STARTX charts to release 11.5.3 |
| 11.7.1 | 2022-10-01 | Upgrade chart to latest release available for OCP 4.11.7 release |
| 11.7.3 | 2022-10-02 | publish stable update for the full repository |
| 11.7.9 | 2022-10-02 | publish stable update for the full repository |
| 11.7.10 | 2022-10-02 | Stable release for all packages |
| 11.7.11 | 2022-10-02 | publish stable update for the full repository |
| 11.7.15 | 2022-10-02 | publish stable update for the full repository |
| 11.7.17 | 2022-10-02 | publish stable update for the full repository |
| 11.7.31 | 2022-10-29 | publish stable update for the full repository |
| 11.7.33 | 2022-10-29 | Update all startx packages to release 11.7.33 |
| 11.7.41 | 2022-11-02 | publish stable update for the full repository |
| 11.7.61 | 2022-11-30 | publish stable update for the full repository |
| 11.7.62 | 2022-11-30 | Debug console links and notifications |
| 11.7.63 | 2022-11-30 | publish stable update for the full repository |
| 11.7.64 | 2022-11-30 | Increment sxapi version |
| 11.7.67 | 2022-11-30 | Debug depedencies on sub charts |
| 11.7.67 | 2022-11-30 | Debug depedencies on sub charts |
| 11.7.69 | 2022-11-30 | Finished dependencies stabilization |
| 11.7.73 | 2022-12-04 | Align all packages to release 11.7.73 |
| 11.7.75 | 2022-12-04 | publish stable update for the full repository |
| 11.7.77 | 2022-12-05 | publish stable update for the full repository |
| 11.7.87 | 2023-02-15 | publish stable update for the full repository |
| 11.7.88 | 2023-02-15 | publish stable update for the full repository |
| 11.7.91 | 2023-02-16 | publish stable update for the full repository |
| 11.7.93 | 2023-02-16 | align dependencies to version 11.7.89 |
| 11.7.97 | 2023-02-19 | publish stable update for the full repository |
| 11.28.11 | 2023-02-19 | publish stable update for the full repository |
| 11.28.15 | 2023-02-19 | publish stable update for the full repository |
| 11.28.16 | 2023-02-19 | publish stable update for the full repository |
| 11.28.19 | 2023-02-19 | publish stable update for the full repository |
| 11.28.21 | 2023-02-19 | Upgrade all dependencies packages to release 11.28.15 |
| 11.28.23 | 2023-02-21 | publish stable update for the full repository |
| 11.28.25 | 2023-02-21 | Debug route NS scope placement |
| 11.28.27 | 2023-02-21 | All chart aligned to release 11.28.27 |
| 11.28.28 | 2023-02-21 | Improve chaos-cerberus options |
| 11.28.29 | 2023-02-21 | publish stable update for the full repository |
| 11.28.35 | 2023-02-21 | publish stable update for the full repository |
| 11.28.39 | 2023-02-21 | Improve chaos-cerberus options |
| 11.28.39 | 2023-02-21 | Improve chaos-cerberus options |
| 11.28.40 | 2023-02-21 | Improve chaos-cerberus options |
| 11.28.41 | 2023-02-21 | Improve chaos-cerberus options |
| 11.28.49 | 2023-02-21 | publish stable update for the full repository |
| 11.28.59 | 2023-02-21 | publish stable update for the full repository |
| 11.28.60 | 2023-02-21 | publish stable update for the full repository |
| 11.28.67 | 2023-02-23 | publish stable update for the full repository |
| 11.28.69 | 2023-03-07 | publish stable update for the full repository |