Commit Graph

185 Commits

Author SHA1 Message Date
Zuul d5d3bb9307 Merge "Add doc description for stop_timeout_before_update" 2021-11-28 23:03:47 +00:00
Zuul 5c416ee6f0 Merge "Correct a typo in the document" 2021-05-06 05:43:34 +00:00
Duc Truong a5407c72e6 Add doc description for stop_timeout_before_update
Update documentation to add stop_timeout_before_update config paramater.

Change-Id: I3f3c7d43c7d732fc712a916a25c762f531118a22
2020-11-30 20:06:39 +00:00
“miaoyuliang” 1bace4641d Update error in install-rdo.rst and update default port
Nova placement use port 8778, to avoid confusion, Update
senlin default port from  8778 to 8777. And update
spelling mistakes in install-rdo.rst

Change-Id: I342b1badf3910ea07ea64523cdb8a19a8a0ccb06
2020-09-26 00:31:31 +00:00
suhaiming 7f7f5d655e Correct a typo in the document
Change-Id: Ibf4d60d1eaf81afb89d68d2a9e0e4ede5f1064d3
2020-09-09 09:03:38 +00:00
Duc Truong 5ae51e7344 Fix doc glossary terms
Glossary terms are case-sensitive. This change fixes the terms used in the
documentation to match the capitalization used in the glossary terms.

Change-Id: I6cc2cf7251e53c98c512f21c6504a2e795c26b33
2020-04-22 10:01:16 -07:00
Adam Harwell d3bd9ef3f3 Allow LB creation with VIP_NETWORK *or* VIP_SUBNET
Octavia allows LB creation with only a vip_network_id specified. This is
necessary for things like routed-network environments where subnets are
often not exposed to users, or else not well understood by them, and
Octavia should retain responsibility for choosing the subnet.

Change-Id: Ic252cf7d5cc7277fa86bf12df8776dac27151f83
2020-03-16 12:43:30 -07:00
Adam Harwell 531283783e Add option to choose LB availability_zone
Octavia now supports availability zones for loadbalancers. Now it is
possible to pass this option through the LB policy.

Depends-On: https://review.opendev.org/#/c/710452/

Change-Id: Ib49b38490f83fea19307751ef1cd073307e352ae
2020-03-03 11:10:39 -08:00
Duc Truong e792d91935 Add tainted field to nodes
Allow users to marked nodes as tainted.  Tainted nodes will be selected
first for scale-in operations.

* Updated API microversion to 1.13
* Updated node table to add tainted field
* Updated docs

Change-Id: I3a391a31240b5206ad83cd054084b9946fbab24e
2019-10-22 21:27:55 +00:00
Duc Truong ebefa20ca2 Update docs and examples for health policy v1.1
The documentation and example health policies need to be updated to
reflect health policy v1.1 schema changes.

Change-Id: Ie447397b001fba9798025370cdb0087e679fdfe4
Closes-Bug: #1834516
2019-06-28 22:34:17 +00:00
jacky06 80ba25ec6a Replace git.openstack.org URLs with opendev.org URLs
Change-Id: Ibf7030d5cef07c29d4e13fddef611715373a4af8
2019-05-29 11:19:30 +08:00
Zuul 248f976d79 Merge "Add sphinx extension to document policies/profiles" 2018-10-29 22:31:19 +00:00
Duc Truong d8df1f8c51 Add sphinx extension to document policies/profiles
This change adds a sphinx extention to build sections of the policy and
profile documentation from source code.

- Add new extension
- Modify contributor documentation for policies to show spec fields
  from source code
- Modify user documentation for policies and profiles to show properties
  from source code
- Modify user documentation for policies and profiles to include
  samples extracted from examples directory
- Update tox to run pep8 against sphinx extension

Change-Id: I32f68867d14c3288385dbdf3b4df14e8ca2fd01f
2018-10-24 16:59:06 +00:00
Jude Cross 364b1402a1 Update scaling policy logic to be applied before action acceptance
This patch alters the cluster_scale_in and cluster_scale_out actions to
no longer place the action into the actions table when a conflict is
detected. This behavior is an improvement on the old way actions are
processed as the requester will now receive immediate feedback from the API
when an action cannot be processed. This change  also honors the scaling
action cooldown in the same manner by erring via the API when a scaling
action cannot be processed due to cooldown.

Depends-On: https://review.openstack.org/#/c/602460/
Implements: blueprint scaling-action-acceptance
Change-Id: If0dcf5e427d3d6973d2c5e52fada8a6c925240d5
2018-10-15 14:30:01 -07:00
Zuul 3ab41e2e2e Merge "Fix doc format errors" 2018-07-14 02:33:18 +00:00
Duc Truong 452d71c7cd Fix doc format errors
This fixes all the documentation formatting errors detected by sphinx
when running the docs tox environment.

The change in conf.py is needed to suppress the unknown option warning
documented in [1] and [2]

[1] https://groups.google.com/forum/#!topic/sphinx-users/6F_EJUEA2f8
[2] https://github.com/sphinx-doc/sphinx/issues/2229

Change-Id: Ib209fa9db7d2d896a34c54919afa396044ad29b7
2018-07-12 17:44:36 +00:00
Duc Truong c2734a47eb Add cluster.stop_node_before_delete documentation
Change-Id: I4a5d7436c97c1e975cf76953dd4415323e799959
2018-07-05 15:45:06 -07:00
Duc Truong b02acea3e6 Add config option to user documentation
This adds user documentation for the node.name.format config property
added in Queens [1].

[1] http://git.openstack.org/cgit/openstack/senlin/tree/releasenotes/notes/node-name-formatter-284b768be7fbe6c6.yaml

Change-Id: I1d32a26ed13fd6380d9236b45c463cc8ed1f6e96
2018-06-26 18:04:03 +00:00
Erik Olof Gunnar Andersson 8b429c795c Fixing documentation for multiple event_dispatchers
[default]
event_dispatchers = database
event_dispatchers = message

Change-Id: I069d3b06ca70d1ac7a1bcd56fe9cf6533f2e11fc
Closes-Bug: #1757052
2018-03-20 00:42:54 -07:00
Zuul 9201cc26bb Merge "Update cluster event command example" 2018-03-01 06:36:19 +00:00
Zuul 4ea455b280 Merge "Update cluster policy binding list command example" 2018-03-01 06:35:12 +00:00
Zuul 653f534993 Merge "Fix documents title error symbol" 2018-03-01 03:31:29 +00:00
Zuul f657f92506 Merge "Fix documents title format error" 2018-03-01 03:31:28 +00:00
Yuanbin.Chen 36c300b569 Fix documents title error symbol
Change-Id: Ia833d478d3a192706f0f666c227001496982482d
Signed-off-by: Yuanbin.Chen <cybing4@gmail.com>
2018-02-27 17:47:04 +08:00
Yuanbin.Chen c31f2c219c Fix documents title format error
Change-Id: If58658785d4fdf4e108e87a6233c873ad18b9c1a
Signed-off-by: Yuanbin.Chen <cybing4@gmail.com>
2018-02-27 17:37:32 +08:00
blkart 836e02d24c Update cluster event command example
Update output information for list and show command example.

Change-Id: Idb4f925490e828809f0be0bd527499f9733e5b3e
Signed-off-by: blkart <blkart.org@gmail.com>
2018-02-26 17:23:30 +08:00
blkart 91c71e0b2a Update cluster action show command example
Update output information for command example.

Change-Id: I32649bc05608a44cf1aae510b91dc5c2177437a6
Signed-off-by: blkart <blkart.org@gmail.com>
2018-02-26 16:28:25 +08:00
blkart 3cf33082a0 Update cluster policy binding list command example
Update output information for command example.

Change-Id: I2ef119af24e16cb71857af7d8bab8d45bec912ba
Signed-off-by: blkart <blkart.org@gmail.com>
2018-02-26 16:16:19 +08:00
Zuul 5cc971d675 Merge "Update cluster create command example" 2018-02-25 16:27:59 +00:00
Zuul d7d5d981a5 Merge "Update cluster policy type list command example" 2018-02-25 16:19:51 +00:00
Zuul 915c2d5fa0 Merge "Update cluster policy type show command example" 2018-02-25 16:19:49 +00:00
blkart a3e9e1c2e2 Update cluster receiver create command example
Add output information for command example.

Change-Id: I5008e088a651455ea6d7db21c6ed363449284e6f
Signed-off-by: blkart <blkart.org@gmail.com>
2018-02-24 17:33:01 +08:00
blkart 8dbebdf35e Update cluster policy type show command example
Use deletion policy version 1.1 in example.

Change-Id: I546519e814af437fbb93f0d7f1043536f299ed0c
Signed-off-by: blkart <blkart.org@gmail.com>
2018-02-24 16:13:26 +08:00
blkart 2a39984862 Update cluster policy type list command example
Add deletion and loadbalance policy version 1.1 support info.
Add scaling policy version 1.0 support info.

Change-Id: I2cb68c57bcb311e84591b436717905e56d4b8343
Signed-off-by: blkart <blkart.org@gmail.com>
2018-02-24 15:43:08 +08:00
blkart 1232ce35d2 Update cluster create command example
Add config into output information.

Change-Id: I7050b89afae68725f86ef198499547117d4929a7
Signed-off-by: blkart <blkart.org@gmail.com>
2018-02-24 14:14:19 +08:00
blkart 1d5469fc03 Update cluster node create command example
Add domain_id into output information.

Change-Id: I3cf88702837454ed1265ceaf34f5f09b74081b16
Signed-off-by: blkart <blkart.org@gmail.com>
2018-02-23 11:21:15 +08:00
Yuanbin.Chen 72026cc269 Fix user document bindings.rst policy attach specify status
Change-Id: I1df3637d092432a87013fdd0f415540192fcb7a9
Signed-off-by: Yuanbin.Chen <cybing4@gmail.com>
2018-02-07 20:34:28 +08:00
Yuanbin.Chen 3ccaf651c5 User documents add cluster and node check and recover opertion
Change-Id: If60636a295a1c3635fc07d66b52b1a1ec215dd0d
Signed-off-by: Yuanbin.Chen <cybing4@gmail.com>
2018-02-06 14:23:44 +08:00
Duc Truong 3dd9f3ecde Lifecycle hook implementation
* Added lifecycle hook properties to deletion policy
* Check if deletion policy has lifecycle hook properties during
deletion and perform lifecycle specific actions if it does
* Added complete lifecycle API endpoint
* Bumped microversion to 1.9
* Added unit-test cases for lifecycle hooks
* Added lifecycle hook notification
* Added lifecycle hook properties to deletion policy
* Modified node_action to process policy preop if it was a
derived action with lifecycle hook properties
* Modified LB policy to defer deletion of node until node_deletion
action is executed if lifecycle hook properties are defined in
deletion policy
* Added zaqar test driver
* Added documentation for lifecycle hook

Depends-On: Id7804abc351c063563b58fb69a66074d0d854ecf

Change-Id: I888a01c4f26959649121d6f82430017858a4c481
2018-01-30 17:31:43 +00:00
Zuul 49ee2c948d Merge "fix user clusters/nodes doc display error" 2018-01-08 08:36:13 +00:00
Yuanbin.Chen c2adb6ae24 fix doc profiles show display error
Change-Id: I51547770f4695b5742a967f52e460ed77ac9d310
Signed-off-by: Yuanbin.Chen <cybing4@gmail.com>
2018-01-03 13:54:17 +08:00
Yuanbin.Chen 6041dfce3f fix user clusters/nodes doc display error
Change-Id: Ia5fe0a772bbf5660017cfdd3a85bc891a79c0ddf
Signed-off-by: Yuanbin.Chen <cybing4@gmail.com>
2018-01-03 13:47:46 +08:00
ruijie a3c97805ea revise the event dispatcher document
This patch revise the user document of event dispatcher
to clear how to configure it.

Change-Id: I33147e699620e89445713733e96e07b7fdbfeb3f
2017-10-20 14:21:02 +08:00
Jenkins 1e5c2a87a6 Merge "revise doc of `event_dispatcher`" 2017-09-19 13:42:20 +00:00
Jenkins 76f73a97c5 Merge "Add profile type operation CLI user guide" 2017-09-19 13:04:27 +00:00
ruijie 3879d6337a revise doc of `event_dispatcher`
this patch revises the event dispatcher documentation to add more
details.

Change-Id: I1947fc509e0e2bff8070b31f501c6a55ef6b02d2
2017-09-19 14:28:08 +08:00
ruijie fd99c79580 revise doc to use openstack commandline
this patch revises the doc to use openstack command line instead
of senlin client command line.

Change-Id: I0b0d18ee75676681c38a630a3e01a7b8fc788d56
2017-09-14 15:28:05 +08:00
liyi ab6da9d361 Deprecate 'senlin cluster-create' in doc
'openstack cluster create' is available, we deprecate 'senlin
cluster-create' cmd in documentation.

Change-Id: Ieba171ffaf25c9b72ef378955034c0e4873c476a
2017-09-12 20:30:53 +08:00
liyi c6aa5539e9 Add node adoption user guide
Change-Id: Id250d6fc1d3a154bc97178b6c0e7309c69984056
Depends-On: 25bd7c3bd9a140dc9d21729b476859d6b37780b5
2017-08-17 14:37:26 +08:00
liyi 36bae90727 Add profile type operation CLI user guide
Change-Id: Ic1a11a4ac3811da615602641a3f3d0374df20687
Depends-On: I40c4da6fc7f449397748a098aa0cb7cd786b0603
2017-08-16 15:25:02 +08:00