Improve dev environment setup and add utility to run backplane locally

Author: RaphaelBut

.gitignore

@@ -5,4 +5,5 @@ dist
 .envrc
 .idea
 .vscode
-cad_testing
+cad_testing
+backplane-api

README.md

@@ -90,23 +90,39 @@ They are initialized for you and passed to the investigation via investigation.R
 ## Testing locally
 
 ### Pre-requirements
-- an existing cluster
-- an existing PagerDuty incident for the cluster and alert type that is being tested
+- An existing stage cluster
+- A Pagerduty incident
 
-To quickly create an incident for a cluster_id, you can run `./test/generate_incident.sh <alertname> <clusterid>`.
-Example usage:`./test/generate_incident.sh ClusterHasGoneMissing 2b94brrrrrrrrrrrrrrrrrrhkaj`.
+```bash
+# (Optional) Export you pagerduty token to automatically retireve the incident id
+export pd_token=<your_pd_token>
+# Generates incident and creates payload file with incident ID
+./test/generate_incident.sh <alertname> <clusterid>
+```
 
-### Running cadctl for an incident ID
-1) Export the required ENV variables, see [required ENV variables](#required-env-variables).
-2) Create a payload file containing the incident ID
+If you are not using pd_token, create the payload file with the incidentID manually
   ```bash
   export INCIDENT_ID=
   echo '{"__pd_metadata":{"incident":{"id":"'${INCIDENT_ID}'"}}}' > ./payload
   ```
+
+### Running cadctl
+
+1) Run backplane-api locally in a second terminal ( requires being logged into ocm )
+
+    ```
+    ./test/backplane.sh
+    ```
+
+    > If there is an issue with this step, comment out the `BACKPLANE_URL` env in `set_stage_env.sh`. You will then run against stage backplane, meaning backplane wont be able to see any local changes to metadata files, expect errors like `file not found`
+2) Export the required ENV variables, see [required ENV variables](#required-env-variables).
+    ```
+    source test/set_stage_env.sh
+    ```
 3) Run `cadctl` using the payload file
-  ```bash
-  ./bin/cadctl investigate --payload-path payload
-  ```
+    ```bash
+    ./bin/cadctl investigate --payload-path payload
+    ```
 
 ## Documentation
 

test/backplane.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+set -euo pipefail
+
+# clone
+git -C backplane-api pull || git clone --depth 1 --branch master [email protected]:service/backplane-api.git
+# build
+cd backplane-api
+make build
+# setup, this does not look to good :D
+sudo make dev-certs
+sudo chmod 644 localhost.key
+# setup ocm config
+cp $HOME/.config/ocm/ocm.json configs/ocm.json
+# run, in background? second terminal ?
+RUN_ARGS=--cloud-config=./configs/cloud-config.yml make run-local-with-testremediation GIT_REPO="../"
+
+

test/set_stage_env.sh

@@ -10,6 +10,7 @@ for v in $(vault kv get  -format=json osd-sre/configuration-anomaly-detection/pd
 unset VAULT_ADDR VAULT_TOKEN
 
 export CAD_EXPERIMENTAL_ENABLED=true
-export BACKPLANE_PROXY=http://squid.corp.redhat.com:3128
+# export BACKPLANE_PROXY=http://squid.corp.redhat.com:3128
+export BACKPLANE_URL=https://localhost:8001
 
 set +euo pipefail