Skip to content

Commit

Permalink
[v9] Kube agent instructions on matching to server version (#11711)
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenGravy authored Apr 4, 2022
1 parent 6130359 commit d3a7fca
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/pages/includes/tctl.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ remotely:
$ tsh login --proxy=myinstance.teleport.sh [email protected]
$ tctl status
# Cluster myinstance.teleport.sh
# Version (=teleport.version=)
# Version (=cloud.version=)
# CA pin sha256:sha-hash-here
```

Expand Down
15 changes: 11 additions & 4 deletions docs/pages/kubernetes-access/getting-started/agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ description: Connecting a Kubernetes cluster to Teleport
- The `jq` tool to process `JSON` output. This is available via common package
managers.

- The `tctl` admin tool version >= (=teleport.version=).
- The `tctl` admin tool version >= (=cloud.version=).

```code
$ tctl version
# Teleport v(=teleport.version=) go(=teleport.golang=)
# Teleport v(=cloud.version=) go(=teleport.golang=)
```

See [Installation](../../installation.mdx) for details.
Expand Down Expand Up @@ -102,6 +102,12 @@ $ echo $TOKEN

## Step 2/2. Deploy teleport-kube-agent

<Notice type="tip" >

The Teleport agent version should be the same as the Teleport Cluster version
or up to one major version back. You can set the version override with the override variable, ex: `--set teleportVersionOverride=(=teleport.version=)`.

</Notice>

<Tabs>
<TabItem scope={["oss", "enterprise"]} label="Self-Hosted">
Expand Down Expand Up @@ -130,14 +136,15 @@ commands, assigning `PROXY_ADDR` to the address of your Teleport Cloud tenant.

```code
# Add teleport-agent chart to charts repository
$ PROXY_ADDR=mytenant.teleport.sh
$ PROXY_ADDR=mytenant.teleport.sh:443
$ helm repo add teleport https://charts.releases.teleport.dev
$ helm repo update
# Install Kubernetes agent. It dials back to the Teleport cluster at $PROXY_ADDR
$ CLUSTER='cookie'
$ helm install teleport-agent teleport/teleport-kube-agent --set kubeClusterName=${CLUSTER?} \
--set proxyAddr=${PROXY_ADDR?} --set authToken=${TOKEN?} --create-namespace --namespace=teleport-agent
--set proxyAddr=${PROXY_ADDR?} --set authToken=${TOKEN?} --create-namespace --namespace=teleport-agent \
--set teleportVersionOverride=(=cloud.version=)
```

</TabItem>
Expand Down

0 comments on commit d3a7fca

Please sign in to comment.