Retire Senlin: remove repo content

Senlin project is retiring
- https://review.opendev.org/c/openstack/governance/+/919347

this commit remove the content of this project repo

Depends-On: https://review.opendev.org/c/openstack/project-config/+/919348/
Change-Id: Id24a51f183aeeb80f0d80b16759694e602b26824
This commit is contained in:
Ghanshyam Mann 2024-05-10 14:29:23 -07:00
parent eb23d5c98f
commit 5f53415593
131 changed files with 8 additions and 13774 deletions

67
.gitignore vendored
View File

@ -1,67 +0,0 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
# C extensions
*.so
# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg
*.eggs
# 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
cover/
htmlcov/
.tox/
.coverage
.coverage.*
.idea
.cache
.stestr/
coverage.xml
# Translations
*.mo
# Django stuff:
*.log
# Sphinx documentation
doc/build/
# PyBuilder
target/
# Files created by releasenotes build
releasenotes/build
# pbr generated files
AUTHORS
ChangeLog
# swap file
*.swp

View File

@ -1,3 +0,0 @@
[DEFAULT]
test_path=${OS_TEST_PATH:-./senlinclient/tests/unit}
top_dir=./

View File

@ -1,41 +0,0 @@
- job:
name: senlinclient-functional
parent: devstack-tox-functional
required-projects:
- openstack/python-senlinclient
- openstack/senlin
vars:
openrc_enable_export: true
devstack_plugins:
senlin: https://opendev.org/openstack/senlin
devstack_local_conf:
post-config:
$SENLIN_CONF:
DEFAULT:
cloud_backend: openstack_test
default_log_levels: >-
amqp=WARN,amqplib=WARN,sqlalchemy=WARN,oslo_messaging=WARN
,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN
,urllib3.connectionpool=WARN
,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN
,keystonemiddleware=WARN
,routes.middleware=WARN
,stevedore=WARN
,oslo_messaging._drivers.amqp=WARN
,oslo_messaging._drivers.amqpdriver=WARN
irrelevant-files:
- ^senlinclient/tests/unit/.*$
- ^setup.cfg$
- ^tools/.*$
- project:
templates:
- check-requirements
- openstack-python3-jobs
- openstackclient-plugin-jobs
- publish-openstack-docs-pti
- release-notes-jobs-python3
check:
jobs:
- senlinclient-functional:
voting: false

View File

@ -1,16 +0,0 @@
If you would like to contribute to the development of OpenStack,
you must follow the steps documented at:
https://docs.openstack.org/infra/manual/developers.html
Once those steps have been completed, changes to OpenStack
should be submitted for review via the Gerrit tool, following
the workflow documented at:
https://docs.openstack.org/infra/manual/developers.html#development-workflow
Pull requests submitted through GitHub will be ignored.
Bugs should be filed on Launchpad, not GitHub:
https://bugs.launchpad.net/python-senlinclient

175
LICENSE
View File

@ -1,175 +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.

View File

@ -1,18 +1,10 @@
========================
Team and repository tags
========================
This project is no longer maintained.
.. image:: https://governance.openstack.org/tc/badges/python-senlinclient.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
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".
.. Change things from this point on
OpenStackClient Plugin for Senlin Clustering Service
====================================================
This is a client library for Senlin built on the Senlin clustering API. It
provides a plugin for the openstackclient command-line tool.
Development takes place via the usual OpenStack processes as outlined in the
`developer guide <https://docs.openstack.org/infra/manual/developers.html>`_.
The master repository is in `Git <https://opendev.org/openstack/python-senlinclient>`_.
For any further questions, please email
openstack-discuss@lists.openstack.org or join #openstack-dev on
OFTC.

23
TODO
View File

@ -1,23 +0,0 @@
High Priority
=============
- Support action_cancel
- Add support to HTTPS connection
* This means a cert and key option using plain HTTP package, while
it means using Transport when we switched to OpenStackSDK
- Add checking for token based authentication
- Add CLI argument checking, required vs optional
Middle Priority
===============
- Use code from https://review.opendev.org/#/c/95679/ to replace
_append_global_identity_args(parser)
- Add unit tests
- Figure out how to use access_info and reauthenticate parameters for
authentication.
- Support trust based authentication
Low Priority
============

View File

@ -1,5 +0,0 @@
# This file contains runtime (non-python) dependencies
# More info at: http://docs.openstack.org/infra/bindep/readme.html
# tools/misc-sanity-checks.sh validates .po[t] files
gettext [test]

2
doc/.gitignore vendored
View File

@ -1,2 +0,0 @@
build/
source/ref/

View File

@ -1,177 +0,0 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python-senlinclient.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-senlinclient.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/python-senlinclient"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/python-senlinclient"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

View File

@ -1,6 +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.
openstackdocstheme>=2.2.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
reno>=3.1.0 # Apache-2.0

View File

@ -1,88 +0,0 @@
..
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.
===================
Senlin CLI man page
===================
SYNOPSIS
========
The Senlin clustering service doesn't provide its own command line tool
since Queens release. Users are supposed to use :program:`openstack cluster`
commands instead. The python-senlinclient project is an implementation of the
OpenStackClient (OSC) plugin that interacts with the Senlin clustering service.
:program:`openstack` [options] <command> [command-options]
:program:`openstack help cluster`
DESCRIPTION
===========
The :program:`openstack cluster` command line utility interacts with OpenStack Cluster
Service (Senlin).
In order to use the CLI, you must provide your OpenStack username, password,
project (historically called tenant), and auth endpoint. You can use
configuration options `--os-username`, `--os-password`, `--os-project-name`,
`--os-identity-api-version`, `-os-user-domain-name`, `--os-project-domain-name`
and `--os-auth-url` or set corresponding environment
variables::
export OS_USERNAME=user
export OS_PASSWORD=pass
export OS_PROJECT_NAME=myproject
export OS_IDENTITY_API_VERSION=3
export OS_AUTH_URL=http://auth.example.com:5000/v3
export OS_USER_DOMAIN_NAME=Default
export OS_PROJECT_DOMAIN_NAME=Default
OPTIONS
=======
To get a list of available commands and options run::
openstack help cluster
To get usage and options of a command::
openstack help cluster <command>
EXAMPLES
========
Get help for profile create command::
openstack help cluster profile create
List all the profiles::
openstack cluster profile list
Create new profile::
openstack cluster profile create --spec-file cirros_basic.yaml PF001
Show a specific profile details::
openstack cluster profile show PF001
Create a node::
openstack cluster node create --profile PF001 NODE001
For more information, please see the senlin documentation.
`https://docs.openstack.org/senlin/latest/tutorial/basics.html`

View File

@ -1,70 +0,0 @@
# 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.
#
# python-senlinclient documentation build configuration file
# -- 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 = [
'openstackdocstheme',
]
# The content that will be inserted into the main body of an autoclass
# directive.
autoclass_content = 'both'
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/python-senlinclient'
openstackdocs_bug_project = 'python-senlinclient'
openstackdocs_bug_tag = ''
copyright = 'OpenStack Contributors'
# List of directories, relative to source directory, that shouldn't be searched
# for source files.
exclude_trees = []
# 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 = 'openstackdocs'
# -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'senlin', 'OpenStack Senlin command line client',
['OpenStack Contributors'], 1),
]

View File

@ -1,55 +0,0 @@
..
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.
==================
SenlinClient Tests
==================
Unit Tests
==========
Senlinclient contains a suite of unit tests, in the senlinclient/tests/unit
directory.
Any proposed code change will be automatically rejected by the OpenStack
Jenkins server if the change causes unit test failures.
Running the tests
-----------------
There are a number of ways to run unit tests currently, and there's a
combination of frameworks used depending on what commands you use. The
preferred method is to use tox, which calls stestr via the tox.ini file.
To run all tests simply run::
tox
This will create a virtual environment, load all the packages from
test-requirements.txt and run all unit tests as well as run flake8 and hacking
checks against the code.
Note that you can inspect the tox.ini file to get more details on the available
options and what the test run does by default.
Running a subset of tests using tox
-----------------------------------
One common activity is to just run a single test, you can do this with tox
simply by specifying to just run py27 or py35 tests against a single test::
tox -epy27 senlinclient.tests.unit.v1.test_node.TestNodeList.test_node_list_defaults
Or all tests in the test_node.py file::
tox -epy27 senlinclient.tests.unit.v1.test_node
For more information on these options and how to run tests, please see the
`stestr documentation <https://stestr.readthedocs.io/en/latest/index.html>`_.

View File

@ -1,21 +0,0 @@
===============================================
Welcome to python-senlinclient's documentation!
===============================================
Contents
--------
.. toctree::
:maxdepth: 2
install/index
contributor/index
cli/index
Indices and tables
------------------
* :ref:`genindex`
* :ref:`search`

View File

@ -1,36 +0,0 @@
..
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.
.. _guide-install:
============
Installation
============
If you are installing senlinclient from an OpenStack distribution, follow the
guide provided by the vendor.
If you prefer installing senlinclient from source repo, you can do it by
first get senlinclient code from OpenStack git repository.
::
$ cd /opt/stack
$ git clone https://opendev.org/openstack/python-senlinclient.git
Then execute the following command
::
$ cd python-senlinclient
$ sudo python setup.py install

View File

@ -1,6 +0,0 @@
---
fixes:
- |
[`bug 1814171 <https://bugs.launchpad.net/senlin/+bug/1814171>`_]
Fixed a bug so that cluster delete and node delete return action id
associated with the delete action.

View File

@ -1,4 +0,0 @@
---
other:
- The 'senlin' CLI will be removed in April 2017. This message is now
explicitly printed when senlin CLI commands are invoked.

View File

@ -1,5 +0,0 @@
---
features:
- A new command 'senlin cluster-collect' and its corresponding OSC plugin
command has been added. This new command can be used to aggregate a
specific property across a cluster.

View File

@ -1,4 +0,0 @@
---
fixes:
- The cluster policy list command was broken by new SDK changes and then
fixed. The 'enabled' field is now renamed to 'is_enabled'.

View File

@ -1,5 +0,0 @@
---
features:
- A new CLI command 'senlin cluster-run' and a new OSC plugin command
'openstack cluster run' have been added. Use the 'help' command to find
out how to use it.

View File

@ -1,5 +0,0 @@
---
upgrade:
- OSC commands for cluster scaling are changed from 'cluster scale in'
and 'cluster scale out' to 'cluster shrink' and 'cluster expand'
respectively.

View File

@ -1,5 +0,0 @@
---
features:
- The senlin CLI 'node-delete' and the OSC plugin command
'cluster node delete' now outputs the action IDs when successful. Error
messages are printed when appropriate.

View File

@ -1,6 +0,0 @@
---
upgrade:
- |
Python 2.7 support has been dropped. Last release of python-senlinclient
to support python 2.7 is OpenStack Train. The minimum version of Python now
supported by python-senlinclient is Python 3.6.

View File

@ -1,3 +0,0 @@
---
fixes:
- Fixed a bug that region name is not respected when connecting to cloud.

View File

@ -1,3 +0,0 @@
---
fixes:
- Fixed a bug that force deletion of cluster or node was not working.

View File

@ -1,3 +0,0 @@
---
fixes:
- Changed CURRENT_API_VERSION to "1.10".

View File

@ -1,4 +0,0 @@
---
features:
- The senlinclient now supports API micro-versioning. Current supported
version is 'clustering 1.2'.

View File

@ -1,3 +0,0 @@
---
features:
- Added command for node-check and node-recover.

View File

@ -1,7 +0,0 @@
---
other:
- Switched testr switch to stestr.
- Fixed tox python3 overrides.
- Followed the new PTI for document build.
- Fix tox python3 overrides.
- Removed pypy because pypy is no longer supported by oslo libraries.

View File

@ -1,4 +0,0 @@
---
features:
- A policy-validate command has been added to senlin command line.
OSC support is added as well.

View File

@ -1,4 +0,0 @@
---
features:
- A profile-validate command has been added to command line. It can be
used for validating the spec of a profile without creating it.

View File

@ -1,3 +0,0 @@
---
features:
- The support to python 3.5 has been verified and gated.

View File

@ -1,5 +0,0 @@
---
other:
- The receiver creation command (both senlin CLI and OSC plugin command)
now allow 'cluster' and 'action' to be left unspecified if the receiver
type is not 'webhook'.

View File

@ -1,4 +0,0 @@
---
upgrade:
- The `senlin` command line support is completely dropped. Users are expected
to use `openstack cluster` commands to interact with Senlin service.

View File

@ -1,10 +0,0 @@
---
fixes:
- Fix resource list operations for openstackclient.
- Add filter "is_enabled" for policy binding list.
- Fix policy binding operations including attach, detach and update.
- Remove unsupported sort key "user" for event-list.
- Fix metadata purging.
- Add "cluster_id" colume for openstack cluster event list.
- Support "global_project" arguments for action-list.
- Fix resource update operations.

View File

@ -1,10 +0,0 @@
---
features:
- Support node replace operation.
- Enhance the parameter check for "path" in cluster collect operation.
- Help message for metadata clean operations.
fixes:
- Fix incorrect description of profile/policy validate operations.
- Fix project_id and user_id show bug for profile/policy validate and
cluster policy show operations.
- Fix enabled option for senlin cluster-policy-detach command.

View File

@ -1,4 +0,0 @@
---
features:
- Improved functional test for python-senlinclient.
- Aded profile, policy, cluster and receiver functional test.

View File

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

View File

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

View File

@ -1,275 +0,0 @@
# 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.
# Senlin 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 = [
'reno.sphinxext',
'openstackdocstheme',
]
# 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 = 'Senlin Client Release Notes'
copyright = '2015, Senlin Developers'
# Release notes are version independent.
# 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'
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/python-senlinclient'
openstackdocs_bug_project = 'python-senlinclient'
openstackdocs_bug_tag = ''
openstackdocs_auto_name = False
# 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 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 = 'SenlinClientReleaseNotesdoc'
# -- 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', 'SenlinClientReleaseNotes.tex',
'Senlin Client Release Notes Documentation',
'Senlin 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', 'senlinclientreleasenotes',
'Senlin Client Release Notes Documentation',
['Senlin 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', 'SenlinClientReleaseNotes',
'Senlin Client Release Notes Documentation',
'Senlin Developers', 'SenlinClientReleaseNotes',
'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/']

View File

@ -1,23 +0,0 @@
=============================
Senlin Client Release Notes
=============================
.. toctree::
:maxdepth: 1
unreleased
2023.2
2023.1
zed
yoga
xena
wallaby
victoria
ussuri
train
stein
rocky
queens
pike
ocata
newton

View File

@ -1,288 +0,0 @@
# Andi Chandler <andi@gowling.com>, 2017. #zanata
# Andi Chandler <andi@gowling.com>, 2018. #zanata
# Andi Chandler <andi@gowling.com>, 2022. #zanata
# Andi Chandler <andi@gowling.com>, 2023. #zanata
msgid ""
msgstr ""
"Project-Id-Version: Senlin Client Release Notes\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2023-02-28 05:32+0000\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"PO-Revision-Date: 2023-07-28 12:45+0000\n"
"Last-Translator: Andi Chandler <andi@gowling.com>\n"
"Language-Team: English (United Kingdom)\n"
"Language: en_GB\n"
"X-Generator: Zanata 4.3.3\n"
"Plural-Forms: nplurals=2; plural=(n != 1)\n"
msgid "0.5.0"
msgstr "0.5.0"
msgid "1.0.0"
msgstr "1.0.0"
msgid "1.1.0"
msgstr "1.1.0"
msgid "1.10.0"
msgstr "1.10.0"
msgid "1.2.0"
msgstr "1.2.0"
msgid "1.6.0"
msgstr "1.6.0"
msgid "1.8.0"
msgstr "1.8.0"
msgid "2.0.0"
msgstr "2.0.0"
msgid "2023.1 Series Release Notes"
msgstr "2023.1 Series Release Notes"
msgid ""
"A new CLI command 'senlin cluster-run' and a new OSC plugin command "
"'openstack cluster run' have been added. Use the 'help' command to find out "
"how to use it."
msgstr ""
"A new CLI command 'senlin cluster-run' and a new OSC plugin command "
"'openstack cluster run' have been added. Use the 'help' command to find out "
"how to use it."
msgid ""
"A new command 'senlin cluster-collect' and its corresponding OSC plugin "
"command has been added. This new command can be used to aggregate a specific "
"property across a cluster."
msgstr ""
"A new command 'senlin cluster-collect' and its corresponding OSC plugin "
"command has been added. This new command can be used to aggregate a specific "
"property across a cluster."
msgid ""
"A policy-validate command has been added to senlin command line. OSC support "
"is added as well."
msgstr ""
"A policy-validate command has been added to Senlin command line. OSC support "
"is added as well."
msgid ""
"A profile-validate command has been added to command line. It can be used "
"for validating the spec of a profile without creating it."
msgstr ""
"A profile-validate command has been added to command line. It can be used "
"for validating the spec of a profile without creating it."
msgid "Add \"cluster_id\" colume for openstack cluster event list."
msgstr "Add \"cluster_id\" column for openstack cluster event list."
msgid "Add filter \"is_enabled\" for policy binding list."
msgstr "Add filter \"is_enabled\" for policy binding list."
msgid "Added command for node-check and node-recover."
msgstr "Added command for node-check and node-recover."
msgid "Aded profile, policy, cluster and receiver functional test."
msgstr "Added profile, policy, cluster and receiver functional test."
msgid "Bug Fixes"
msgstr "Bug Fixes"
msgid "Changed CURRENT_API_VERSION to \"1.10\"."
msgstr "Changed CURRENT_API_VERSION to \"1.10\"."
msgid "Current Series Release Notes"
msgstr "Current Series Release Notes"
msgid "Enhance the parameter check for \"path\" in cluster collect operation."
msgstr "Enhance the parameter check for \"path\" in cluster collect operation."
msgid "Fix enabled option for senlin cluster-policy-detach command."
msgstr "Fix enabled option for Senlin cluster-policy-detach command."
msgid "Fix incorrect description of profile/policy validate operations."
msgstr "Fix incorrect description of profile/policy validate operations."
msgid "Fix metadata purging."
msgstr "Fix metadata purging."
msgid "Fix policy binding operations including attach, detach and update."
msgstr "Fix policy binding operations including attach, detach and update."
msgid ""
"Fix project_id and user_id show bug for profile/policy validate and cluster "
"policy show operations."
msgstr ""
"Fix project_id and user_id show bug for profile/policy validate and cluster "
"policy show operations."
msgid "Fix resource list operations for openstackclient."
msgstr "Fix resource list operations for openstackclient."
msgid "Fix resource update operations."
msgstr "Fix resource update operations."
msgid "Fix tox python3 overrides."
msgstr "Fix tox python3 overrides."
msgid "Fixed a bug that force deletion of cluster or node was not working."
msgstr "Fixed a bug that force deletion of cluster or node was not working."
msgid "Fixed a bug that region name is not respected when connecting to cloud."
msgstr ""
"Fixed a bug that region name is not respected when connecting to cloud."
msgid "Fixed tox python3 overrides."
msgstr "Fixed tox python3 overrides."
msgid "Followed the new PTI for document build."
msgstr "Followed the new PTI for document build."
msgid "Help message for metadata clean operations."
msgstr "Help message for metadata clean operations."
msgid "Improved functional test for python-senlinclient."
msgstr "Improved functional test for python-senlinclient."
msgid "New Features"
msgstr "New Features"
msgid "Newton Series Release Notes"
msgstr "Newton Series Release Notes"
msgid ""
"OSC commands for cluster scaling are changed from 'cluster scale in' and "
"'cluster scale out' to 'cluster shrink' and 'cluster expand' respectively."
msgstr ""
"OSC commands for cluster scaling are changed from 'cluster scale in' and "
"'cluster scale out' to 'cluster shrink' and 'cluster expand' respectively."
msgid "Ocata Series Release Notes"
msgstr "Ocata Series Release Notes"
msgid "Other Notes"
msgstr "Other Notes"
msgid "Pike Series Release Notes"
msgstr "Pike Series Release Notes"
msgid ""
"Python 2.7 support has been dropped. Last release of python-senlinclient to "
"support python 2.7 is OpenStack Train. The minimum version of Python now "
"supported by python-senlinclient is Python 3.6."
msgstr ""
"Python 2.7 support has been dropped. Last release of python-senlinclient to "
"support python 2.7 is OpenStack Train. The minimum version of Python now "
"supported by python-senlinclient is Python 3.6."
msgid "Queens Series Release Notes"
msgstr "Queens Series Release Notes"
msgid "Remove unsupported sort key \"user\" for event-list."
msgstr "Remove unsupported sort key \"user\" for event-list."
msgid "Removed pypy because pypy is no longer supported by oslo libraries."
msgstr "Removed pypy because pypy is no longer supported by oslo libraries."
msgid "Rocky Series Release Notes"
msgstr "Rocky Series Release Notes"
msgid "Senlin Client Release Notes"
msgstr "Senlin Client Release Notes"
msgid "Stein Series Release Notes"
msgstr "Stein Series Release Notes"
msgid "Support \"global_project\" arguments for action-list."
msgstr "Support \"global_project\" arguments for action-list."
msgid "Support node replace operation."
msgstr "Support node replace operation."
msgid "Switched testr switch to stestr."
msgstr "Switched testr switch to stestr."
msgid ""
"The 'senlin' CLI will be removed in April 2017. This message is now "
"explicitly printed when senlin CLI commands are invoked."
msgstr ""
"The 'senlin' CLI will be removed in April 2017. This message is now "
"explicitly printed when Senlin CLI commands are invoked."
msgid ""
"The `senlin` command line support is completely dropped. Users are expected "
"to use `openstack cluster` commands to interact with Senlin service."
msgstr ""
"The `senlin` command line support is completely dropped. Users are expected "
"to use `openstack cluster` commands to interact with Senlin service."
msgid ""
"The cluster policy list command was broken by new SDK changes and then "
"fixed. The 'enabled' field is now renamed to 'is_enabled'."
msgstr ""
"The cluster policy list command was broken by new SDK changes and then "
"fixed. The 'enabled' field is now renamed to 'is_enabled'."
msgid ""