[DOCS] Cleanup the role docs for consistency and clarity
Utilizing RST includes to reduce duplication of documentation effort. All contents of the Ansible defaults/main.yml are now included in the documentation directly. Change-Id: I84822047d5570853e2530f698dc53ff13220090e
This commit is contained in:
Travis Truman
parent
583bccce58
commit
5ce73596ba
63
README.rst
63
README.rst
|
|
@ -1,12 +1,35 @@
|
|||
OpenStack horizon
|
||||
##############
|
||||
:tags: openstack, horizon, cloud, ansible
|
||||
:category: \*nix
|
||||
OpenStack-Ansible Horizon
|
||||
#########################
|
||||
|
||||
Role for deployment, setup and installation of horizon.
|
||||
This Ansible role installs and configures OpenStack Horizon served by the
|
||||
Apache webserver. Horizon is configured to use Galera for session caching and
|
||||
memcached for other caching.
|
||||
|
||||
This role will install the following:
|
||||
* horizon-dashboard
|
||||
Default Variables
|
||||
=================
|
||||
|
||||
.. literalinclude:: ../../defaults/main.yml
|
||||
:language: yaml
|
||||
:start-after: under the License.
|
||||
|
||||
|
||||
Required Variables
|
||||
==================
|
||||
|
||||
This list is not exhaustive at present. See role internals for further
|
||||
details.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
horizon_ssl_protocol: "ALL -SSLv2 -SSLv3"
|
||||
horizon_ssl_cipher_suite: "ECDH+AESGCM:DH+AESGCM:ECDH+AES256:DH+AES256:ECDH+AES128:DH+AES:ECDH+3DES:DH+3DES:RSA+AESGCM:RSA+AES:RSA+3DES:!aNULL:!MD5:!DSS"
|
||||
horizon_galera_address: 10.100.100.101
|
||||
horizon_container_mysql_password: "SuperSecrete"
|
||||
horizon_secret_key: "SuperSecreteHorizonKey"
|
||||
|
||||
|
||||
Example Playbook
|
||||
================
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
|
@ -16,4 +39,28 @@ This role will install the following:
|
|||
roles:
|
||||
- { role: "os_horizon", tags: [ "os-horizon" ] }
|
||||
vars:
|
||||
horizon_galera_address: "{{ internal_lb_vip_address }}"
|
||||
galera_client_drop_config_file: false
|
||||
external_lb_vip_address: 10.100.100.101
|
||||
internal_lb_vip_address: 10.100.100.101
|
||||
horizon_galera_address: 10.100.100.101
|
||||
horizon_container_mysql_password: "SuperSecrete"
|
||||
horizon_secret_key: "SuperSecreteHorizonKey"
|
||||
horizon_external_ssl: true
|
||||
horizon_ssl_protocol: "ALL -SSLv2 -SSLv3"
|
||||
horizon_ssl_cipher_suite: "ECDH+AESGCM:DH+AESGCM:ECDH+AES256:DH+AES256:ECDH+AES128:DH+AES:ECDH+3DES:DH+3DES:RSA+AESGCM:RSA+AES:RSA+3DES:!aNULL:!MD5:!DSS"
|
||||
galera_root_password: "secrete"
|
||||
rabbitmq_servers: 10.100.100.101
|
||||
rabbitmq_use_ssl: false
|
||||
rabbitmq_port: 5671
|
||||
keystone_auth_admin_token: "SuperSecreteTestToken"
|
||||
keystone_auth_admin_password: "SuperSecretePassword"
|
||||
keystone_service_adminuri_insecure: false
|
||||
keystone_service_internaluri_insecure: false
|
||||
keystone_service_internaluri: "http://{{ internal_lb_vip_address }}:5000"
|
||||
keystone_service_internalurl: "{{ keystone_service_internaluri }}/v3"
|
||||
keystone_service_adminuri: "http://{{ internal_lb_vip_address }}:35357"
|
||||
keystone_service_adminurl: "{{ keystone_service_adminuri }}/v3"
|
||||
openrc_os_password: "{{ keystone_auth_admin_password }}"
|
||||
openrc_os_domain_name: "Default"
|
||||
memcached_servers: 10.100.100.101
|
||||
memcached_encryption_key: "secrete"
|
||||
|
|
|
|||
|
|
@ -78,7 +78,7 @@ horizon_enable_password_retrieve: False
|
|||
horizon_can_set_password: False
|
||||
horizon_enable_cinder_backup: False
|
||||
|
||||
# If the following variables are unset in user_variables, the value set will be half the number of available VCPUs
|
||||
# WSGI tuning parameters
|
||||
# horizon_wsgi_processes: 4
|
||||
# horizon_wsgi_threads: 4
|
||||
|
||||
|
|
@ -91,10 +91,11 @@ horizon_ssl_cipher_suite: "{{ ssl_cipher_suite }}"
|
|||
# if using a self-signed certificate, set this to true to regenerate it
|
||||
horizon_ssl_self_signed_regen: false
|
||||
horizon_ssl_self_signed_subject: "/C=US/ST=Texas/L=San Antonio/O=IT/CN={{ horizon_server_name }}/subjectAltName=IP.1={{ external_lb_vip_address }}"
|
||||
# Set these in user_variables to deploy custom certificates
|
||||
#horizon_user_ssl_cert: <path to cert on ansible deployment host>
|
||||
#horizon_user_ssl_key: <path to cert on ansible deployment host>
|
||||
#horizon_user_ssl_ca_cert: <path to cert on ansible deployment host>
|
||||
|
||||
# Set these variables to deploy custom certificates
|
||||
# horizon_user_ssl_cert: <path to cert on ansible deployment host>
|
||||
# horizon_user_ssl_key: <path to cert on ansible deployment host>
|
||||
# horizon_user_ssl_ca_cert: <path to cert on ansible deployment host>
|
||||
|
||||
# Set this to True if you do ssl termination on an external device, like the
|
||||
# load balancer
|
||||
|
|
@ -111,7 +112,6 @@ horizon_secure_proxy_ssl_header_django: "HTTP_{{ horizon_secure_proxy_ssl_header
|
|||
# - { url: "http://cluster1.example.com:5000/v2.0", name: "RegionTwo" }
|
||||
|
||||
## Horizon's keystone endpoint settings
|
||||
|
||||
horizon_keystone_host: "{{ internal_lb_vip_address }}"
|
||||
horizon_keystone_endpoint: "{{ keystone_service_internalurl }}"
|
||||
|
||||
|
|
|
|||
|
|
@ -1,15 +1 @@
|
|||
os_horizon Docs
|
||||
===============
|
||||
|
||||
Installation and setup of OpenStack Horizon. This role
|
||||
is designed to be used with OpenStack Ansible
|
||||
|
||||
Basic Role Example
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Tell us how to use the role.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
- role: openstack-ansible-os_horizon
|
||||
ROLE_VARS...
|
||||
.. include:: ../../README.rst
|
||||
Loading…
Reference in New Issue