Add removal of --key parameter to CLI rewrite note

Also rewrite/reformat while here.

Change-Id: Ife2acdb0d4360c58c7de68cf259a0ed4a86234c2
This commit is contained in:
Pierre Riteau 2024-10-31 14:09:03 +01:00
parent 9b98ce997e
commit 2339561eb7

View File

@ -1,16 +1,16 @@
---
upgrade:
- |
Rewrite kolla-ansible CLI to python
Rewrite kolla-ansible CLI in Python. Moving the CLI to Python allows for
easier maintenance and larger feature set. The CLI was built using the
cliff package that is used in the ``openstack`` and ``kayobe`` commands.
Moving the CLI to python allows for easier
maintenance and larger feature set.
The CLI was built using the cliff package
that is used in openstack-cli and kayobe-cli.
This patch introduces a few breaking changes stemming from the nature of
the cliff package:
This patch introduces a few breaking changes.
The changes stem the nature of the cliff package.
1. the order of parameters must be
kolla-ansible <action> <arguments>
2. mariadb_backup and mariadb_recovery now are
mariadb-backup and mariadb-recovery
* the order of parameters must be ``kolla-ansible <action> <arguments>``
* ``mariadb_backup`` and ``mariadb_recovery`` now are ``mariadb-backup``
and ``mariadb-recovery``
The ``--key`` parameter has also been dropped as it was duplicating
``--vault-password-file``.