summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2018-06-11 11:54:36 +0000
committerGerrit Code Review <review@openstack.org>2018-06-11 11:54:36 +0000
commitf588675226309f545319bee08e7cfd41e5b2d35f (patch)
tree378cca092601108ef36b5e6b0d5fe5b6a6e8be52
parentfcf5da99f7082b51688870dc7e004a277b233a7d (diff)
parent39e7c2d3200b2e2895650ff28e73ee49eb4b369f (diff)
Merge "doc: external link helper for other projects' doc"
-rw-r--r--doc/source/admin/advanced-configuration-guide.rst28
-rw-r--r--doc/source/conf.py15
-rw-r--r--doc/source/contributor/development-guidelines.rst6
-rw-r--r--doc/source/install/installation-guide.rst6
-rw-r--r--doc/source/reference/restapi.rst4
-rw-r--r--doc/source/user/features.rst5
-rw-r--r--doc/source/user/sahara-on-ironic.rst6
7 files changed, 41 insertions, 29 deletions
diff --git a/doc/source/admin/advanced-configuration-guide.rst b/doc/source/admin/advanced-configuration-guide.rst
index 00fa07b..22c9f61 100644
--- a/doc/source/admin/advanced-configuration-guide.rst
+++ b/doc/source/admin/advanced-configuration-guide.rst
@@ -58,10 +58,12 @@ displayed as hostnames instead of just ip addresses.
58 58
59You should configure DNS server with Designate. Designate service should be 59You should configure DNS server with Designate. Designate service should be
60properly installed and registered in Keystone catalog. The detailed 60properly installed and registered in Keystone catalog. The detailed
61instructions about Designate configuration can be found here: `Designate manual 61instructions about Designate configuration can be found here:
62installation`_ and here: `Configuring OpenStack Networking with Designate`_. 62:designate-doc:`Designate manual installation <install/index.html>`
63Also if you use devstack you can just enable Designate plugin: 63and here: :neutron-doc:`Configuring OpenStack Networking with Designate
64`Designate devstack`_. 64<admin/config-dns-int.html#configuring-openstack-networking-for-integration-with-an-external-dns-service>`.
65Also if you use devstack you can just enable the
66:designate-doc:`Designate devstack plugin <contributor/devstack.html>`.
65 67
66When Designate is configured you should create domain(s) for hostname 68When Designate is configured you should create domain(s) for hostname
67resolution. This can be done by using the Designate dashboard or by CLI. Also 69resolution. This can be done by using the Designate dashboard or by CLI. Also
@@ -94,10 +96,6 @@ change your ``/etc/resolv.conf`` file by adding appropriate ip addresses of
94DNS servers (e.g. 1.1.1.1 and 2.2.2.2). Also the VMs with DNS servers should 96DNS servers (e.g. 1.1.1.1 and 2.2.2.2). Also the VMs with DNS servers should
95be available from your local machine. 97be available from your local machine.
96 98
97.. _Designate manual installation: https://docs.openstack.org/designate/latest/install/index.html
98.. _Configuring OpenStack Networking with Designate: https://docs.openstack.org/neutron/latest/admin/config-dns-int.html#configuring-openstack-networking-for-integration-with-an-external-dns-service
99.. _Designate devstack: https://docs.openstack.org/designate/latest/contributor/devstack.html
100
101.. _data_locality_configuration: 99.. _data_locality_configuration:
102 100
103Data-locality configuration 101Data-locality configuration
@@ -265,7 +263,8 @@ Distributed periodic tasks are based on Hash Ring implementation and the Tooz
265library that provides group membership support for a set of backends. In order 263library that provides group membership support for a set of backends. In order
266to use periodic tasks distribution, the following steps are required: 264to use periodic tasks distribution, the following steps are required:
267 265
268* One of the `supported backends <https://docs.openstack.org/tooz/latest/user/compatibility.html#driver-support>`_ should be configured and started. 266* One of the :tooz-doc:`supported backends <user/compatibility.html#driver-support>`
267 should be configured and started.
269* Backend URL should be set in the sahara configuration file with the 268* Backend URL should be set in the sahara configuration file with the
270 ``periodic_coordinator_backend_url`` parameter. For example, if the 269 ``periodic_coordinator_backend_url`` parameter. For example, if the
271 ZooKeeper backend is being used: 270 ZooKeeper backend is being used:
@@ -324,7 +323,7 @@ within the stack.
324 323
325With a Key Manager service deployed on the stack, sahara must be configured 324With a Key Manager service deployed on the stack, sahara must be configured
326to enable the external storage of secrets. Sahara uses the 325to enable the external storage of secrets. Sahara uses the
327`castellan <https://docs.openstack.org/castellan/latest/>`_ library 326:castellan-doc:`castellan <>` library
328to interface with the OpenStack Key Manager service. This library provides 327to interface with the OpenStack Key Manager service. This library provides
329configurable access to a key manager. To configure sahara to use barbican as 328configurable access to a key manager. To configure sahara to use barbican as
330the key manager, edit the sahara configuration file as follows: 329the key manager, edit the sahara configuration file as follows:
@@ -485,9 +484,8 @@ users created by sahara. This domain must have an identity backend driver
485that allows for sahara to create new users. The default SQL engine is 484that allows for sahara to create new users. The default SQL engine is
486sufficient but if your keystone identity is backed by LDAP or similar 485sufficient but if your keystone identity is backed by LDAP or similar
487then domain specific configurations should be used to ensure sahara's 486then domain specific configurations should be used to ensure sahara's
488access. Please see the `Keystone documentation`_ for more information. 487access. Please see the :keystone-doc:`Keystone documentation
489 488<configuration.html#domain-specific-drivers>` for more information.
490.. _Keystone documentation: https://docs.openstack.org/keystone/latest/configuration.html#domain-specific-drivers
491 489
492With the domain created, sahara's configuration file should be updated to 490With the domain created, sahara's configuration file should be updated to
493include the new domain name and any potential roles that will be needed. For 491include the new domain name and any potential roles that will be needed. For
@@ -617,7 +615,8 @@ CORS (Cross Origin Resource Sharing) Configuration
617 615
618Sahara provides direct API access to user-agents (browsers) via the HTTP 616Sahara provides direct API access to user-agents (browsers) via the HTTP
619CORS protocol. Detailed documentation, as well as troubleshooting examples, 617CORS protocol. Detailed documentation, as well as troubleshooting examples,
620may be found in the OpenStack `Administrator Guide`_. 618may be found in the :oslo.middleware-doc:`documentation of the oslo.db
619cross-project features <admin/cross-project-cors.html>`.
621 620
622To get started quickly, use the example configuration block below, replacing 621To get started quickly, use the example configuration block below, replacing
623the :code:`allowed origin` field with the host(s) from which your API expects 622the :code:`allowed origin` field with the host(s) from which your API expects
@@ -639,7 +638,6 @@ access.
639For more information on Cross Origin Resource Sharing, please review the `W3C 638For more information on Cross Origin Resource Sharing, please review the `W3C
640CORS specification`_. 639CORS specification`_.
641 640
642.. _Administrator Guide: https://docs.openstack.org/oslo.middleware/latest/admin/cross-project-cors.html
643.. _W3C CORS specification: http://www.w3.org/TR/cors/ 641.. _W3C CORS specification: http://www.w3.org/TR/cors/
644 642
645Cleanup time for incomplete clusters 643Cleanup time for incomplete clusters
diff --git a/doc/source/conf.py b/doc/source/conf.py
index a1238a7..3e0920d 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -48,6 +48,21 @@ html_last_updated_fmt = '%Y-%m-%d %H:%M'
48config_generator_config_file = 'config-generator.conf' 48config_generator_config_file = 'config-generator.conf'
49config_sample_basename = 'sahara' 49config_sample_basename = 'sahara'
50 50
51openstack_projects = [
52 'barbican',
53 'castellan',
54 'designate',
55 'devstack',
56 'ironic',
57 'keystone',
58 'keystoneauth',
59 'kolla-ansible',
60 'neutron',
61 'nova',
62 'oslo.middleware',
63 'tooz'
64]
65
51# Add any paths that contain templates here, relative to this directory. 66# Add any paths that contain templates here, relative to this directory.
52templates_path = ['_templates'] 67templates_path = ['_templates']
53 68
diff --git a/doc/source/contributor/development-guidelines.rst b/doc/source/contributor/development-guidelines.rst
index ec68364..66471ef 100644
--- a/doc/source/contributor/development-guidelines.rst
+++ b/doc/source/contributor/development-guidelines.rst
@@ -178,7 +178,7 @@ keystone ``Session`` and auth plugin objects (for example, ``Token`` and
178``Password``). Sahara is migrating all clients to use this authentication 178``Password``). Sahara is migrating all clients to use this authentication
179methodology, where available. For more information on using sessions with 179methodology, where available. For more information on using sessions with
180keystone, please see 180keystone, please see
181https://docs.openstack.org/keystoneauth/latest/using-sessions.html 181:keystoneauth-doc:`the keystoneauth documentation <using-sessions.html>`
182 182
183Storing sensitive information 183Storing sensitive information
184----------------------------- 184-----------------------------
@@ -188,8 +188,8 @@ information (for example, login credentials) in the records for a cluster,
188job, or some other record. Storing secret information this way is **not** 188job, or some other record. Storing secret information this way is **not**
189safe. To mitigate the risk of storing this information, sahara provides 189safe. To mitigate the risk of storing this information, sahara provides
190access to the OpenStack Key Manager service (implemented by the 190access to the OpenStack Key Manager service (implemented by the
191`barbican project <https://docs.openstack.org/barbican/latest/>`_) through 191:barbican-doc:`barbican project <>`) through
192the `castellan library <https://docs.openstack.org/castellan/latest/>`_. 192the :castellan-doc:`castellan library <>`.
193 193
194To utilize the external key manager, the functions in 194To utilize the external key manager, the functions in
195``sahara.service.castellan.utils`` are provided as wrappers around the 195``sahara.service.castellan.utils`` are provided as wrappers around the
diff --git a/doc/source/install/installation-guide.rst b/doc/source/install/installation-guide.rst
index 84a4f0b..9b639bc 100644
--- a/doc/source/install/installation-guide.rst
+++ b/doc/source/install/installation-guide.rst
@@ -6,7 +6,7 @@ consistent state. We suggest the following options:
6 6
7* Install via `Fuel <http://fuel.mirantis.com/>`_ 7* Install via `Fuel <http://fuel.mirantis.com/>`_
8 8
9* Install via `Kolla <https://docs.openstack.org/kolla-ansible/latest/>`_ 9* Install via :kolla-ansible-doc:`Kolla <>`
10 10
11* Install via `RDO <https://www.rdoproject.org/>`_ 11* Install via `RDO <https://www.rdoproject.org/>`_
12 12
@@ -26,8 +26,8 @@ To install with Fuel
26To install with Kolla 26To install with Kolla
27--------------------- 27---------------------
28 28
291. Start by following the `Kolla Quickstart 291. Start by following the :kolla-ansible-doc:`Kolla Quickstart
30 <https://docs.openstack.org/kolla-ansible/latest/user/quickstart.html>`_ 30 <user/quickstart.html>`
31 to install and setup OpenStack. 31 to install and setup OpenStack.
32 32
332. Enable the sahara service during installation. 332. Enable the sahara service during installation.
diff --git a/doc/source/reference/restapi.rst b/doc/source/reference/restapi.rst
index 2d69993..7f23b22 100644
--- a/doc/source/reference/restapi.rst
+++ b/doc/source/reference/restapi.rst
@@ -14,8 +14,8 @@ authentication service. When the Identity service is enabled, users who
14submit requests to the sahara service must provide an authentication token in 14submit requests to the sahara service must provide an authentication token in
15the ``X-Auth-Token`` request header. A user can obtain the token by 15the ``X-Auth-Token`` request header. A user can obtain the token by
16authenticating to the Identity service endpoint. For more information about 16authenticating to the Identity service endpoint. For more information about
17the Identity service, please see the `keystone project developer documentation 17the Identity service, please see the :keystone-doc:`keystone project developer
18<https://docs.openstack.org/keystone/latest/>`_ 18documentation <>`.
19 19
20With each request, a user must specify the keystone project 20With each request, a user must specify the keystone project
21in the url path, for example: '/v1.1/{project_id}/clusters'. Sahara 21in the url path, for example: '/v1.1/{project_id}/clusters'. Sahara
diff --git a/doc/source/user/features.rst b/doc/source/user/features.rst
index 64e500d..2e2b9c0 100644
--- a/doc/source/user/features.rst
+++ b/doc/source/user/features.rst
@@ -23,14 +23,13 @@ processes to increase HDFS replica reliability.
23Starting with the Juno release, sahara can create server groups with the 23Starting with the Juno release, sahara can create server groups with the
24``anti-affinity`` policy to enable this feature. Sahara creates one server 24``anti-affinity`` policy to enable this feature. Sahara creates one server
25group per cluster and assigns all instances with affected processes to 25group per cluster and assigns all instances with affected processes to
26this server group. Refer to the `Nova Anti-Affinity documentation`_ 26this server group. Refer to the :nova-doc:`Nova Anti-Affinity documentation
27<admin/configuration/schedulers.html#servergroupantiaffinityfilter>`
27on how server group affinity filters work. 28on how server group affinity filters work.
28 29
29This feature is supported by all plugins out of the box, and can be enabled 30This feature is supported by all plugins out of the box, and can be enabled
30during the cluster template creation. 31during the cluster template creation.
31 32
32.. _Nova Anti-Affinity documentation: https://docs.openstack.org/nova/latest/admin/configuration/schedulers.html#servergroupantiaffinityfilter
33
34Block Storage support 33Block Storage support
35--------------------- 34---------------------
36 35
diff --git a/doc/source/user/sahara-on-ironic.rst b/doc/source/user/sahara-on-ironic.rst
index 4630d3e..b9fc926 100644
--- a/doc/source/user/sahara-on-ironic.rst
+++ b/doc/source/user/sahara-on-ironic.rst
@@ -9,10 +9,10 @@ from the bare metal performance with self-service resource provisioning.
9 9
10 10
111. Create a new OpenStack environment using Devstack as described 111. Create a new OpenStack environment using Devstack as described
12 in the `Devstack Guide <https://docs.openstack.org/devstack/latest/>`_ 12 in the :devstack-doc:`Devstack Guide <>`
13 13
142. Install Ironic as described in the `Ironic Installation Guide 142. Install Ironic as described in the :ironic-doc:`Ironic Installation Guide
15 <https://docs.openstack.org/ironic/latest/install/index.html>`_ 15 <install/>`
16 16
173. Install Sahara as described in the `Sahara Installation Guide 173. Install Sahara as described in the `Sahara Installation Guide
18 <../install/installation-guide.html>`_ 18 <../install/installation-guide.html>`_