Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: use scrape result reference in masking doc #280

Merged
merged 1 commit into from
Sep 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion mission-control/docs/config-db/concepts/transform.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@

| Field | Description | Scheme | Required |
| ---------- | ---------------------------------------------------------------------- | ------------------------------------------------- | -------- |
| `jsonpath` | All matching elements will be removed from the `config` | <CommonLink to="jsonpath">`jsonpath`</CommonLink> | `true` |

Check warning on line 46 in mission-control/docs/config-db/concepts/transform.md

View workflow job for this annotation

GitHub Actions / vale

[vale] mission-control/docs/config-db/concepts/transform.md#L46

[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'will'. Say '(event) happens' instead of '(event) will happen'.
Raw output
{"message": "[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'will'. Say '(event) happens' instead of '(event) will happen'.", "location": {"path": "mission-control/docs/config-db/concepts/transform.md", "range": {"start": {"line": 46, "column": 38}}}, "severity": "WARNING"}
| `types` | Only run exclusion rules for these config types, if empty apply to all | `[]string` | |

### Masking
Expand Down Expand Up @@ -76,7 +76,7 @@

| Field | Description | Scheme |
| ---------- | ------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `selector` | Filter which config items to apply masks on | <CommonLink to="cel">`CEL`</CommonLink> with [Config Item](/reference/config-db) context |
| `selector` | Filter which config items to apply masks on | <CommonLink to="cel">`CEL`</CommonLink> with [ScrapeResult](/reference/config-db/scrape-result) context |
| `jsonpath` | Values to mask | <CommonLink to="jsonpath">`JSONPath`</CommonLink> |
| `value` | The replacement value of matched elements | `md5` or any static string e.g. `***` |

Expand Down
Loading