Environment Onboarding

3 min read

BuildPiper
Environment
Onboarding

Environment Onboarding #

An environment acts as a dedicated workspace that enables teams to build and deploy their services efficiently.

Environment Overview #

Typically, technology teams require a set of environments such as Development (Dev), Quality Assurance (QA), Staging (Stage), User Acceptance Testing (UAT), and Production (Prod) to ensure a reliable and structured release process for end users.

At the application level, project administrators can create the necessary environments, allowing team members to work, test, and validate their services. BuildPiper supports creating multiple environments within the same category.

Example: Two QA environments can be created — one for Feature 1 testing and another for Feature 2 testing.

In BuildPiper, an environment represents both a logical and physical construct. During environment creation, users must specify the Cluster and the Namespace within that cluster. This ensures that any service configured for that environment is deployed only in the selected namespace of the specified cluster. From a logical perspective, builds generated for a particular environment are available for deployment only within that environment. If the same build needs to be deployed to higher environments, it must be promoted accordingly.

Environment Configuration Details #

There are certain details that a platform team user should be aware of while onboarding a new environment onto BuildPiper. The details are elaborated below:

Field Configuration Guide
Choose Environment Type* Select the environment type (e.g., DEV, QA, STAGING, UAT, or PROD).
Environment Name* Provide a specific name to the environment for reference, such as ot-dev, ot-prod, etc.
Enable Hyper Build Select Yes to use parallel processing for faster Docker image creation; default is No.
Allow Manual Build* Select Yes to permit users to manually trigger a build process for this environment.
Allow Manual Deploy* Select Yes to permit users to manually trigger a deployment for this environment.
Deploy to Playstore* Select Yes only for mobile app services requiring automated releases to the Google Play Store.
Select Artifactory Choose the pre-configured binary repository where build artifacts (like .jar or .npm files) will be stored. This will be used for non-microservice based services.
Select Cluster* Map this environment to a specific Kubernetes Cluster from the dropdown list.
Select Namespace* Map this environment to a specific Namespace within the chosen cluster.
Select Database Tick the checkboxes for the databases (e.g., buildpiper-test-db) this environment needs to connect to.

Workflow: Onboarding an Environment via BP-UI #

BuildPiper (BP) workflow to onboard an environment is detailed out below:

Navigation Path
How to Access / Navigate
Login to BP

User Portal

Application

Select Application

Environment Overview

Add Environment
Final Step: Fill in the environment details and click Save to onboard the environment.

Note: The BP Environment onboarding page is accessible inside the User Portal.

BP Snapshots #

Reference screenshots showing the environment onboarding flow inside BuildPiper.

BP Snapshot: Onboarding a new environment onto an application in BP.

BP Snapshot: Onboarding a new environment onto an application in BP

BP Snapshot: Editing already onboarded environment in BP.

BP Snapshot: Editing already onboarded environment in BP

BuildPiper Documentation · Environment Onboarding

Last updated: May 2026