openstack/sushy-cli
Code Issues Proposed changes

Retire sushy-cli - Step 2

Browse Source 
The sushy-cli project has been inactive for a while and as announced in
the ML[1] it will be retired.

[1] http://lists.openstack.org/pipermail/openstack-discuss/2021-May/022405.html

Change-Id: Ifcaf56d2eac6b827f1b6f00d38d91d51ee3f547f
This commit is contained in:
Riccardo Pittau 2021-05-18 15:35:09 +02:00
parent 8b6e416b94
commit a6780093ab
60 changed files with 8 additions and 3212 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

108
.gitignore vendored
View File

@ -1,108 +0,0 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
.pytest_cache/
.stestr/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
target/
# Jupyter Notebook
.ipynb_checkpoints
# pyenv
.python-version
# celery beat schedule file
celerybeat-schedule
# SageMath parsed files
*.sage.py
# dotenv
.env
# virtualenv
.venv
venv/
ENV/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
# Others
AUTHORS
ChangeLog

3
.stestr.conf
View File

@ -1,3 +0,0 @@
[DEFAULT]
test_path=./sushycli/tests
top_dir=.

29
.travis.yml
View File

@ -1,29 +0,0 @@
# Config file for automatic testing at travis-ci.org
language: python
python:
- 3.8
- 3.7
- 3.6
- 3.5
# Command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
install: pip install -U tox-travis
# Command to run tests, e.g. python setup.py test
script: tox
# Assuming you have installed the travis-ci CLI tool, after you
# create the Github repo and add it to Travis, run the
# following command to finish PyPI deployment setup:
# $ travis encrypt --add deploy.password
deploy:
provider: pypi
distributions: sdist bdist_wheel
user: khansaAmrouni
password:
secure: PLEASE_REPLACE_ME
on:
tags: true
repo: khansaAmrouni/sushycli
python: 3.8

17
CONTRIBUTING.rst
View File

@ -1,17 +0,0 @@
If you would like to contribute to the development of OpenStack, you must
follow the steps in this page:
http://docs.openstack.org/infra/manual/developers.html
If you already have a good understanding of how the system works and your
OpenStack accounts are set up, you can skip to the development workflow
section of this documentation to learn how changes to OpenStack should be
submitted for review via the Gerrit tool:
http://docs.openstack.org/infra/manual/developers.html#development-workflow
Pull requests submitted through GitHub will be ignored.
Bugs should be filed in StoryBoard, not GitHub:
https://storyboard.openstack.org/#!/project/960

4
HACKING.rst
View File

@ -1,4 +0,0 @@
Sushy CLI Style Commandments
============================
Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/

176
LICENSE
View File

@ -1,176 +0,0 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

85
Makefile
View File

@ -1,85 +0,0 @@
.PHONY: clean clean-test clean-pyc clean-build docs help
.DEFAULT_GOAL := help
define BROWSER_PYSCRIPT
import os, webbrowser, sys
from urllib.request import pathname2url
webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
endef
export BROWSER_PYSCRIPT
define PRINT_HELP_PYSCRIPT
import re, sys
for line in sys.stdin:
match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
if match:
target, help = match.groups()
print("%-20s %s" % (target, help))
endef
export PRINT_HELP_PYSCRIPT
BROWSER := python -c "$$BROWSER_PYSCRIPT"
help:
@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
clean-build: ## remove build artifacts
rm -fr build/
rm -fr dist/
rm -fr .eggs/
find . -name '*.egg-info' -exec rm -fr {} +
find . -name '*.egg' -exec rm -f {} +
clean-pyc: ## remove Python file artifacts
find . -name '*.pyc' -exec rm -f {} +
find . -name '*.pyo' -exec rm -f {} +
find . -name '*~' -exec rm -f {} +
find . -name '__pycache__' -exec rm -fr {} +
clean-test: ## remove test and coverage artifacts
rm -fr .tox/
rm -f .coverage
rm -fr htmlcov/
rm -fr .pytest_cache
lint: ## check style with flake8
flake8 sushycli tests
test: ## run tests quickly with the default Python
python setup.py test
test-all: ## run tests on every Python version with tox
tox
coverage: ## check code coverage quickly with the default Python
coverage run --source sushycli setup.py test
coverage report -m
coverage html
$(BROWSER) htmlcov/index.html
docs: ## generate Sphinx HTML documentation, including API docs
rm -f docs/sushycli.rst
rm -f docs/modules.rst
sphinx-apidoc -o docs/ sushycli
$(MAKE) -C docs clean
$(MAKE) -C docs html
$(BROWSER) docs/_build/html/index.html
servedocs: docs ## compile the docs watching for changes
watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
release: dist ## package and upload a release
twine upload dist/*
dist: clean ## builds source and wheel package
python setup.py sdist
python setup.py bdist_wheel
ls -l dist
install: clean ## install the package to the active Python's site-packages
python setup.py install

26
README.rst
View File

@ -1,22 +1,12 @@
About Sushy CLI
===============
This project is no longer maintained.
Sushy CLI tool is intended to help human beings to communicate with `Redfish`_
based baseboard management controllers (BMC).
The contents of this repository are still available in the Git
source code management system. To see the contents of this
repository before it reached its end of life, please check out the
previous commit with "git checkout HEAD^1".
BMCs offer powerful means of controlling bare metal machines. For example, one
can flip machine power, change BIOS configuration or even flash the firmware.
For any further questions, please email
openstack-discuss@lists.openstack.org or join #openstack-ironic on
OFTC.
The `sushycli` tool offers a friendly command-line interface to some of the BMC
features. It's main audience include software developers working on bare metal
management automation and system administrators handling the raw iron with bare
hands.
* Free software: Apache license
* Documentation: https://docs.openstack.org/sushy-cli/latest/
* Usage: https://docs.openstack.org/sushy-cli/latest/reference/usage.html
* Source: https://opendev.org/openstack/sushy-cli
* Bugs: https://storyboard.openstack.org/#!/project/960
.. _Redfish: http://www.dmtf.org/standards/redfish

4
doc/requirements.txt
View File

@ -1,4 +0,0 @@
openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD

20
doc/source/Makefile
View File

@ -1,20 +0,0 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = python -msphinx
SPHINXPROJ = sushycli
SOURCEDIR = .
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

79
doc/source/conf.py
View File

@ -1,79 +0,0 @@
# -*- coding: utf-8 -*-
# Copyright 2010-2020 OpenStack Foundation
#
# 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 os
import sys
sys.path.insert(0, os.path.abspath('../..'))
# -- General configuration ----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
'openstackdocstheme'
]
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
# execute "export SPHINX_DEBUG=1" in your terminal to disable
# The suffix of source filenames.
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# General information about the project.
copyright = '2020, OpenStack Foundation'
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/sushy-cli'
openstackdocs_use_storyboard = True
openstackdocs_pdf_link = True
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
add_module_names = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'native'
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."]
html_theme = 'openstackdocs'
# html_static_path = ['static']
# Output file base name for HTML help builder.
htmlhelp_basename = 'sushyclidoc'
latex_use_xindy = False
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index',
'doc-sushycli.tex',
'Sushy CLI Documentation',
'OpenStack Foundation', 'manual'),
]

10
doc/source/contributor/index.rst
View File

@ -1,10 +0,0 @@
.. _contributing:
=========================
Contributing to Sushy CLI
=========================
How to contribute
=================
.. include:: ../../../CONTRIBUTING.rst

16
doc/source/index.rst
View File

@ -1,16 +0,0 @@
Welcome to sushycli's documentation!
====================================
.. toctree::
:maxdepth: 2
:caption: Contents:
install/index
reference/usage
contributor/index
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

12
doc/source/install/index.rst
View File

@ -1,12 +0,0 @@
====================
Installing Sushy CLI
====================
At the command line::
$ pip install sushy-cli
Or, if you have virtualenvwrapper installed::
$ mkvirtualenv sushy-cli
$ pip install sushy-cli

7
doc/source/reference/usage.rst
View File

@ -1,7 +0,0 @@
=====
Usage
=====
To use sushycli in a project::
import sushycli

0
releasenotes/notes/.placeholder
View File

6
releasenotes/notes/add-manager-vmedia-52817366f5d402b3.yaml
View File

@ -1,6 +0,0 @@
---
features:
- |
Adds ``manager vmedia`` family of commands. These commands allow to list
available virtual media devices as exposed by the BMC, as well as
mount/umount images served over HTTP.

5
releasenotes/notes/add-system-bios-3751837665544231.yaml
View File

@ -1,5 +0,0 @@
---
features:
- |
Adds ``system bios`` family of commands. These commands allow to list
BIOS attribues, as exposed by the BMC, and change them.

5
releasenotes/notes/add-tls-options-3331d369f5d101b7.yaml
View File

@ -1,5 +0,0 @@
---
features:
- |
Adds `--insecure` and `--tls-certificates` options to work around
self-signed or invalid TLS certificates sometimes found in BMCs.

6
releasenotes/notes/add-traffic-snooping-1696daa5a98e5523.yaml
View File

@ -1,6 +0,0 @@
---
features:
- |
Adds ``--show-traffic`` command-line option that makes ``sushycli``
pretty-printing full HTTP exchange with Redfish agent. This feature
can be handy for Redfish issues troubleshooting.

0
releasenotes/source/_static/.placeholder
View File

0
releasenotes/source/_templates/.placeholder
View File

283
releasenotes/source/conf.py
View File

@ -1,283 +0,0 @@
# -*- coding: utf-8 -*-
# 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.
# Glance Release Notes documentation build configuration file, created by
# sphinx-quickstart on Tue Nov 3 17:40:50 2015.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
# sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'openstackdocstheme',
'reno.sphinxext',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = 'sushy-cli Release Notes'
copyright = '2020, OpenStack Foundation'
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/sushy-cli'
openstackdocs_use_storyboard = True
openstackdocs_auto_name = False
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
# The full version, including alpha/beta/rc tags.
release = ''
# The short X.Y version.
version = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
# Else, today_fmt is used as the format for a strftime call.
# today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []
# The reST default role (used for this markup: `text`) to use for all
# documents.
# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'native'
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'openstackdocs'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
# html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
# html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
# html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
# html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
# html_additional_pages = {}
# If false, no module index is generated.
# html_domain_indices = True
# If false, no index is generated.
# html_use_index = True
# If true, the index is split into individual pages for each letter.
# html_split_index = False
# If true, links to the reST sources are added to the pages.
# html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
# html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
# html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'SushyCliReleaseNotesdoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
# 'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'SushyCliReleaseNotes.tex',
'Sushy CLI Release Notes Documentation',
'Ironic Developers', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
# latex_use_parts = False
# If true, show page references after internal links.
# latex_show_pagerefs = False
# If true, show URL addresses after external links.
# latex_show_urls = False
# Documents to append as an appendix to all manuals.
# latex_appendices = []
# If false, no module index is generated.
# latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'sushyclireleasenotes',
'Sushy CLI Release Notes Documentation',
['Ironic Developers'], 1)
]
# If true, show URL addresses after external links.
# man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'SushyCliReleaseNotes',
'Sushy CLI Release Notes Documentation',
'Ironic Developers', 'SushyCliReleaseNotes',
'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
# texinfo_appendices = []
# If false, no module index is generated.
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
# texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
# texinfo_no_detailmenu = False
# -- Options for Internationalization output ------------------------------
locale_dirs = ['locale/']

11
releasenotes/source/index.rst
View File

@ -1,11 +0,0 @@
=======================
sushy-cli Release Notes
=======================
.. toctree::
:maxdepth: 1
unreleased
wallaby
victoria
ussuri

5
releasenotes/source/unreleased.rst
View File

@ -1,5 +0,0 @@
============================
Current Series Release Notes
============================
.. release-notes::

6
releasenotes/source/ussuri.rst
View File

@ -1,6 +0,0 @@
===========================
Ussuri Series Release Notes
===========================
.. release-notes::
:branch: stable/ussuri

6
releasenotes/source/victoria.rst
View File

@ -1,6 +0,0 @@
=============================
Victoria Series Release Notes
=============================
.. release-notes::
:branch: stable/victoria

6
releasenotes/source/wallaby.rst
View File

@ -1,6 +0,0 @@
============================
Wallaby Series Release Notes
============================
.. release-notes::
:branch: stable/wallaby

7
requirements.txt
View File

@ -1,7 +0,0 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
sushy>=3.2.0 # Apache-2.0
cliff>=2.17.0 # Apache-2.0
urllib3>=1.22 # MIT

63
setup.cfg
View File

@ -1,63 +0,0 @@
[metadata]
name = sushy-cli
summary = Redfish CLI tool based on sushy Redfish client library
description_file =
README.rst
author = OpenStack
author_email = openstack-discuss@lists.openstack.org
home_page = https://docs.openstack.org/sushy-cli/latest/
python_requires = >=3.6
classifier =
Environment :: OpenStack
Intended Audience :: Information Technology
Intended Audience :: System Administrators
License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux
Programming Language :: Python
Programming Language :: Python :: Implementation :: CPython
Programming Language :: Python :: 3 :: Only
Programming Language :: Python :: 3
Programming Language :: Python :: 3.6
Programming Language :: Python :: 3.7
Programming Language :: Python :: 3.8
[files]
packages =
sushycli
[entry_points]
console_scripts =
sushycli = sushycli.cmd.sushycli:main
sushycli =
chassis_inventory_show = sushycli.chassis_inventory:ChassisInventoryShow
chassis_list = sushycli.chassis_list:ChassisList
manager_inventory_show = sushycli.manager_inventory:ManagerInventoryShow
manager_list = sushycli.manager_list:ManagerList
manager_vmedia_eject = sushycli.manager_vmedia:ManagerVmediaEject
manager_vmedia_insert = sushycli.manager_vmedia:ManagerVmediaInsert
manager_vmedia_list = sushycli.manager_vmedia:ManagerVmediaList
system_bios_reset = sushycli.system_bios:SystemBiosReset
system_bios_set = sushycli.system_bios:SystemBiosSet
system_bios_show = sushycli.system_bios:SystemBiosShow
system_boot_set = sushycli.system_boot:SystemBootSet
system_boot_show = sushycli.system_boot:SystemBootShow
system_inventory_show = sushycli.system_inventory:SystemInventoryShow
system_list = sushycli.system_list:SystemList
system_power = sushycli.system_power:SystemPowerSet
system_power_show = sushycli.system_power:SystemPowerShow
version_show = sushycli.version:VersionShow
[compile_catalog]
directory = sushycli/locale
domain = sushycli
[update_catalog]
domain = sushycli
output_dir = sushycli/locale
input_file = sushycli/locale/sushycli.pot
[extract_messages]
keywords = _ gettext ngettext l_ lazy_gettext
mapping_file = babel.cfg
output_file = sushycli/locale/sushycli.pot

22
setup.py
View File

@ -1,22 +0,0 @@
# -*- coding: utf-8 -*-
# Copyright 2010-2020 OpenStack Foundation
#
# 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.
# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
import setuptools
setuptools.setup(
setup_requires=['pbr>=2.0.0'],
pbr=True)

5
sushycli/__init__.py
View File

@ -1,5 +0,0 @@
"""Top-level package for sushycli."""
__author__ = """khansa amrouni"""
__email__ = 'khansa.amrouni@gmail.com'
__version__ = '0.1.0'

191
sushycli/base.py
View File

@ -1,191 +0,0 @@
# -*- coding: utf-8 -*-
# Copyright 2010-2020 OpenStack Foundation
#
# 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 argparse
import json
import sys
from urllib.parse import urlsplit
from urllib.parse import urlunsplit
from cliff import command
from cliff import lister
import sushy
from sushy import connector
import urllib3
class BaseParserMixIn(object):
"""Common bits and pieces of all `sushycli` commands.
Does not implement any CLI command by its own.
"""
def add_parser_options(self, parser):
parser.add_argument(
'--username',
help='Redfish BMC username')
parser.add_argument(
'--password',
help='Redfish BMC user password')
parser.add_argument(
'--service-endpoint',
required=True,
help='Redfish BMC service endpoint URL (e.g. '
'http://localhost:8000). If location part of the URL is not '
'specified, it defaults to `/redfish/v1`.')
parser.add_argument(
'--insecure', action='store_true',
help='Do not verify server TLS certificate')
parser.add_argument(
'--tls-certificates', metavar='<FILE|DIR>',
help='Path to a CA bundle or a directory containing trusted '
'TLS certificates.')
parser.add_argument(
'--show-traffic',
action='store_true',
help='Show Redfish HTTP message exchange.')
return parser
def _to_json(self, data):
"""Turn input object into JSON when possible.
:param data: object to jsonize
:type data: dict or str or None
"""
if not data:
data = {}
elif isinstance(data, (str, bytes)):
try:
data = json.loads(data)
except json.JSONDecodeError as exc:
self.app.LOG.error(
'Malformed JSON document %(doc)s: %(error)s',
{'doc': data, 'error': exc})
data = {}
else:
data = dict(data)
return json.dumps(data, indent=2)
def observer(self, response):
"""Pretty print HTTP request and response details.
:param response: HTTP response object
:type response: requests.Response
"""
sys.stdout.write(
'%s %s\n%s\n%s\n' % (
response.request.method, response.request.url,
self._to_json(response.request.headers),
self._to_json(response.request.body)))
sys.stdout.write(
'%s %s\n%s\n%s\n' % (
response.reason, response.status_code,
self._to_json(response.headers),
self._to_json(response.text)))
sys.stdout.flush()
def take_action(self, args):
"""Common base for all command actions
:param args: a namespace of command-line option-value pairs that
come from the user
:returns: CLI process exit code
"""
url = urlsplit(args.service_endpoint, scheme='http')
address = []
path = []
for idx, component in enumerate(url):
if idx < 2:
address.append(component)
path.append('')
else:
address.append('')
path.append(component)
base_url = urlunsplit(address)
kwargs = {
'base_url': base_url,
'username': args.username,
'password': args.password,
}
verify = args.tls_certificates or not args.insecure
if verify is not True:
kwargs.update(verify=verify)
path = urlunsplit(path)
if path:
kwargs.update(root_prefix=path)
if args.insecure:
urllib3.disable_warnings(
urllib3.exceptions.InsecureRequestWarning)
conn = connector.Connector(
base_url, verify=verify,
response_callback=args.show_traffic and self.observer)
kwargs.update(connector=conn)
return sushy.Sushy(**kwargs)
class BaseCommand(BaseParserMixIn, command.Command):
"""Common base for all sushycli status commands"""
def get_parser(self, prog_name):
"""Common base for all status command parsers.
:param prog_name: name of the cliff command being executed
:returns: an `argparse.ArgumentParser` instance
"""
parser = super(BaseCommand, self).get_parser(prog_name)
# Get correctly formatted help description
parser.formatter_class = argparse.RawDescriptionHelpFormatter
return self.add_parser_options(parser)
class BaseLister(BaseParserMixIn, lister.Lister):
"""Common base for all sushycli listing commands"""
def get_parser(self, prog_name):
"""Common base for all listing command parsers.
:param prog_name: name of the cliff command being executed
:returns: an `argparse.ArgumentParser` instance
"""
parser = super(BaseLister, self).get_parser(prog_name)
return self.add_parser_options(parser)

47
sushycli/base_chassis.py
View File

@ -1,47 +0,0 @@
# -*- coding: utf-8 -*-
# Copyright 2010-2020 OpenStack Foundation
#
# 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 sushycli import base
class BaseParserMixIn(base.BaseParserMixIn):
"""Common bits and pieces of all `sushycli chassis` commands.
Does not implement any CLI command by its own.
"""
CHASSIS_ID_HELP = (
'The canonical path to the Chassis resource to interact with. '
'It should include the root service, version and the unique resource '
'path to a Chassis. For example: /redfish/v1/Chassis/1U'
)
def add_parser_options(self, parser):
parser = super(BaseParserMixIn, self).add_parser_options(parser)
parser.add_argument(
'--chassis-id',
help=self.CHASSIS_ID_HELP)
return parser
class BaseCommand(BaseParserMixIn, base.BaseCommand):
"""Common base for all sushycli chassis status commands"""
class BaseLister(BaseParserMixIn, base.BaseLister):
"""Common base for all sushycli chassis listing commands"""

47
sushycli/base_manager.py
View File

@ -1,47 +0,0 @@
# -*- coding: utf-8 -*-
# Copyright 2010-2020 OpenStack Foundation
#
# 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 sushycli import base
class BaseParserMixIn(base.BaseParserMixIn):
"""Common bits and pieces of all `sushycli manager` commands.
Does not implement any CLI command by its own.
"""
MANAGER_ID_HELP = (
'The canonical path to the Manager resource to interact with. It '
'should include the root service, version and the unique resource '
'path to a Manager. For example: /redfish/v1/Managers/BMC'
)
def add_parser_options(self, parser):
parser = super(BaseParserMixIn, self).add_parser_options(parser)
parser.add_argument(
'--manager-id',
help=self.MANAGER_ID_HELP)
return parser
class BaseCommand(BaseParserMixIn, base.BaseCommand):
"""Common base for all sushycli manager status commands"""
class BaseLister(BaseParserMixIn, base.BaseLister):
"""Common base for all sushycli manager listing commands"""

47
sushycli/base_system.py
View File

@ -1,47 +0,0 @@
# -*- coding: utf-8 -*-
# Copyright 2010-2020 OpenStack Foundation
#
# 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 sushycli import base
class BaseParserMixIn(base.BaseParserMixIn):
"""Common bits and pieces of all `sushycli system` commands.
Does not implement any CLI command by its own.
"""
SYSTEM_ID_HELP = (
'The canonical path to the ComputerSystem resource to interact with. '
'It should include the root service, version and the unique resource '
'path to a ComputerSystem. For example: /redfish/v1/Systems/1'
)
def add_parser_options(self, parser):
parser = super(BaseParserMixIn, self).add_parser_options(parser)
parser.add_argument(
'--system-id',
help=self.SYSTEM_ID_HELP)
return parser
class BaseCommand(BaseParserMixIn, base.BaseCommand):
"""Common base for all sushycli system status commands"""
class BaseLister(BaseParserMixIn, base.BaseLister):
"""Common base for all sushycli system listing commands"""

49
sushycli/base_vmedia.py
View File

@ -1,49 +0,0 @@
# -*- coding: utf-8 -*-
# Copyright 2010-2020 OpenStack Foundation
#
# 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 sushycli import base
from sushycli import base_manager
class BaseParserMixIn(base.BaseParserMixIn):
"""Common bits and pieces of all `sushycli manager vmedia` commands.
Does not implement any CLI command by its own.
"""
DEVICE_ID_HELP = (
'The canonical path to the Virtual Media Device Manager resource to '
'interact with. It should include the root service, version, '
'the unique resource path to a Manager and the virtual media '
'device id. For example: /redfish/v1/Managers/BMC/VirtualMedia/Cd'
)
def add_parser_options(self, parser):
parser = super(BaseParserMixIn, self).add_parser_options(parser)
parser.add_argument(
'--device-id',
help=self.DEVICE_ID_HELP)
return parser
class BaseCommand(BaseParserMixIn, base_manager.BaseCommand):
"""Common base for all sushycli system status commands"""
class BaseLister(BaseParserMixIn, base_manager.BaseLister):
"""Common base for all sushycli system listing commands"""

41
sushycli/chassis_inventory.py
View File

@ -1,41 +0,0 @@
# -*- coding: utf-8 -*-
# Copyright 2010-2020 OpenStack Foundation
#
# 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 sushycli import base_chassis
from sushycli import utils
class ChassisInventoryShow(base_chassis.BaseLister):
"""Show chassis inventory information"""
def take_action(self, args):
"""Show chassis inventory information command action.
:param args: a namespace of command-line option-value pairs that
come from the user
:returns: CLI process exit code
"""
root = super(ChassisInventoryShow, self).take_action(args)
ch_inst = root.get_chassis(args.chassis_id)
columns = [
'Identity', 'Name', 'Description', 'Manufacturer', 'Part Number',
'Serial Number', 'SKU', 'Asset Tag', 'OEM Vendors'
]
return columns, [[utils.get_resource_column(ch_inst, column)
for column in columns]]

57
sushycli/chassis_list.py
View File

@ -1,57 +0,0 @@
# -*- coding: utf-8 -*-
# Copyright 2010-2020 OpenStack Foundation
#
# 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 sushycli import base