Merge "Fix doc format errors"
This commit is contained in:
commit
3ab41e2e2e
|
@ -12,6 +12,10 @@
|
|||
under the License.
|
||||
|
||||
|
||||
==============
|
||||
Authentication
|
||||
==============
|
||||
|
||||
(TBD)
|
||||
|
||||
This document describes the authentication model used by Senlin.
|
||||
|
|
|
@ -111,5 +111,7 @@ latex_documents = [
|
|||
# Example configuration for intersphinx: refer to the Python standard library.
|
||||
# intersphinx_mapping = {'http://docs.python.org/': None}
|
||||
|
||||
suppress_warnings = ['ref.option']
|
||||
|
||||
[extensions]
|
||||
# todo_include_todos = True
|
||||
|
|
|
@ -191,9 +191,9 @@ An action can be in one of the following statuses during its lifetime:
|
|||
- ``WAITING``: Action object has dependencies on other actions, it may
|
||||
become ``READY`` only when the dependents are all completed with successes;
|
||||
- ``WAITING_LIFECYCLE_COMPLETION``: Action object is a node deletion that is
|
||||
awaiting lifecycle completion. It will become ``READY`` when complete
|
||||
lifecycle API is called or the lifecycle hook timeout in deletion policy is
|
||||
reached.
|
||||
awaiting lifecycle completion. It will become ``READY`` when complete
|
||||
lifecycle API is called or the lifecycle hook timeout in deletion policy is
|
||||
reached.
|
||||
- ``RUNNING``: Action object is being executed by a worker thread;
|
||||
- ``SUSPENDED``: Action object is suspended during execution, so the only way
|
||||
to put it back to ``RUNNING`` status is to send it a ``RESUME`` signal;
|
||||
|
|
|
@ -13,7 +13,7 @@
|
|||
|
||||
|
||||
====================
|
||||
Deletion Policy V1.0
|
||||
Deletion Policy V1.1
|
||||
====================
|
||||
|
||||
The deletion policy is designed to be enforced when a cluster's size is to be
|
||||
|
|
|
@ -13,7 +13,7 @@
|
|||
|
||||
|
||||
==========================
|
||||
Load Balancing Policy V1.0
|
||||
Load Balancing Policy V1.1
|
||||
==========================
|
||||
|
||||
This policy is designed to enable senlin clusters to leverage the Neutron
|
||||
|
|
|
@ -209,7 +209,7 @@ Install and configure components
|
|||
driver = messaging
|
||||
|
||||
For more comprehensive helps on configuration options, please refer to
|
||||
:doc:`Configuration Options <configuration>` documentation.
|
||||
:doc:`Configuration Options </configuration/index>` documentation.
|
||||
|
||||
|
||||
3. Populate the Senlin database:
|
||||
|
|
|
@ -89,7 +89,7 @@ The most common options to be customized include:
|
|||
driver = messaging
|
||||
|
||||
For more comprehensive helps on configuration options, please refer to
|
||||
:doc:`Configuration Options <configuration>` documentation.
|
||||
:doc:`Configuration Options </configuration/index>` documentation.
|
||||
|
||||
In case you want to modify access policies of Senlin, please generate sample
|
||||
policy file, copy it to `/etc/senlin/policy.yaml` and then update it.
|
||||
|
|
|
@ -76,5 +76,5 @@ Installation
|
|||
~~~~~~~~~~~~
|
||||
|
||||
You will need to make sure you have a suitable environment for deploying
|
||||
Senlin. Please refer to :ref:`Installation <guide-install>` for detailed
|
||||
Senlin. Please refer to :doc:`Installation </install/index>` for detailed
|
||||
instructions on setting up an environment to use the Senlin service.
|
||||
|
|
|
@ -161,6 +161,7 @@ by two nodes every time it is triggered:
|
|||
| updated_at | None |
|
||||
| user_id | 6c369aec78b74a4da413f86dadb0255e |
|
||||
+------------+---------------------------------------------------------------------------------+
|
||||
|
||||
At present, all property values shown for a receiver are read only. You cannot
|
||||
change their values once the receiver is created. The only type of receivers
|
||||
senlin understands is "``webhook``". For the "``action``" parameter, there are
|
||||
|
|
|
@ -1,42 +0,0 @@
|
|||
..
|
||||
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||
not use this file except in compliance with the License. You may obtain
|
||||
a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||
License for the specific language governing permissions and limitations
|
||||
under the License.
|
||||
|
||||
.. _tutorial-heat:
|
||||
|
||||
===============================
|
||||
Cluster Orchestration with Heat
|
||||
===============================
|
||||
|
||||
|
||||
Senlin Resource Types
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
(TBD)
|
||||
|
||||
|
||||
A Basic Heat Template
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
(TBD)
|
||||
|
||||
|
||||
Adding more Resources
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
(TBD)
|
||||
|
||||
|
||||
An End-to-End AutoScaling Cluster
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
(TBD)
|
|
@ -56,6 +56,7 @@ notifications and published on the global message queue. This dispatcher is
|
|||
by default disabled. To enable it, you can add the following line to the
|
||||
``[DEFAULT]`` section of the ``senlin.conf`` file and then restart the service
|
||||
engine::
|
||||
|
||||
[default]
|
||||
event_dispatchers = message
|
||||
|
||||
|
@ -73,6 +74,7 @@ means you can only access to the events by the message queue.
|
|||
3. The ``event_dispatchers`` field is ``MultiString``, you can enable
|
||||
both the ``database`` and ``message`` dispatchers if needed by the following
|
||||
configuration::
|
||||
|
||||
[default]
|
||||
event_dispatchers = database
|
||||
event_dispatchers = message
|
||||
|
|
|
@ -138,13 +138,13 @@ specify a lifecycle hook in the deletion policy:
|
|||
params:
|
||||
queue: 'my_queue'
|
||||
|
||||
The valid values for the "``type`` are:
|
||||
The valid values for the ``type`` are:
|
||||
|
||||
- ``zaqar``: send message to zaqar queue. The name of the zaqar must be
|
||||
specified in ``queue`` property.
|
||||
specified in ``queue`` property.
|
||||
|
||||
- ``webhook``: send message to webhook URL. The URL of the webhook must be
|
||||
specified in ``url`` property.
|
||||
specified in ``url`` property.
|
||||
|
||||
``timeout`` property specifies the number of seconds to wait before the
|
||||
actual node deletion happens. This timeout can be preempted by calling
|
||||
|
|
|
@ -106,7 +106,7 @@ it can be used by both users and developers.
|
|||
deletion during scale-in operation.
|
||||
|
||||
1.10
|
||||
---
|
||||
----
|
||||
- Modified the ``webhook_trigger`` API. Inputs for the targeted action
|
||||
are now sent directly in the query body rather than in the params
|
||||
field.
|
||||
|
|
Loading…
Reference in New Issue