Skip to content

Quick-Start

This four step guide aims to get you started with MiCADO. For more detail on this installation method, please see CLI Install.

Pre-requisites

First, provision a virtual machine in the cloud according to the requirements.

The following commands can be run from any device or instance that has Python 3.8 or higher, and SSH access to the newly provisioned instance. This can be a local device, or remote instance.

Steps

Install micado-client

pip install micado-client

Initialise a new config directory

The below example creates a new directory called micado_conf_dir

micado init micado_conf_dir
cd micado_conf_dir

Configure your deployment

It is mandatory to configure hosts

micado config hosts

micado config cloud 

micado config web

micado config registry

micado config settings

Example

The command above will open the specified configuration in your preferred editor.
Sample snippets of each config file are shown below.

Configure IP and username for SSH access to the control plane node.
If your SSH private key is not at a default path (e.g. .ssh/id_rsa) also specify path here

all:
  hosts:
    micado:
      ansible_host: 123.456.78.90
      ansible_connection: ssh
      ansible_user: ubuntu
      ansible_ssh_private_key_file: /path/to/private/key

Configure cloud credentials for desired clouds.
Please consider using ansible-vault to encrypt this file

resource:
- type: ec2
  auth_data:
    accesskey: ABC123DEF
    secretkey: 456XYZ789

Configure login and TLS for the MiCADO Dashboard and Submitter.
Please consider using ansible-vault to encrypt this file

tls:
  provision_method: self-signed
authentication:
  username: admin
  email: user@example.com
  password: s3cur3p4ssw0rd

Configure private registry mirror/auth details as a K3s registries file.

configs:
  registry-1.docker.io:
    auth:
      username: USERNAME
      password: PASSWORD

Configure various advanced settings. See the relevant section for details.

# enable specific components
# -------------------------------------------------------
enable_optimizer: False
enable_occopus: False
enable_terraform: True

# enable multicloud support
# -------------------------------------------------------
enable_multicloud: False

Deploy the MiCADO control plane

micado up

That's it! Have a look at our demos to start deploying applications.