This chart is a tool that asserts compatibility between an EKS cluster and lineblocs charts.

The structure is :

├── charts # Subcharts location
├── Chart.yaml
├── checks # Scripts used in k8s Jobs to assert compatibility. Will be loaded by Helm with {{ .Files ... }}
│   ├── cloudwatch.sh
│   ├── crds.sh
│   ├── csi.sh
│   ├── kubent.sh
│   ├── metrics.sh
│   └── etc...
├── README.md
├── templates # K8S resources (Jobs, ConfigMap, ...) that will run the tests. 
│   ├── configmap-cloudwatch.yml
│   ├── configmap-crds.yml
│   ├── configmap-csi.yml
│   ├── configmap-kubent.yml
│   ├── configmap-metrics.yml
│   ├── _helpers.tpl
│   ├── job-cloudwatch.yml
│   ├── job-crds.yml
│   ├── job-csi.yml
│   ├── job-kubent.yml
│   ├── job-metrics.yml
│   ├── NOTES.txt
│   ├── rbac.yml
│   └── etc...
└── values.yaml # Default values for a release. Feel free to create your own !

First, you will need an AWS account and AWS CLI set up.

After that, you will need Helm.

To deploy these checks, you can run :

helm upgrade --install -f values.yaml <release_name> . -n <namespace>

Of course, you need to replace words surrounded by <>. Feel free to customize it, so it fits your needs. You can also copy values.yaml and create new values with different settings. It will merge your new values with the default one.

File: cloudwatch.sh

It checks if CloudWatch related resources are present in the cluster. It will run kubectl get ds and search for the corresponding CloudWatch resources. An agent for metrics and,if set, a fluentd will be needed to pass the check.

Searched resources: DaemonSets

File: crds.sh

It checks if the crds listed in helm values matches their desired version.

Searched resources: CustomResourceDefinitions

File: csi.sh

This check is a bit more complex than the others. It has four modes :

1. ATLEASTONE: will make sure that at least one driver is present
2. REGEX: will compare the result of a kubectl get against a regex (output format is <csidriver1_name> < csidriver2_name> ...).
3. ONEPRESENT: not implemented yet
4. ALLPRESENT: not implemented yet

Searched resources: CSIDrivers

File: kubent.sh

This check runs kubent in the cluster to find resources in deprecated APIs.

Searched resources: All kinds

File: metrics.sh

This check will make sure that the metrics API is backed by a service. It can be k8s metrics-server, a Prometheus or anything else.

Searched resources: APIServices

You can add more checks by creating a new script in checks/ folder. Don't forget to add the configmap and the job in templates/ folder. Then reference some default values and we are good to go. Inspire yourself from existing checks, the documentation should be clear enough for you to understand everything.