Getting Started

This quick introduction helps you start using AIOP quickly. Feel free to check out the demo video that covers the elements of this page.

You can install AIOP in a local Python environment or with Docker. For a local installation, follow the instructions below. For installation with Docker, refer to this section.

To make the installation of AIOP simple, we provide a one line command to execute in a shell terminal. The following button will put in your clipboard the command that you can paste into your shell and run:

Prerequisites

Python

A Python 3.9+ environment is required to use AIOP. If you don't have Python installed, you can download the following versions, depending on your operating system:

Python (3.9 +)Recommended (3.11.8)→Stable and recent (3.12.2)

The Python installation guide on Windows can be found here (opens in a new tab).

Code Editor

A code editor is also required to work with AIOP. You can use any code editor you prefer. However, we recommend using Visual Studio Code. We have specially designed shortcuts for VSCode. In the future, we will develop extensions for VSCode.

You can download Visual Studio Code by clicking the button below.

VSCode→

Installation

Create an AIOP Account (Optional)

Start by creating an AIOP account. If you don't have an account, click the button below to create one.

Install AIOP

Installing AIOP is simple. Open a terminal and run the following command:

pip install aiop --index-url https://gitlab.com/api/v4/projects/52727704/packages/pypi/simple

This will install AIOP and all its dependencies.

Download a Playbook Template

To use AIOP, you need a playbook. You can install a demo playbook template by running the following command:

aiop demo ./my-demo-playbook

This will download the playbook template into the my-playbook folder.

Generate Your First Package

You're finally there! You can now generate your first package by running the following command:

cd my-playbook
aiop build archi1/model_range1/model1 --apps app1 --envs dev --contexts context1

✅

Done, you've just generated your first package !

You can now see the generated package in the .build folder at the root of the playbook.

Docker

If you prefer to use Docker, you can install it by following the instructions below.

Install Docker

Install Docker on your machine:

Docker (opens in a new tab)

Download the Docker image

Download the aiop Docker image by running the following command:

docker pull registry.gitlab.com/aiop/aiop:latest

For a specific version, replace latest with the desired version.

docker pull registry.gitlab.com/aiop/aiop:0.3.1

For a development version:

docker pull registry.gitlab.com/aiop/aiop/dev:latest

(Recommended / Optional) Rename the image

To simplify the use of the Docker image, you can rename the image by running the following command:

docker tag registry.gitlab.com/aiop/aiop:latest aiop

Run aiop

To run aiop, execute the following command:

docker run -it registry.gitlab.com/aiop/aiop:latest

ℹ️

The -it option is used to run the container in interactive mode and allocate a pseudo-TTY.

Or, if you have renamed the image:

docker run aiop

Generate your first package

You can now generate your first package by running the following command:

docker run -v {local_playbook}:/playbook -v {path_to_aiop.yml}:/config/aiop.yml build {build_args}

You'll notice 3 arguments:

-v {local_playbook}:/playbook: local_playbook is the path to your playbook on your local machine.
-v {path_to_aiop.yml}:/config/aiop.yml: path_to_aiop.yml is the path to your aiop.yml file on your local machine.
build {build_args}: build_args are the package build arguments.

What's Next?

Now it's time to modify the playbook and make it your own. Move on to the configuration section to learn how to configure your playbook. Alternatively, you can watch an introductory video on AIOP here.

Configuration→

Demo→

Overview Demo