PUBLIC ALPHABiztraak is now in public alpha. Share feedback
Biztraak
Git & CI/CD
Private GitLab Build & Deploy Pipeline Unit Tests Environment Variables Deploy Web Services Configure Web Services

Component Environment Variables

Environment variables provide configuration and protected values to a deployed component. They are managed on the component and become available to the component according to its deployment and runtime configuration.

Manage variables in Biztraak

  1. Open a project and select a component.
  2. Open the component’s environment-variable settings.
  3. Add a variable name and value.
  4. Mark the value as protected when it contains a secret.
  5. Save the change and redeploy the component when the new value must be included in a running deployment.

Variables are scoped to the component. Review the component and project before changing a value that may affect a deployment or a dependent service.

Protected values

Use protected variables for API keys, passwords, tokens, and other values that should not be exposed in ordinary UI views or committed to source control.

  • Never put secrets in source code, Markdown, pipeline files, or screenshots.
  • Limit variable access to the team members and roles that need it.
  • Rotate a secret at its provider and update the protected variable afterward.
  • Treat a variable as available to a deployment only after checking the component’s deployment status and runtime configuration.

Naming and values

Use names that describe the setting, such as API_BASE_URL or LOG_LEVEL. Keep names consistent with the application or image consuming them.

Values are strings at the environment boundary. Applications should parse URLs, numbers, booleans, and structured values explicitly.

Troubleshooting

If a component cannot use a variable:

  1. Confirm the variable name matches the application’s expected name exactly.
  2. Confirm the variable belongs to the deployed component and intended environment.
  3. Confirm the value is protected when it is sensitive.
  4. Redeploy if the running workload was created before the variable was changed.
  5. Review deployment status and logs without exposing the variable value.

This page covers component runtime configuration in the Biztraak product. Repository and deployment-maintainer configuration is separate from these customer-managed component values.

Related documentation