Commit Graph

46 Commits

Author SHA1 Message Date
wangkuntian 4f71562214 install dependencies when installing masakari
Change-Id: I72b442c400e65bf388804df18a2ba487ccf9b228
2023-09-07 10:49:01 +08:00
suzhengwei fdee6e1dab add api-ref for masakari vmoves
Change-Id: I82ba71efba7dd8b0b7e0919bfd543cd105b8f3d1
2023-02-02 17:10:33 +08:00
Mitya_Eremeev 9fef8807cf DLM to fix host notification race.
Two concurrent events that host is down
might be accepted by different instances of API
which triggers two evacuation workflows for instances.
Patch introduces distributed lock for creation of
host type notifications. It solves the issue.

Closes-Bug: 1961110
Change-Id: Ie8f10b14f29a8548181560cd8a26b4dc79afc3dc
2022-07-19 09:31:47 +00:00
sunjia 7b47a2a7a4 Generate PDF documentation
For PDFLaTeX, remove the irrelevant parts (contributing,
search) and those that break (full config examples).
Additionally, this replaces fancy quotes as they don't work
in PDFLaTeX either (it handles regular quotes internally).

Change-Id: I60459407e49a88c2231217152fc078346e5f4b4f
Co-Authored-By: Radosław Piliszek <radoslaw.piliszek@gmail.com>
2021-08-17 16:42:09 +00:00
zhaoleilc 5d3b41fd55 Fix an error in the document
The "default" section is invalid in masakari.conf
file. This patch changes "default" to "DEFAULT" so
that the configurations under "DEFAULT" section
become effective.

Change-Id: Ibc510653312d82529ea41b555b68f823c02c3078
2021-07-21 11:00:32 +08:00
Zuul 6b9561935b Merge "[community goal] Update contributor documentation" 2021-06-05 14:20:48 +00:00
Ghanshyam Mann 44cae8ad7f [community goal] Update contributor documentation
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html

Story: #2007236
Task: #38536
Change-Id: I1d8ff80322deffb904d1bfe16b5a5ad9d4d9fc07
2021-05-31 20:33:51 +00:00
Radosław Piliszek b4094afabd Fix segment enabled json examples
JSON requires lowercase booleans.

Change-Id: If0a14f4943a4c9107ddb4de4655315e393b8edce
2021-03-20 14:47:03 +00:00
ericxiett 151915960a Fix some errors in the document
If the recovery policy uses uppercase, an error will be reported.
This patch modifies these to lowercase.

Closes-Bug: #1914482
Co-Authored-By: zhangyangyang <zhangyangyang@unionpay.com>
Change-Id: Ic4bf5a4b19df07364c09fd46f1a92a809c77b241
2021-03-20 14:38:50 +00:00
Zuul 3128ef748f Merge "[docs] Add "release notes" contributors' section" 2021-03-17 08:29:12 +00:00
Zuul c685b3051d Merge "update docs for enabled to segment" 2021-03-04 01:27:06 +00:00
suzhengwei 3e5c29b99a update docs for enabled to segment
Implements: BP enable-to-segment
Change-Id: Ie92243b2cf4440096cd674f86fb35381d6758297
2021-03-03 09:36:32 +08:00
Zuul 4698d74280 Merge "[goal] Deprecate the JSON formatted policy file" 2021-02-27 19:32:32 +00:00
Radosław Piliszek 9aad73d21c [docs] Add "release notes" contributors' section
This should help us write better release notes (or write them
at all in the first place :-) ).
This is an adaptation of the work I have done for Kolla in [1].

[1] https://review.opendev.org/c/openstack/kolla-ansible/+/759254

Change-Id: I60ff41d721117a9e973c02e3e2a2fdf6550960a7
2021-02-27 19:00:10 +01:00
Jegor van Opdorp 5caad48713 [docs] Add docs on code structure
Additionally restructures the contributor guide.

Change-Id: I869e00b214cacb0dc223e962201944d3ce13526c
Co-Authored-By: Radosław Piliszek <radoslaw.piliszek@gmail.com>
2021-02-27 18:40:36 +01:00
suzhengwei 27c31cbd9a update docs
Change-Id: Ia6849b67128e6aa635fbfddf463c20f5c71db554
2021-01-06 10:30:12 +08:00
Zuul 0e5048c6dc Merge "add host failure reovery method in Masakari doc" 2021-01-05 09:32:03 +00:00
songwenping ab8b1eae4e remove unicode from code
Change-Id: Id3b9bad4bc617c168200d34d69bbe760a24dfcf0
2021-01-04 01:02:06 +00:00
suzhengwei a1d5917f38 add host failure reovery method in Masakari doc
Change-Id: I9b9d9a4ccd87f655239f7db2f93e7c38e014f5c1
2020-12-28 11:13:07 +08:00
Ghanshyam Mann 513c29078f [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: Iad942530b5d540af3d3c074e9944687b93bcd7f2
2020-12-23 00:47:36 +00:00
Radosław Piliszek d4529e36e5 [docs] Quick fixes around contribution process
Change-Id: I49039ba2f64535eedff51d325d85264b569ab492
2020-11-17 16:13:22 +01:00
Radosław Piliszek f12052a9a4 Fix files to pass linting
The multiline change is about CR being removed.

Change-Id: I54268c61b3f341fa0c373dda090cef1192acbb78
2020-09-11 17:24:16 +00:00
Zuul b02657e6b3 Merge "Check if host belongs to a segment" 2020-06-03 00:51:43 +00:00
Andreas Jaeger 7020fc48eb 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.

Disable openstackdocs_auto_name to use 'project' variable as name.

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.

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.

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

Change-Id: Ib8c912844becebbfef3bf6579ebea9350676a322
2020-06-01 15:08:16 +02:00
Hervé Beraud c78e1816e1 Drop python 3.4 constraint on sphinx
Now we support only python 3.6 and higher versions so we don't need
this condition. Also it will fix the requirements-check job.

Change-Id: I653c98e5dac9b1f094803ff840ccef7b0dac198d
2020-05-27 10:31:59 +02:00
Shilpa 895899f11b Check if host belongs to a segment
If you query a host passing an existing failover segment but not
the one that is assigned to the host, it still returns the host
successfully. In this case, it should fail with 404 error.

This patch checks if the host belongs to the segment that is
present in the URI. If not, it will return 404 error.

Change-Id: I16256cc2a01696a1d54cb9326aed17b723b87727
Closes-Bug: #1854323
2020-05-20 11:25:35 +05:30
Zuul 94ec9596d4 Merge "Correct indentation for spaces for doc files" 2020-03-30 06:21:01 +00:00
Shilpa 4228308876 Correct indentation for spaces for doc files
Corrected json data which was indented using tabs instead of spaces.

Also corrected key in response dict of host `create` and `get` to
singular since user can create/update single host in a request.

Change-Id: I19f9c620d348d40fde720557bca06b9fe1f95401
2019-12-18 10:30:07 +05:30
pengyuesheng a6abc4a355 Sync Sphinx requirement
Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.

Change-Id: I031feb46aee4e33fab0f96d033a32198a742214e
2019-12-16 11:17:02 -06:00
Shilpa Devharakar 596b3d142e Reorganize masakari documentation
Updated operator guide documentation for
1. segregated sections appropriately
2. referred masakariclient for CLI section
3. added detailed 'Install and configure for Ubuntu' section
4. added detailed 'Verify operation' section
5. used sphinx-build instead of the pbr sphinx extention for building docs
   as instructed by the PTI[1]
6. cleaned up build_sphinx related entries in setup.cfg

[1]: https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation

Change-Id: Iec93bebdbc7ffe1ccd27bb11f474384ff06a559c
2019-10-11 01:32:08 +00:00
caoyuan 50938d0636 Replace git.openstack.org URLs with opendev.org URLs
Change-Id: I3976f7c19b4813a40a800cea58d3dc8e343e4ac8
2019-08-11 15:00:14 +00:00
Sean McGinnis 0e100304a7
Switch from oslosphinx to openstackdocstheme
The oslosphinx package is not compatible with the current Sphinx 2.0
release. Migration has been happening to openstackdocstheme for some
time. To fix build failures for docs and releasenotes jobs, this
switches masakari jobs to use openstackdocstheme.

Uncapping jsonschema to pass requirements check so it matches global
requirements.

Change-Id: Ic74e8b075aa67d410617dac3346bf1c903995da7
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2019-04-10 09:07:04 -05:00
Ian Wienand e2f9a3df2b Replace openstack.org git:// URLs with https://
This is a mechanically generated change to replace openstack.org
git:// URLs with https:// equivalents.

This is in aid of a planned future move of the git hosting
infrastructure to a self-hosted instance of gitea (https://gitea.io),
which does not support the git wire protocol at this stage.

This update should result in no functional change.

For more information see the thread at

 http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003825.html

Change-Id: I4596e5c35143c0e7757cdf2acabdd6eac98159ea
2019-03-24 20:34:10 +00:00
shilpa.devharakar 7321ee32fd Add progress details for recovery workflows
This patch uses taskflow's persistence feature to store recovery
workflows details into database.

Added a new microversion to return progress_details of the
notification in `GET /notifications/<notification_uuid>` API.

APIImpact:
GET /notifications/<notification_uuid> API includes details
of recovery workflow

Change-Id: I93c1b7d88823e02d9a02855cabb8b22c9e40a7d5
Implements: bp progress-details-recovery-workflows
2019-03-08 10:52:51 +05:30
Kengo Takahara 0616b4bd99 Send notifications for all API changes
This patch send notifications for all API changes.
1. Segment: create, update, delete
2. Host: create, update, delete
3. Notifications: create, update

Co-Authored-By: Shilpa Devharakar <Shilpa.Devharakar@nttdata.com>

Change-Id: I02411db0b3563f6a24e164dbaf50bb30744c2fda
Implements: bp notifications-in-masakari
2019-03-05 10:46:23 +05:30
chenjiao a4e63a572b Update the HTTP links to HTTPS
Change-Id: I3e69f8d8683ae4d83c3f2746e24a9f9cc2a7e154
2018-12-08 19:15:49 +08:00
akhiljain23 7700cdd3bf Add framework for masakari-status upgrade check
This commit adds the functionality of masakari-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: I17c79af15eca5f6da7e32dbedbdc392c97114d42
Story: 2003657
Task: 26140
2018-11-08 13:19:06 +00:00
bhagyashris ad3dc737c9 Add hooks for recovery method customization plugins
This change adds hooks for pulling in plugins for
Interoperable recovery method customization taksflow
by configuring the actions in terms of execution order,
extra parameters to execute commands in action.

Implements: blueprint recovery-method-customization

Change-Id: I8150935ce0a4e592bd0f87bb3c7b3e599cefa033
2018-08-02 13:13:00 +05:30
shilpa.devharakar d7592cbe25 Register and Document policy in code
Adds below things for the implementation of framework for registering and
using default policy rules.
* Policy-in-code
  The framework for registering and using default policy rules.
  Rules should be defined and returned from a module in
  masakari/policies/, and then added to the list in masakari/policies/__init__.py.
  A new context.can() method has been added for policy enforcement of
  registered rules. It has the same parameters as the enforce() method
  currently being used.
* Add policy sample generation
  The entry point and config file necessary for using the
  oslo.policy sample generation script. It also adds a tox target to
  simplify the usage of it.
* Add policy documentation and sample file
  Documentation and sample file for default policy in code feature.
* Hacking check for policy registration
  It ensures that policy registration happens in the centralized
  masakari/policies/ directory.
* Hacking check for _ENFORCER.enforce()
  Hacking check in order to ensure that only registered policies
  are used for authorization checks _ENFORCER.authorize should be used rather
  than _ENFORCER.enforce.
* Add entry_point for oslo policy scripts
  There are two helper scripts in oslo.policy to help deployers understand
  their policy configuration better. With the setup.cfg entry these can be
  called directly from oslo.policy.

Changes done here are with the reference of [1] at NOVA side
which is contributed by Andrew Laski and Claudiu Belu

[1] https://review.openstack.org/#/q/topic:bp/policy-in-code+project:openstack/nova+status:merged

Change-Id: If885a66d92c31be440d27d6780635800a0b12e3e
2018-07-27 12:15:14 +05:30
Zuul e92410fc9a Merge "Drop all qpid related explanations" 2018-05-29 02:44:46 +00:00
Vu Cong Tuan 1c0b3d0ce7 Update "auth_url"
Following the change in Keystone Install Guide [1],
this patch replace port 35357 with 5000 for "auth_url".

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

In addition, update deprecated "auth_uri" to "www_authenticate_uri",
according to [6].

[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
[6] https://review.openstack.org/#/c/508522

Change-Id: I262c3b75f98e3ae85b913a5086c3c5ff5edba8f9
2018-05-11 10:29:45 +07:00
melissaml e3deca53c3 Drop all qpid related explanations
Qpid was removed in Mitaka from Oslo Messaging, so we
can remove all qpid related explanations.

Change-Id: I68088d97c9422d78841cf53bc47e27edf663f968
2018-03-13 01:02:43 +08:00
Abhishek Kekane fa0e35dc29 Masakari operator's documentation
Added overview of masakari, sample configuration and policies
required for masakari.

Change-Id: If81e92dbdaa4bd9869b7e60d5aaf313532c25676
2017-11-27 05:31:21 +00:00
Abhishek Kekane c54d45f5db Masakari developer's documentation
Added documentation for how to get involved, development qucikstart
and masakari system architecture.

Change-Id: Ie2cbdde7698a79a1b996e485d141eb15dbded4cd
2017-11-27 05:31:13 +00:00
Abhishek Kekane f5e074c9e4 Masakari API Specifications
Added api specifications for versions, segments, hosts and
notifications as per OpenStack standards.

Change-Id: Iefc83254e22fc31d1f0d13f52e71d42c63e82b7d
2017-11-27 05:29:45 +00:00
sampathP b59503d7aa Initial Cookiecutter Commit.
Change-Id: I42dea4c1d43a041cfd948703355ce7456c8850e1
2016-06-28 13:28:27 +09:00