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

[v17] update links in AWS Terraform READMEs and helm charts #49358

Merged
merged 6 commits into from
Nov 26, 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
4 changes: 2 additions & 2 deletions examples/aws/terraform/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ If you are planning on using our Terraform example in production, please referen

We recommend familiarizing yourself with the following resources prior to reviewing our Terraform examples:

- [Teleport Architecture](https://goteleport.com/docs/architecture/overview/)
- [Teleport Architecture](https://goteleport.com/docs/reference/architecture/)
- [Admin Guide](https://goteleport.com/docs/management/admin/)

In order to spin up AWS resources using these Terraform examples, you need the following software:
Expand Down Expand Up @@ -39,4 +39,4 @@ Please [see the AMIS.md file](AMIS.md) for a list of public Teleport AMI IDs tha

## This is not the Teleport Terraform Provider

If you are looking for Teleport's [Terraform Provider](https://goteleport.com/docs/setup/guides/terraform-provider/) which can be used to provision users, roles, auth connectors and other resources inside an existing Teleport cluster, its source code can be found in the `teleport-plugins` repo here: https://github.com/gravitational/teleport-plugins/tree/master/terraform
If you are looking for Teleport's [Terraform Provider](https://goteleport.com/docs/reference/terraform-provider/terraform-provider/) which can be used to provision users, roles, auth connectors and other resources inside an existing Teleport cluster, its source code can be found here: https://github.com/gravitational/teleport/tree/master/integrations/terraform
2 changes: 1 addition & 1 deletion examples/aws/terraform/ha-autoscale-cluster/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ the ports to the other parts.

We recommend familiarizing yourself with the following resources prior to reviewing our Terraform examples:

- [Teleport Architecture](https://goteleport.com/docs/architecture/overview/)
- [Teleport Architecture](https://goteleport.com/docs/reference/architecture/)
- [Admin Guide](https://goteleport.com/docs/management/admin/)
- [Running Teleport Enterprise in High Availability mode on AWS](https://goteleport.com/docs/deploy-a-cluster/deployments/aws-ha-autoscale-cluster-terraform/)

Expand Down
2 changes: 1 addition & 1 deletion examples/aws/terraform/starter-cluster/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Do not use this in production! This example should be used for demo, proof-of-co

## How does this work?

Teleport AMIs are built so you only need to specify environment variables to bring a fully configured instance online. See `data.tpl` or our [documentation](https://goteleport.com/docs/deploy-a-cluster/deployments/aws-terraform/#set-up-variables) to learn more about supported environment variables.
Teleport AMIs are built so you only need to specify environment variables to bring a fully configured instance online. See `data.tpl` or our [documentation](https://goteleport.com/docs/admin-guides/deploy-a-cluster/deployments/aws-starter-cluster-terraform/#set-up-variables) to learn more about supported environment variables.

A series of systemd [units](https://github.com/gravitational/teleport/tree/master/assets/aws/files/system) bootstrap the instance, via several bash [scripts](https://github.com/gravitational/teleport/tree/master/assets/aws/files/bin).

Expand Down
2 changes: 1 addition & 1 deletion examples/chart/teleport-cluster/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ authentication:
proxyListenerMode: "separate"

# Optional setting for configuring session recording.
# See `session_recording` under https://goteleport.com/docs/setup/reference/config/#teleportyaml
# See `session_recording` under https://goteleport.com/docs/reference/config/#auth-service
sessionRecording: ""

# By default, Teleport will multiplex Postgres and MongoDB database connections on the same port as the proxy's web listener (443)
Expand Down
9 changes: 1 addition & 8 deletions examples/chart/teleport-kube-agent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,7 @@ To use it, you will need:
- a reachable proxy endpoint (`$PROXY_ENDPOINT` e.g. `teleport.example.com:3080` or `teleport.example.com:443`)
- a reachable reverse tunnel port on the proxy (e.g. `teleport.example.com:3024`). The address is automatically
retrieved from the Teleport proxy configuration.
- either a static or dynamic join token for the Teleport Cluster
- a [static join token](https://goteleport.com/docs/setup/admin/adding-nodes/#adding-nodes-to-the-cluster)
for this Teleport cluster (`$JOIN_TOKEN`) is used by default.
- optionally a [dynamic join token](https://goteleport.com/docs/setup/admin/adding-nodes/#short-lived-dynamic-tokens) can
be used on Kubernetes clusters that support persistent volumes. Set `storage.enabled=true` and
`storage.storageClassName=<storage class configured in kubernetes>` in the helm configuration to use persistent
volumes.

- a join token for the Teleport Cluster. For this Teleport cluster (`$JOIN_TOKEN`) is used by default. See the [Join Methods and Token Reference](https://goteleport.com/docs/reference/join-methods/) for supported join methods and creating tokens.

## Combining roles

Expand Down
Loading