39 Commits

Author SHA1 Message Date
Alfredo Moralejo
d17bfa04ad Add action update command to support skipping actions manually
This commit introduces the "openstack optimize action update" command
that allows cloud admins to manually update action states. The only
current use case is to mark actions as SKIPPED before starting an
action plan.

Additionally, the option `--reason` can be used to provide a text that
will be stored as part of the status_message field.

Command usage:
  openstack optimize action update --state SKIPPED --reason "reason" <uuid>

The feature requires Watcher API microversion 1.5 or higher and includes
automatic version checking.

In order to assert specific strings in stderr, I'm enabling
`merge_stderr` option by default in execute. It's totally backwards
compatible, so I'm not parametrizing it.

Implements: blueprint add-skip-actions

Assisted-By: Claude (claude-sonnet-4)

Depends-On: https://review.opendev.org/c/openstack/watcher/+/955753/
Change-Id: Ice88c0ab58c0cfd784c707620da89a891055ffc2
Signed-off-by: Alfredo Moralejo <amoralej@redhat.com>
2025-08-28 14:44:46 -03:00
Goutham Pacha Ravi
489d8c3e74 Replace CLA with DCO
Change-Id: I4581a2ef78ebf00e803c9f81ceb8a0625131bc40
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2025-08-01 14:49:17 +00:00
zhangboye
c97e16fd01 remove unicode from code
Change-Id: I42166c2db7c305c816bc1934e954d5d4acca659e
2021-01-03 16:31:39 +08:00
Andreas Jaeger
21b106dc15 Switch to newer openstackdocstheme version
Switch to openstackdocstheme 2.2.0. Using
the version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I58edf52ff891328b14edecc9e6e990b34cb730b7
2020-05-21 09:31:12 +02:00
Andreas Jaeger
5946fbb5b1 Cleanup py27 support
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
  know about the requirement
- Remove obsolete sections from setup.cfg: Wheel is not needed for python
  3 only repo
- Update requirements, no need for python_version anymore
- Use modern sphinx-build for docs building, update openstackdocstheme,
  fix api-doc building.

Change-Id: I40b67f330ac850bf45cca742a8b967fd12480ce3
2020-04-04 14:27:51 +02:00
Ghanshyam Mann
e3c903cfce Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

python-watcherclient is ready with python 3 and ok to drop the
python 2.7 support.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal - https://review.opendev.org/#/c/691178/

Change-Id: Id66df6c12e7b533381a354937e23e33f992adbfa
2019-10-30 04:34:43 +00:00
chenke
88351df1c2 Fix details doc format error
This error was caused because of rst format.

pls see:
https://github.com/openstack/python-watcherclient/blob/master/doc/source/cli/details.rst

This patch solved this error.

Change-Id: I756d2f6327349c36e4523513a2ac84ad91f7785f
2019-10-26 09:55:34 +08:00
licanwei
1d1f28a256 Build pdf docs
Add a new pdf-docs environment to enable PDF build.

Change-Id: I59bdc7cf339b022458b3b0d1fa3b694b7998c20f
2019-09-17 00:20:25 -07:00
chenke
a8f919e1f7 Add datamodel doc in watcherclient
Change-Id: I319d47dc66cb10e5ba5b6e0e318ecff0438b2d05
2019-08-26 20:28:47 +08:00
Matt Riedemann
573ca6ed59 Cleanup doc dependencies
This creates a dedicated doc/requirements.txt for doc-only
dependencies like sphinx packages so we can decouple those
from the test-requirements.txt.

As a result, the missing oslo.serialization runtime dependency
is added (I used the same version that python-novaclient uses).

Due to change If558f184c959e4b63b56dec3ca1571d1034cfe5c in the
openstack/requirements repo, in order to pass the
requirements-check job we have to specify both the py27 and py3
versions for sphinx.

Change-Id: I8bc3330a456f8bb76a17c4277a094a64fe9be449
2019-05-13 13:35:25 -04:00
jacky06
ffb71506aa Replace git.openstack.org URLs with opendev.org URLs
Change-Id: Ib764e351a42de92b532f4c0b4ff51758bb47b6a2
2019-04-28 09:36:25 +00:00
Hidekazu Nakamura
b0ac926ee6 [Doc] Fix OS_AUTH_URL value
Since Keystone v2 was removed in Queens release, this patch set
updates keystone version from v2.0 to v3 in OS_AUTH_URL value.

Change-Id: I77e8b1519ea8241e3c5cdeaffd9be9046b6315ce
2019-01-09 14:01:59 +09:00
melissaml
ec7e8ca803 Change openstack-dev to openstack-discuss
Mailinglists have been updated. Openstack-discuss replaces openstack-dev.

Change-Id: I141558842442c165ea662ddd5a85914faef8ddb8
2018-12-14 20:09:07 +08:00
Hidekazu Nakamura
946ef06dc6 Update watcher api command argument
This patch set updates watcher api command argument.
1. os_watcher_api_version to os_infra_optim_api_version
2. OS_WATCHER_API_VERSION to OS_INFRA_OPTIM_API_VERSION

This patch set also updated --os-infra-optim-api-version help message.

Change-Id: I2502377b350b8cabfeba80c68f0569d567d24b3a
2018-11-05 13:07:00 +09:00
Zuul
eed22ea2bb Merge "Add audit name to CLI help doc" 2018-08-03 08:03:15 +00:00
Zuul
47241e0462 Merge "Add --marker help info" 2018-08-03 01:47:22 +00:00
Yumeng Bao
5e928b80be Update watcher strategy state in CLI
Change-Id: Ie77336207c9affcf2c9a0ef0247cf5adef38c87f
2018-08-02 05:40:55 +00:00
Yumeng Bao
723ad12afa Add --marker help info
Change-Id: Ia132e45d7f9665a386d1e40360a75c4234aecc7d
2018-08-02 11:12:33 +08:00
licanwei
496f4c1365 Add audit name to CLI help doc
Change-Id: I9749bb679d66a65de3d4abe3564109bf4a8f8ccd
2018-07-26 18:36:09 -07:00
licanwei
adc812746c Add --marker help info
Change-Id: I34c1a83f49b101d5ef85e1a19858b9d2b59c921d
2018-07-22 23:20:29 -07:00
Dao Cong Tien
d82be4c8c4 Invalid doc for Client exceptions
There is no BaseException any more.

Change-Id: I9bf4613fa27cfc6d62a466afe703d907e8aa737a
2018-07-11 14:54:17 +07:00
suzhengwei
f5b2e7e4f5 add name for audit, changes for python-watcherclient
Change-Id: I9000018459913cd3107814e34977525eb3da10f4
Implements:blueprint add-name-for-audit
2017-11-01 02:42:15 +00:00
Jenkins
b33a444e90 Merge "Fix to use "." to source script files" 2017-09-06 07:59:28 +00:00
melissaml
320bb4c14f Fix to use "." to source script files
Adhering to coding conventions. Refer to ``Code conventions`` at
https://docs.openstack.org/contributor-guide/ for details.

Change-Id: Ie6b7d00e63acba0ffd8b27acd791fdb0b08417fe
2017-08-29 02:42:07 +08:00
Hidekazu Nakamura
7b5908b390 import content from cli-reference in openstack-manuals
This patch addes details.rst generated automatically by
openstack-doc-tools.

Change-Id: Ia9cd77f7fe5841d9b5bc2c81e3c1974ec3a744dd
2017-08-28 12:13:36 +09:00
Hangdong Zhang
2e47d77f86 Update the documentation link for doc migration
Change-Id: Ia7119776f3d173af71561b1263e021dafc5c010d
BTW: Do some optimization as well (http -> https)
2017-07-24 13:55:17 +08:00
Jenkins
2b155f9505 Merge "Move existing content into the new standard structure" 2017-07-12 15:01:40 +00:00
Yumeng Bao
ed5e1b86c3 Move existing content into the new standard structure
This patch rearranges and reformats existing content.

Change-Id: I05088140504ba55abc724115828a7a977bd5c087
2017-07-05 16:10:09 +08:00
Yumeng Bao
0d0192c472 switch to openstackdocstheme
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I93dfcbd516810c41a1d64e872a28a539ec4f3155
2017-07-04 09:56:28 +08:00
Yumeng Bao
984601ecfa Turn on warning-is-error in sphinx build
Turn on the flag to ensure that future warnings in the doc build
trigger a build failure.

Change-Id: I6f93e229cfd9bc56208750d1ddfe88404f89ab8e
2017-06-26 20:17:57 +08:00
Chris Spencer
cd267c9fa4 Remove RST files located in doc/source/api.
Change-Id: Ib9600297b6b65a44a72090cfb0c7d8f80dcfd34a
Closes-Bug: 1640811
2017-02-14 10:06:50 -07:00
DeepaJon
17a144e2f8 Removes unnecessary utf-8 encoding
This patches removes unnecessary utf-8 encoding in the
watcherclient/*
doc/source/conf.py

Change-Id: Ic74c9c57f52f7bf021dfa25d4de069b57e5cb474
2017-01-11 14:23:40 +05:30
Antoine Cabot
b66834506a Remove readme reference because of sphinx error
Change-Id: Ide4b84131fd516ae4784dab9673354c5bab0968a
Closes-Bug: #1650173
2016-12-15 09:42:46 +01:00
David.T
c8bf47d72d Remove obsolete object attributes
As we are about to version the Watcher objects, we need to make sure
that upcoming model/object modifications are additive in order to
avoid having to bump the major version of the API. Therefore,
this changeset removes 2 unused DB fields: extra in Audit Template
object and deadline in Audit object.

Change-Id: Ib9750d2dee8b565bd837341f826999b64c4e2cc3
Partially-Implements: blueprint watcher-versioned-objects
2016-11-14 10:03:37 +00:00
Antoine Cabot
e64e597aa6 Remove useless index on root doc page
Change-Id: I37a882cd6725220d7fe99604f067030d50aed019
2016-06-10 10:47:22 +02:00
David.T
89cfc55870 Update Watcher CLI documentation
I updated, in this patchset, some examples of wacher CLI, because
option format has changed (we have no more '-' character in
keywords)
I added a new page for the openstack client + our watcher plugin.

Change-Id: Ia2ae148e4357eb64c8e3df1f3036dc992e85714c
2016-05-27 08:19:17 +00:00
David.T
03d12fd030 Sync with oslo-incubator
Most of librairies available under openstack/common folder are
now deployed by using oslo dedicated package. So we can remove
them and point to new python package.

Moreover, According to the November agreement in Oslo team,
apiclient and clituils will be removed from Oslo incubator.
We should keep the local copy by ourselfs

Change-Id: I3abc09d1c512df1f5cb868ed462a7900260705ce
Implements: blueprint make-watcherclient-use-graduated-oslo-lib
2016-01-12 15:52:32 +00:00
venkatamahesh
5bc7813de3 Change stackforge to openstack
Change-Id: I19290bdb37c4e20ffde7cc2d781ce154dc0d6999
2015-10-23 16:14:56 +05:30
David TARDIVEL
3957331e52 push initial version
Change-Id: Ifecc2c7dd6bd859ba6ef327fddd891982382df3b
2015-06-04 14:59:34 +02:00