Skip to content

Commit e4131e1

Browse files
authored
Merge pull request #32 from charlieegan3/update-pre-reqs
Minor clarifications in cluster install pre-reqs
2 parents e287d35 + 3c4b97e commit e4131e1

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/installation_manual_in_cluster.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@ This doc explains how to run Preflight inside a GKE cluster, and get periodic re
55
## Prerequisites
66

77
- A Google Cloud Platform project where to create the destination Google Cloud Storage Bucket.
8-
- A Kubernetes cluster where to install Preflight (it can be a GKE cluster inside the previous project, for instance).
8+
- A GKE cluster with Workload Identity enabled to run Preflight (it can be a GKE cluster inside the previous project, for instance).
9+
- `kubectl` 1.14+
910

10-
We will apply Terraform modules in this guide, so having Terraform installed locally is also needed. However, those operations can be done from the GCP console or using `gcloud`, so Terraform is not strictly a requirement.
11+
We will apply Terraform modules as part of this guide, so Terraform should also be installed. However, if required, these operations can be completed in the GCP console or using `gcloud` instead.
1112

1213
## A Preflight Docker image that includes your Preflight Packages.
1314

@@ -73,10 +74,10 @@ If you built your own Docker image for Preflight, you need to edit `deployment/k
7374

7475
**Preflight configuration**
7576

76-
We also need to customize some things in the configuration file. Edit `deployment/kubernetes/overlays/scanner/config/preflight.yaml` and chagne:
77+
We also need to customize some things in the configuration file. Edit `deployment/kubernetes/overlays/scanner/config/preflight.yaml` and change:
7778
- `cluster-name`, this is the name of the cluster in the context of Preflight. Will be used in the generated reports.
7879
- `data-gatherers.gke`, make sure `project`, `location` and `cluster` correspond to the GKE cluster you want Preflight to scan.
79-
- `bucket-name`, change it so it points to the cluster you created before.
80+
- `outputs[_].bucket-name`, change it so it points to the bucket you created before.
8081

8182
**Deploy**
8283

0 commit comments

Comments
 (0)