install observability CRD via Helm (#873)

stackrox · Mar 28, 2023 · a91bec1 · a91bec1
1 parent 99a2224
commit a91bec1
Show file tree

Hide file tree

Showing 2 changed files with 2,824 additions and 0 deletions.
diff --git a/dp-terraform/helm/rhacs-terraform/charts/observability/README.md b/dp-terraform/helm/rhacs-terraform/charts/observability/README.md
@@ -12,6 +12,24 @@ The observability operator offers further integrations with
 - PagerDuty for alert routing.
 - webhooks for a dead man switch in case the monitoring system degrades.
 
+## Custom resource definitions
+
+The initial deployment of the chart requires the installation of the `Observability`
+custom resource definition. It's required to define the customized `observability-stack`
+custom resource in the template folder. Helm installs all CRDs inside the `crds/` folder
+on the first run. Afterwards OLM and the observability operator itself keep the CRDs up to date.
+See the [Helm documentation](https://helm.sh/docs/chart_best_practices/custom_resource_definitions/#some-caveats-and-explanations)
+for some caveats and explanations of this approach.
+
+The following commands generate `crds/observability.yaml`:
+
+```
+git clone [email protected]:redhat-developer/observability-operator.git
+cd observability-operator
+git checkout v4.0.4
+kustomize build config/crd > crds/observability.yaml
+```
+
 ## Usage
 
 Create a file `~/acs-terraform-obs-values.yaml` with the values for the parameters in [values.yaml](./values.yaml) that are missing or that you want to override. That file will contain credentials, so make sure you put it in a safe location, and with suitable permissions.