Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 2.17 KB

configuration-base.md

File metadata and controls

39 lines (30 loc) · 2.17 KB

Base Configuration

Each deployment tool is traditionally controlled with a set of CLI arguments. Instead of defining arguments within your pipeline configuration, they can instead either be defined with environment variables or in a bitops.config.yaml file. While the core schema for a bitops.config.yaml file is common between tools, the specific properties and environment variable equivalents vary from tool to tool.

For more information on tool configuration, see plugins.


Base Schema

All bitops.config.yaml files share the following structure

$tool
  cli: {}
  options: {}
  • $tool - identifies the deployment tool
  • cli - object that contains CLI arguments
  • options - an object that offers additional control over how a tool executes

Arbitrary Environment Variables

During the docker run command, you can specify an ENV var and it will be accessible during all processing stages of BitOps.

Common Configuration

There are some global configuration options that are shared among all tools and cloud providers during a BitOps run. These are set via environment variables

Property Environment Variable Description Default Required
environment BITOPS_ENVIRONMENT Each BitOps run is done against a single environment. This property tells BitOps which environment to run. For more information on environments, see Operations Repo Structure. Yes
kubeconfig_base64 KUBECONFIG_BASE64 Base64 encoded kubeconfig file. Allows deployment tools to interact with a Kubernetes cluster. null No

Cloud Providers

Tool Configuration