Plugin implementation

[ConnorGraham]

Plugin implementation using Python (#54)

Overview

If plugin.config.yml (new file) is as follows

plugins:
- name: fav-color
  repo: https://github.com/ConnorGraham/bitops-sample-plugin.git

Then on docker build, scripts/setup/install_plugins.py is called to

1. git clone the fav-color repo to scripts/plugins/fav-color/
2. Call scripts/plugins/fav-color/install.sh if it exists

During BitOps execution, $SCRIPTS_DIR/plugins/deploy.py is called to loop through all plugins and:

1. set env vars PLUGIN_DIR and ENVIRONMENT_DIR
2. Call before hooks
3. Reconcile $PLUGIN_DIR/bitops.schema.yaml and $ENVIRONMENT_DIR/bitops.config.yaml
4. source env vars from previous setup along with CLI_OPTIONS
5. Call scripts/plugins/fav-color/deploy.sh
6. Call after hooks

Testing

Docker Build

We can see in the docker build -t temp . log, that

• https://github.com/ConnorGraham/bitops-sample-plugin is being cloned
• https://github.com/ConnorGraham/bitops-sample-plugin/blob/master/install.sh is being invoked

Cloning into '/opt/bitops/scripts/plugins/fav-color'...

When including a plugin in a BitOps install, this script will be called during docker build.
It should be used to install any dependencies required to actually run your plugin.
BitOps uses alpine linux as its base, so you'll want to use apk commands (Alpine Package Keeper)

musl
busybox
alpine-baselayout
alpine-keys
libcrypto1.1

Runtime

Operations Repo

My operations repo contains only 1 file test/fav-color/bitops.config.yaml:

my-fav-color:
  cli:
    version: 0.1.0
  options:
    name: connor
    color: red

BitOps execution (truncated):

We can see that

• https://github.com/ConnorGraham/bitops-sample-plugin/blob/master/deploy.sh is being invoked
• All expected env variables are present

connor@Connors-MacBook-Pro bitops-custom % docker run -e ENVIRONMENT=test -v $(pwd):/opt/bitops_deployment temp
making a temporary directory
TEMPDIR: /tmp/tmp.cMLNoH
environment variable (DEBUG) not set
Successfully Copied repo to /tmp/tmp.cMLNoH 

Loading BitOps Config for fav-color
Calling /opt/bitops/scripts/plugins/fav-color/deploy.sh

Welcome to the BitOps sample plugin!
The follow environment variables are available on every plugin:
PLUGIN_DIR: The root of your plugin directory. Useful if you want to invoke other scripts!
PLUGIN_DIR=/opt/bitops/scripts/plugins/fav-color

ENVIRONMENT_DIR: The location of your operations repo code for your plugin
ENVIRONMENT_DIR=/tmp/tmp.cMLNoH/test/fav-color

All the options defined in your plugin's bitops.schema.yaml. These values are overridden by bitops.config.yaml files in operations repos
MY_FAV_COLOR=red
MY_NAME=connor

Lastly, options defined as cli options will be formatted and available in the CLI_OPTIONS env var
CLI_OPTIONS= --version=0.1.0  

Lets test it out!
Hello connor! Your favourite color is red!


cleaning up...
/tmp/tmp.cMLNoH
removing temporary directory: /tmp/tmp.cMLNoH
BitOps Completed.% 

[dylan-bitovi]

I've been playing around with this and hashing it out with Connor over Slack. Everything looks good to me :)

[mickmcgrath13]

Let's get this hooked up prior to merging:
https://docs.docker.com/engine/reference/builder/#onbuild