Changeset - 1ab4192d3d9a
[Not reviewed]
0 1 0
Branko Majic (branko) - 6 years ago 2018-06-28 21:49:20
branko@majic.rs
MAR-129: Update development documentation for testsite:

- Update versions of VirtualBox/Vagrant that have been tested.
- Move notes about how the servers have been set-up to towards
beginning of section describing the test site.
- Put deployment of test site into a sub-section of its own.
1 file changed with 18 insertions and 14 deletions:
0 comments (0 inline, 0 general)
docs/development.rst
Show inline comments
 
@@ -34,7 +34,7 @@ performing the following steps:
 
   <https://www.virtualbox.org/>`_ and `Vagrant <https://www.vagrantup.com/>`_,
 
   using instructions outlined on their respective websites. It is recommended
 
   to use latest versions available. At time of this writing the role tests have
 
   been successfully run on *VirtualBox 5.1.22* and *Vagrant 1.9.5*.
 
   been successfully run on *VirtualBox 5.2.12* and *Vagrant 2.0.4*.
 

	
 
3. Clone the git repository::
 

	
 
@@ -452,6 +452,23 @@ xmpp.yml
 
backup.yml
 
  This playbook sets-up the backup server. It is included in ``site.yml``.
 

	
 
The playbooks and configurations for test site make a couple of assumptions:
 

	
 
* Each server will be set-up with an operating system user ``admin``, capable of
 
  running the sudo commands.
 
* The password for operating system user ``admin`` is hard-coded to ``admin``.
 
* An SSH ``authorized_keys`` file is set-up for the operating system user
 
  ``admin``. The SSH key stored in it will be read from location
 
  ``~/.ssh/id_rsa.pub`` (i.e. from home directory of user running the Ansible
 
  commands).
 

	
 
For more details on how the playbooks and configuration have been implemented,
 
feel free to browse the test site files (in directory ``testsite``).
 

	
 

	
 
Deploying test site
 
~~~~~~~~~~~~~~~~~~~
 

	
 
In order to deploy the test site, the following steps would normally be taken:
 

	
 
1. As mentioned in introduction, default domain used by test site is
 
@@ -612,16 +629,3 @@ In order to deploy the test site, the following steps would normally be taken:
 
    .. code-block:: shell
 

	
 
       ansible-playbook playbooks/site.yml
 

	
 
The playbooks and configurations for test site make a couple of assumptions:
 

	
 
* Each server will be set-up with an operating system user ``admin``, capable of
 
  running the sudo commands.
 
* The password for operating system user ``admin`` is hard-coded to ``admin``.
 
* An SSH ``authorized_keys`` file is set-up for the operating system user
 
  ``admin``. The SSH key stored in it will be read from location
 
  ``~/.ssh/id_rsa.pub`` (i.e. from home directory of user running the Ansible
 
  commands).
 

	
 
For more details on how the playbooks and configuration have been implemented,
 
feel free to browse the test site files (in directory ``testsite``).
0 comments (0 inline, 0 general)