Add framework for karbor-status upgrade check
This commit adds the functionality of karbor-status CLI for performing upgrade checks as part of the Stein cycle upgrade-checkers goal. It only includes a sample check which must be replaced by real checks in future. Change-Id: I8b75d516725c7cdf169d558b1c4b6f92a695ab2e Story: 2003657 Task: 26134
This commit is contained in:
parent
096fc2d28a
commit
b03585d2ca
|
@ -0,0 +1,11 @@
|
||||||
|
========================
|
||||||
|
Karbor CLI Documentation
|
||||||
|
========================
|
||||||
|
|
||||||
|
In this section you will find information on Karbor’s command line
|
||||||
|
interface.
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
karbor-status
|
|
@ -0,0 +1,83 @@
|
||||||
|
=============
|
||||||
|
karbor-status
|
||||||
|
=============
|
||||||
|
|
||||||
|
----------------------------------------
|
||||||
|
CLI interface for Karbor status commands
|
||||||
|
----------------------------------------
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
========
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
karbor-status <category> <command> [<args>]
|
||||||
|
|
||||||
|
Description
|
||||||
|
===========
|
||||||
|
|
||||||
|
:program:`karbor-status` is a tool that provides routines for checking the
|
||||||
|
status of a Karbor deployment.
|
||||||
|
|
||||||
|
Options
|
||||||
|
=======
|
||||||
|
|
||||||
|
The standard pattern for executing a :program:`karbor-status` command is::
|
||||||
|
|
||||||
|
karbor-status <category> <command> [<args>]
|
||||||
|
|
||||||
|
Run without arguments to see a list of available command categories::
|
||||||
|
|
||||||
|
karbor-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::
|
||||||
|
|
||||||
|
karbor-status upgrade
|
||||||
|
|
||||||
|
These sections describe the available categories and arguments for
|
||||||
|
:program:`karbor-status`.
|
||||||
|
|
||||||
|
Upgrade
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
.. _karbor-status-checks:
|
||||||
|
|
||||||
|
``karbor-status upgrade check``
|
||||||
|
Performs a release-specific readiness check before restarting services with
|
||||||
|
new code. For example, missing or changed configuration options,
|
||||||
|
incompatible object states, or other conditions that could lead to
|
||||||
|
failures while upgrading.
|
||||||
|
|
||||||
|
**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**
|
||||||
|
|
||||||
|
**x.x.x (Stein)**
|
||||||
|
|
||||||
|
* Sample check to be filled in with checks as they are added in Stein.
|
|
@ -27,6 +27,7 @@ Using Karbor
|
||||||
readme
|
readme
|
||||||
install/index
|
install/index
|
||||||
configuration/index
|
configuration/index
|
||||||
|
cli/index
|
||||||
admin/index
|
admin/index
|
||||||
|
|
||||||
Available Plugins
|
Available Plugins
|
||||||
|
|
|
@ -0,0 +1,53 @@
|
||||||
|
# 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 karbor.i18n import _
|
||||||
|
|
||||||
|
CONF = cfg.CONF
|
||||||
|
|
||||||
|
|
||||||
|
class Checks(upgradecheck.UpgradeCommands):
|
||||||
|
|
||||||
|
"""Contains upgrade checks
|
||||||
|
|
||||||
|
Various upgrade checks should be added as separate methods in this class
|
||||||
|
and added to _upgrade_checks tuple.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def _sample_check(self):
|
||||||
|
"""This is sample check added to test the upgrade check framework
|
||||||
|
|
||||||
|
It needs to be removed after adding any real upgrade check
|
||||||
|
"""
|
||||||
|
return upgradecheck.Result(upgradecheck.Code.SUCCESS, 'Sample detail')
|
||||||
|
|
||||||
|
_upgrade_checks = (
|
||||||
|
# Sample check added for now.
|
||||||
|
# Whereas in future real checks must be added here in tuple
|
||||||
|
(_('Sample Check'), _sample_check),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
return upgradecheck.main(
|
||||||
|
CONF, project='karbor', upgrade_command=Checks())
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
sys.exit(main())
|
|
@ -0,0 +1,30 @@
|
||||||
|
# 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.
|
||||||
|
|
||||||
|
from oslo_upgradecheck.upgradecheck import Code
|
||||||
|
|
||||||
|
from karbor.cmd import status
|
||||||
|
from karbor.tests import base
|
||||||
|
|
||||||
|
|
||||||
|
class TestUpgradeChecks(base.TestCase):
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
super(TestUpgradeChecks, self).setUp()
|
||||||
|
self.cmd = status.Checks()
|
||||||
|
|
||||||
|
def test__sample_check(self):
|
||||||
|
check_result = self.cmd._sample_check()
|
||||||
|
self.assertEqual(
|
||||||
|
Code.SUCCESS, check_result.code)
|
|
@ -78,6 +78,7 @@ oslo.middleware==3.31.0
|
||||||
oslo.policy==1.30.0
|
oslo.policy==1.30.0
|
||||||
oslo.serialization==2.18.0
|
oslo.serialization==2.18.0
|
||||||
oslo.service==1.24.0
|
oslo.service==1.24.0
|
||||||
|
oslo.upgradecheck==0.1.0
|
||||||
oslo.utils==3.36.0
|
oslo.utils==3.36.0
|
||||||
oslo.versionedobjects==1.31.2
|
oslo.versionedobjects==1.31.2
|
||||||
oslotest==3.2.0
|
oslotest==3.2.0
|
||||||
|
|
|
@ -0,0 +1,13 @@
|
||||||
|
---
|
||||||
|
prelude: >
|
||||||
|
Added new tool ``karbor-status upgrade check``.
|
||||||
|
features:
|
||||||
|
- |
|
||||||
|
New framework for ``karbor-status upgrade check`` command is added.
|
||||||
|
This framework allows adding various checks which can be run before a
|
||||||
|
Karbor upgrade to ensure if the upgrade can be performed safely.
|
||||||
|
upgrade:
|
||||||
|
- |
|
||||||
|
Operator can now use new CLI tool ``karbor-status upgrade check``
|
||||||
|
to check if Karbor deployment can be safely upgraded from
|
||||||
|
N-1 to N release.
|
|
@ -24,6 +24,7 @@ oslo.middleware>=3.31.0 # Apache-2.0
|
||||||
oslo.policy>=1.30.0 # Apache-2.0
|
oslo.policy>=1.30.0 # Apache-2.0
|
||||||
oslo.serialization!=2.19.1,>=2.18.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.service!=1.28.1,>=1.24.0 # Apache-2.0
|
||||||
|
oslo.upgradecheck>=0.1.0 # Apache-2.0
|
||||||
oslo.versionedobjects>=1.31.2 # Apache-2.0
|
oslo.versionedobjects>=1.31.2 # Apache-2.0
|
||||||
Paste>=2.0.2 # MIT
|
Paste>=2.0.2 # MIT
|
||||||
PasteDeploy>=1.5.0 # MIT
|
PasteDeploy>=1.5.0 # MIT
|
||||||
|
|
|
@ -31,6 +31,7 @@ console_scripts =
|
||||||
karbor-manage = karbor.cmd.manage:main
|
karbor-manage = karbor.cmd.manage:main
|
||||||
karbor-operationengine = karbor.cmd.operationengine:main
|
karbor-operationengine = karbor.cmd.operationengine:main
|
||||||
karbor-protection = karbor.cmd.protection:main
|
karbor-protection = karbor.cmd.protection:main
|
||||||
|
karbor-status = karbor.cmd.status:main
|
||||||
oslo.config.opts =
|
oslo.config.opts =
|
||||||
karbor.common.opts = karbor.common.opts:list_opts
|
karbor.common.opts = karbor.common.opts:list_opts
|
||||||
oslo.policy.enforcer =
|
oslo.policy.enforcer =
|
||||||
|
|
Loading…
Reference in New Issue