From 7af196ff4d3b450c995c9bfeabf4b79febd72143 Mon Sep 17 00:00:00 2001 From: Joachim Jablon Date: Mon, 5 Jul 2021 17:12:19 +0200 Subject: [PATCH 1/3] Remove legacy name for cli tool --- setup.cfg | 1 - 1 file changed, 1 deletion(-) diff --git a/setup.cfg b/setup.cfg index 0d78dd6..ba7b290 100644 --- a/setup.cfg +++ b/setup.cfg @@ -29,7 +29,6 @@ install_requires = [options.entry_points] console_scripts = vault-cli = vault_cli.cli:main - vault = vault_cli.cli:main [options.extras_require] From 06fd2650bface1e601a85b6adc2e41ee5297fcbd Mon Sep 17 00:00:00 2001 From: Joachim Jablon Date: Mon, 5 Jul 2021 17:16:36 +0200 Subject: [PATCH 2/3] Update docs --- docs/howto/templated_secrets.rst | 2 +- docs/howto/upgrade.rst | 6 ++++++ docs/howto/write.rst | 10 +++++----- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/howto/templated_secrets.rst b/docs/howto/templated_secrets.rst index 0da1062..ace53ec 100644 --- a/docs/howto/templated_secrets.rst +++ b/docs/howto/templated_secrets.rst @@ -68,7 +68,7 @@ to leave the rest of the value as-is, and not run Jinja2 on it: .. code:: yaml - name: Add templated secrets - command: vault set {{ item.path }} '{{ item.key }}={{ item.template }}' + command: vault-cli set {{ item.path }} '{{ item.key }}={{ item.template }}' loop: - path: path/one key: mykey diff --git a/docs/howto/upgrade.rst b/docs/howto/upgrade.rst index d917998..9d455b6 100644 --- a/docs/howto/upgrade.rst +++ b/docs/howto/upgrade.rst @@ -1,6 +1,11 @@ Upgrade ``vault-cli`` from previous version =========================================== +From 1.x to 2.x +~~~~~~~~~~~~~~~ + +Switch command name from ``vault-cli`` to ``vault`` if you're using it. + From 0.x to 1.x ~~~~~~~~~~~~~~~ @@ -26,6 +31,7 @@ variables names. but ``vault`` is kept for backwards compatibility. Because ``vault-cli 0.x`` was only compatible with the name ``vault``, the examples below are written with ``vault`` + After 2.0, command ``vault`` has disappeared. The following list shows how to update your commands: diff --git a/docs/howto/write.rst b/docs/howto/write.rst index df82ef4..d596207 100644 --- a/docs/howto/write.rst +++ b/docs/howto/write.rst @@ -6,9 +6,9 @@ Secrets in the vault are either written manually or generated by secret engines .. code:: console - $ vault set a b=c + $ vault-cli set a b=c Done - $ vault get a + $ vault-cli get a --- b: c @@ -31,9 +31,9 @@ to redefine a secret object from scratch, use ``--clear``: .. code:: console - $ vault set a f=g + $ vault-cli set a f=g Done - $ vault get a + $ vault-cli get a --- f: g @@ -64,7 +64,7 @@ the output of a program into the vault: Done $ # Or: - $ pwgen 64 1 | vault set myapp secret_key=- + $ pwgen 64 1 | vault-cli set myapp secret_key=- Done You can also load a several key/values in YAML (or JSON) format from a From 29e777ae88c75c1b615ad51d85bab02133738c40 Mon Sep 17 00:00:00 2001 From: Joachim Jablon Date: Mon, 5 Jul 2021 17:21:12 +0200 Subject: [PATCH 3/3] Update docs/howto/upgrade.rst --- docs/howto/upgrade.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/howto/upgrade.rst b/docs/howto/upgrade.rst index 9d455b6..6945729 100644 --- a/docs/howto/upgrade.rst +++ b/docs/howto/upgrade.rst @@ -4,7 +4,7 @@ Upgrade ``vault-cli`` from previous version From 1.x to 2.x ~~~~~~~~~~~~~~~ -Switch command name from ``vault-cli`` to ``vault`` if you're using it. +Switch command name from ``vault`` to ``vault-cli`` if you're using it. From 0.x to 1.x ~~~~~~~~~~~~~~~