tutorial.md

Tutorial

Here is a simple step-by-step tutorial that will show you where Hybrid Platforms Conductor can be useful to you, and how to use it to strengthen your DevOps processes.

Use-case

Congratulations! You are just appointed DevOps team member, and you are in charge of the different processes and platforms useful to your development and operations teams! Let's make them robust and agile!

You'll start small, by delevering small increments, and scaling little-by-little both your processes and platforms.

In the end you will achieve performing robust DevOps processes on various platforms using different technologies, and wrapping complex deployment/test/monitoring tasks in a very efficient and agile way.

You'll learn:

1. How to install and setup Hybrid Platforms Conductor.
2. How to deploy and check easily 1 node using existing plugins. See basic concepts and processes.
3. How to scale the process from 1 node to other ones, using other plugins. See how heterogenous environments and technologies integrate together.
4. How to test and monitor your processes. See how easy and robust it is to integrate that in a CI/CD.
5. How to extend the functionalities and adapt them to your very own technological choices by writing your own plugins easily.

Prerequisites

Docker: This tutorial requires a Linux distribution in which Docker is installed. Installing Docker is beyond the scope of this tutorial, so please refer to the official Docker documentation to know how to install Docker in your Linux distribution. To check that Docker is correctly installed, you should be able to run docker run hello-world and not run into any error.

Tutorial setup

This tutorial will use a dedicated Docker container to perform all operations to ensure you won't mess up with your system. However you can also consider installing Hybrid Platforms Conductor directly in your system without using Docker. Please make note however that Docker will be used to provisioned test nodes later in this tutorial.

To provision a simple Docker image to install and run this tutorial, we will use a Debian buster image to create a Docker container named hpc_tutorial:

docker create --name hpc_tutorial -it -v /var/run/docker.sock:/var/run/docker.sock debian:buster /bin/bash

Now everytime you need to access this tutorial container, issue the following:

docker start -ai hpc_tutorial

The tutorial assumes that all of the Hybrid Platforms Conductor commands will be executed from the bash instance of this hpc_tutorial container, as root.

All steps, command lines and files creations are explicitly detailed in the tutorial steps. No previous knowledge of Ruby is required to get through this tutorial.

If in doubt, you can always refer to the tutorial example folder to check files content. Please note however that the content of this example tutorial folder maps the content of the files at the end of each section of the tutorial (numberd from 01 to 05), and intermediate steps in the tutorial can modify such files. So the tutorial example folders may not reflect the expected content at an intermediate tutorial step.

Next >> Let's start by the first step: installation of your Hybrid Platforms Conductor's environment

---

Tutorial navigation

👇You are here👇 Introduction	1. Installation and first-time setup	2. Deploy and check a first node	3. Scale your processes	4. Testing your processes and platforms	5. Extend Hybrid Platforms Conductor with your own requirements
Use-case	Dependencies installation	Add your first node and its platform repository	Provision our web services platform	Hello test framework	Create your plugins' repository
Prerequisites	Our platforms' main repository	Check and deploy services on this node	Run commands on our new web services	Testing your nodes	Your own platform handler
Tutorial setup		Updating the configuration	Check and deploy our web services on several nodes at once	Testing your platforms' configuration	Write your own tests
				Other kinds of tests	Enough of stdout, we want to report to other tools
					What next?