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

Add doc for filter support for cli tools #11012

Merged
merged 7 commits into from
Mar 18, 2022
Merged

Add doc for filter support for cli tools #11012

merged 7 commits into from
Mar 18, 2022

Conversation

kimlisa
Copy link
Contributor

@kimlisa kimlisa commented Mar 9, 2022

Description

By 9.1 the cli tools tsh and tctl will have filter support. This PR adds docs on how to use the filters.

Rendered Doc Links

CLI help

The CLI --help has the following minimum instructions (same output for supported resources):

image

docs/pages/setup/reference/cli.mdx Outdated Show resolved Hide resolved
docs/pages/setup/reference/cli.mdx Outdated Show resolved Hide resolved
docs/pages/setup/reference/cli.mdx Outdated Show resolved Hide resolved
docs/pages/setup/reference/cli.mdx Outdated Show resolved Hide resolved
@kimlisa kimlisa requested review from zmb3 and ptgott March 14, 2022 17:15
Comment on lines 16 to 17
- [Dynamic Impersonation](./access-controls/guides/impersonation/#dynamic-impersonation)
- [RBAC for sessions](./access-controls/reference/#rbac-for-sessions)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the predicate language is also used for access requests, but i could not find documentation on how to define the fields (so i left it out for now). there are mentions of the field here though but with no examples: https://goteleport.com/docs/setup/reference/terraform-provider/#teleport_role,

image

i'm not sure if these fields are only applicable to terraform provider?

@kimlisa kimlisa force-pushed the lisa/update-cli-doc branch 5 times, most recently from c6562f8 to 9d2a2b0 Compare March 14, 2022 17:36
Copy link
Contributor

@ptgott ptgott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for putting this together!

docs/pages/setup/reference/cli.mdx Outdated Show resolved Hide resolved
docs/pages/setup/reference/cli.mdx Outdated Show resolved Hide resolved
docs/pages/setup/reference/cli.mdx Outdated Show resolved Hide resolved
docs/pages/setup/reference/predicate-language.mdx Outdated Show resolved Hide resolved
docs/pages/setup/reference/predicate-language.mdx Outdated Show resolved Hide resolved
docs/pages/setup/reference/predicate-language.mdx Outdated Show resolved Hide resolved
docs/pages/setup/reference/predicate-language.mdx Outdated Show resolved Hide resolved
docs/pages/setup/reference/predicate-language.mdx Outdated Show resolved Hide resolved
docs/pages/setup/reference/predicate-language.mdx Outdated Show resolved Hide resolved
docs/pages/setup/reference/predicate-language.mdx Outdated Show resolved Hide resolved
@kimlisa kimlisa force-pushed the lisa/update-cli-doc branch 4 times, most recently from 2b7e292 to 8c133da Compare March 16, 2022 19:26
@kimlisa kimlisa requested a review from ptgott March 16, 2022 19:28
Copy link
Contributor

@ptgott ptgott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just left some minor suggestions

docs/pages/access-controls/guides/impersonation.mdx Outdated Show resolved Hide resolved
docs/pages/access-controls/guides/impersonation.mdx Outdated Show resolved Hide resolved

| Field | Description |
|---------------------------------------------------|----------------------------------------------------------------|
| `user.spec.traits["<list name>"]` | the `list` of traits from a local or SSO user |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see list used literally within a configuration resource, so "the list" might not be the clearest description to use here. Is there another way to phrase this that might be more recognizable? In other words, where would a user know how to find the value to use here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually, the doc says that user traits typically come from an external identity provider, so this tells me this value will rarely change, so instead of <list name> i put the actual value of what it will typically be

docs/pages/access-controls/guides/impersonation.mdx Outdated Show resolved Hide resolved
docs/pages/access-controls/guides/impersonation.mdx Outdated Show resolved Hide resolved
docs/pages/access-controls/reference.mdx Outdated Show resolved Hide resolved
docs/pages/access-controls/reference.mdx Outdated Show resolved Hide resolved
docs/pages/access-controls/reference.mdx Outdated Show resolved Hide resolved
docs/pages/setup/reference/cli.mdx Outdated Show resolved Hide resolved
docs/pages/setup/reference/predicate-language.mdx Outdated Show resolved Hide resolved
@kimlisa kimlisa force-pushed the lisa/update-cli-doc branch from 8c133da to bba724d Compare March 18, 2022 06:16
@kimlisa kimlisa requested a review from ptgott March 18, 2022 06:20
@kimlisa kimlisa force-pushed the lisa/update-cli-doc branch from bba724d to ca766c4 Compare March 18, 2022 06:22
@kimlisa kimlisa merged commit f39e3bf into master Mar 18, 2022
@kimlisa kimlisa deleted the lisa/update-cli-doc branch March 18, 2022 15:36
kimlisa added a commit that referenced this pull request Mar 18, 2022
For the flags --search, --query, and labels
kimlisa added a commit that referenced this pull request Mar 18, 2022
For the flags --search, --query, and labels
@webvictim webvictim mentioned this pull request Apr 19, 2022
@webvictim webvictim mentioned this pull request Jun 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants