BuildPiper
Service Onboarding
User Portal

Service Configuration #

Essential configuration details every platform team user should understand while onboarding a new service onto BuildPiper. This guide covers field requirements, the onboarding workflow, and strategic best practices to align with your existing development practices.

1. Service Configuration Overview #

There are certain details that a platform team user should be aware of while onboarding a new service onto BuildPiper. The platform supports multiple service architectures and build strategies, allowing teams to align onboarding with their existing development practices.

Multi-Architecture Support

BuildPiper supports microservices (containerised), VM-based legacy systems, and Android mobile builds from a single onboarding workflow.

Flexible Build Strategies

Choose between “Build once and promote” for Docker-based workflows or “Build for every environment” depending on your release model.

Configuration Fields #

The following fields are required when onboarding a new service through the BuildPiper UI.

Field Name	Configuration Guide
Service Name*	A unique identifier for the microservice (e.g., payment-gateway). Use alphanumeric characters and hyphens only.
Service Type*	Select the service architecture from the dropdown: microservice (containerised), VM-based (legacy/standalone), or Android (mobile builds).
Business Functions*	Specify the business vertical, functional role, or business category this service belongs to (e.g., “Order Processing”).
How do you build?*	Build once and promote: The same artifact/image moves through all environments (Dev → QA → Stage → UAT → Prod). Build for every environment: A new artifact is compiled specifically for each environment.

Workflow: Onboarding a Service via BP-UI #

The BuildPiper workflow to onboard a service is detailed below.

Navigation Path
How to Access / Navigate

Final Step: Fill in the service details and click Save to onboard the service.

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

Strategic Considerations for Onboarding Services #

Keep these two best practices in mind to simplify tracking and avoid environment-drift issues.

Naming Consistency

It is best practice to match the service name with your Git repository name to simplify tracking across the CI/CD pipeline.

Build Strategy

“Build once and promote” is the industry standard for Docker-based workflows. It ensures the exact code tested in lower environments reaches production, reducing “it worked in Dev but not in Prod” scenarios.

BP Snapshots #

Reference screenshots showing the service onboarding flow inside BuildPiper.

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

BP Snapshot: Onboarding a sample service by providing relevant details.

BuildPiper Documentation · Service Configuration

Last updated: May 2026