project_selector doc updates #13
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wr0ngway
approved these changes
Mar 27, 2023
| @@ -45,7 +45,7 @@ Parameterize the helm install with `--set *` or `--values yourConfig.yaml` to co | |||
| | appSettings.pollingInterval | Interval to poll CloudTruth api for changes | integer | 300 | no | | |||
| | appSettings.debug | Debug logging and behavior | flag | false | 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 | | |||
There was a problem hiding this comment.
Note this is always treated as a regexp, but a regexp can just be a simple string that matches the project name. However, if you don't anchor the regexp, then you may match more than the project you intended. e.g. foo matches the projects foobar and barfoo, but ^foo$ only matches foo.
| @@ -143,6 +143,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"`. | |||
There was a problem hiding this comment.
See first comment about anchoring so that you don't inadvertently match not_kubernetes_secrets
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A few updates to the explanation of
project_selector