Environments

An environment provides environment-level variables and run-time storage for project execution.

Initialize an environment

sequor env_init <path to env directory>

For example:

sequor env_init ~/sequor-env

Manage your environment

Directory structure

Each environment is defined as a folder with the following structure:

my-environment/               # Root directory of environment
├── logs/                     
│   └── sequor.log            # Sequor log file (viewed by the user)
├── project_state/            # Directory for storing run-time data for each project
│   └── project_name_1        # Directory for specific project
│       └── variables.yaml    # Project-level variables set during flow execution
│   ...
└── variables.yaml            # Environment-level variables (defined by the user)

In this structure, variables.yaml is maintained by the user, while logs and project_state are run-time data maintained by Sequor.

Environment variables

Environment variables define environment-level variables used in projects. They are typically used to store:

• Credentials (to avoid committing them to shared repositories)
• Parameters specific to development, QA, or production environments (such as db connection strings and file paths)

The variables.yaml file has the following structure:

<variable-name1>: <variable-value1>
...

For example:

postgres_conn_str: "postgresql://10.10.57.5:5432/sequor_stage_db"
postgres_username: "sequor"
postgres_password: "D0c$-Ex4mpl3-P@ssw0rd"

Set the active environment

Use the --env-dir CLI option to specify the path to your environment to use it for execution. For example:

sequor run my_flow --env-dir "/Users/john/sequor-env"