From 18bb7bdacb89e4618015194d30e37e467971822e Mon Sep 17 00:00:00 2001 From: Paul Gottschling Date: Mon, 4 Nov 2024 11:08:36 -0500 Subject: [PATCH] Fix markdown-lint issues Running markdown-lint in the Docusaurus site flags some issues that the gravitational/docs markdown-lint configuration doesn't catch. This change resolves these issues, fixing indentation and list item spacing. --- .../helm-deployments/kubernetes-cluster.mdx | 12 ++++++------ docs/pages/admin-guides/deploy-a-cluster/hsm.mdx | 1 + .../terraform-provider/terraform-cloud.mdx | 1 + .../mongodb-self-hosted.mdx | 1 + docs/pages/upgrading/automatic-agent-updates.mdx | 8 ++++---- docs/pages/upgrading/upgrading-reference.mdx | 14 +++++++------- 6 files changed, 20 insertions(+), 17 deletions(-) diff --git a/docs/pages/admin-guides/deploy-a-cluster/helm-deployments/kubernetes-cluster.mdx b/docs/pages/admin-guides/deploy-a-cluster/helm-deployments/kubernetes-cluster.mdx index abe2e2a4ba415..431d441c9973e 100644 --- a/docs/pages/admin-guides/deploy-a-cluster/helm-deployments/kubernetes-cluster.mdx +++ b/docs/pages/admin-guides/deploy-a-cluster/helm-deployments/kubernetes-cluster.mdx @@ -198,12 +198,12 @@ chart. 1. Install the `teleport-cluster` Helm chart using the values file you wrote: - ```code - $ helm install teleport-cluster teleport/teleport-cluster \ - --create-namespace \ - --version (=teleport.version=) \ - --values teleport-cluster-values.yaml - ``` + ```code + $ helm install teleport-cluster teleport/teleport-cluster \ + --create-namespace \ + --version (=teleport.version=) \ + --values teleport-cluster-values.yaml + ``` 1. After installing the `teleport-cluster` chart, wait a minute or so and ensure that both the Auth Service and Proxy Service pods are running: diff --git a/docs/pages/admin-guides/deploy-a-cluster/hsm.mdx b/docs/pages/admin-guides/deploy-a-cluster/hsm.mdx index ad1b376bd50e5..8a1c0ec9b3a6a 100644 --- a/docs/pages/admin-guides/deploy-a-cluster/hsm.mdx +++ b/docs/pages/admin-guides/deploy-a-cluster/hsm.mdx @@ -188,6 +188,7 @@ to use. DEBU[0000] preflight complete cert= config= key= pid=73502 seccomp=false serial= syslog=false timeout=0s version=3.0.3 DEBU[0000] takeoff TLS=false listen="localhost:12345" pid=73502 ``` + 1. Use `yubihsm-shell` to create a new authentication key to be used by Teleport with the necessary capabilities. diff --git a/docs/pages/admin-guides/infrastructure-as-code/terraform-provider/terraform-cloud.mdx b/docs/pages/admin-guides/infrastructure-as-code/terraform-provider/terraform-cloud.mdx index cf1145ee2f314..cc2e6b00cf1c1 100644 --- a/docs/pages/admin-guides/infrastructure-as-code/terraform-provider/terraform-cloud.mdx +++ b/docs/pages/admin-guides/infrastructure-as-code/terraform-provider/terraform-cloud.mdx @@ -42,6 +42,7 @@ provider in these environments. (!docs/pages/includes/commercial-prereqs-tabs.mdx!) - (!docs/pages/includes/tctl.mdx!) + - [Terraform >= (=terraform.version=)+](https://learn.hashicorp.com/tutorials/terraform/install-cli) ```code diff --git a/docs/pages/enroll-resources/database-access/enroll-self-hosted-databases/mongodb-self-hosted.mdx b/docs/pages/enroll-resources/database-access/enroll-self-hosted-databases/mongodb-self-hosted.mdx index 4bd874c64c678..382c020e67a73 100644 --- a/docs/pages/enroll-resources/database-access/enroll-self-hosted-databases/mongodb-self-hosted.mdx +++ b/docs/pages/enroll-resources/database-access/enroll-self-hosted-databases/mongodb-self-hosted.mdx @@ -34,6 +34,7 @@ videoBanner: 6lgVObxoLkc - (!docs/pages/includes/tctl.mdx!) + - A certificate authority for MongoDB Replica Set, and the public certificate for that CA, in PEM format: ``. You can also configure Teleport to trust this CA for standalone MongoDB instances. diff --git a/docs/pages/upgrading/automatic-agent-updates.mdx b/docs/pages/upgrading/automatic-agent-updates.mdx index b68be1a6406af..f6c8a27c6f78a 100644 --- a/docs/pages/upgrading/automatic-agent-updates.mdx +++ b/docs/pages/upgrading/automatic-agent-updates.mdx @@ -316,10 +316,10 @@ This section assumes that the name of your `teleport-kube-agent` release is 1. Check for any deployment issues by checking the updater logs: - ```code - $ kubectl -n logs deployment/-updater - 2023-04-28T13:13:30Z INFO StatefulSet is already up-to-date, not updating. {"controller": "statefulset", "controllerGroup": "apps", "controllerKind": "StatefulSet", "StatefulSet": {"name":"my-agent","namespace":"agent"}, "namespace": "agent", "name": "my-agent", "reconcileID": "10419f20-a4c9-45d4-a16f-406866b7fc05", "namespacedname": "agent/my-agent", "kind": "StatefulSet", "err": "no new version (current: \"v12.2.3\", next: \"v12.2.3\")"} - ``` + ```code + $ kubectl -n logs deployment/-updater + 2023-04-28T13:13:30Z INFO StatefulSet is already up-to-date, not updating. {"controller": "statefulset", "controllerGroup": "apps", "controllerKind": "StatefulSet", "StatefulSet": {"name":"my-agent","namespace":"agent"}, "namespace": "agent", "name": "my-agent", "reconcileID": "10419f20-a4c9-45d4-a16f-406866b7fc05", "namespacedname": "agent/my-agent", "kind": "StatefulSet", "err": "no new version (current: \"v12.2.3\", next: \"v12.2.3\")"} + ``` ## Troubleshooting diff --git a/docs/pages/upgrading/upgrading-reference.mdx b/docs/pages/upgrading/upgrading-reference.mdx index d6635b32442e1..f802d28f1bda8 100644 --- a/docs/pages/upgrading/upgrading-reference.mdx +++ b/docs/pages/upgrading/upgrading-reference.mdx @@ -369,15 +369,15 @@ your `teleport-cluster` release is called `teleport-cluster`. 1. Update the Teleport Helm chart repository so you can install the latest version of the `teleport-cluster` chart: - (!docs/pages/includes/kubernetes-access/helm/helm-repo-add.mdx!) + (!docs/pages/includes/kubernetes-access/helm/helm-repo-add.mdx!) 1. Upgrade the `teleport-cluster` Helm release: - ```code - $ helm upgrade teleport-cluster teleport/teleport-cluster \ - --version= \ - --values=values.yaml - ``` + ```code + $ helm upgrade teleport-cluster teleport/teleport-cluster \ + --version= \ + --values=values.yaml + ``` The `teleport-cluster` Helm chart automatically waits for the previous version of the Proxy Service to stop responding to requests before running a @@ -395,7 +395,7 @@ that your `teleport-kube-agent` release is called `teleport-agent`. 1. Update the Teleport Helm chart repository so you can install the latest version of the `teleport-kube-agent` chart: - (!docs/pages/includes/kubernetes-access/helm/helm-repo-add.mdx!) + (!docs/pages/includes/kubernetes-access/helm/helm-repo-add.mdx!) 1. Upgrade the Helm release: