Skip to content

Commit

Permalink
docs: include version in rds helm install (#50756)
Browse files Browse the repository at this point in the history
* docs: include version in rds helm install

* docs: update verbiage for rds helm install

Co-authored-by: Gavin Frazar <[email protected]>

---------

Co-authored-by: Gavin Frazar <[email protected]>
  • Loading branch information
stevenGravy and GavinFrazar authored Jan 7, 2025
1 parent 8b21221 commit 6c5b737
Showing 1 changed file with 17 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -204,13 +204,15 @@ Token Type Labels Expiry Time (UTC)
Create a Helm values file called `values.yaml`, assigning <Var name="token" />
to the value of the join token you retrieved above, <Var
name="example.teleport.sh:443" /> to the host **and port** of your Teleport
Proxy Service, and <Var name="endpoint:port" /> to the host **and port** of your RDS
Proxy Service, `enterprise` to false if you are using the community/OSS version,
and <Var name="endpoint:port" /> to the host **and port** of your RDS
database (e.g., `myrds.us-east-1.rds.amazonaws.com:5432`):

```yaml
authToken: <Var name="token" />
proxyAddr: <Var name="example.teleport.sh:443" />
roles: db
enterprise: true
databases:
- name: example
uri: "<Var name="endpoint:port" />"
Expand All @@ -222,11 +224,24 @@ annotations:
eks.amazonaws.com/role-arn: arn:aws:iam::<Var name="aws-account" />:role/teleport-rds-role
```
Get the version of Teleport to install. If you have automatic agent updates enabled in your cluster, query the latest Teleport version that is compatible with the updater:
```code
$ TELEPORT_VERSION="$(curl https://<Var name="example.teleport.sh:443" />/v1/webapi/automaticupgrades/channel/default/version | sed 's/v//')"
```

Otherwise, get the version of your Teleport cluster:

```code
$ TELEPORT_VERSION="$(curl https://<Var name="example.teleport.sh:443" />/v1/webapi/ping | jq -r '.server_version')"
```


Install the Helm chart for Teleport agent services, `teleport-kube-agent`:

```code
$ helm -n teleport-agent install teleport-kube-agent teleport/teleport-kube-agent \
--values values.yaml --create-namespace
--values values.yaml --create-namespace --version $TELEPORT_VERSION
```

Make sure that the Teleport agent pod is running. You should see one
Expand Down

0 comments on commit 6c5b737

Please sign in to comment.