Installation Mode

OpeNgine can be installed by using one of the two approaches:

  • Installation using Docker image

  • Advanced installation

Both options require cloning of the OpeNgine repository and filling out parameters in the configuration file.

Installation using Docker image

To start installation using docker image, navigate to root directory of cloned OpeNgine repo and run following command. Before starting docker installation make sure that you pass docker login command and export required variables

export ENV=environment_name
...

where environment_name the name of created configuration. Then start installation:

./opengine.sh install

OpeNgine will do next steps:

  • download latest docker image with all pre-installed components such as terraform, ansible, cloud cli(aws, gcp, azure) etc

  • mount local folder with OpeNgine code

  • expose environment variables and credentials to container

  • run OpeNgine provisioning inside docker container

Advanced installation

This installation mode relies on the make command and requires a list of software to be pre-installed on the system where the command is being executed.

make options

  • ENV - name of environment file to be used for OpeNgine provisioning. This a name of folder with ansible variables under vars folder

  • COMPONENTS - list of components of OpeNgine to be installed/destroyed during current run, default values is all That command will install only following components: vpc,k8s,helm

    make install ENV=project1 COMPONENTS=vpc,k8s,helm
    
  • SKIP - list of components of OpeNgine to be skipped during current run, default values is none. This option could be used as opposite to COMPONENTS if necessary to avoid installing some of components. That command will start installation directly from helm component, skipping vpc and k8s part.

    make install ENV=project1 SKIP=vpc,k8s
    
  • DEBUG - flag to enable showing additional information such as terraform plans and stdout of terraform command, default value is false. That command will install vpc part with printing terraform outputs.

    make install ENV=project1 COMPONENTS=vpc DEBUG=true
    

To start installation using make navigate to root directory of cloned OpeNgine repo and run following command:

make install ENV=environment_name

where environment_name the name of created configuration