Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v14] Fix markdown-lint issues #48370

Merged
merged 1 commit into from
Nov 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Before you get started, verify the following:

- You have a Teleport cluster, Enterprise edition, and command-line tools.

(!docs/pages/includes/commercial-prereqs-tabs.mdx!)
(!docs/pages/includes/commercial-prereqs-tabs.mdx!)

- (!docs/pages/includes/tctl.mdx!)

Expand Down
1 change: 0 additions & 1 deletion docs/pages/admin-guides/deploy-a-cluster/gcp-kms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ higher.
(!docs/pages/includes/commercial-prereqs-tabs.mdx!)

- (!docs/pages/includes/tctl.mdx!)

- A Google Cloud account.

## Step 1/5. Create a key ring in GCP
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions docs/pages/admin-guides/deploy-a-cluster/hsm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,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.

Expand Down
6 changes: 3 additions & 3 deletions docs/pages/contributing/documentation/style-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -163,9 +163,9 @@ for the audience of a specific guide.

- Prefer putting commands (e.g., Bash scripts) into full-line code snippets. These will render with a handy copy button.

```code
$ echo "This is an example."
```
```code
$ echo "This is an example."
```

### Diagrams

Expand Down
3 changes: 2 additions & 1 deletion docs/pages/upgrading/cloud-kubernetes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ updating works. Automatic agent upgrades require:
$ curl -s https://mytenant.teleport.sh/webapi/ping | jq '.automatic_upgrades'
true
```

- At least one Teleport Enterprise agent deployed via the `teleport-kube-agent`
Helm chart.

Expand Down Expand Up @@ -187,7 +188,7 @@ Run the following commands to upgrade Teleport agents running on Kubernetes.
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:

Expand Down
8 changes: 4 additions & 4 deletions docs/pages/upgrading/self-hosted-automatic-agent-updates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -340,10 +340,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 <Var name="teleport" /> logs deployment/<Var name="teleport-agent" />-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 <Var name="teleport" /> logs deployment/<Var name="teleport-agent" />-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 automatic agent upgrades on Kubernetes

Expand Down
14 changes: 7 additions & 7 deletions docs/pages/upgrading/self-hosted-kubernetes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,15 @@ running on Kubernetes.
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 Helm release:

```code
$ helm upgrade teleport-cluster teleport/teleport-cluster \
--version=<Var name="(=teleport.version=)" /> \
--values=values.yaml
```
```code
$ helm upgrade teleport-cluster teleport/teleport-cluster \
--version=<Var name="(=teleport.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 new version
Expand All @@ -66,7 +66,7 @@ Run the following commands to upgrade Teleport agents running on Kubernetes.
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:

Expand Down
Loading