Add framework for sahara-status upgrade check
This commit adds the functionality of sahara-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: Idcb8d9eaf689800812cf6087e9c5937058c89ea6 Story: 2003657 Task: 26152
This commit is contained in:
parent
6fc5a7b8ba
commit
cc41e8621b
|
@ -0,0 +1,11 @@
|
|||
========================
|
||||
Sahara CLI Documentation
|
||||
========================
|
||||
|
||||
In this section you will find information on Sahara’s command line
|
||||
interface.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
sahara-status
|
|
@ -0,0 +1,83 @@
|
|||
=============
|
||||
sahara-status
|
||||
=============
|
||||
|
||||
----------------------------------------
|
||||
CLI interface for Sahara status commands
|
||||
----------------------------------------
|
||||
|
||||
Synopsis
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
sahara-status <category> <command> [<args>]
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
:program:`sahara-status` is a tool that provides routines for checking the
|
||||
status of a Sahara deployment.
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
The standard pattern for executing a :program:`sahara-status` command is::
|
||||
|
||||
sahara-status <category> <command> [<args>]
|
||||
|
||||
Run without arguments to see a list of available command categories::
|
||||
|
||||
sahara-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::
|
||||
|
||||
sahara-status upgrade
|
||||
|
||||
These sections describe the available categories and arguments for
|
||||
:program:`sahara-status`.
|
||||
|
||||
Upgrade
|
||||
~~~~~~~
|
||||
|
||||
.. _sahara-status-checks:
|
||||
|
||||
``sahara-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**
|
||||
|
||||
**10.0.0 (Stein)**
|
||||
|
||||
* Sample check to be filled in with checks as they are added in Stein.
|
|
@ -42,6 +42,15 @@ User Guide
|
|||
user/index
|
||||
|
||||
|
||||
CLI Guide
|
||||
---------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
cli/index
|
||||
|
||||
|
||||
Operator Documentation
|
||||
----------------------
|
||||
|
||||
|
|
|
@ -83,6 +83,7 @@ oslo.policy==1.30.0
|
|||
oslo.rootwrap==5.8.0
|
||||
oslo.serialization==2.18.0
|
||||
oslo.service==1.24.0
|
||||
oslo.upgradecheck==0.1.0
|
||||
oslo.utils==3.33.0
|
||||
oslotest==3.2.0
|
||||
packaging==17.1
|
||||
|
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
prelude: >
|
||||
Added new tool ``sahara-status upgrade check``.
|
||||
features:
|
||||
- |
|
||||
New framework for ``sahara-status upgrade check`` command is added.
|
||||
This framework allows adding various checks which can be run before a
|
||||
Sahara upgrade to ensure if the upgrade can be performed safely.
|
||||
upgrade:
|
||||
- |
|
||||
Operator can now use new CLI tool ``sahara-status upgrade check``
|
||||
to check if Sahara deployment can be safely upgraded from
|
||||
N-1 to N release.
|
|
@ -27,6 +27,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.0 # Apache-2.0
|
||||
oslo.utils>=3.33.0 # Apache-2.0
|
||||
paramiko>=2.0.0 # LGPLv2.1+
|
||||
requests>=2.14.2 # Apache-2.0
|
||||
|
|
|
@ -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 sahara.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='sahara', 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 sahara.cli import sahara_status
|
||||
from sahara.tests.unit import base
|
||||
|
||||
|
||||
class TestUpgradeChecks(base.SaharaTestCase):
|
||||
|
||||
def setUp(self):
|
||||
super(TestUpgradeChecks, self).setUp()
|
||||
self.cmd = sahara_status.Checks()
|
||||
|
||||
def test__sample_check(self):
|
||||
check_result = self.cmd._sample_check()
|
||||
self.assertEqual(
|
||||
Code.SUCCESS, check_result.code)
|
|
@ -41,6 +41,7 @@ console_scripts =
|
|||
_sahara-subprocess = sahara.cli.sahara_subprocess:main
|
||||
sahara-templates = sahara.db.templates.cli:main
|
||||
sahara-image-pack = sahara.cli.image_pack.cli:main
|
||||
sahara-status = sahara.cli.sahara_status:main
|
||||
|
||||
wsgi_scripts =
|
||||
sahara-wsgi-api = sahara.cli.sahara_api:setup_api
|
||||
|
|
Loading…
Reference in New Issue