CloudKitty's v1 API has been deprecated for a while, but the CLI
continued to use that as a default, keeping v2 as optional. This patch
changes that behaviour, switching to use the more modern and currently
maintained v2 as default, while v1 is still available via the
--os-rating-api-version parameter.
Change-Id: I4ca8c4f69b022af53d9f7ec71f3a2efadfc9163e
Signed-off-by: Juan Larriba <jlarriba@redhat.com>
- Remove skipsdist which breaks automatic generation in CLI reference
and API reference sections of the docs since tox 4
- repository_name is deprecated in favor of openstackdocs_repository_name
- bug_project and bug_tag are replaced by openstackdocs_use_storyboard
Change-Id: I28d9e87ebd59823ad0ef2b1893a711bfad700286
Signed-off-by: Jaromir Wysoglad <jwysogla@redhat.com>
New theme of docs (Victoria+) respects pygments_style.
Since we starts using Victoria reqs while being on Ussuri,
this patch ensures proper rendering both in Ussuri and Victoria.
Change-Id: If42b2154a5a28f92d89dde9882afa31f01bc5ac3
This drops python2.7 support for cloudkittyclient. Even if this should be
done between milestone-1 and milestone-2, zuul jobs running on python2 are
currently broken since nova dropped python2.7 support.
Depends-On: https://review.opendev.org/#/c/693631/
Change-Id: I7615601540419e45259291a7bfce1cc038c27986
Work items:
* Removed the globale-requirements constraint. Since python-cloudkittyclient
is now part of the global requirements, the upstream requirements
file can't be used anymore.
* Add cliff to docs requirements.
* Change cloudkittyclient namespace names: Having a dot in a namespace
name causes the "autoprogram-cliff" to use the "application mode".
Change-Id: I8020d816b3397550fbcbd42cc14a9861bca7ae80
Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be
introduced.
[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045
Change-Id: Ie373018aafc05f7ea859a73c55163840dee60b56
This commit adds a new tox target to build PDF documentation.
It's a part of community goal, see storyboard for more
information.
Change-Id: I6e4f6372ff026a9eb379ee06c683451f58a99976
Story: 2006075
Task: 34812
Support for the ``/v2/dataframes`` endpoint has been added to the client.
A new ``dataframes add`` CLI command is also available.
Change-Id: I7fe9072d7280f251edc865a653a0b9ed2ab26c90
Story: 2005890
Task: 35970
This allows to get a summary through the v2 API endpoint via the client
library and cli tool.
Depends-On: https://review.opendev.org/#/c/660608/
Change-Id: Id63f2419fe3a1eb518a0ffa7ea5fa572b18df651
Story: 2005664
Task: 30960
This updates cloudkittyclient's requirement files in order to use
openstack/requirements for constraints. This will help to avoid dependency
conflicts when cloudkittyclient is deployed in an openstack context.
Work items:
* Updated requirements.txt, test-requirements.txt and doc/requirements.txt
with the `update-requirements` tool provided by openstack/requirements.
* Added a lower-constraints.txt file.
* Added the "check-requirements" zuul job template to the CI.
Change-Id: I12a882ce4d24ade153a64b75852396377ac42ca6
The client does support SSL authentication through keystoneauth right now. In
CLI mode, this is done through the "--os-cert" and "--os-cacert" options, or
through environment variables.
However, when the client is used as a python library,this is done through
requests' "verify" parameter, which is not very explicit.
This adds two parameters to the client
Change-Id: I68969c658724f53c85c47ab6098a3e2165f5925d
Story: 2003689
Task: 26224
The client has been completely rewritten in order to use cliff. The code
should be easier to maintain: authentication is now entirely handled by
keystoneauth, CloudKitty's client and CK's OSC plugin use the exact same
classes (no code duplication).
New features for users:
* Client-side CSV report generation: It is possible for users to generate
CSV reports with the new client. There is a default format, but reports
may also be configured through a yaml config file. (see documentation)
* The documentation has been improved. (A few examples on how to use the
python library + complete API bindings and CLI reference).
* It is now possible to use the client without Keystone authentication (this
requires that CK's API is configured to use the noauth auth strategy).
* Various features are brought by cliff: completion, command output formatting
(table, shell, yaml, json...).
New features for developpers:
* Python 2.7/3.5 compatible 'python-cloudkittyclient' module.
* Integration tests (for 'openstack rating' and 'cloudkitty') have been
added. These allow to create gate jobs running against a CK devstack
* Tests are now ran with stestr instead of testr, which allows a better
control over execution.
* The dependency list has been reduced and upper constraints have been set.
Change-Id: I7c6afa46138d499b37b8be3d049b23ab5302a928
Task: 6589
Story: 2001614
Use the new theme for the docs.
This needs an update of requirements, I synced all requirements with
global requirements list.
Change-Id: I50c451501a8c428a174f477b89a2986f93adfcb1
- Dynamic import of cloudkitty modules
- Support the new cloudkitty-api
- Support the new hashmap API
Change-Id: I8e3067d3144ed9f78ffd6a89c97a2435939f0590
Co-Authored-By: Stéphane Albert <stephane.albert@objectif-libre.com>
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)
This also removes the requirement for internet access during docs build.
This can cause docs jobs to fail if the project errors out on
warnings.
Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910