Changeset - ce24831d92f8
[Not reviewed]
0 4 0
Branko Majic (branko) - 6 years ago 2020-05-06 14:42:56
branko@majic.rs
MAR-152: Update documentation regarding removal of support for Debian 8 Jessie:

- Updated introductory information about the project.
- Removed references to Debian 8 Jessie from documentation.
- Updated release notes.
4 files changed with 9 insertions and 7 deletions:
0 comments (0 inline, 0 general)
docs/about.rst
Show inline comments
 
About Majic Ansible Roles
 
=========================
 

	
 
Majic Ansible Roles is a collection of Ansible roles that are used on regular
 
basis for deployment and maintenance of Majic infrastructure.
 

	
 
The roles are kept as a separate project in hope of making them potentially
 
useful to wider audience, and for reference purposes.
 

	
 
Roles cover different aspects of infrastructure, such as mail servers, web
 
servers, web applications etc. The roles are mainly well-suited for smaller
 
installations.
 

	
 
Roles are mainly written for use with *Debian 8 Jessie*, although some support
 
*Debian 9 Stretch* as well. You can find out more about distribution
 
compatibility in :ref:`rolereference`.
 
Roles are written for use with *Debian GNU/Linux*. For more details on
 
supported releases, see :ref:`rolereference`.
 

	
 
At the moment, the roles have been written for and tested against **Ansible
 
2.9.x**.
 

	
 
The role also utilises the ``dig`` lookup plugin which requires ``dnspython``
 
package to be installed. Make sure you have the package available on controller
 
machine.
 

	
 

	
 
Why were these roles created?
 
-----------------------------
 

	
 
For a long time I have had a couple of Internet-facing servers where I hosted
 
all the IT infrastructure I needed for my day-to-day life.
 

	
 
This started off with some basic services, like mail and XMPP server, and in
 
time extended to include a web server, code repository etc.
 

	
 
As the number of services I used grew, I found it more difficult to track
 
updates and upgrades, let alone test them in reliable way. The biggest problem
 
in particular was lack of time to properly document all the different things
 
I've set-up.
 

	
 
Being familiar with some Puppet-based deployments, I've started looking into the
docs/development.rst
Show inline comments
 
@@ -583,49 +583,49 @@ In order to deploy the test site, the following steps would normally be taken:
 
     %commit
 

	
 
     Key-Type:RSA
 
     Key-Length:1024
 
     Name-Real:backup.example.com
 
     Expire-Date:0
 
     %no-protection
 
     %commit
 

	
 
     Key-Type:RSA
 
     Key-Length:1024
 
     Name-Real:ws01.example.com
 
     Expire-Date:0
 
     %no-protection
 
     %commit
 
     EOF
 

	
 
8. Generate the preseed files:
 

	
 
  .. code-block:: shell
 

	
 
     ansible-playbook playbooks/preseed.yml
 

	
 
9. Install all servers using the generated preseed files. Use *Debian
 
   8 Jessie* or *Debian 9 Stretch* in any combination desired.
 
   9 Stretch*.
 

	
 
10. Add the SSH host fingerprints to your ``known_hosts`` file (don't forget to
 
    remove old entries if you are redoing the process). You can easily obtain all
 
    the necessary fingerprints with command (don't forget to modify domain if you
 
    need to):
 

	
 
    .. code-block:: shell
 

	
 
      ssh-keyscan -t ed25519 mail.example.com ldap.example.com xmpp.example.com web.example.com backup.example.com ws01.example.com $(dig +short mail.example.com) $(dig +short ldap.example.com) $(dig +short xmpp.example.com) $(dig +short web.example.com) $(dig +short backup.example.com) $(dig +short ws01.example.com)
 

	
 
11. Invoke the ``bootstrap.yml`` playbook in order to set-up some basic
 
    environment for Ansible runs on all servers:
 

	
 
    .. code-block:: shell
 

	
 
       ansible-playbook playbooks/bootstrap.yml
 

	
 
12. Finally, apply configuration on all servers:
 

	
 
    .. code-block:: shell
 

	
 
       ansible-playbook playbooks/site.yml
 

	
 

	
docs/index.rst
Show inline comments
 
Majic Ansible Roles documentation
 
=================================
 

	
 
Majic Ansible Roles is a collection of Ansible roles that are used on regular
 
basis for deployment and maintenance of Majic infrastructure.
 

	
 
The roles are kept as a separate project in hope of making them potentially
 
useful to wider audience, and for reference purposes.
 

	
 
Roles cover different aspects of infrastructure, such as mail servers, web
 
servers, web applications etc. The roles are mainly well-suited for smaller
 
installations.
 

	
 
Roles are written for use with *Debian 8 Jessie* and *Debian 9
 
Stretch*. You can find out more about distribution compatibility in
 
:ref:`rolereference`.
 
Roles are written for use with *Debian GNU/Linux*. For more details on
 
supported releases, see :ref:`rolereference`.
 

	
 
At the moment, the roles have been written for and tested against **Ansible
 
2.9.x**.
 

	
 
The role also utilises the ``dig`` lookup plugin which requires ``dnspython``
 
package to be installed. Make sure you have the package available on controller
 
machine.
 

	
 

	
 
Contents
 
========
 

	
 
.. toctree::
 
   :maxdepth: 2
 

	
 
   about
 
   usage
 
   rolereference
 
   development
 
   releaseprocedures
 
   releasenotes
 

	
 
Indices and tables
 
==================
docs/releasenotes.rst
Show inline comments
 
Release notes
 
=============
 

	
 

	
 
NEXT RELEASE
 
------------
 

	
 
Upgrade to Ansible 2.9.x.
 

	
 
Breaking changes:
 

	
 
* Switched to Ansible 2.9.x, removing support for older versions. All
 
  documentation has been updated.
 

	
 
* All roles
 

	
 
  * Support for Debian 8 Jessie has been dropped from all roles.
 

	
 
Bug fixes:
 

	
 
* ``common`` role
 

	
 
  * Run apticron at least once during initial installation to avoid
 
    accidental locking later on during the same playbook run.
 

	
 
New features/improvements:
 

	
 
* Tests have been updated to work with latest Molecule/Testinfra as
 
  part of the Ansible upgrade process.
 

	
 

	
 
4.0.0
 
-----
 

	
 
A couple of smaller bug-fixes, and introduction of (minor) breaking
 
change related to handling of pip requirements upgrade checks in the
 
``common`` role (see below).
 

	
 
Breaking changes:
 

	
 
* ``common`` role:
 

	
0 comments (0 inline, 0 general)