From 545fe4815b1a5501b72977e9c0104eeea1be0858 Mon Sep 17 00:00:00 2001 From: Paul Gottschling Date: Thu, 20 Jun 2024 17:26:16 -0400 Subject: [PATCH] [v14] Fix docs markup errors (#43316) Backports #43223 Co-authored-by: Alexey Ivanov --- docs/config.json | 17 +- docs/img/IBM/IBM_HA.svg | 213 +++++++++++++++++- .../access-request-plugins/servicenow.mdx | 2 +- .../access-controls/login-rules/guide.mdx | 2 +- .../management/admin/trustedclusters.mdx | 2 +- .../management/operations/db-ca-rotation.mdx | 4 +- docs/pages/reference/terraform-provider.mdx | 9 - 7 files changed, 216 insertions(+), 33 deletions(-) diff --git a/docs/config.json b/docs/config.json index 19e9a5e8ec6a1..daa585b7dac57 100644 --- a/docs/config.json +++ b/docs/config.json @@ -3220,16 +3220,6 @@ "destination": "/access-controls/device-trust/device-management/", "permanent": true }, - { - "source": "/management/guides/teleport-operator/", - "destination": "/management/dynamic-resources/teleport-operator/", - "permanent": true - }, - { - "source": "/management/guides/terraform-provider/", - "destination": "/management/dynamic-resources/terraform-provider/", - "permanent": true - }, { "source": "/get-started/", "destination": "/", @@ -3287,7 +3277,7 @@ }, { "source": "/machine-id/guides/", - "destination": "/machine-id/", + "destination": "/machine-id/introduction/", "permanent": true }, { @@ -3325,11 +3315,6 @@ "destination": "/machine-id/deployment/gitlab/", "permanent": true }, - { - "source": "/machine-id/guides/gitlab/", - "destination": "/machine-id/deployment/github-actions/", - "permanent": true - }, { "source": "/server-access/guides/openssh/", "destination": "/server-access/guides/openssh/openssh/", diff --git a/docs/img/IBM/IBM_HA.svg b/docs/img/IBM/IBM_HA.svg index 2dde67c51c185..246d230c0b1d7 100644 --- a/docs/img/IBM/IBM_HA.svg +++ b/docs/img/IBM/IBM_HA.svg @@ -1,3 +1,210 @@ - - -
IBM Cloud
IBM Cloud
Teleport Proxy Autoscale Group
Teleport Proxy Aut...
IBM Cloud Virtual Server
IBM Cloud Virtual...
Teleport Auth
Autoscale Group
Teleport Auth...
IBM Cloud Virtual Server
IBM Cloud Virtual...
VPC
VPC
Instances
Instances
One Teleport cluster can support 10,000 nodes. See Teleport Node setup for more info. 
One Teleport cluster c...
IBM Object Store
IBM Object Store
IBM Database for etcd
IBM Database for etcd
Client
Client
End user using Teleport
Client Tool tsh
End user using T...
SSO Provider
SSO Provider \ No newline at end of file + + + + + +
+
+
+ IBM Cloud +
+
+
+ + IBM Cloud + + + + + +
+
+
+ + Teleport Proxy Autoscale Group + +
+
+
+ + Teleport Proxy Aut... + + + + + +
+
+
+ IBM Cloud Virtual Server +
+
+
+ + IBM Cloud Virtual... + + + + + + + + +
+
+
+ + Teleport Auth +
+ Autoscale Group + +
+
+
+ + Teleport Auth... + + + + + +
+
+
+ IBM Cloud Virtual Server +
+
+
+ + IBM Cloud Virtual... + + + + +
+
+
+ VPC +
+
+
+ + VPC + + + + + + +
+
+
+ Instances +
+
+
+ + Instances + + + +
+
+
+ + + One Teleport cluster can support + + + 10,000 nodes. See Teleport Node + + + setup for more info. + + +
+
+
+ + One Teleport cluster c... + + + +
+
+
+ IBM Object Store +
+
+
+ + IBM Object Store + + + + +
+
+
+ IBM Database for etcd +
+
+
+ + IBM Database for etcd + + + + + + + + + + + + + + +
+
+
+ Client +
+
+
+ + Client + + + +
+
+
+ End user using Teleport +
+ Client Tool + + tsh + +
+
+
+ + End user using T... + + + +
+
+
+ SSO Provider +
+
+
+ + SSO Provider + + + + diff --git a/docs/pages/access-controls/access-request-plugins/servicenow.mdx b/docs/pages/access-controls/access-request-plugins/servicenow.mdx index a47fe600daefe..c4013213c1ab3 100644 --- a/docs/pages/access-controls/access-request-plugins/servicenow.mdx +++ b/docs/pages/access-controls/access-request-plugins/servicenow.mdx @@ -63,7 +63,7 @@ To retrieve the ServiceNow rotation ID, navigate to the group record of the ServiceNow group the rotation belongs to and right click on header, then click 'Select copy sys_id' to copy the ID. -Then using the ServiceNow endpoint '/api/now/on_call_rota/workbench/group/{groupSysId}' +Then using the ServiceNow endpoint `/api/now/on_call_rota/workbench/group/{groupSysId}` retrieve the group's on-call rota information. Select the value of the desired 'rota' from the response. diff --git a/docs/pages/access-controls/login-rules/guide.mdx b/docs/pages/access-controls/login-rules/guide.mdx index 2968d502ebd7b..9fee51b16b766 100644 --- a/docs/pages/access-controls/login-rules/guide.mdx +++ b/docs/pages/access-controls/login-rules/guide.mdx @@ -17,7 +17,7 @@ cluster on version `11.3.1` or greater. Login Rules only operate on SSO logins, so make sure you have configured an OIDC, SAML, or GitHub connector before you begin. -Check the [Single Sign-On](../sso/) docs to learn how to set this up. +Check the [Single Sign-On](../sso.mdx) docs to learn how to set this up. ## Step 1/5. Configure RBAC diff --git a/docs/pages/management/admin/trustedclusters.mdx b/docs/pages/management/admin/trustedclusters.mdx index 6e9cc702592a1..66ffe521efcac 100644 --- a/docs/pages/management/admin/trustedclusters.mdx +++ b/docs/pages/management/admin/trustedclusters.mdx @@ -106,7 +106,7 @@ configured with a single sign-on identity provider that authenticates her identi Based on the information from the identity provider, the root cluster assigns Alice the `full-access` role and issues her a certificate. The mapping of single sign-on properties to Teleport roles is configured when you add an authentication connector to the Teleport cluster. To learn more about configuring single sign-on -through an external identity provider, see [Configure Single Sign-on](../../access-controls/sso). +through an external identity provider, see [Configure Single Sign-on](../../access-controls/sso.mdx). Alice receives the certificate that specifies the roles assigned to her in the root cluster. This metadata about her roles is contained in the certificate extensions and is protected by the signature of the root diff --git a/docs/pages/management/operations/db-ca-rotation.mdx b/docs/pages/management/operations/db-ca-rotation.mdx index 0454968fcd205..5b22f91f571fa 100644 --- a/docs/pages/management/operations/db-ca-rotation.mdx +++ b/docs/pages/management/operations/db-ca-rotation.mdx @@ -128,7 +128,7 @@ You do not need to reconfigure databases at this point if you are rotating only the `db` CA, although there is no harm in doing so. Consult the appropriate -[Teleport Database Access Guide](../../database-access/guides) for your +[Teleport Database Access Guide](../../database-access/guides.mdx) for your databases before proceeding to the `update_clients` rotation phase. @@ -172,7 +172,7 @@ lose access** to those databases after transitioning to the `standby` phase in this final step. To avoid down time, consult the appropriate -[Teleport Database Access Guide](../../database-access/guides) and reconfigure +[Teleport Database Access Guide](../../database-access/guides.mdx) and reconfigure your databases before proceeding. Otherwise, access may still be restored by reconfiguring your self-hosted databases after this step. diff --git a/docs/pages/reference/terraform-provider.mdx b/docs/pages/reference/terraform-provider.mdx index 3ed283811cb06..1e66056712b85 100644 --- a/docs/pages/reference/terraform-provider.mdx +++ b/docs/pages/reference/terraform-provider.mdx @@ -1413,15 +1413,6 @@ GitLab allows the configuration of options specific to the "gitlab" join method. Allow is a list of TokenRules, nodes using this token must match one allow rule to use this token. -| Name | Type | Required | Description | -|-----------------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| environment | string | | Environment limits access by the environment the job deploys to (if one is associated) | -| namespace_path | string | | NamespacePath is used to limit access to jobs in a group or user's projects. Example: `mygroup` | -| pipeline_source | string | | PipelineSource limits access by the job pipeline source type. https://docs.gitlab.com/ee/ci/jobs/job_control.html#common-if-clauses-for-rules Example: `web` | -| project_path | string | | ProjectPath is used to limit access to jobs belonging to an individual project. Example: `mygroup/myproject` | -| ref | string | | Ref allows access to be limited to jobs triggered by a specific git ref. Ensure this is used in combination with ref_type. | -| ref_type | string | | RefType allows access to be limited to jobs triggered by a specific git ref type. Example: `branch` or `tag` | -| sub | string | | Sub roughly uniquely identifies the workload. Example: `project_path:mygroup/my-project:ref_type:branch:ref:main` project_path:{group}/{project}:ref_type:{type}:ref:{branch_name} | #### spec.kubernetes