Skip to content

Commit 7e9ce6f

Browse files
authored
Update GKE config docs (#175)
The format for the configuration of this datagatherer has changed. Signed-off-by: Charlie Egan <[email protected]>
1 parent b8d5efd commit 7e9ce6f

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs/datagatherers/gke.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,26 +25,27 @@ data-gatherers:
2525
- kind: "gke"
2626
name: "gke"
2727
config:
28+
# Path to a file containing the credentials. If empty, it will try to use
29+
# the SDK defaults (explained below)
30+
# credentials-path: /tmp/credentials.json
2831
cluster:
2932
project: my-gcp-project
3033
location: us-central1-a
3134
name: my-gke-cluster
32-
# Path to a file containing the credentials. If empty, it will try to use
33-
# the SDK defaults
34-
# credentials: /tmp/credentials.json
3535
```
3636

3737
The `gke` configuration contains the following fields:
3838

39-
- `project`: The ID of your Google Cloud Platform project.
40-
- `location`: The compute zone or region where your cluster is running.
41-
- `cluster`: The name of your GKE cluster.
42-
- `credentials`: *optional* The path to a file containing credentials for your
43-
cluster.
39+
- `credentials-path`: *optional* The path to a file containing credentials for
40+
your cluster.
41+
- `cluster`
42+
- `name`: The name of your GKE cluster.
43+
- `project`: The ID of your Google Cloud Platform project.
44+
- `location`: The compute zone or region where your cluster is running.
4445

4546
## Permissions
4647

47-
If a `credentials` file is not specified, Preflight will attempt to use
48+
If a `credentials-path` file is not specified, Preflight will attempt to use
4849
Application Default Credentials or the metadata API (as per Google SDK default).
4950

5051
If Preflight is running locally and the `gcloud` command is installed and

0 commit comments

Comments
 (0)