Commit Graph

581 Commits

Author SHA1 Message Date
Takashi Kajinami d6416e32e4 doc: Drop DJANGO_SETTINGS_MODULE environment
... because django is not relevant to aodh.

Change-Id: I23baadd4c69de2b1f0fac335ddc48bb5e3ec971f
2023-12-18 21:03:28 +09:00
Stephen Finucane 6c032153bf setup: Remove unused dependencies
None of oslo.context, debtcollector or testresources are used by aodh.
Remove them, along with the warnings about requirements order that no
longer applies with the "new" dependency resolver introduced in pip
20.3.

Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Change-Id: I37a1ffe9c9617262eb5e40fc3ad1b02277a11513
2023-11-16 14:52:35 +00:00
Erno Kuvaja ab29096236 Revert "Fix docs job"
The actual cause is been solved here
Depends-on: https://review.opendev.org/c/openstack/requirements/+/896195

This reverts commit 2a2958bd63.

Change-Id: I29123962edc4b0e1423dbbf1b2705a4692adbf6c
2023-09-22 16:18:15 +01:00
Stephen Finucane 2a2958bd63 Fix docs job
aodh is relying on WSME, which is effectively no longer maintained.
We're waiting on a new release to fix compatibility with Sphinx 5.0
(!!!). While we wait for this, monkey patch the fix in and allow us to
unblock the gate.

Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Change-Id: Ia1fe3ac109973a3414911f3fa0ab4a3106a9e2b5
2023-09-21 15:22:26 +01:00
Dmitriy Rabotyagov 800402e7ad Add check-requirements job
This job is maintained by requirements team and ensures that
requirements and constraints have proper format and do not conflict
with guidelines.

Co-Authored-By: Erno Kuvaja <jokke@usr.fi>
Change-Id: I3dd8b1b1826473495725bb8cff2c42c6aa7b35f1
2023-05-10 13:31:18 +01:00
Hervé Beraud ddf12d559d Remove unnecessary unicode prefixes
Change-Id: I4b6815bad979e19bda2d59ac37c51f592dc385e8
2022-04-20 12:29:28 +02:00
Takashi Kajinami 0416ccec8c Introduce Guru Meditation Reports into Aodh
This change introduces support for Guru Meditation Report(GMR) into
Aodh, using oslo.reportis library.
With this change, each service prints GMR to stderr or file when
the service receives SIGUSR1.

The same was introduced into Cilometer a long ago[1], and this change
is based on the change made in Ceilometer.
 [1] https://review.opendev.org/c/openstack/ceilometer/+/196369

Change-Id: I7f67acd98c2089bb248d3249159719a3979d27e7
2021-08-15 03:23:23 +09:00
Ghanshyam Mann 5e7a0519cf [goal] Deprecate the JSON formatted policy file
As per the community goal of migrating the policy file
the format from JSON to YAML[1], we need to do two things:

1. Change the default value of '[oslo_policy] policy_file''
config option from 'policy.json' to 'policy.yaml' with
upgrade checks.

2. Deprecate the JSON formatted policy file on the project side
via warning in doc and releasenotes.

Also replace policy.json to policy.yaml ref from doc and tests.

[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html

Change-Id: Ia0fa4ba1fecf2740a291c5a65b906b089c95404d
2020-12-25 16:41:53 +00:00
Zuul d4f6067d5d Merge "Fix pygments style" 2020-12-03 10:51:41 +00:00
Rabi Mishra 8635b67777 Use SETUPTOOLS_USE_DISTUTILS=stdlib for global pip installs
A new setuptools release has changed the way pip installs are done,
see [0]. With this change we switch back to using the distro
method for global pip installs.

This patch also disables including aodh.conf sample to fix
PDF build. This follows the same pattern like in
https://review.opendev.org/#/c/737230/

[0] http://lists.openstack.org/pipermail/openstack-discuss/2020-August/016905.html

Depends-On: https://review.opendev.org/749543
Change-Id: Ied9bf958c6b19e5a25224b7a63ef8756ecd56666
2020-09-03 08:34:44 +02:00
Andreas Jaeger d86bc73d35 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions 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.

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.

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.

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

Change-Id: Ic3745264cee3515683dfe028014203388e735fdd
2020-05-21 14:22:45 +02:00
gugug 31777297e9 Fix pygments style
New theme of docs respects pygments_style.

more info: http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: Iecaf623e413c514d0a7cf42557576fa0e6fd4ba1
2020-05-21 01:22:04 +00:00
Andreas Jaeger 54f2eb0904 Cleanup py27 support
This repo is now testing only with Python 3, so let's 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
- Update classifiers
- Update requirements, no need for python_version anymore
- Use newer openstackdocstheme and reno version
- Update hacking version to 3.0
- move python3 setting into toxenv, remove install_command and
  move constraints into deps

Change-Id: Ibb42f8199eb4ca93e438e5e7ef5d4c4e0b35a738
2020-04-13 18:04:34 +02:00
Lingxian Kong 6e5c918fc7 Documentation about quota management
Change-Id: Id2e9dbe600ff72e827171e51ccdec88a5e1cdc00
2020-01-31 14:03:24 +13:00
Lingxian Kong c0190a0a59 Improve the description of aodh notifiers
Change-Id: I322d22a8c3156e63d76e19d525aac2526bdde978
2020-01-11 13:48:48 +13:00
Lingxian Kong 3bb8de94f7 Some minor improvements for doc and log
Change-Id: I7901f9a4d871a20d833049db11c39f0270ccc098
2019-11-27 13:31:53 +13:00
zhurong 28f7d804e8 PDF documentation build
Change-Id: I98f6a8dcfd434fbbd519dd0ab76ebf5d89fee4b8
2019-09-19 01:55:54 -07:00
zhurong b1a7ed61f3 Add _static folder to fix docs build error
Change-Id: Ib783f293120e5f4832d0c2a28352f4abd5a1e935
2019-08-27 18:51:26 +08:00
Zuul 4b93caca42 Merge "Bump the openstackdocstheme extension to 1.20" 2019-07-09 09:01:02 +00:00
pengyuesheng a492d329e4 Bump the openstackdocstheme extension to 1.20
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

Change-Id: I33deff1b7c87d223af33cc8f95273e3795a74065
2019-07-08 10:32:38 +08:00
pengyuesheng 34684ee412 Blacklist sphinx 2.1.0 (autodoc bug)
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details
Depend-On: https://review.opendev.org/#/c/663060/

Change-Id: Ib6bbd7465d62ebbe45df30b975d70263be55cbea
2019-07-08 10:28:27 +08:00
jacky06 f3ffbb4dce Sync Sphinx requirement
1. Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.
2. Update some URLs to latest

Change-Id: I24cb8d8d084a291028a961823fcac4f09b4bf1ca
2019-06-19 14:46:28 +08:00
ZhongShengping 65eb29477b Replace git.openstack.org URLs with opendev.org URLs
Thorough replacement of git.openstack.org URLs with their opendev.org
counterparts.

Change-Id: I5adbc8490a6ab23d080e60b813febd1334f3f4e0
2019-04-22 14:20:45 +08:00
akhiljain23 bef0f9bfd0 Add framework for aodh-status upgrade check
This commit adds the functionality of aodh-status CLI for performing
upgrade checks as part of the Stein cycle upgrade-checkers goal.
It only includes a sample check which must be replaced by real checks in
future.

Change-Id: I21e331266ab061a41d0ffe3c179b10f777af44f5
Story: 2003657
Task: 27733
2019-04-10 10:43:37 +00:00
prankul 9dd0e8ae04 Change in Aodh docs:
Change-Id: I48c8b8605a95dc133d208f6e2f81a40d9bb70093
Reference: https://docs.openstack.org/aodh/latest/admin/telemetry-alarms.html#threshold-rule-alarms
Closes-bug: #1811069
2019-01-09 15:09:08 +05:30
Zuul 4c50a98f1e Merge "fix the loaction of api/v2 file." 2018-07-30 14:26:58 +00:00
Zuul 9fc086cf01 Merge "Update pypi url to new url" 2018-07-30 14:26:57 +00:00
Nguyen Van Trung a89016706f Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html

For more details information, please refer to:
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: I28b26e9fa38c2ef854cc5f84e00b4f50ad55394d
2018-07-18 08:40:33 +00:00
Nick Wiecha 8585a065c9 remove outdated evaluation_service documentation
the evaluation_service option was removed in
Ie1f1f6593e058167fd1aa1587cfe19f2b867d5e1

Change-Id: I52272dd880d17fdbecb7bc5130fb1d45c918644f
2018-07-17 10:55:09 +02:00
Tuan Do Anh f92e1906a1 Update pypi url to new url
Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: Ibf0929a88a9ce284b11a8cb09e14d89fe5b66f53
2018-07-12 14:23:16 +07:00
wolfgang 94bbca8a5f Fixing small typo
A minor grammatical error was fixed

Change-Id: Ifbe5c1e8f501b4e4af409709fdbe0204a9c023a3
2018-07-10 14:40:25 +02:00
Dao Cong Tien 179c8b798c Invalid link to static file in doc
Change-Id: I96811e7644423c74fc2cb5ad62f0c0a09995a821
2018-07-03 15:27:36 +07:00
lipan fb686eb95b fix the loaction of api/v2 file.
According to structure of tests file, we know api/v2 be in functional
directory, test_bin be in unit directory.

Change-Id: If1e7bfb756516b6c0f79732cabd576750cce9a44
2018-06-05 15:51:04 +08:00
zhang.lei 08075d07aa Fix the incorrect content indents
Change-Id: I973fdb0320b443b68b1e0906711ec8f1a7e5b281
2018-05-25 08:47:15 +00:00
Vu Cong Tuan 8396dbe15b Update "auth_url" in install docs
Following the change in Keystone Install Guide [1],
this patch replace port 35357 with 5000 for "auth_url" in docs.

For more details, please check similar changes which have been done
on other projects: Nova [2], Neutron [3], Cinder [4], Glance [5].

[1] https://review.openstack.org/#/c/541857
[2] https://review.openstack.org/#/c/562812
[3] https://review.openstack.org/#/c/566491
[4] https://review.openstack.org/#/c/565464
[5] https://review.openstack.org/#/c/558932

Change-Id: I96c45181c344ab78fa33f6fe05f6d898732fb780
2018-05-10 14:05:40 +07:00
Zuul 06fa1f469c Merge "Update auth_uri option to www_authenticate_uri" 2018-04-23 13:17:10 +00:00
caoyuan 90796cfed9 Update auth_uri option to www_authenticate_uri
Option auth_uri from group keystone_authtoken is deprecated[1].
Use option www_authenticate_uri from group keystone_authtoken.

[1]https://review.openstack.org/#/c/508522/

Change-Id: I0f808e84ccacb952d4da22bfb4266c29e79b12a6
2018-04-11 22:24:51 +08:00
lipan a612ef0d38 fix value of severity field
the value of severity should be low,moderate or critical, but this file
gives "high" to severity. It's unreasonable. Default severity value is
low.

Change-Id: Ie31fa423c4795b8e418d0529b4d3e8af1cb3cd6c
2018-04-10 10:17:04 +08:00
Yuanbin.Chen 86117fd98c Fix doc title format error
Change-Id: Iafe03c967ca7b3e39d532f434b2f21fb43fa0d29
Signed-off-by: Yuanbin.Chen <cybing4@gmail.com>
2018-04-09 13:24:01 +08:00
gord chung 139cb62723 fix internal doc links
don't point to ocata

Change-Id: Iae0766a69e1bfcafb77bb02a00bae724eaef8a28
closes-bug: #1727460
2018-02-09 20:21:53 +00:00
Zuul 49bde26207 Merge "fix partitioning documentation" 2018-01-30 19:17:26 +00:00
gord chung d2c6722d85 fix partitioning documentation
Change-Id: I8da18f2e9f63f27f22d2d03d7ea476305c3acd42
2018-01-30 00:55:24 +00:00
gord chung 214cd0d91b remove unrelated ceilometer definition
"fun" police :P

Change-Id: If2f9a0b9476d6a090adb8d5b70d659a1e749f9d5
Closes-Bug: #1728073
2018-01-29 20:11:08 +00:00
Zuul 661017d8ad Merge "Remove ceilometer-api alarm type" 2018-01-16 16:24:47 +00:00
Mehdi Abaakouk b53d862bb5 Remove ceilometer-api alarm type
This change removes the deprecated 'threshold' alarm type from Aodh.

This also removes the useless ceilometerclient dependency.

Depends-On: Id89130fd8a782dea863c85b37a919fbf0f0897dd
Change-Id: I7ccf930f2ad0316dbda0675a2ec0344e61986022
2018-01-12 21:03:25 +01:00
Yuanbin.Chen 4a46b9b2cc change doc aodh bug tracker url
Change-Id: I1e9e79f4c7dc5e12e6a001b60b6654f536408d47
Signed-off-by: Yuanbin.Chen <cybing4@gmail.com>
2018-01-11 08:53:57 +08:00
Zuul 91fe7b9f8f Merge "Fix releasenotes builds" 2017-11-23 21:13:11 +00:00
Andreas Jaeger 5bd747b888 Fix releasenotes builds
The updated releasenote and requirements jobs expect requirements for
docs in one of the requirements files. Move requirements from setup.cfg
to doc/requirements.txt file.

Update also releasenotes build to use same command as in jobs - build
with warnings as errors.

See also
https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation

Fix failure of building with warnings as errors:
Replace the instructions for querying for release notes for newton
with the results of a reno report because some of the broken release notes
are on branches that have been closed and we have no way to edit them.

Depends-On: I994aa3cf173ec8a9412239544e3269aca17adc25
Change-Id: If8df8a6e8cad2d9247f07c9ed7a71f29b19f7d51
2017-11-22 20:35:32 +01:00
Zuul b59f5732a4 Merge "[doc] fix word usage of composite alarm" 2017-11-20 15:21:34 +00:00
Dai Dang Van f6ce4df181 Implement policy in code - reno and doc (end)
This commit migrate all policies into code [1].

[1] https://governance.openstack.org/tc/goals/queens/policy-in-code.html

Change-Id: Ibdc8611dbb665595b4b3bca493b8bdb241db3fae
Co-authored-By: Hieu LE <hieulq@vn.fujitsu.com>
2017-11-08 11:18:26 +07:00