Skip to content

Commit

Permalink
Update instructions about license install
Browse files Browse the repository at this point in the history
Signed-off-by: Donny Yung <donaldyung@datawire.io>
  • Loading branch information
Donny Yung committed Sep 1, 2021
1 parent 9c42835 commit 7aada32
Showing 1 changed file with 58 additions and 5 deletions.
63 changes: 58 additions & 5 deletions reference/cluster-config.md
Expand Up @@ -98,11 +98,17 @@ run this command to generate the Cluster ID:

4. Click *Generate API Key* to finish generating the license.

5. On the licenses page, download the license file associated with your cluster.

### Add license to cluster
There are two separate ways you can add the license to your cluster: manually creating and deploying
the license secret or having the helm chart manage the secret

You only need to do one of the two options.

1. On the licenses page, download the license file associated with your cluster.
#### Manual deploy of license secret

2. Use this command to generate a Kubernetes Secret config using the license file:
1. Use this command to generate a Kubernetes Secret config using the license file:

```
$ telepresence license -f <downloaded-license-file>
Expand All @@ -118,13 +124,60 @@ run this command to generate the Cluster ID:
namespace: ambassador
```

3. Save the output as a YAML file and apply it to your
2. Save the output as a YAML file and apply it to your
cluster with `kubectl`.

4. Ensure that you have the docker image for the Smart Agent (datawire/ambassador-telepresence-agent:1.8.0)
3. When deploying the `traffic-manager` chart, you must add the additional values when running `helm install` by putting
the following into a file (for the example we'll assume it's called license-values.yaml)

```
licenseKey:
# This mounts the secret into the traffic-manager
create: true
secret:
# This tells the helm chart not to create the secret since you've created it yourself
create: false
```

4. Install the helm chart into the cluster

```
helm install traffic-manager -n ambassador datawire/telepresence --create-namespace -f license-values.yaml
```

5. Ensure that you have the docker image for the Smart Agent (datawire/ambassador-telepresence-agent:1.11.0)
pulled and in a registry your cluster can pull from.

5. Have users use the `images` [config key](../config/#images) keys so telepresence uses the aforementioned image for their agent.
6. Have users use the `images` [config key](../config/#images) keys so telepresence uses the aforementioned image for their agent.

#### Helm chart manages the secret

1. Get the jwt token from the downloaded license file

```
$ cat ~/Downloads/ambassador.License_for_yourcluster
eyJhbGnotarealtoken.butanexample
```

2. Create the following values file, substituting your real jwt token in for the one used in the example below.
(for this example we'll assume the following is placed in a file called license-values.yaml)

```
licenseKey:
# This mounts the secret into the traffic-manager
create: true
# This is the value from the license file you download. this value is an example and will not work
value: eyJhbGnotarealtoken.butanexample
secret:
# This tells the helm chart to create the secret
create: true
```

3. Install the helm chart into the cluster

```
helm install traffic-manager charts/telepresence -n ambassador --create-namespace -f license-values.yaml
```

Users will now be able to use preview intercepts with the
`--preview-url=false` flag. Even with the license key, preview URLs
Expand Down

0 comments on commit 7aada32

Please sign in to comment.