base-rc (Base Remote Control)

Purpose: Setup and control a Cubbles-Base ... locally or on a remote host.

Prerequisite

If you want to use base-rc with local docker instance on windows you need to install docker-machine (comes with Docker Toolbox installation).

Usage

1. Clone the Repo
2. Open your git-bash and cd into the root directory

Basically you need to provide a .conf -file (../base-rc.local-setup/conf/xyz.conf) AND 1..n commands (lib/command-file.sh)

    # Usage instructions
    $ ./bin/run.sh
    
    # Example:
    $ ./bin/run.sh ../base-rc.local-setup/conf/local.conf lib/setup.sh

Configuration

Remote Control Configuration

The Remote Control (esp. the commands within the /lib folder) are configured using *.conf files. The default configuration is provided at etc/default.conf. Additional configuration is expected to be provided outside of the base-rc folder.

The config defines e.g. the host the command will be executed on (DOCKER_VBOX or DOCKER_REMOTE_HOST_IP)

Some configuration files for a local setup are prepared at https://github.com/cubbles/base-rc.local-setup:

• local.conf: Use this to setup and run a Cubbles Base locally using docker-machine and virtual box.
• local-ssh.conf: The same as local.conf but to exemplify the interaction via ssh only.

Base Configuration

The ../**/*.conf file refers to a local and a host -config folder:

ENV_LOCAL_CONFIG_FOLDERS="cubbles-base-local"
ENV_HOST_CONFIG_FOLDER="/mnt/sda1/tmp/base-config-local"

• ENV_LOCAL_CONFIG_FOLDERS: The local folder to manage additional resource for the Base instance a runtime.
  • The folder may contain any number of resources, but is expected to contain a docker-compose-<xyz>.yml file.
• ENV_HOST_CONFIG_FOLDER: The host folder all the (local) resources will be transferred to.
  • The folder will be created (and updated) automatically, when running the lib/setup.sh command.
  • Make sure your DOCKER_REMOTE_HOST_USER has the permissions to create this folder on the host.

Want to setup some individual configs? Just copy one of the existing files, adapt it to your needs and use it.

Known Issues

Known Issues are managed in JIRA. Your are welcome to raise a bug report or propose useful improvements.