chore: Update readme with features and packages

kubernetes-sigs / cli-utils

This repo contains binaries that built from libraries in cli-runtime.

Apache License 2.0

154 stars 77 forks source link

chore: Update readme with features and packages #589

Closed karlkfi closed 2 years ago

karlkfi commented 2 years ago

Documented the following features:
1. Pruning
2. Status Interpretation
3. Status Lookup
4. Diff & Preview
5. Waiting for Reconciliation
6. Resource Ordering
7. Explicit Dependency Ordering
8. Implicit Dependency Ordering
9. Apply Time Mutation
10. CLI Printers
Added a short description explaining kapply as a reference implementation for testing.
Clarified usage for gitops, not just CLIs
Added package list with descriptions

karlkfi commented 2 years ago

Possible additional features to document:

jsonpath manipulation of objects (could be extracted)
flow control detection (could be extracted)
test comparison matcher extensions (could be extracted)
object validation framework
abandonment without deletion
explicit deletion prevention
in-use namespace deletion prevention
adoption policies
status aggregation (inventory status)
object status watcher

I don't think any of these should block merge, but maybe good additions for the future.

k8s-ci-robot commented 2 years ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: karlkfi, mortent

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/kubernetes-sigs/cli-utils/blob/master/OWNERS)~~ [mortent] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment