Kuemmel

Setup your device with this simple script and a single config file.

• Kuemmel
  • How to
    • Config file
    • Let there be order
    • Stages
      • Install stage
      • Download stage
    • Providers
      • Default
      • Custom
    • Running the setup
  • Run on a server

How to

Config file

In order to run the script you have to create your cyml file. This is a Yaml format.

Let there be order

At the top of the file is the order of the stages. The key is a single increasing number with the value being the name of the stage used later on.

order:
  1: "base"
  2: "docker_cfgs"
  3: "compose"

Stages

There are different types of stages.

Every stage requires a type and a provider key.

Install stage

This stage will add new packages from the package manager or some other source.

The type of this stage is always install.

# Install packages
base:
  type: install
  provider: apt
  packages: "git-core docker"

Download stage

In this stage you can download/copy files from one location to another.

The type of this stage is always download.

This stage type always requires a from and a to key.

# Download configs
docker_cfgs:
  type: download
  provider: git
  from: https://git.i-love-alpa.ca/server/docker-configs.git
  to: /docker/configs

Providers

Providers are used to support any action you may encounter while setting up your device.

Default

Default providers at this time are

• cyml
• apt
• git

Custom

In order to create your custom provider take a look at the default providers on how they are built.

Running the setup

Make sure you have the required providers in the scripts/ directory. Run the setup command with your file as the only argument.

./setup.sh config.cyml

Run on a server

Download this repository to somewhere on the PC you use to configure the new system.

Create a config file as described in Config file.

Transfer the files to your server and open a shell on the remote server.

Run the script as described in Running the setup where config.cyml is the file you just created.

Example:

git clone https://github.com/Alpaka-tech/Kuemmel.git # Do this on your local machine
cd Kuemmel
vim config.cyml # Create your config
tar zcf - printers scripts/* setup.sh config.cyml | ssh your-server 'cat - > cfg.tar.gz' # Transfer through SSH using a tar archive
ssh your-server # Now we start working on the remote server
tar xzf cfg.tar.gz # This will extract the required files
./setup.sh config.cyml # Run the config

Of course there are many other ways to achieve the same thing but this can be done in less than 10 steps.