majic-ansible-roles Changeset

Changeset - 36f65ea9de39

Parent rev.

Child rev.

[Not reviewed]

0 1 0

Branko Majic (branko) - 4 years ago 2020-05-09 21:24:20
branko@majic.rs

MAR-149: Improved documentation for the test site (more details):

- Cover server names.
- Cover additional names that should be resolvable towards the web
server (for reaching sample web applications)
- Include links for testing the sample web applications.

1 file changed with 39 insertions and 0 deletions:

docs/development.rst

0 comments (0 inline, 0 general)

docs/development.rst

➞

Show inline comments

 instructions). Some changes may be necessary to listed commands in that case
 (i.e. replace every occurance of ``example.com`` with your own domain).
 By default, the following hosts are used in test site (listed names
 should be resolvable towards the servers):
 - ``ldap.example.com``, acting as LDAP server
 - ``xmpp.example.com``, acting as XMPP server
 - ``mail.example.com``, acting as mail server
 - ``web.example.com``, acting as web server
 - ``backup.example.com``, acting as backup server
 - ``ws01.example.com``, acting as "workstation" (mainly demonstrating
   use of mail forwarder role)
 The web server is also set-up with one sample PHP application and two
 WSGI applications deployed via roles:
 - ``phpinfo``, used to serve information about the local PHP
   installation.
 - ``wsgihello``, small hello world application using Python 2
 - ``wsgihello2``, small hello world application using Python 3 and a
   couple of additional ``wsgi_website`` role parameters.
 To make the web applications reachable, make sure the web server
 (``web.example.com``) IP is also resolvable via names:
 - ``phpinfo.example.com`` (``phpinfo`` application/role)
 - ``wsgi.example.com`` (``wsgihello`` application/role)
 - ``wsgireq.example.com`` (``wsgihello2`` application/role)
 All example commands listed within this section should be ran from within the
 ``testsite`` directory in order to have proper environment available for
 playbook runs.
@@ @@ -658,3 +685,15 @@ configuration, run (take note it is upper-case ``F``):: @@
   mutt -F mutt/john.doe
   mutt -F mutt/jane.doe
 To test the provided web applications, use the following links in a
 browser:
 .. note::
    To avoid untrusted certificate errors, it is recommended to test
    the links with dedicated instance of Mozilla Firefox, and to import
    the CA certificate (``tls/ca.pem``) into it.
 - https://phpinfo.example.com/
 - https://wsgi.example.com/
 - https://wsgireq.example.com/

0 comments (0 inline, 0 general)