Commit Graph

32 Commits

Author SHA1 Message Date
Hasan Acar a24fd834d0 fix: migrate CI to jammy
fix: change tox.ini

fix: change queries for list_dimension_names and list_dimension_values because of influxdb time filter problem

fix: remove build_sphinx group from setup.cfg

fix: handle hashlib security problem

Change-Id: I0d31a8db5ed71c70e7b878ce5e7940e041d0fa43

Change-Id: I6f7066da10e834550cbf0c053c7bf425ac0ead93

Change-Id: If9575aee73d600bbc84fcdf58deb1c57b508d9c2

Change-Id: If515eaeee7539da3ca49997e88785dc65572b334
2024-02-22 14:35:03 +00:00
Martin Chacon Piza ae5dffc94c [Doc] Update Freenode to OFTC as our IRC server
Change-Id: Iae33eec8f9c8b96332252e2fe48dee74fb8cf0a7
2021-06-01 13:25:05 +02:00
Martin Chacon Piza 64d62a54f6 Fix warnings in documentation
This change defaults the warning-as-error to True:

  https://review.openstack.org/#/c/559348/

Which is causing our documentation jobs to fail locally and in the
gate/check queues.

This commit fixes both issues that are causing failures so that
we can get the doc jobs passing again.

Change-Id: I5dd71b6c69b975f8dd922aa3cab9d027f535f422
2021-03-31 18:16:46 +02:00
Hervé Beraud 9cb4a752c0 Add doc/requirements
We need to specify doc requirements in doc/requirements.txt
to avoid problems with the pip resolver [1] for the release team [2][3].

Removing specific doc requirements from test-requirements.txt.

The problem here is that this repos haven't doc/requirements.txt file
and by default in this case zuul will use the test-requirements.txt file
to pull requirements [4].

This requirements file contains extra requirements like flake8 that
collided with those allowed in our job environment and so the new pip
resolver fails to install these requirements and the job exits in error.

This project meet the conditions leading to the bug.

[1] http://lists.openstack.org/pipermail/release-job-failures/2021-January/001500.html
[2] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019611.html
[3] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019612.html
[4] https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/ensure-sphinx/tasks/main.yaml#L36

Change-Id: I582c7b1b8008e72f376a24a58ca1ee5ac4d933bb
2021-01-07 13:18:06 +01:00
Zuul 738bd43559 Merge "Move DB migrations documentation to its own file" 2020-05-26 19:59:23 +00:00
Zuul 05d0c1fe4a Merge "Switch to newer openstackdocstheme and reno versions" 2020-05-26 17:43:09 +00:00
Witek Bedyk 01b59aa66c Move DB migrations documentation to its own file
This part does not really belong to the contributor guide. Also
following up on the comment from the previous review [1].

[1] https://review.opendev.org/729270

Change-Id: Id49130044c3be3ec3c4b00736f678b541bdc5dfa
2020-05-22 17:06:02 +02:00
Andreas Jaeger 7abc95f1e3 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: Ia65588ae734c6995c060332e5198afb95b105084
2020-05-21 17:14:23 +02:00
Witek Bedyk 5c55909003 Update Monasca contribution documentation
Change-Id: I22f6686cbba3eaa884ee406c516c4f506cc61a9d
Story: 2007236
Task: 38538
2020-05-19 16:51:08 +02:00
Zuul ce93e00050 Merge "Add Reviews Prioritisation section" 2019-10-09 16:13:27 +00:00
Bharat Kunwar 967b918bae Implement separate db per tenancy
At present, all time series are accumulated in the same database in
InfluxDB. This makes queries slow for tenants that have less data. This
patch enables the option to use separate database per tenancy.

This changeset implements the changes on monasca-api which handles read
requests to InfluxDB database.

It also updates the relevant docs providing link to the migration tool
which enables users to migrate their existing data to a database per
tenant model.

Change-Id: I7de6e0faf069b889d3953583b29a876c3d82c62c
Story: 2006331
Task: 36073
2019-09-27 14:24:37 +00:00
Witek Bedyk 2f29cdd98c Add Reviews Prioritisation section
The change adds reviews prioritisation process description. It also adds
link to the Gerrit dashboard with the list of prioritized code changes.

Change-Id: If183de198c8ad90553ee5b54b6ba0a9cef86d25c
2019-09-18 16:23:03 +02:00
Zuul e27daddcb6 Merge "Bump the openstackdocstheme extension to 1.20" 2019-09-16 17:54:02 +00:00
agreentree 1f9ef03828 generate monasca pdf documentation
https://storyboard.openstack.org/#!/story/2006097

Change-Id: Ia915b535cee5f80fe7c7bcc10c7c87ca3de3bc14
2019-09-04 19:40:47 +00:00
pengyuesheng aa769d0d69 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: I89f2de245df7d5393a066d5c225897887978b03e
2019-08-01 10:13:52 +08:00
Isaac Prior 36aec23cac Enables InfluxDB TSI data storage as default
See https://docs.influxdata.com/influxdb/v1.7/concepts/time-series-index/
and https://docs.influxdata.com/influxdb/v1.7/concepts/tsi-details/
for details.

Change-Id: Id0daa331378473cb2629228f323d5bc01cb80750
2019-06-24 08:55:59 +00:00
Thomas Bechtold 96e13dad75 Replace api-config.conf with monasca-api.conf
api-config.conf is the deprecated path for the configuration file. The
new path is /etc/monasca/monasca-api.conf .

Story: 2004708
Task: 28987

Change-Id: If06d9114529c3ef4520247dfc7c32d3769f07084
2019-01-19 12:15:22 +01:00
Zuul 42584c12b4 Merge "Add "monasca-status upgrade check" for pre-upgrade" 2018-11-22 14:24:45 +00:00
Zuul 1e6e5a562b Merge "Add link to `Administration guide` on frontpage" 2018-11-15 11:21:49 +00:00
Joseph Davis 22be5aa57f Add "monasca-status upgrade check" for pre-upgrade
Add a tool to run before upgrading a Monasca installation
that will check for potential issues and report on readiness to upgrade.

For Monasca, this initial version effectively does nothing, but gives a
framework for future checks to be included.

This is a community-wide story for Stein [1].

Story: 2003657
Task: 26142

[1] https://governance.openstack.org/tc/goals/stein/upgrade-checkers.html

Change-Id: I799602caa4029d67f59307bf1ca0d1e8f254d415
2018-11-12 11:24:21 -08:00
Witold Bedyk b40cb8e0e0 Highlight Monasca Board in Contributor Document
* remove generic blabla introduction

Change-Id: Ie347274562608b5b1a7d317749f7e949d9baa1af
2018-10-18 14:52:55 +02:00
Witold Bedyk fce1ad1a39 Add reference to Monasca Board and Monasca Bugs
References to Monasca boards and worklists are added to contributor
documentation at https://docs.openstack.org/monasca-api

Story: 2004093
Task: 27495
Change-Id: I4378c50e598e5eea6ea982877229c26892ae024b
2018-10-16 16:18:02 +02:00
Witold Bedyk bbf1d9f160 Add link to `Administration guide` on frontpage
Change-Id: If4091b7882618a42381af923c7f6faa0460ea50f
Story: 2001654
Task: 27075
2018-10-11 15:39:28 +02:00
Andreas Jaeger dfcccff83e Remove dead links
The sample files referenced do not exist, see links from
https://docs.openstack.org/monasca-api/latest/configuration/sample.html.

Replace with links to git.

Change-Id: Ia13a6a2b1aa79450d66623cc019b4310e055e64c
2018-10-08 15:55:32 +02:00
Johannes Grassler 0250f81cdc Add monasca_db command line tool
This commit adds a schema management tool for the Monasca
configuration database. Apart from the usual OpenStack schema
management tool subcommands (stamp, upgrade, version) it has
two extra subcommands:

* fingerprint: for computing a SHA1 fingerprint of the
               currently currently active database schema.
* detect-revision: for identifiying the Alembic revision
                   (if any) corresponding to a database
                   schema that was created with one of the
                   legacy SQL scripts.

The data provided by the detect-revision subcommand can be
used for stamping the database with Alembic version metadata
when transitioning an existing Monasca configuration database
to Alembic based database migrations.

Story: 2001654
Task: 14341

Change-Id: Ibdd877a23ab5d6d1bbf8d83515c0197554098526
2018-08-01 11:10:14 +00:00
Dao Cong Tien b472a88120 Activate html_static_path config option
This config option is disbaled causes some static links
cannot be found (error 404). Eg.

The link to sample file in:
https://docs.openstack.org/monasca-api/latest/configuration/sample.html

Change-Id: Ifb0f11b47d8d7b2a842cf4b717be0c6606f9535d
2018-07-05 10:44:35 +07:00
Witold Bedyk 0970d81fd0 Add architecture diagram
* list Monasca repositories

Task: 14430
Story: 2001912

Change-Id: I40f3af3a1b4d3da25ac92cc2c0ca92f07d476499
2018-05-22 15:24:59 +02:00
Witold Bedyk 2822922d9f Update Monasca documentation page
* add introduction
* remove empty references

Change-Id: I5a1b36db1d03ba27633679cd9fdd3570157335cf
Story: 2001912
Task: 14428
2018-05-22 10:37:26 +00:00
Tomasz Trębski dae93af09d Make legacy gates working
- make pep8 working by removing ChangeLog that is not generated
- make maven working by removing condidation for user
- make legacy dsvm working by using $USER intstead of hardcoded jenkins

Change-Id: I30f2edc4d34d0fad63f961f99dcecaf5c767f57f
2017-10-18 11:01:28 +00:00
Witold Bedyk 66b0bc6103 Add Contributor Guide
The document shortly describes how to report bugs and propose new
features. Specifications are introduced to the workflow to allow
describing and reviewing more complex features and to document team's
priorities.

Change-Id: I2fd9df1d242d9be4378eb497e1b5edfc41ac518c
Depends-On: Ie2d6f4391f8d711aa057c6cc3ff6fd475ee73754
Story: 2001171
Task: 4905
2017-09-20 08:50:17 +00:00
Tomasz Trębski 5d27af4079 Config-generator for monasca-api
Change migrates the monasca-api to use oslo-config-generator in
order to always build newest configuration file. That removes
the need of maintaning the file along with changes to oslo configuration.
The example of the file is also included in the documentation.

Also:
* ported case for launching api under WSGI and allowing the argument
  parsing of oslo to take place

Story: 2000970
Task: 4865

Story: 2000964
Task: 4106

Change-Id: I57547b0e2122e40f58db5f949773900b76214526
2017-08-28 06:58:57 +00:00
Tomasz Trębski 332634f74f Prepare foundation for doc migration
Commit aims at providing the foundation to launch
doc migration for monasca-api:

* api-ref
* releasenotes
* doc

Extra:
* fixed documentation errors to enable codebase documentation

Story: 2001058
Task: 4768

Change-Id: Ic7af65a154dba7e52ffb90d0e6dbf0ae87d5d699
2017-07-31 10:43:49 +00:00