Document existing list/filter behaviour for PackageRevisions #257
Conversation
…Revisions
- add descriptions in porchctl-cli-guide.md
- selected as place closest in concept although selector flags are only
supported by kubectl
- new paragraphs in "Package Revision Filtering" section
- descriptions of --selector and --field-selector
- example commands and output
- list of selectable fields for --field-selector
- include note that changing selectable fields requires code changes
due to aggregated-API nature of PackageRevision
- fixed a typo
nephio-project/nephio#677
✅ Deploy Preview for nephio ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
JamesMcDermott
changed the title
| The common `kubectl` flags that control output format are available as well: | ||
| You can also filter package revisions using the `kubectl` CLI with the `--selector` and `--field-selector` flags under the same conventions as for other KRM objects. | ||
|
|
||
| `--selector` filters by the values of one or more metadata labels (see [Kubernetes documentation](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#list-and-watch-filtering) for full details): |
There was a problem hiding this comment.
might just be nit picking here but i don't think we should start sentences with the variable this way. something like "The --selector variable filters by ..." instead i think would be a better way to proceed.
|
|
||
| `--field-selector` filters by the values of one or more package revision fields (see [Kubernetes documentation](https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/)): |
There was a problem hiding this comment.
same as above comment
|
|
||
| {{% /alert %}} | ||
|
|
||
| The common `kubectl` flags that control output format are available as well: |
There was a problem hiding this comment.
perhaps we should link to the kubernetes docs here also https://kubernetes.io/docs/reference/kubectl/#output-options
| | Kind | Fields | | ||
| | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | PackageRevision | `metadata.name`<br/>`metadata.namespace`<br/>`spec.revision`<br/>`spec.packageName`<br/>`spec.repository`<br/>`spec.workspaceName`<br/>`spec.lifecycle` | | ||
|
|
There was a problem hiding this comment.
perhaps if we can make the table scale to the entire length of the page instead of cropped to a subsection. looks a bit odd compared to the rest of the page and a bit hard to read e.g. https://docs.nephio.org/docs/porch/package-mutation-pipeline-order/#key-differences-and-use-cases
There was a problem hiding this comment.
After offline discussion, changed to a bullet list
|
|
Looks Great! |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: Catalin-Stratulat-Ericsson The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Part of #677.