Open Stack

We are pleased to announce the release of:

python-tripleoclient 10.0.0: TripleO client

This release is part of the rocky release series.

Download the package from:

    https://tarballs.openstack.org/python-tripleoclient/

For more details, please see below.

10.0.0
^^^^^^


New Features
************

* TLS is now used by default for the containerized undercloud. This
  is done by setting the "generate_service_certificate" parameter to
  True by default.

* Introduce deployment_user parameter, default to the current user,
  will feed DeploymentUser parameter in THT, primarly used to add the
  user to the 'docker' group, so our operators can run the *overcloud
  container* commands when the undercloud is containerized.

* Add a new option to the TripleO client in order to create an
  Undercloud backup. Usage, openstack undercloud backup [--add-path
  ADD_FILES_TO_BACKUP]

* Added a warning message if user has provided an invalid role-
  specific parameter in the environment file.

* If no undercloud.conf *container_images_file* is set then
  *openstack undercloud install --use-heat* will deploy an undercloud
  with the latest containers as specified by the defaults. This allows
  the *container_images_file* option to be not mandatory.

* Similar to what instack-undercloud does, the containerized
  undercloud can now take user-provided certificates/keys in the
  bundled PEM format. This is done through the service_certificate
  option and is processed tripleoclient.

* New command line arguments *--output-dir* and *--cleanup* define
  the heat templates processing rules for undercloud: "undercloud
  deploy --cleanup --output-dir /tmp/tht".

  The *output_dir* and *cleanup* configuration options for
  *undercloud.conf* may be used the same way and allow to configure
  "undercloud install --use-heat" behavior.

* The "openstack undercloud install" command now has a "--dry-run"
  argument which will print the resulting install command instead of
  executing it.

* Bind "undercloud_nameservers" defined in *undercloud.conf* to the
  "DnsServers" heat stack parameter. This ensures DNS configuration
  applied via os-net-config undercloud install time as well. That
  works additionally to "UndercloudNameserver" limited to the ctlplane
  subnet DNS configuration executed at post-install steps only.

* Verbosity is disabled by default when deploying or upgrading a
  containerized undercloud; but it can be enabled with the option:
  --verbose

* New "openstack overcloud roles" "list" and "show" commands were
  added in order to look at the roles as they are defined in the plan
  in the Swift container.


Upgrade Notes
*************

* This adds a --skip-tags parameter to the openstack overcloud
  upgrade run command

     openstack overcloud upgrade run --nodes compute-0 --skip-tags validation

  This is useful for skipping those step 0 tasks (tagged "validation")
  that check if services are running before allowing the upgrade to
  proceed, especially if you must re-run the upgrade after a failed
  attempt and some services cannot easily be started. The currently
  supported values for this are validation and pre-upgrade, and they
  can be combined as "--skip-tags 'validation,pre-upgrade'" if
  required.

* The default location for "openstack overcloud config download" has
  changed to "~/tripleo-config".  "config download" also no longer
  uses tmpdirs and will overwrite files on subsequent runs to the same
  "--config-dir" location.

* The "`action`" parameter for overcloud fencing generation is now
  ignored. This is because recent versions of the underlying fencing
  agents now produce an error if the action parameter is used.
  Previously the use of the parameter was discouraged.

* This adds the new --roles and --nodes parameters for the Queens
  major upgrade cli, specifically for the 'openstack overcloud upgrade
  run' which executes the ansible playbooks on overcloud nodes.

     openstack overcloud upgrade run --nodes compute-0 compute-1
     openstack overcloud upgrade run --roles Controller

  Nodes for controlplane roles (the default 'Controller' role for
  example) need to be upgraded using the --roles parameter as these
  nodes must be upgraded together/in parallel.

  For non controlplane roles the --nodes parameter can be used to
  limit the upgrade run to one or more nodes as specified by the
  operator.

* The content of the processed heat templates will be persisted
  under the given path as *$output_dir/$tempdir/templates*, for each
  run of the undercloud deploy or install commands, unless the
  *cleanup* mode is requested.


Deprecation Notes
*****************

* "openstack overcloud role list" and "openstack overcloud role
  show" are deprecated in favour of "openstack overcloud roles list"
  and "openstack overcloud roles show" respectively. The new commands
  operate directly on the plan rather than on the local filesystem.


Bug Fixes
*********

* This patch fixes https://bugs.launchpad.net/tripleo/+bug/1743575
  The bug prevents a successeful stack creation when using a custom
  role with a composable service.

* Fix undercloud heat installer renders Heat templates in
  */usr/share*, which contains t-h-t installed from the package.


Other Notes
***********

* When using containerized undercloud installation with *openstack
  undercloud install --use-heat*, the container_images_file is a
  required configuration parmeter.

Changes in python-tripleoclient 9.1.0..10.0.0
---------------------------------------------

c4ace0e Correct stack and add ceph_ansible_playbook in upgrade unittests.
44d573c Follow the new PTI for document build [Updated]
6f53a9d Stop saying that containerized undercloud is experimental
855ded9 Manage upgrades to a containerized undercloud
623c9c8 Do container image prepare during undercloud deploy
a42a9c1 Use the build_service_filter from kolla_builder
1db4335 containerized/undercloud: disable verbosity by default
d5c58c2 Update prepare using an environment file
a31c22b Add upgrade-[prepare|converge].yaml into upgrade cli
18efb19 Stop persisting previous configuration on update/upgrade prepare
2fd5bcc Use six to import things from urllib
6e29ecd Use no TLS environment explicitly
8f87c8e Fix switching services-docker to services
3ebe9c2 Default environment/services/* to docker
11a4adb Add missing unit tests for undercloud_deploy
17cd141 Allow providing --ssh-user for update/upgrade run commands
5741603 Use container_images_file for all image prepare
b6f867b Add tripleo-ui docker service to undercloud config
03d61dd Make download_config backwards compatible
2b8d679 undercloud: load masquerade-networks service
fecf526 Remove the disable_upgrade_deployment flag validation
81c64c6 Contanerized Undercloud - Routed Spine-Leaf
d257297 Enable TLS by default in the containerized undercloud
11465ba Remove repeated code from TLS related bits in undercloud_config
644cfd3 Updated from global requirements
02a49c9 Generate inventory with tripleo-admin user
8393d3f Fix Issue: Netmask on br-ctlplane is always /24
48fda1c Change default output-dir to be $HOME
99520c9 Don't delete the tripleo Zaqar queue
11f094f Fix pre-flight validation undercloud-passwords.conf
7632a2d Updated from global requirements
ef3e8dc Undercloud: inspection_runbench, inspection_extras
b17e8ca Fix Genconfig - no HOME in environment
d1c39c1 Wire up a --skip-tags parameter for overcloud upgrade run cli
4961bc7 Use openstackdocstheme for python-tripleoclient
b05d6aa Undercloud: wire in 'clean_nodes'
0b55151 Updated from global requirements
0b3b552 Prepare t-h-t for undercloud in a work dir
0329c25 Fix the error message in _validate_no_ip_change
7eaee1b Deprecate the action parameter for fencing generation.
5513feb Containerized undercloud: Enable novajoin if configured
f1504ee Containerized undercloud: Set --local-domain from undercloud.conf
2332386 Pass plan/stack name into config_download workflow
90b0bdb Remove nargs="+" from --nodes and --roles expect "comma, string"
c6fed1f Refactor some common code between overcloud_upgrade and update
a0386cf Updated from global requirements
b4762cd undercloud: create EnableValidations
9e869e0 undercloud-deploy: Use process-templates.py from t-h-t root
74fbe7a Updated from global requirements
67d40fc Populate ContainerImagePrepare variable
b84e4e1 Add --roles and --nodes params to overcloud upgrade run cli
088b6de Update new documentation PTI jobs
f0b3f37 Generate NeutronDnsDomain on containerized undercloud
a6f1daf Change default config download directory
f0bad0d Make container_images_file required
9254f8b Configure heat DnsServers for undercloud install
bc6be96 Wire in undercloud_mtu
97f5fdf Improve unit tests for overcloud deploy cleanup
bef8cfa uc/deploy: try to keep passwords from undercloud-passwords.conf
187f4f8 Drop the inspection_enable_uefi option
cac0dd5 undercloud_deploy: Default --output-only to False
cb6a347 Updated from global requirements
a51ee8e Use poll_for_events in undercloud install
96ffa3a Adds Overcloud Upgrade class and entry points for major upgrade
50a0932 undercloud_deploy: add --output-only option
04f40df undercloud_deploy: Drop the keep_running option
7b86460 Change List Plans to call workflow
bfaf74e Don't print the start of a workflow, log it
6956e07 Clarify minor update CLI and split minor and major classes
e2b84ba Make debug option working for UC heat installer
b365080 Fix haproxy and keepalived env paths
af8ad36 Drop masquerade_network from undercloud_config
f55ad2c Persist user-files/* for 'overcloud update' command
8e715b9 Preserve roles_data and network_data
d1db364 Use the generic preservation method for plan-environment.yaml
78e24e2 Keep original behavior of `overcloud deploy`
ba10675 Add generic method for preserving plan files, use for user-environment.yaml
ef23c77 Add generic methods to upload files to plan
af19f35 Changes Delete Plan to Call Workflow
c7583ed Fix temp files teardown for undercloud deploy
8f37a1e Added a warning message for the invalid role-specific parameters
36dd874 Updated from global requirements
068ebe0 Add --dry-run option to undercloud install
714195b undercloud: introduce deployment_user parameter
56e009b undercloud_config: setup VIPs, haproxy, etc
6ca0ee1 Inherit UpdateCommand class from overcloud DeployCommand class
b3fae6e Pass the queue_name to messaging_websocket function for update
d4696b9 undercloud_deploy: add opts to setup virtual-ips
40e6ec4 Fix lint errors
eaaf2e8 Add Openstack Undercloud backup
e72065c image_upload: allow ctrl-c
eaa2e9c Get message from websocket instead from zaqarclient directly
07e27ff Zuul: Remove project name
e62b638 Add major update implementation
51023bf Default verbosity to 1 if no verbosity_level available
eaacf4e Update reno for stable/queens
8a6e018 Revert "Remove the overcloudrc.v3 file"
2a9ba1c Updated from global requirements
679a1f1 Document template enabled --tag-from-label
3cf44eb Allow passing an agent-name as a command line argument
ebc64b6 Add --validate-only to openstack overcloud node import
6a45d44 Update the doc links to the right ones
7c0ad1d Composable role and service fails workflow
4cbb6cc Add workflows-based role listing commands
7012843 Handle user-provided TLS certificate/key for the undercloud


Diffstat (except docs and test files)
-------------------------------------

CONTRIBUTING.rst                                   |   6 +-
bindep.txt                                         |   2 +-
...ult-for-undercloud_config-f8cdcf206de51b3c.yaml |   6 +
...ags-overcloud-upgrade-run-6aaf5925ffc02359.yaml |  16 +
.../notes/bug-1743575-dcacfa668eaf51a6.yaml        |   6 +
...nload-default-dir-changed-58a4b756b80050d0.yaml |   6 +
...iner-images-file-required-ff11154429796729.yaml |   6 +
.../notes/deployment_user-bc451a45754035b9.yaml    |   7 +
...-fencing-action-parameter-6ca390e9ebf43796.yaml |   7 +
...enstack-undercloud-backup-b0c83afeb565c41d.yaml |   5 +
...-cli-add-roles-nodes.yaml-6ac6ecda01286006.yaml |  16 +
.../remove-overcloudrc-v3-088643d24a622473.yaml    |   8 -
.../role-specific-warning-63ce21643d51236c.yaml    |   5 +
...ercloud-container-prepare-d272bdc30c073b29.yaml |   8 +
...undercloud-containers-tls-d513bfccb117ab35.yaml |   6 +
.../undercloud-deploy-tht-4af4b91774600e8f.yaml    |  20 +
.../notes/undercloud-dry-run-30264c62d6d44626.yaml |   5 +
.../undercloud-nameservers-fbfca8af10b3097f.yaml   |   8 +
.../notes/undercloud_debug-764ec17aa0653def.yaml   |   5 +
.../workflow-based-listings-6935d507c40a7e9d.yaml  |  13 +
releasenotes/source/conf.py                        |   2 +-
releasenotes/source/index.rst                      |   1 +
releasenotes/source/queens.rst                     |   6 +
requirements.txt                                   |  10 +-
setup.cfg                                          |  20 +-
test-requirements.txt                              |   7 +-
tox.ini                                            |  17 +-
tripleoclient/constants.py                         |  24 +-
tripleoclient/plugin.py                            |   5 +-
.../v1/overcloud_deploy/test_overcloud_deploy.py   | 112 ++++-
.../v1/overcloud_image/test_container_image.py     | 132 +-----
.../v1/overcloud_image/test_overcloud_image.py     |  18 +
.../v1/overcloud_update/test_overcloud_update.py   | 167 ++++++--
.../v1/overcloud_upgrade/test_overcloud_upgrade.py | 380 +++++++++++++++++
tripleoclient/utils.py                             | 148 ++++++-
tripleoclient/v1/container_image.py                |  94 ++---
tripleoclient/v1/overcloud_config.py               |   2 +-
tripleoclient/v1/overcloud_credentials.py          |   2 +-
tripleoclient/v1/overcloud_deploy.py               | 138 ++----
tripleoclient/v1/overcloud_image.py                |  41 +-
tripleoclient/v1/overcloud_node.py                 |   8 +
tripleoclient/v1/overcloud_parameters.py           |   6 +-
tripleoclient/v1/overcloud_plan.py                 |  17 +-
tripleoclient/v1/overcloud_plan_roles.py           | 158 +++++++
tripleoclient/v1/overcloud_roles.py                |  15 +-
tripleoclient/v1/overcloud_update.py               | 198 +++++----
tripleoclient/v1/overcloud_upgrade.py              | 236 +++++++++++
tripleoclient/v1/undercloud.py                     |  29 +-
tripleoclient/v1/undercloud_backup.py              |  84 ++++
tripleoclient/v1/undercloud_config.py              | 463 +++++++++++++++++----
tripleoclient/v1/undercloud_deploy.py              | 340 ++++++++++-----
tripleoclient/v1/undercloud_preflight.py           | 106 +++--
tripleoclient/workflows/baremetal.py               |  30 ++
tripleoclient/workflows/base.py                    |   7 +-
tripleoclient/workflows/deployment.py              |   3 +-
tripleoclient/workflows/package_update.py          |  64 ++-
tripleoclient/workflows/parameters.py              |  15 +-
tripleoclient/workflows/plan_management.py         | 174 ++++++--
tripleoclient/workflows/roles.py                   |  45 ++
tripleoclient/workflows/undercloud_backup.py       |  35 ++
zuul.d/layout.yaml                                 |   2 -
77 files changed, 4155 insertions(+), 904 deletions(-)


Requirements updates
--------------------

diff --git a/requirements.txt b/requirements.txt
index 1e9ae49..4ed70f9 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -7 +7 @@ Babel!=2.4.0,>=2.3.4 # BSD
-ipaddress>=1.0.16;python_version<'3.3' # PSF
+ipaddress>=1.0.17;python_version<'3.3' # PSF
@@ -12,2 +12,2 @@ python-heatclient>=1.10.0 # Apache-2.0
-python-ironicclient>=1.14.0 # Apache-2.0
-python-mistralclient>=3.1.0 # Apache-2.0
+python-ironicclient>=2.3.0 # Apache-2.0
+python-mistralclient!=3.2.0,>=3.1.0 # Apache-2.0
@@ -18 +18 @@ osc-lib>=1.8.0 # Apache-2.0
-websocket-client<=0.40.0,>=0.33.0 # LGPLv2+
+websocket-client>=0.44.0 # LGPLv2+
@@ -20 +20 @@ tripleo-common>=7.1.0 # Apache-2.0
-python-zaqarclient>=1.0.0 # Apache-2.0
+cryptography>=2.1 # BSD/Apache-2.0
diff --git a/test-requirements.txt b/test-requirements.txt
index 80dbb69..cae089c 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -10,2 +9,0 @@ mock>=2.0.0 # BSD
-oslosphinx>=4.7.0 # Apache-2.0
-sphinx!=1.6.6,>=1.6.2 # BSD
@@ -14,4 +12 @@ testtools>=2.2.0 # MIT
-requests-mock>=1.1.0 # Apache-2.0
-
-# releasenotes
-reno>=2.5.0 # Apache-2.0
+requests-mock>=1.2.0 # Apache-2.0