Compositional Agile System

Introduction

Compositional Agile System (CAS) in an open source development environment mainly oriented towards the Agile methodology.
Included software are Gitlab, Taiga, Jenkins, Sonarqube and Mattermost.

Installation

Prerequisites

• A Debian or Ubuntu server with SSH and root access
• A machine with Ansible (may also be the server itself)

  # To install Ansible
  pip install --user ansible
  
  # To install Ansible Docker module
  ansible-galaxy collection install community.docker
  

Settings

The hosts file contains some parameters that have to be changed.

• ansible_host set to the address of the server
• ansible_user set to the user to use during the installation (has to be root or a sudoer)
• domain to the domain name or the IP address of the server
• install is a dictionary to select which services will be installed

Enable HTTPS

If schema is set to https, it will handle the request of a Let's Encrypt certificate (which will automatically accept its TOS) and create a cron job for the renewal.
In order to issue the certificate, the email field is required and the server must be publicly reachable on port 80.

Deployment

ansible-playbook main.yml -i hosts

If the user requires password authentication, add the -kK flag (it will prompt for the password of the user and then for the password to use sudo).

Note: the server key fingerprint should already be on the Ansible host.

Initial setup

Gitlab

URL: http(s)://domain/gitlab
The root user temporary password is located in the container:

docker exec cas-gitlab cat /etc/gitlab/initial_root_password

Gitlab runner

To enable Gitlab runner, run the following playbook:

ansible-playbook runner.yml -i hosts

It will prompt for the name of the runner and the registration token (it can be generated at the http(s)://domain/gitlab/admin/runners page).

Jenkins

URL: http(s)://domain/jenkins
The initial password is located in the container:

docker exec cas-jenkins cat /var/jenkins_home/secrets/initialAdminPassword

Sonarqube

URL: http(s)://domain/sonarqube
The default user is admin/admin.

Set the Server base URL field in Administration > Configuration > General Settings > General with the URL of Sonarqube (e.g. http(s)://domain/sonarqube).

Taiga

URL: http(s)://domain/taiga
Create an admin user by running:

docker exec -it cas-taiga-back python manage.py createsuperuser

The admin panel can be found at http(s)://domain/taiga/admin/ (beware of the final slash).

Mattermost

URL: http(s)://domain/mattermost
The first user to signup will automatically become administrator.

Setup Gitlab SSO

There is an Ansible playbook to setup Gitlab SSO.
If you prefer to do it manually, some references can be found here.

To use the playbook, all services should already have been initialized.
Run:

ansible-playbook sso.yml -i hosts

If the user requires password authentication, add the -kK flag (it will prompt for the password of the user and then for the password to use sudo).

Jenkins

Jenkins SSO setup must be done manually.

1. Install the plugin: GitLab Authentication.
2. Go into the Manage Jenkins > Configure Global Security tab and select as Security Realm Gitlab Authentication Plugin.
3. Create a new Gitlab OAuth application (Admin Area > Applications) with scope api and return URI /jenkins/securityRealm/finishLogin (e.g. http(s)://domain/jenkins/securityRealm/finishLogin).
4. On the Jenkins panel insert the required data.

Unified dashboard

This dashboard allows to access all services within a single page.
Gitlab SSO should be enabled to make the dashboard work.
Run:

ansible-playbook dashboard.yml -i hosts

If the user requires password authentication, add the -kK flag (it will prompt for the password of the user and then for the password to use sudo).

Add or remove a service

Refer to this file.

Useful integrations

• Gitlab - Taiga
• Gitlab - Mattermost
• Gitlab - Jenkins
• Jenkins - Sonarqube
• Jenkins - Mattermost
• Discord - Jenkins
• Discord - Gitlab