Improve README with better examples
Change-Id: I86e203c70fca62004733ec1dd4c9107bb377a4f6
This commit is contained in:
parent
a9b8f25c01
commit
bda8d7b63a
18
README.rst
18
README.rst
|
@ -34,27 +34,23 @@ It provides installation and configuration of the web application under the
|
|||
Using the role
|
||||
--------------
|
||||
|
||||
You can get the role using the following commands:
|
||||
|
||||
::
|
||||
mkdir roles
|
||||
git clone https://git.openstack.org/openstack/ansible-role-ara roles/ara
|
||||
|
||||
By default, the embedded server will be use, you have to edit defaults/main.yaml to set
|
||||
use_apache_server to True
|
||||
|
||||
Create a simple playbook to do the deployment:
|
||||
The default parameters of the role will install ARA and configure a persistent
|
||||
systemd service to run the embedded development server:
|
||||
|
||||
::
|
||||
mkdir roles
|
||||
git clone https://git.openstack.org/openstack/ansible-role-ara roles/ara
|
||||
cat << EOF > playbook.yml
|
||||
- hosts: all
|
||||
- name: Install ARA with default settings
|
||||
hosts: localhost
|
||||
roles:
|
||||
- ara
|
||||
EOF
|
||||
ansible-playbook playbook.yml
|
||||
|
||||
For more configuration and deployment examples, please refer to the
|
||||
``example-playbooks`` directory.
|
||||
|
||||
Contributors
|
||||
============
|
||||
See contributors on GitHub_.
|
||||
|
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
# Copyright (c) 2018 Red Hat, Inc.
|
||||
#
|
||||
# This file is part of ARA Records Ansible.
|
||||
#
|
||||
# ARA is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# ARA is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with ARA. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
# This runs the ARA role with default parameters on localhost.
|
||||
# It sets up ARA to run through the embedded webserver with a systemd unit file.
|
||||
- name: Install ARA with default settings
|
||||
hosts: localhost
|
||||
roles:
|
||||
- ara
|
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
# Copyright (c) 2018 Red Hat, Inc.
|
||||
#
|
||||
# This file is part of ARA Records Ansible.
|
||||
#
|
||||
# ARA is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# ARA is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with ARA. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
# This runs the ARA role with parameters to set up apache with mod_wsgi.
|
||||
- name: Install ARA with mod_wsgi
|
||||
hosts: localhost
|
||||
vars:
|
||||
ara_override:
|
||||
deployment:
|
||||
server: apache
|
||||
type: mod_wsgi
|
||||
roles:
|
||||
- ara
|
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
# Copyright (c) 2018 Red Hat, Inc.
|
||||
#
|
||||
# This file is part of ARA Records Ansible.
|
||||
#
|
||||
# ARA is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# ARA is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with ARA. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
# This runs the ARA role with parameters to set up nginx as a reverse proxy to
|
||||
# the embedded server. The web application will be available on '/ara'.
|
||||
- name: Install ARA with nginx as reverse proxy to the embedded server
|
||||
hosts: localhost
|
||||
vars:
|
||||
ara_override:
|
||||
config:
|
||||
application_root: /ara
|
||||
deployment:
|
||||
server: nginx
|
||||
type: embedded_proxy
|
||||
roles:
|
||||
- ara
|
Loading…
Reference in New Issue