Skip to content

Commit

Permalink
docs: updates for GCP discovery instructions (gravitational#36952)
Browse files Browse the repository at this point in the history
* docs: updates for GCP discovery instructions

* Include required permissions
  • Loading branch information
stevenGravy authored Jan 23, 2024
1 parent fc65c2c commit 875e933
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
Binary file modified docs/img/server-access/guides/gcp/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 12 additions & 4 deletions docs/pages/server-access/guides/gcp-discovery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,9 @@ discover instances.
- `compute.instances.getGuestAttributes`
- `compute.instances.list`
- `compute.instances.setMetadata`
- `iam.serviceAccounts.actAs`
- `iam.serviceAccounts.get`
- `iam.serviceAccounts.list`

![Custom role](../../../img/server-access/guides/gcp/[email protected])

Expand Down Expand Up @@ -103,6 +106,9 @@ discover instances.
- compute.instances.getGuestAttributes
- compute.instances.list
- compute.instances.setMetadata
- iam.serviceAccounts.actAs
- iam.serviceAccounts.get
- iam.serviceAccounts.list
```

Then run the following command to create the role:
Expand All @@ -123,7 +129,7 @@ discover instances.
```code
$ gcloud projects add-iam-policy-binding <Var name="project_id" description="GCP project ID" /> \
--member="serviceAccount:teleport-discovery@<Var name="project_id" />.iam.gserviceaccount.com" \
--role="projects/<Var name="project_id" />/role/teleport_discovery"
--role="projects/<Var name="project_id" />/roles/teleport_discovery"
```
</TabItem>
</Tabs>
Expand Down Expand Up @@ -212,12 +218,12 @@ In order to enable GCP instance discovery the `discovery_service.gcp` section
of `teleport.yaml` must include at least one entry:

```yaml
version: v2
version: v3
teleport:
join_params:
token_name: "/tmp/token"
method: token
proxy_server: "teleport.example.com:443"
proxy_server: "<Var name="teleport.example.com" />:443"
auth_service:
enabled: off
proxy_service:
Expand All @@ -239,6 +245,8 @@ discovery_service:
# (Optional) Labels that joining VMs must have.
labels:
"env": "prod" # Match virtual machines where label:env=prod
installer:
public_proxy_addr: "<Var name="teleport.example.com" />:443"
```

- Edit the `teleport.auth_server` or `teleport.proxy_server` key to match your Auth Service or Proxy Service's domain name
Expand Down Expand Up @@ -269,4 +277,4 @@ for details on alternate methods.
- Full documentation on GCP discovery configuration can be found through the [
config file reference documentation](../../reference/config.mdx).
- The complete default installer can be found [with the Teleport source
](https://github.com/gravitational/teleport/blob/branch/v(=teleport.major_version=)/api/types/installers/installer.sh.tmpl).
](https://github.com/gravitational/teleport/blob/branch/v(=teleport.major_version=)/api/types/installers/installer.sh.tmpl).

0 comments on commit 875e933

Please sign in to comment.