Skip to content

Latest commit

 

History

History
55 lines (47 loc) · 3.16 KB

lifecycle.md

File metadata and controls

55 lines (47 loc) · 3.16 KB
Raw

Execution Lifecycle

Lifecycle hooks

Within each tool directory, you can optionally have a bitops.before-deploy.d/ and/or a bitops.after-deploy.d/. If any shell scripts exist within these directories, BitOps will execute them in alphanumeric order.

This is a useful way to extend the functionality of BitOps. A popular use case we've seen is loading secrets, preparing the environment or dynamically editing bitops.config.yaml.

Detailed Execution Flow

lifecycle diagram

A single run of BitOps will:

  1. Copy the contents of /opt/bitops_deployment to a temporary working directory
  2. Attempt to setup a cloud provider
  3. If a terraform/ directory exists within the selected environment:
    • Run any bitops.before-deploy.d/*.sh scripts
    • Load bitops.config.yaml and set environment
    • Merge contents with Default environment - TODO
    • Select terraform version
    • Run terraform init
    • Select terraform workspace
    • Run terraform plan
    • Run terraform apply or terraform destroy
    • Run any bitops.after-deploy.d/*.sh scripts
  4. If a ansible/ directory exists within the selected environment:
    • Run any bitops.before-deploy.d/*.sh scripts
    • Load bitops.config.yaml and set environment
    • Merge contents with Default environment - TODO
    • Run ansible-playbook $playbook for each *.yaml or *.yml file in $env/ansible/
    • Run any bitops.after-deploy.d/*.sh scripts
  5. If a helm/ directory exists within the selected environment:
    • Run the following for $env/helm/$ENVIRONMENT_HELM_SUBDIRECTORY/ or for all charts in $env/helm/
      • Run any bitops.before-deploy.d/*.sh scripts
      • Load bitops.config.yaml and set environment
      • Merge contents with Default environment
      • Use $KUBE_CONFIG_PATH if defined, if not use AWS CLI to build .kubeconfig
      • Gather all values files - TODO document
      • Run helm dep up
      • Run helm upgrade or helm install
      • Run helm rollback on failure
      • Run any bitops.after-deploy.d/*.sh scripts
      • TODO helm_install_external_charts and helm_install_charts_from_s3 never run!
  6. If a cloudformation/ directory exists within the selected environment:
    • Run any bitops.before-deploy.d/*.sh scripts
    • Load bitops.config.yaml and set environment
    • Merge contents with Default environment - TODO
    • Run cfn template validation
    • Create or delete cfn stack. Wait for completion
    • Run any bitops.after-deploy.d/*.sh scripts

Environment Variables

Plugins can export the environment when a value is specified in an ops_repo level bitops.config.yaml. These environment variables are prefixed with BITOPS_ and their plugin name.

So for example, if the terraform plugin exported the environment variable BUTTER_FLAG, it would be accessible in the lifecycle hooks by referencing BITOPS_TERRAFORM_BUTTER_FLAG.