zuul/releasenotes/notes/zuul-admin-cli-53f52cff1aad986c.yaml
Matthieu Huin 57c78c08e1 Clarify zuul admin CLI scope
We have two CLIs: zuul-client for REST-related operations, which cover
tenant-scoped, workflow modifying actions such as enqueue, dequeue and
promote; and zuul which supercedes zuul-client and covers also true admin
operations like ZooKeeper maintenance, config checking and issueing auth tokens.
This is a bit confusing for users and operators, and can induce code
duplication.

* Rename zuul CLI into zuul-admin. zuul is still a valid endpoint
  and will be removed after next release.
* Print a deprecation warning when invoking the admin CLI as zuul
  instead of zuul-admin, and when running autohold-*, enqueue-*,
  dequeue and promote subcommands. These subcommands will need to be
  run with zuul-client after next release.
* Clarify the scopes and deprecations in the documentation.

Change-Id: I90cf6f2be4e4c8180ad0f5e2696b7eaa7380b411
2022-05-19 15:35:30 +02:00

8 lines
400 B
YAML

---
deprecations:
- |
The zuul CLI is renamed `zuul-admin`. The `zuul` command will remain usable until a future version,
then will be phased out. Likewise, tenant-scoped, workflow affecting commands such as autohold,
enqueue, dequeue, promote are deprecated from the zuul-admin CLI and will be phased out in a
future version. They can still be performed via the `zuul-client` CLI.