summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAndrey Pavlov <apavlov@mirantis.com>2017-03-02 19:34:08 +0400
committerAndrey Pavlov <apavlov@mirantis.com>2017-03-04 18:00:40 +0000
commit4f134c6dd1426c1044bf6f0a4f35be3af9557ee6 (patch)
tree2d01c16de5e2ad4a4a63aa16176d7e82ffed8a90 /doc
parenta5083dc520fd65f5d1194834ebbfc41284e639ba (diff)
Adding "services" doc
Notes
Notes (review): Verified+1: Mirantis CCP CI <mirantis-fuel-ccp-ci@mirantis.com> Code-Review+2: Proskurin Kirill <kproskurin@mirantis.com> Code-Review+2: Sergey Reshetnyak <sreshetniak@mirantis.com> Workflow+1: Sergey Reshetnyak <sreshetniak@mirantis.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Mon, 06 Mar 2017 11:04:56 +0000 Reviewed-on: https://review.openstack.org/440636 Project: openstack/fuel-ccp Branch: refs/heads/master
Diffstat (limited to 'doc')
-rw-r--r--doc/source/config/services.rst79
-rw-r--r--doc/source/config/types.rst40
2 files changed, 119 insertions, 0 deletions
diff --git a/doc/source/config/services.rst b/doc/source/config/services.rst
new file mode 100644
index 0000000..08e1351
--- /dev/null
+++ b/doc/source/config/services.rst
@@ -0,0 +1,79 @@
1.. _services_section:
2
3==================
4"services" section
5==================
6
7You would want to have dedicated DB/messaging/memcached/etc for some of your
8services. Or you could have several backends and want to switch between them
9easily. This guide will describe how to make proper configuration for both
10cases.
11
12All required configuration is located under `services` config group and can be
13propagated via :file:`ccp.yaml`.
14
15The following abstractions are being used all over the CCP:
16
17* database
18* rpc
19* notifications
20
21You should explicitly define backends for them before deployment. For example:
22
23::
24
25 services:
26 database:
27 service_def: galera
28 rpc:
29 service_def: rabbitmq
30 notifications:
31 service_def: rabbitmq
32
33Those services can be used in topology definition. You don't have to define
34anything else. By default will be assumed that service has a name of service
35definition.
36
37In the following example will be created dedicated databases for keystone and
38glance, dedicated memcached for keystone and horizon and those services will
39be connected through `mapping` section.
40
41::
42
43 services:
44 database:
45 service_def: galera
46 keystone-db:
47 service_def: galera
48 glance-db:
49 service_def: galera
50
51 keystone-memcached:
52 service_def: memcached
53 horizon-memcached:
54 service_def: memcached
55
56 rpc:
57 service_def: rabbitmq
58 notifications:
59 service_def: rabbitmq
60
61 keystone:
62 service_def: keystone
63 mapping:
64 database: keystone-db
65 memcached: keystone-memcached
66 glance-api:
67 service_def: glance-api
68 mapping:
69 database: glance-db
70 glance-registry:
71 service_def: glance-registry
72 mapping:
73 database: glance-db
74 horizon:
75 service_def: horizon
76 mapping:
77 memcached: horizon-memcached
78
79.. NOTE:: Each galera instance should have it's own subset of nodes. \ No newline at end of file
diff --git a/doc/source/config/types.rst b/doc/source/config/types.rst
index 4a517e1..939e6ae 100644
--- a/doc/source/config/types.rst
+++ b/doc/source/config/types.rst
@@ -44,6 +44,7 @@ of the microservices and credentials for connecting to Kubernetes cluster.
44- :ref:`configs` 44- :ref:`configs`
45- :ref:`files` 45- :ref:`files`
46- :ref:`kubernetes` 46- :ref:`kubernetes`
47- :ref:`services`
47- :ref:`nodes` 48- :ref:`nodes`
48- :ref:`roles` 49- :ref:`roles`
49- :ref:`replicas` 50- :ref:`replicas`
@@ -470,6 +471,45 @@ For example:
470 replicas: 471 replicas:
471 heat-engine: 3 472 heat-engine: 3
472 473
474
475.. _services
476
477services
478--------
479
480Isolation:
481
482- Not used in any template file, only used by the CCP CLI to create new
483 services and connect them between each other.
484
485Allowed content:
486
487- This is a dict that contains definitions for dedicated services.
488 Its keys are service names, values are dicts with the following keys:
489
490.. list-table::
491 :widths: 10 25 10 10
492 :header-rows: 1
493
494 * - Name
495 - Description
496 - Schema
497 - Default
498 * - service_def
499 - Name of the service definition associated with that service.
500 - string
501 - --
502 * - mapping
503 - Dict to map service abstractions to defined services.
504 - dict
505 - --
506 * - configs
507 - Config overrides for this particular service.
508 - dict
509 - --
510
511You can find more information and examples in :doc:`services_section` page.
512
473.. _nodes: 513.. _nodes:
474 514
475nodes 515nodes