Provisioning

Ansible is Python package used to deploy rewards-suite infrastructure.

This guide is made for Ubuntu Server 24.04.03 LTS hosts, but it’s applicable for many other Debian based Linux/GNU distros.

Local machine requirements

Ansible installation

The most recent stable Ansible version is available through pip and its Python 3 version for Debian systems is called python3-pip.

sudo apt-get install python3-pip

pip3 install ansible --user

Server requirements/setup

Production

SSH access

For majority of VPS providers, root user is already configured and ssh access is allowed by provided public key.

Virtual machine

Local network setup

Configuration for Ubuntu 24.04.3 server:

/etc/netplan/50-cloud-init.yaml

network:
  version: 2
  ethernets:
    enp0s3:
      dhcp4: false
      addresses:
        - 192.168.1.82/24
      routes:
        - to: default
          via: 192.168.1.1
      nameservers:
        addresses: [8.8.8.8, 4.4.4.4]

Configuration from above is activated by sudo netplan apply.

SSH access

Server should have openssh-server installed and running. Many GNU/Linux have Python 3 preinstalled.

sudo apt-get install openssh-server python3

For testing purposes in VM environment, a temporary user should be created. Upon first start it will enable the root login by running:

tempuser@ubuntu:~# sudo passwd root

In Ubuntu ssh login for root is restricted, so it should be temporary allowed:

sudo nano /etc/ssh/sshd_config
PermitRootLogin yes

Default identity public key copying (use -i identity_file for different identity) from the local machine is issued by:

ssh-copy-id root@192.168.1.82

Temporary user should be deleted afterwards:

ssh root@192.168.1.82 "userdel tempuser; rm -rf /home/tempuser"

Project provisioning

Warning

Before using in production, you need to update the content of the error pages in the rewardsweb/templates/ directory, as well as the static/auth_privacy.html and static/auth_terms.html HTML pages to reflect your company name.

Use the following commands from the deploy directory to provision the Rewards Suite on your testing server:

# testing (virtual machine)
ansible-playbook --limit=testing site_playbook.yml

Similarly, for your production server use:

# production
ansible-playbook --limit=production site_playbook.yml

For debugging purpose, add -vv or -vvvv for more verbose output:

ansible-playbook -vv --limit=testing site_playbook.yml

In order to initially fetch issues from configured provider’s platform, the GITHUB_TOKEN environment variable should be set.

Upgrade system and project

Issue the following command if you want to fully upgrade system and Python packages to the latest versions:

ansible-playbook --limit=production --tags=upgrade site_playbook.yml

Update project code

After code has changed, issue the following command to apply those changes:

ansible-playbook --limit=production --tags=update-project-code site_playbook.yml