Infrastructure
==============

The infrastructure is still being setup, and is not final, however the documentation here serves both as a documentation of what we currently have setup and what we strive to setup.

Servers
=======

The main OpenAGPS infrastructure runs on leafcloud, which provides a OpenStack interface. The VMs run Flatcar Linux, and are configured with Butane.
The Butane scripts are processed by a python script, which adds the authorized SSH keys.

To create the Butane / Ignition scripts, clone the `infra <https://gitlab.com/openagps/infra>`_ repository and run the following command::

    ./generate.py --ssh-key "SSH PUBLIC KEY HERE" --run-butane

or::

    ./generate.py --ssh-key-file /path/to/ssh/public/key --run-butane

The processed Butane and Ignition files are created in the `processed` directory. This requires podman to be installed; if you do not have podman installed but wish to only template the 
butane files, omit the `--run-butane` argument.

Deploying
=========

The generate script supports automatically deploying the required instances onto OpenStack. You will need to have a suitable `clouds.yaml` file, and will need to make the needed adjustments
to the `deployments.yaml` file.

To enable automatic OpenStack deployment, use the following command::

    ./generate --ssh-key{-file} { } --run-butane --deploy-on-openstack

The `--run-butane` argument is required for OpenStack deployment.