Skip to content

Commit

Permalink
project_selector doc updates (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
AdminTurnedDevOps authored Mar 27, 2023
1 parent a01a4ce commit b644a1c
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Parameterize the helm install with `--set *` or `--values yourConfig.yaml` to co
| secret.create | Create the kubernetes Secret containing the supplied api-key | boolean | true | no |
| secret.name | The name of the kubernetes Secret to create | string | `<helm fullname>` | no |
| projectMappings.root.environment | The CloudTruth environment to lookup parameter values for. | string | `default` | yes |
| projectMappings.root.project_selector | A regexp to limit the projects acted against (client-side). Supplies any named matches for template evaluation | string | "" | no |
| projectMappings.root.project_selector | A regexp, or static CloudTruth project name value, to limit the projects acted against (client-side). Supplies any named matches for template evaluation | string | "" | no |
| projectMappings.root.key_selector | A regexp to limit the keys acted against (client-side). Supplies any named matches for template evaluation | string | "" | no |
| projectMappings.root.tag | The version tag used when querying for parameters | string | `none` | no |
| projectMappings.root.skip | Skips the generation of resources for the selected projects | flag | false | no |
Expand Down Expand Up @@ -145,6 +145,8 @@ standard ways, e.g. `kubectl edit projectmapping kubetruth-root`. The
`override` scope allows you to override the root scope's behavior for those
CloudTruth projects whose names match its `project_selector` pattern.

For the `project_selector`, which is defined under the *Usage* section, you can either use a regex (i.e - `"^k8s-"`) which matches any CloudTruth project that starts with `k8s-`, or a specific CloudTruth project name. For example, if you have a CloudTruth project called `kubernetes_secrets`, you'll want the `project_selector` value to be `"kubernetes_secrets"`.

Note that Kubetruth watches for changes to ProjectMappings, so touching any of
them wakes it up from a polling sleep. This makes it quick and easy to test out
configuration changes without having a short polling interval. You can also
Expand Down

0 comments on commit b644a1c

Please sign in to comment.