From aa5ec451f79fc94d99f1c07e553240753bc4df74 Mon Sep 17 00:00:00 2001 From: Daniel Mellado Date: Tue, 20 Nov 2018 13:18:25 +0100 Subject: [PATCH] Rename kuryr-status to kuryr-k8s-status As there's another kuryr-status binary in kuryr repo this creates issues when creating packags out of the repo and could get confusing, therefore I'm renaming this one. Change-Id: I4b958d53c6530dd5099b3ac1dbcde4648055ff38 --- doc/source/installation/upgrades.rst | 22 +++++++++---------- kuryr_kubernetes/cmd/status.py | 8 +++---- .../notes/stein-upgrade-226c8e7b735701ee.yaml | 4 ++-- setup.cfg | 2 +- 4 files changed, 18 insertions(+), 18 deletions(-) diff --git a/doc/source/installation/upgrades.rst b/doc/source/installation/upgrades.rst index 8ed4e9584..9ed52348d 100644 --- a/doc/source/installation/upgrades.rst +++ b/doc/source/installation/upgrades.rst @@ -6,7 +6,7 @@ is possible and safe: .. code-block:: bash - $ kuryr-status upgrade check + $ kuryr-k8s-status upgrade check +---------------------------------------+ | Upgrade Check Results | +---------------------------------------+ @@ -24,21 +24,21 @@ Stein (0.6.x) to T (0.7.x) upgrade In T we want to drop support for old format of Pod annotations (switch was motivated by multi-vif support feature implemented in Rocky). To make sure that -you don't have unsupported Pod annotations you need to run ``kuryr-status +you don't have unsupported Pod annotations you need to run ``kuryr-k8s-status upgrade check`` utility **before upgrading Kuryr-Kubernetes services to T**. .. note:: In case of running Kuryr-Kubernetes containerized you can use ``kubectl - exec`` to run kuryr-status + exec`` to run kuryr-k8s-status .. code-block:: bash - $ kubectl -n kube-system exec -it kuryr-status upgrade check + $ kubectl -n kube-system exec -it kuryr-k8s-status upgrade check .. code-block:: bash - $ kuryr-status upgrade check + $ kuryr-k8s-status upgrade check +---------------------------------------+ | Upgrade Check Results | +---------------------------------------+ @@ -48,21 +48,21 @@ upgrade check`` utility **before upgrading Kuryr-Kubernetes services to T**. +---------------------------------------+ In case of *Failure* result of *Pod annotations* check you should run -``kuryr-status upgrade update-annotations`` command and check again: +``kuryr-k8s-status upgrade update-annotations`` command and check again: .. code-block:: bash - $ kuryr-status upgrade check + $ kuryr-k8s-status upgrade check +----------------------------------------------------------------------+ | Upgrade Check Results | +----------------------------------------------------------------------+ | Check: Pod annotations | | Result: Failure | | Details: You have 3 Kuryr pod annotations in old format. You need to | - | run `kuryr-status upgrade update-annotations` | + | run `kuryr-k8s-status upgrade update-annotations` | | before proceeding with the upgrade. | +----------------------------------------------------------------------+ - $ kuryr-status upgrade update-annotations + $ kuryr-k8s-status upgrade update-annotations +-----------------------+--------+ | Stat | Number | +-----------------------+--------+ @@ -72,7 +72,7 @@ In case of *Failure* result of *Pod annotations* check you should run +-----------------------+--------+ | Annotations left | 0 | +-----------------------+--------+ - $ kuryr-status upgrade check + $ kuryr-k8s-status upgrade check +---------------------------------------+ | Upgrade Check Results | +---------------------------------------+ @@ -86,4 +86,4 @@ a warning that should be investigated, but isn't blocking upgrading to T (it won't make things any worse). If in any case you need to rollback those changes, there is -``kuryr-status upgrade downgrade-annotations`` command as well. +``kuryr-k8s-status upgrade downgrade-annotations`` command as well. diff --git a/kuryr_kubernetes/cmd/status.py b/kuryr_kubernetes/cmd/status.py index b8553daa8..d3028d6bb 100644 --- a/kuryr_kubernetes/cmd/status.py +++ b/kuryr_kubernetes/cmd/status.py @@ -51,7 +51,7 @@ UPGRADE_CHECK_MSG_MAP = { class UpgradeCheckResult(object): - """Class used for 'kuryr-status upgrade check' results. + """Class used for 'kuryr-k8s-status upgrade check' results. The 'code' attribute is an UpgradeCheckCode enum. The 'details' attribute is a message generally only used for @@ -118,8 +118,8 @@ class UpgradeCommands(object): return UpgradeCheckResult(1, msg) elif old_count > 0: msg = ('You have %d Kuryr pod annotations in old format. You need ' - 'to run `kuryr-status upgrade update-annotations` before ' - 'proceeding with the upgrade.' % old_count) + 'to run `kuryr-k8s-status upgrade update-annotations` ' + 'before proceeding with the upgrade.' % old_count) return UpgradeCheckResult(2, msg) def upgrade_check(self): @@ -244,7 +244,7 @@ def add_parsers(subparsers): def main(): opt = cfg.SubCommandOpt( 'category', title='command', - description='kuryr-status command or category to execute', + description='kuryr-k8s-status command or category to execute', handler=add_parsers) conf = cfg.ConfigOpts() diff --git a/releasenotes/notes/stein-upgrade-226c8e7b735701ee.yaml b/releasenotes/notes/stein-upgrade-226c8e7b735701ee.yaml index 67d6eb502..f2c1309ea 100644 --- a/releasenotes/notes/stein-upgrade-226c8e7b735701ee.yaml +++ b/releasenotes/notes/stein-upgrade-226c8e7b735701ee.yaml @@ -1,6 +1,6 @@ --- upgrade: - | - Before upgrading to T (0.7.x) run ``kuryr-status upgrade check`` to check - if upgrade is possible. In case of negative result refer to + Before upgrading to T (0.7.x) run ``kuryr-k8s-status upgrade check`` to + check if upgrade is possible. In case of negative result refer to kuryr-kubernetes documentation for mitigation steps. diff --git a/setup.cfg b/setup.cfg index df3b5f712..082541002 100644 --- a/setup.cfg +++ b/setup.cfg @@ -31,7 +31,7 @@ console_scripts = kuryr-k8s-controller = kuryr_kubernetes.cmd.eventlet.controller:start kuryr-daemon = kuryr_kubernetes.cmd.daemon:start kuryr-cni = kuryr_kubernetes.cmd.cni:run - kuryr-status = kuryr_kubernetes.cmd.status:main + kuryr-k8s-status = kuryr_kubernetes.cmd.status:main kuryr_kubernetes.vif_translators = ovs = kuryr_kubernetes.os_vif_util:neutron_to_osvif_vif_ovs