From 8469ee3c4a183d5096e04431542fd7691a06f2fe Mon Sep 17 00:00:00 2001 From: Mike Bell Date: Fri, 24 May 2024 10:52:15 +0100 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20Update=20docs=20an?= =?UTF-8?q?d=20fix=20minor=20spelling=20mistakes?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- runbooks/source/add-new-opa-policy.html.md.erb | 2 +- runbooks/source/auth0-rotation.html.md.erb | 6 +++--- runbooks/source/bastion-node.html.md.erb | 2 +- runbooks/source/delete-prometheus-metrics.html.md.erb | 2 +- runbooks/source/delete-state-lock.html.md.erb | 10 +++------- .../source/export-elasticsearch-to-csv.html.md.erb | 2 +- runbooks/source/get-audit-log-from-modsec.html.md.erb | 2 +- runbooks/source/resolve-opensearch-no-logs.html.md.erb | 4 ++-- .../source/resolve-opensearch-shard-issues.html.md.erb | 2 +- runbooks/source/upgrade-terraform-version.html.md.erb | 2 +- runbooks/source/upgrade-user-components.html.md.erb | 2 +- 11 files changed, 16 insertions(+), 20 deletions(-) diff --git a/runbooks/source/add-new-opa-policy.html.md.erb b/runbooks/source/add-new-opa-policy.html.md.erb index e64611bb..8cd36c6b 100644 --- a/runbooks/source/add-new-opa-policy.html.md.erb +++ b/runbooks/source/add-new-opa-policy.html.md.erb @@ -1,7 +1,7 @@ --- title: Add a new OPA policy weight: 9000 -last_reviewed_on: 2023-11-20 +last_reviewed_on: 2024-05-24 review_in: 6 months --- diff --git a/runbooks/source/auth0-rotation.html.md.erb b/runbooks/source/auth0-rotation.html.md.erb index 48e0ec22..9a4fd274 100644 --- a/runbooks/source/auth0-rotation.html.md.erb +++ b/runbooks/source/auth0-rotation.html.md.erb @@ -1,7 +1,7 @@ --- title: Credentials rotation for auth0 apps weight: 68 -last_reviewed_on: 2023-11-20 +last_reviewed_on: 2024-05-24 review_in: 6 months --- @@ -43,14 +43,14 @@ $terraform plan $ terraform apply -target=module.monitoring.kubernetes_secret.grafana_secret -target=module.monitoring.helm_release.prometheus_proxy -target=module.monitoring.helm_release.alertmanager_proxy -target=module.kuberos.helm_release.kuberos -target=module.monitoring.helm_release.kibana_audit_proxy -target=module.monitoring.helm_release.kibana_proxy ``` -Unfortunately, grafana pod will not pick up the secret change, so it needs to be recyled (just delete it and it will automatically get redeployed): +Unfortunately, grafana pod will not pick up the secret change, so it needs to be recycled (just delete it and it will automatically get redeployed): ``` $ GrafanaPodName=$(kubectl -n monitoring get pods -o name | grep grafana) $ kubectl -n monitoring delete pod $GrafanaPodName ``` -## 3) Verifiying changes +## 3) Verifying changes In order to verify that the changes were successfully applied, follow the checklist below (order doesn't matter): diff --git a/runbooks/source/bastion-node.html.md.erb b/runbooks/source/bastion-node.html.md.erb index b4debed3..9dd5fd3a 100644 --- a/runbooks/source/bastion-node.html.md.erb +++ b/runbooks/source/bastion-node.html.md.erb @@ -1,7 +1,7 @@ --- title: Create and access bastion node weight: 97 -last_reviewed_on: 2023-11-20 +last_reviewed_on: 2024-05-24 review_in: 6 months --- diff --git a/runbooks/source/delete-prometheus-metrics.html.md.erb b/runbooks/source/delete-prometheus-metrics.html.md.erb index 3150bb74..8807c51c 100644 --- a/runbooks/source/delete-prometheus-metrics.html.md.erb +++ b/runbooks/source/delete-prometheus-metrics.html.md.erb @@ -1,7 +1,7 @@ --- title: Delete Prometheus Metrics weight: 170 -last_reviewed_on: 2023-11-20 +last_reviewed_on: 2024-05-24 review_in: 6 months --- diff --git a/runbooks/source/delete-state-lock.html.md.erb b/runbooks/source/delete-state-lock.html.md.erb index 85917bbc..70684230 100644 --- a/runbooks/source/delete-state-lock.html.md.erb +++ b/runbooks/source/delete-state-lock.html.md.erb @@ -1,7 +1,7 @@ --- title: Delete terraform state lock weight: 199 -last_reviewed_on: 2023-11-20 +last_reviewed_on: 2024-05-24 review_in: 6 months --- @@ -16,9 +16,7 @@ Error: Error locking state: Error acquiring the state lock: ConditionalCheckFail status code: 400, request id: 8F9C5H04HLD0TVN4V0PQIRRMFBVV4KQNSO5AEMVJF66Q9ASUAAJG ``` -If you see repeated failures trying to acquire the lock on the same namespace, -it probably means the lock record has been left in place by mistake, because a -previous run failed to release the lock when it should have. +If you see repeated failures trying to acquire the lock on the same namespace, it probably means the lock record has been left in place by mistake, because a previous run failed to release the lock when it should have. To fix this, you need to delete the lock record. @@ -61,9 +59,7 @@ Invoke it like this: 4. Enter `LockID` as the filter attribute, and change `String, =` to `String, contains` as the filter criteria 5. Enter the namespace name as the string value to match, and click `Start search` -When you find the relevant lock records, delete them. Terraform will recreate -any missing records the next time it tries to acquire the lock for that -terraform state file. +When you find the relevant lock records, delete them. Terraform will recreate any missing records the next time it tries to acquire the lock for that terraform state file. ## Terraform command diff --git a/runbooks/source/export-elasticsearch-to-csv.html.md.erb b/runbooks/source/export-elasticsearch-to-csv.html.md.erb index 87bb0878..db88f15e 100644 --- a/runbooks/source/export-elasticsearch-to-csv.html.md.erb +++ b/runbooks/source/export-elasticsearch-to-csv.html.md.erb @@ -1,7 +1,7 @@ --- title: Export data from AWS Elasticsearch into a CSV file weight: 190 -last_reviewed_on: 2023-11-20 +last_reviewed_on: 2024-05-24 review_in: 6 months --- diff --git a/runbooks/source/get-audit-log-from-modsec.html.md.erb b/runbooks/source/get-audit-log-from-modsec.html.md.erb index df1a6d6a..9211340a 100644 --- a/runbooks/source/get-audit-log-from-modsec.html.md.erb +++ b/runbooks/source/get-audit-log-from-modsec.html.md.erb @@ -1,7 +1,7 @@ --- title: Get an audit log from modsec weight: 8600 -last_reviewed_on: 2023-11-20 +last_reviewed_on: 2024-05-24 review_in: 6 months --- diff --git a/runbooks/source/resolve-opensearch-no-logs.html.md.erb b/runbooks/source/resolve-opensearch-no-logs.html.md.erb index 5f8f17d2..1713d664 100644 --- a/runbooks/source/resolve-opensearch-no-logs.html.md.erb +++ b/runbooks/source/resolve-opensearch-no-logs.html.md.erb @@ -1,7 +1,7 @@ --- title: Resolving no logs in modsec OpenSearch weight: 190 -last_reviewed_on: 2023-11-20 +last_reviewed_on: 2024-05-24 review_in: 6 months --- @@ -9,7 +9,7 @@ review_in: 6 months [Please read up on the architecture first](https://github.com/ministryofjustice/cloud-platform-terraform-ingress-controller/#cloud-platform-terraform-ingress-controller) -## Deebugging +## Debugging The first place to look is in the fluent bit side car logs diff --git a/runbooks/source/resolve-opensearch-shard-issues.html.md.erb b/runbooks/source/resolve-opensearch-shard-issues.html.md.erb index 205da8f1..d86fd11f 100644 --- a/runbooks/source/resolve-opensearch-shard-issues.html.md.erb +++ b/runbooks/source/resolve-opensearch-shard-issues.html.md.erb @@ -1,7 +1,7 @@ --- title: Resolving OpenSearch shard problems weight: 190 -last_reviewed_on: 2023-11-20 +last_reviewed_on: 2024-05-24 review_in: 6 months --- diff --git a/runbooks/source/upgrade-terraform-version.html.md.erb b/runbooks/source/upgrade-terraform-version.html.md.erb index 03c15c20..ee294346 100644 --- a/runbooks/source/upgrade-terraform-version.html.md.erb +++ b/runbooks/source/upgrade-terraform-version.html.md.erb @@ -1,7 +1,7 @@ --- title: Upgrade Terraform Version weight: 54 -last_reviewed_on: 2023-11-20 +last_reviewed_on: 2024-05-24 review_in: 6 months --- diff --git a/runbooks/source/upgrade-user-components.html.md.erb b/runbooks/source/upgrade-user-components.html.md.erb index 6774e716..d0e041a4 100644 --- a/runbooks/source/upgrade-user-components.html.md.erb +++ b/runbooks/source/upgrade-user-components.html.md.erb @@ -1,7 +1,7 @@ --- title: Upgrade user components weight: 55 -last_reviewed_on: 2023-11-20 +last_reviewed_on: 2024-05-24 review_in: 6 months ---