Update policy resources with list examples #1361
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
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
ctauchen
reviewed
Mar 11, 2024
There was a problem hiding this comment.
Thanks for this, @MichalFupso ! I've added a few suggestions. Please make similar changes to the other three resources.
In particular, it's important that we keep the resource name as we see it in the code. Sometimes it's hard to resist the temptation to use it as a noun and make it plural.
GlobalNetworkPolicies --> GlobalNetworkPolicy resources
Comment on lines
191
to
193
| #### List filtering on tiers | ||
| List and Watch operations may specify label selector or field selector to filter GlobalNetworkPolicies on tiers returned by the API server. | ||
| When no selector is specified the API server returns all GlobalNetworkPolicies from all tiers that the user has access to. |
There was a problem hiding this comment.
Suggested change
| #### List filtering on tiers | |
| List and Watch operations may specify label selector or field selector to filter GlobalNetworkPolicies on tiers returned by the API server. | |
| When no selector is specified the API server returns all GlobalNetworkPolicies from all tiers that the user has access to. | |
| #### List filtering on tiers | |
| List and watch operations may specify label selectors or field selectors to filter `GlobalNetworkPolicy` resources on tiers returned by the API server. | |
| When no selector is specified, the API server returns all `GlobalNetworkPolicy` resources from all tiers that the user has access to. |
| List and Watch operations may specify label selector or field selector to filter GlobalNetworkPolicies on tiers returned by the API server. | ||
| When no selector is specified the API server returns all GlobalNetworkPolicies from all tiers that the user has access to. | ||
|
|
||
| ##### Field selector |
There was a problem hiding this comment.
Add newline after heading.
| When no selector is specified the API server returns all GlobalNetworkPolicies from all tiers that the user has access to. | ||
|
|
||
| ##### Field selector | ||
| When using the field selector, supported operators are = and == |
There was a problem hiding this comment.
Suggested change
| When using the field selector, supported operators are = and == | |
| When using the field selector, supported operators are `=` and `==`. |
Comment on lines
198
to
201
| Example to retrieve all GlobalNetworkPolicies in default tier: | ||
| ``` | ||
| kubectl get globalnetworkpolicy --field-selector spec.tier=default | ||
| ``` |
There was a problem hiding this comment.
Suggested change
| Example to retrieve all GlobalNetworkPolicies in default tier: | |
| ``` | |
| kubectl get globalnetworkpolicy --field-selector spec.tier=default | |
| ``` | |
| The following example shows how to retrieve all `GlobalNetworkPolicy` resources in the default tier: | |
| ```bash | |
| kubectl get globalnetworkpolicy --field-selector spec.tier=default |
Comment on lines
203
to
209
| ##### Label selector | ||
| When using the label selector, supported operators are =, == and IN | ||
|
|
||
| Example to retrieve all GlobalNetworkPolicies in default and net-sec tier: | ||
| ``` | ||
| kubectl get globalnetworkpolicy -l 'projectcalico.org/tier in (default, net-sec)' | ||
| ``` |
There was a problem hiding this comment.
Suggested change
| ##### Label selector | |
| When using the label selector, supported operators are =, == and IN | |
| Example to retrieve all GlobalNetworkPolicies in default and net-sec tier: | |
| ``` | |
| kubectl get globalnetworkpolicy -l 'projectcalico.org/tier in (default, net-sec)' | |
| ``` | |
| ##### Label selector | |
| When using the label selector, supported operators are `=`, `==` and `IN`. | |
| The following example shows how to retrieve all `GlobalNetworkPolicy` resources in the `default` and `net-sec` tiers: | |
| ```bash | |
| kubectl get globalnetworkpolicy -l 'projectcalico.org/tier in (default, net-sec)' |
|
LGTM, thanks! |
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.
Update policy with List examples
Product Version(s):
Calico Enterprise
Issue:
Link to docs preview:
SME review:
DOCS review:
Additional information:
Merge checklist: