8000 samson/plugins/env at master · irfanahmadein/samson · GitHub
[go: up one dir, main page]

Skip to content

Latest commit

 

History

History
 
 

env

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Env Plugin

Plugin to manage ENV settings for projects/stages/deploys and write .env files during deploy.

Stage ENV Vars

Can be used to have 1-off settings that differ from the project.

Deploy ENV Vars

Can be used to have generic stages to run one-off jobs or other tasks that need to be parameterized on each run. Since these pose a compliance problem, they can be disabled with the samson environment variable DEPLOY_ENV_VARS=false. Alternatively, only allow it via the API by using DEPLOY_ENV_VARS=api_only.

API

Includes /projects/:permalink/environment?deploy_group=permalink endpoint that returns the .env content for a project and deploy_group.

Service to manage environment variables

Run a service that writes config to an s3 bucket, 1 folder per project and 1 file per deploy group. To enable reading environment variables from an S3 bucket, set samson environment variables CONFIG_SERVICE_BUCKET and CONFIG_SERVICE_REGION. To support reading from a replicated S3 bucket on failure, also set CONFIG_SERVICE_DR_BUCKET and CONFIG_SERVICE_DR_REGION environment variables. Database environment variable config will override returned env variables.

For details, see app/models/environment_variable.rb

GitHub to manage environment variables

This plugin has an option to use a GitHub repository as source for environment variables. The DEPLOYMENT_ENV_REPO must be set in samson's start up to be the organization/repo.

Each project must opt-in to it via project settings.

The expected structure of this repository is a directory named generated with a sub directory for each project permalink samson deploys. Within this directory for a project are the deploy group .env files using the name of the deploy group permalink with a .env extension. For a project with the permalink data_processor and the deploy group permalinks staging1, prod1 and prod2 samson expects to see this directory tree:

.
├── deploy_groups.yml
├── generated
│   └── fake_project
│       ├── staging1.env
│       ├── prod1.env
│       └── prod2.env
├── projects
│   └── fake_project.env.erb
└── shared
    └── env_three.env.erb

The contents of the .env file is a sequence of environment variable key and value pairs.

# cat generated/fake_project/staging1.env
MAX_RETRY_ATTEMPTS=10
SECRETE_TOKEN=/secrets/SECRET_TOKEN
RAILS_THREAD_MIN=3
RAILS_THREAD_MAX=5

Merging enviroment variables stored in the database with those in the repo

The generated enviornment variables is the merger of deploy_group env variables, if the samson deploy_group plugin is activated, the project environment variables in the samson database and the environment variables in the github repo. The order of precedence for variables with the same key name: deploy_group replaces project which replaces repo variables.

The variables in the Samson database overwrite any variables in the repo.

0