k3s/docs/cli-roadmap.md

7.6 KiB
Raw Blame History

Kubernetes CLI/Configuration Roadmap

See also issues with the following labels:

At least the first three issues should block 1.0.

  1. stop command in kubectl #2144: Gracefully terminate any object(s), to the extent currently possible. We also eventually want first-class support in the API for graceful termination. #1535
  2. Kind-based filtering on object streams -- only operate on the kinds of objects specified. This would make directory-based kubectl operations much more useful. Users should be able to instantiate the example applications using kubectl create -f <example-dir> ...
  3. Create services before other objects, or at least before objects that depend upon them. Namespace-relative DNS mitigates this some, but most users are still using service environment variables. #1768
  4. Pretty printing of endpoints
  5. Service address/port lookup command(s)
  6. Multiple objects on command line #3050
  7. Finish rolling update #1353
  8. Friendly to auto-scaling #2863
  9. Rollback (make rollingupdate reversible, and complete an in-progress rolling update by taking 2 replication controller names rather than always taking a file)
  10. Rollover (replace multiple replication controllers with one, such as to clean up an aborted partial rollout)
  11. Write a ReplicationController generator to derive the new ReplicationController from an old one (e.g., --image-version=newversion, which would apply a name suffix, update a label value, and apply an image tag)
  12. Use readiness #620
  13. Perhaps factor this in a way that it can be shared with Openshifts deployment controller
  14. Rolling update service as a plugin
  15. List supported API versions
  16. List supported resources
  17. Swagger lookups #3060
  18. --name, --name-suffix applied during creation and updates
  19. --labels and opinionated label injection: --app=foo, --tier={fe,cache,be,db}, --uservice=redis, --env={dev,test,prod}, --stage={canary,final}, --track={hourly,daily,weekly}, --release=0.4.3c2. Exact ones TBD. We could allow arbitrary values -- the keys are important. The actual label keys would be (optionally?) namespaced with kubectl.kubernetes.io/, or perhaps the users namespace.
  20. --annotations and opinionated annotation injection: --description, --revision
  21. Bulk updates (similar to get, create, delete)
  22. Imperative updates. We'll want to optionally make these safe(r) by supporting preconditions based on the current value and resourceVersion.
  23. label updates: addlabel, rmlabel, changelabel
  24. annotation updates: addannotation, rmannotation, changeannotation
  25. more user-friendly on-command-line json for patch
  26. We also want to support the following flavors of more general updates:
  27. whichever we dont support: 1. safe update: update the full resource, guarded by resourceVersion precondition (and perhaps selected value-based preconditions) 1. forced update: update the full resource, blowing away the previous Spec without preconditions; delete and re-create if necessary
  28. diff/dryrun: Compare new config with current Spec
  29. submit/apply/reconcile/ensure/merge: Merge user-provided fields with current Spec. Keep track of user-provided fields using an annotation -- see #1702. Delete all objects with deployment-specific labels.
  30. --dry-run for all commands
  31. Support full label selection syntax, including support for namespaces.
  32. Wait on conditions #1899
  33. Make kubectl scriptable: make output and exit code behavior consistent and useful for wrapping in workflows and piping back into kubectl and/or xargs (e.g., dump full URLs?, distinguish permanent and retry-able failure, identify objects that should be retried)
  34. Here's an example where multiple objects on the command line and an option to dump object names only (-q) would be useful in combination.
  35. Easy generation of clean configuration files from existing objects (including containers -- podex) -- remove readonly fields, status
  36. Export from one namespace, import into another is an important use case
  37. Derive objects from other objects
  38. pod clone
  39. rc from pod
  40. --labels-from (services from pods or rcs)
  41. Kind discovery (i.e., operate on objects of all kinds) #3233
  42. A fairly general-purpose way to specify fields on the command line during creation and update, not just from a config file
  43. Extensible API-based generator framework (i.e. invoke generators via an API/URL rather than building them into kubectl), so that complex client libraries dont need to be rewritten in multiple languages, and so that the abstractions are available through all interfaces: API, CLI, UI, logs, ...
  44. Need schema registry, and some way to invoke generator (e.g., using a container)
  45. Convert run-container to API-based generator
  46. Transformation framework
  47. More intelligent defaulting of fields (e.g., #2643)
  48. Update preconditions based on the values of arbitrary object fields.
  49. Deployment manager compatibility on GCP: #3685

TODO:

  • watch
  • ssh #1513
  • attach #1521
  • image/registry commands
  • do any other server paths make sense? validate? generic curl functionality?
  • template parameterization
  • dynamic/runtime configuration

Server-side support:

Only finishing v1beta3 is a requirement for 1.0. The others are strong nice-to-haves.

  1. Finish v1beta3
  2. Default selectors from labels #1698
  3. List supported resources #2057
  4. Stop #1535
  5. Deleted objects #2789
  6. Clone #170
  7. Resize #1629
  8. Useful /operations API: wait for finalization/reification
  9. Readiness #620
  10. Reverse label lookup #1348
  11. Field selection #1362
  12. Field filtering #1459
  13. Operate on uids