Pak.yml Reference¶
This is the reference documentation for the pak.yml file.
Reference List¶
bitbucket_key¶
Set the environment variable which holds your Bitbucket App Password
bitbucket_key: MY_BITBUCKET_APP_PASSWORD
In the environment key you set the app password: MY_BITBUCKET_APP_PASSWORD="username:password"
Note
The format for the bitbucket app password in the environment key must be: username:password
.
clone_dir¶
Set the base path where the projects will be cloned:
envs:
virtualenv:
clone_dir: /tmp
Outpak will generate a full path for each project, using the base path provided and the project name found in url:
For example, if url is git+git@git.myproject.org:MyProject and clone_dir is /tmp
the cloning path will be /tmp/myproject
.
You need to inform a full path, do not use relative paths.
Note
Make sure the current user can be the right permissions to save in this directory.
env_key¶
Set the environment variable which control your Project environment.
env_key: MY_ENVIRONMENT_KEY
envs¶
Returns a list of possible values for the enviroment key defined env_key
:
env_key: MY_ENVIRONMENT_KEY
envs:
Virtualenv:
key_value: development
Docker:
key_value: docker
Staging:
key_value: stage
Production:
key_value: prod
At least one enviroment must be set.
Note
Make sure you have create entries for all possible values for your environment key.
files¶
Returns a list of requirement.txt
files must be processed for each enviroment defined:
env_key: MY_ENVIRONMENT_KEY
envs:
Dev:
key_value: development
files:
- requirements.txt
- requirements_test.txt
Prod:
key_value: prod
files:
- requirements.txt
github_key¶
Set the environment variable which holds your Git Personal Token
github_key: MY_GIT_PERSONAL_TOKEN
key_value¶
OutPak will get value found inside the environment variable you define in env_key
to find the correct env to process the requirement.txt
files.
env_key: MY_ENVIRONMENT_KEY
envs:
Virtualenv:
key_value: development
clone_dir: /tmp
Docker:
key_value: docker
clone_dir: /opt/src
Staging:
key_value: stage
clone_dir: /opt/src
Production:
key_value: prod
clone_dir: /opt/src
For example, if the env MY_ENVIRONMENT_KEY="development"
, then Outpak will use the /tmp
as base path for cloning projects.