diff --git a/doc/source/admin/cli.rst b/doc/source/admin/cli.rst index 01c43cd4..f58c1be7 100644 --- a/doc/source/admin/cli.rst +++ b/doc/source/admin/cli.rst @@ -14,3 +14,12 @@ The CLI for Tricircle can be executed as follows :: openstack multiregion networking [] All commands will issue request to Tricircle Admin API. + + +Management commands +=================== + +.. toctree:: + :maxdepth: 1 + + tricircle-status diff --git a/doc/source/admin/tricircle-status.rst b/doc/source/admin/tricircle-status.rst new file mode 100644 index 00000000..0c13f2e0 --- /dev/null +++ b/doc/source/admin/tricircle-status.rst @@ -0,0 +1,78 @@ +================ +tricircle-status +================ + +Synopsis +======== + +:: + + tricircle-status [] + +Description +=========== + +:program:`tricircle-status` is a tool that provides routines for checking the +status of a Tricircle deployment. + +Options +======= + +The standard pattern for executing a :program:`tricircle-status` command is:: + + tricircle-status [] + +Run without arguments to see a list of available command categories:: + + tricircle-status + +Categories are: + +* ``upgrade`` + +Detailed descriptions are below. + +You can also run with a category argument such as ``upgrade`` to see a list of +all commands in that category:: + + tricircle-status upgrade + +These sections describe the available categories and arguments for +:program:`tricircle-status`. + +Upgrade +~~~~~~~ + +.. _tricircle-status-checks: + +``tricircle-status upgrade check`` + Performs a release-specific readiness check before restarting services with + new code. This command expects to have complete configuration and access + to databases and services. + + **Return Codes** + + .. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Return code + - Description + * - 0 + - All upgrade readiness checks passed successfully and there is nothing + to do. + * - 1 + - At least one check encountered an issue and requires further + investigation. This is considered a warning but the upgrade may be OK. + * - 2 + - There was an upgrade status check failure that needs to be + investigated. This should be considered something that stops an + upgrade. + * - 255 + - An unexpected error occurred. + + **History of Checks** + + **6.0.0 (Stein)** + + * Placeholder to be filled in with checks as they are added in Stein. diff --git a/releasenotes/notes/tricircle-status-upgrade-check-framework-13ee546a958d17f7.yaml b/releasenotes/notes/tricircle-status-upgrade-check-framework-13ee546a958d17f7.yaml new file mode 100644 index 00000000..4ad407e1 --- /dev/null +++ b/releasenotes/notes/tricircle-status-upgrade-check-framework-13ee546a958d17f7.yaml @@ -0,0 +1,13 @@ +--- +prelude: > + Added new tool ``tricircle-status upgrade check``. +features: + - | + New framework for ``tricircle-status upgrade check`` command is added. + This framework allows adding various checks which can be run before a + Tricircle upgrade to ensure if the upgrade can be performed safely. +upgrade: + - | + Operator can now use new CLI tool ``tricircle-status upgrade check`` + to check if Tricircle deployment can be safely upgraded from + N-1 to N release. diff --git a/requirements.txt b/requirements.txt index 7d1337fb..2296d143 100644 --- a/requirements.txt +++ b/requirements.txt @@ -40,6 +40,7 @@ oslo.policy>=1.30.0 # Apache-2.0 oslo.rootwrap>=5.8.0 # Apache-2.0 oslo.serialization!=2.19.1,>=2.18.0 # Apache-2.0 oslo.service!=1.28.1,>=1.24.0 # Apache-2.0 +oslo.upgradecheck>=0.1.1 # Apache-2.0 oslo.utils>=3.33.0 # Apache-2.0 sqlalchemy-migrate>=0.11.0 # Apache-2.0 diff --git a/setup.cfg b/setup.cfg index df769948..dc22ac9e 100644 --- a/setup.cfg +++ b/setup.cfg @@ -48,6 +48,7 @@ output_file = tricircle/locale/tricircle.pot console_scripts = tricircle-api = tricircle.cmd.api:main tricircle-db-manage = tricircle.cmd.manage:main + tricircle-status = tricircle.cmd.status:main tricircle-xjob = tricircle.cmd.xjob:main wsgi_scripts = tricircle-api-wsgi = tricircle.api.wsgi:init_application diff --git a/tricircle/cmd/status.py b/tricircle/cmd/status.py new file mode 100644 index 00000000..5f0437cf --- /dev/null +++ b/tricircle/cmd/status.py @@ -0,0 +1,54 @@ +# Copyright (c) 2018 NEC, Corp. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import sys + +from oslo_config import cfg +from oslo_upgradecheck import upgradecheck + +from tricircle.common.i18n import _ + + +class Checks(upgradecheck.UpgradeCommands): + + """Upgrade checks for the tricircle-status upgrade check command + + Upgrade checks should be added as separate methods in this class + and added to _upgrade_checks tuple. + """ + + def _check_placeholder(self): + # This is just a placeholder for upgrade checks, it should be + # removed when the actual checks are added + return upgradecheck.Result(upgradecheck.Code.SUCCESS) + + # The format of the check functions is to return an + # oslo_upgradecheck.upgradecheck.Result + # object with the appropriate + # oslo_upgradecheck.upgradecheck.Code and details set. + # If the check hits warnings or failures then those should be stored + # in the returned Result's "details" attribute. The + # summary will be rolled up at the end of the check() method. + _upgrade_checks = ( + # In the future there should be some real checks added here + (_('Placeholder'), _check_placeholder), + ) + + +def main(): + return upgradecheck.main( + cfg.CONF, project='tricircle', upgrade_command=Checks()) + +if __name__ == '__main__': + sys.exit(main()) diff --git a/tricircle/tests/unit/cmd/__init__.py b/tricircle/tests/unit/cmd/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/tricircle/tests/unit/cmd/test_status.py b/tricircle/tests/unit/cmd/test_status.py new file mode 100644 index 00000000..2f1eebed --- /dev/null +++ b/tricircle/tests/unit/cmd/test_status.py @@ -0,0 +1,31 @@ +# Copyright (c) 2018 NEC, Corp. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import unittest + +from oslo_upgradecheck.upgradecheck import Code + +from tricircle.cmd import status + + +class TestUpgradeChecks(unittest.TestCase): + + def setUp(self): + super(TestUpgradeChecks, self).setUp() + self.cmd = status.Checks() + + def test__check_placeholder(self): + check_result = self.cmd._check_placeholder() + self.assertEqual( + Code.SUCCESS, check_result.code)