Skip to content

Commit

Permalink
Add a two-part Terraform starter guide
Browse files Browse the repository at this point in the history
Closes #41055

Add a learning series for users who wants to get started with managing
Teleport resources using Terraform. The guide takes the user through
some fundamental cluster setup tasks: deploying Agents, enrolling
resources, adding labels, configuring roles, and setting up SSO. The
series includes two guides:

- Part One: Enrolling resources
- Part Two: Configuring RBAC

Part One of the series is based on the "Deploy Agents with Terraform"
guide. This change adds instructions to the guide to label
infrastructure resources so the user can access those resources with the
roles configured in Part Two.

Other changes:

- Rename `agent-pool-terraform` to `terraform-starter`.
- Rename the "Dynamic Resources" guide to be more explicitly about
  Infrastructure as Code. Organize this section into subsections to make
  room for the new starter guide.
- Edit the Further Reading discussion in Part One. Move the static
  resource discussion to Further Reading because, otherwise, there is
  too much explanatory text between instructions. Also mention
  auto-discovery.
  • Loading branch information
ptgott committed Aug 1, 2024
1 parent e9dae49 commit b866fc7
Show file tree
Hide file tree
Showing 42 changed files with 1,672 additions and 633 deletions.
114 changes: 88 additions & 26 deletions docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -655,37 +655,59 @@
"slug": "/management/introduction/"
},
{
"title": "Using Dynamic Resources",
"slug": "/management/dynamic-resources/",
"title": "Using Infrastructure as Code",
"slug": "/management/infrastructure-as-code/",
"entries": [
{
"title": "Managing Users and Roles",
"slug": "/management/dynamic-resources/user-and-role/"
},
{
"title": "Registering Agentless OpenSSH",
"slug": "/management/dynamic-resources/agentless-ssh-servers/"
},
{
"title": "Managing Access Lists",
"slug": "/management/dynamic-resources/access-list/"
},
{
"title": "Terraform Starter Setup",
"slug": "/management/infrastructure-as-code/terraform-starter/",
"entries": [
{
"title": "Part 1: Enroll Resources",
"slug": "/management/infrastructure-as-code/terraform-starter/enroll-resources/"
},
{
"title": "Part 2: Configure RBAC",
"slug": "/management/infrastructure-as-code/terraform-starter/rbac/"
}
]
},
{
"title": "Managing Resources",
"slug": "/management/infrastructure-as-code/managing-resources/managing-resources/",
"entries": [
{
"title": "Managing Users and Roles",
"slug": "/management/infrastructure-as-code/managing-resources/user-and-role/"
},
{
"title": "Registering Agentless OpenSSH",
"slug": "/management/infrastructure-as-code/managing-resources/agentless-ssh-servers/"
},
{
"title": "Managing Access Lists",
"slug": "/management/infrastructure-as-code/managing-resources/access-list/"
}
]
},
{
"title": "Kubernetes Operator",
"slug": "/management/dynamic-resources/teleport-operator/"
},
{
"title": "Kubernetes Operator in teleport-cluster Helm chart",
"slug": "/management/dynamic-resources/teleport-operator-helm/",
"forScopes": ["oss","enterprise"]
},
{
"title": "Standalone Kubernetes Operator",
"slug": "/management/dynamic-resources/teleport-operator-standalone/"
"slug": "/management/infrastructure-as-code/teleport-operator/",
"entries": [
{
"title": "Kubernetes Operator in teleport-cluster Helm chart",
"slug": "/management/infrastructure-as-code/teleport-operator/teleport-operator-helm/",
"forScopes": ["oss","enterprise"]
},
{
"title": "Standalone Kubernetes Operator",
"slug": "/management/infrastructure-as-code/teleport-operator/teleport-operator-standalone/"
}
]
},
{
"title": "Set up the Terraform Provider",
"slug": "/management/dynamic-resources/terraform-provider/"
"slug": "/management/infrastructure-as-code/terraform-provider/"
}
]
},
Expand Down Expand Up @@ -1486,7 +1508,7 @@
},
{
"source": "/agents/deploy-agents-terraform/",
"destination": "/enroll-resources/agents/deploy-agents-terraform/",
"destination": "/management/infrastructure-as-code/terraform-starter/enroll-resources/",
"permanent": true
},
{
Expand Down Expand Up @@ -2673,6 +2695,46 @@
"source": "/user-manual/",
"destination": "/",
"permanent": true
},
{
"source": "/management/dynamic-resources/",
"destination": "/management/infrastructure-as-code/",
"permanent": true
},
{
"source": "/management/dynamic-resources/access-list/",
"destination": "/management/infrastructure-as-code/managing-resources/access-list/",
"permanent": true
},
{
"source": "/management/dynamic-resources/agentless-ssh-servers/",
"destination": "/management/infrastructure-as-code/managing-resources/agentless-ssh-servers/",
"permanent": true
},
{
"source": "/management/dynamic-resources/teleport-operator-helm/",
"destination": "/management/infrastructure-as-code/teleport-operator/teleport-operator-helm/",
"permanent": true
},
{
"source": "/management/dynamic-resources/teleport-operator-standalone/",
"destination": "/management/infrastructure-as-code/teleport-operator/teleport-operator-standalone/",
"permanent": true
},
{
"source": "/management/dynamic-resources/teleport-operator/",
"destination": "/management/infrastructure-as-code/teleport-operator/",
"permanent": true
},
{
"source": "/management/dynamic-resources/terraform-provider/",
"destination": "/management/infrastructure-as-code/terraform-provider/",
"permanent": true
},
{
"source": "/management/dynamic-resources/user-and-role/",
"destination": "/management/infrastructure-as-code/managing-resources/user-and-role/",
"permanent": true
}
]
}
Loading

0 comments on commit b866fc7

Please sign in to comment.