Skip to content

Commit

Permalink
Merge pull request #1150 from weaveworks/1065-update-branch-planner-docs
Browse files Browse the repository at this point in the history
docs: update branch planner default configuration
  • Loading branch information
yitsushi committed Nov 29, 2023
2 parents 7389304 + 246acd0 commit e1b93ae
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/branch_planner/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,10 @@ EOF

Branch Planner uses a ConfigMap as configuration. That ConfigMap is optional to use but useful for fine-tuning Branch Planner.

### Custom Configuration
### Configuration

By default, Branch Planner will look for the `branch-planner` ConfigMap in the same namespace as where the `tf-controller` is installed. That ConfigMap allows users to precisely specify which Terraform resources in a cluster should be monitored by Branch Planner.
By default, Branch Planner will look for the `branch-planner` ConfigMap in the same namespace as where the `tf-controller` is installed.
That ConfigMap allows users to precisely specify which Terraform resources in a cluster should be monitored by Branch Planner.

The ConfigMap has two fields:

Expand All @@ -102,6 +103,7 @@ data:
secretName: branch-planner-token
resources: |-
- namespace: terraform
- namespace: flux-system
```
#### Secret
Expand Down Expand Up @@ -134,7 +136,8 @@ data:

### Default Configuration

If a ConfigMap is not found, it will watch the `flux-system` namespace for any Terraform resources and expect to find a GitHub token in a secret named `branch-planner-token` in the `flux-system` namespace. Note that supplying a secret with a token is a necessary task, otherwise Branch Planner will not be able to interact with the GitHub API.
If a ConfigMap is not found, it will not watch any namespaces and expect to find a GitHub token in a secret named `branch-planner-token` in the `flux-system` namespace.
Note that supplying a secret with a token is a necessary task, otherwise Branch Planner will not be able to interact with the GitHub API.

## Enable Branch Planner

Expand Down

0 comments on commit e1b93ae

Please sign in to comment.