System Settings: Deployment and Platform #
This document covers five categories: Deployment & CD Configuration (21 settings), BP Versioning Management (3), Database (1), Application Level Settings (2) and Service Level Settings (2).
1. Deployment & CD Configuration #
Figure 1: Deployment & CD Configuration, Configurations table
Canary Based Deployment Configuration #
Configures the naming convention for canary deployments. Each new canary deployment in Kubernetes needs a unique name, so a suffix is added to keep it unique across rollouts.
| Field | What it does |
|---|---|
| Convention Add Suffix in Canary Deployment | The suffix that is added to Kubernetes deployment names for canary releases. |
Read more: Canary Deployment
Figure 2: Canary Based Deployment Configuration setting
Environment Hierarchy for Artifacts Promote #
Defines the environment hierarchy that is used when artifacts are promoted, which sets the order in which artifacts move across environments.
| Field | What it does |
|---|---|
| Environment Hierarchy for Promote the Build Tags | The allowed promotion sequence, for example dev → qa → staging → production. |
Read more: Promote
Load Artifacts for Deployment #
Configures how build artifacts are discovered and loaded for deployment. Build tags are loaded from the database when a deployment is selected, and filtered as set below.
| Field | What it does |
|---|---|
| Deployment Tags Load Regex Pattern | A regular expression for each project and environment that filters the registry tags, in the format {“Project”: {“Env”: “regex”}}. |
| Deployment Tags Count | The maximum number of tags listed for deployment. |
Transactional Rollback #
Sets how many old versions of ConfigMaps and Secrets are kept for transactional rollback.
| Field | What it does |
|---|---|
| No of Count to Persist of ConfigMap Version | How many old ConfigMap versions are kept before they are removed automatically. |
| No of Count to Persist of Secret Version | How many old Secret versions are kept before they are removed automatically. |
Read more: ConfigMaps
Secrets
Deployment Phase Tracker #
Configures deployment phase tracking and visibility in the deployment logs.
| Field | What it does |
|---|---|
| Deployment Phase Tracker in Logs | Records deployment milestones in the logs. |
Task Time Out Limit #
Shows the timeout behavior of deployment and promotion tasks.
No editable fields are shown here. The timeouts are set under Task Time Out Limit Build, in the Build and CI document.
Environment Master Manual Deploy #
Shows the manual deployment permissions across environments.
No editable fields are shown here. Set them under Environment Master Manual Build, in the Build and CI document.
Env Offline Actions #
Configures the actions that are permitted when an environment is offline.
| Field | What it does |
|---|---|
| Disable Deploy If Env Offline | Blocks deployments to offline or maintenance environments. |
Multi Cluster Deploy #
Configures the deployment of services across multiple Kubernetes clusters.
| Field | What it does |
|---|---|
| Multi Cluster Deploy | Deploys the same service to multiple clusters in one pipeline run. |
Canary Deployment #
Configures canary deployment behavior and recovery handling.
| Field | What it does |
|---|---|
| Canary Deployment on Service Level | Enables the Canary Deployment strategy at the service level, allowing a portion of traffic to be directed to the new application version for validation before it is fully deployed. |
| Pass Canary on Deployment Delete Failure | Allows the deployment to proceed even if deletion of the previous canary deployment fails. |
| Rollback Canary on Pipeline Revoked | Rolls back the canary when the pipeline is cancelled or revoked. |
Read more: Canary Deployment
Canary Setup and Pipeline
Figure 3: Canary Deployment setting
Cleanup of Deployments, ConfigMaps and Secrets #
Configures the cleanup of old deployments, ConfigMaps and Secrets.
| Field | What it does |
|---|---|
| ConfigMap Cleanup Enable | Removes ConfigMap versions beyond the retention limit. |
| Secret Cleanup Enable | Removes Secret versions beyond the retention limit. |
| Environment Level Deployment Cleanup | JSON, for example {“prod”: false, “dev”: true}, that allows or blocks deletion of deployments for each environment. |
Read more: ConfigMaps
Secrets
Canary Analysis #
Configures the evaluation and rollback behavior of canary analysis.
| Field | What it does |
|---|---|
| Rollback in Case of Multi-Cluster Deployment | Rolls back across clusters when a canary fails. |
| Metric Weight Min Value / Max Value | The allowed range of metric weights. |
| Canary Analysis Public API Domain | The domain that is used to push canary metrics. |
Read more: Canary Analysis Templates
Canary Approval and Rollback
Release Package #
Configures change detection and related behavior for release packages.
| Field | What it does |
|---|---|
| Enable Change Detection | Detects the entities that were modified between releases. |
| Change Detection List | The types to check: CONFIGMAP, SECRET and DATABASE. |
Read more: Release Packages
Manifest Branch Name #
Configures the branch selection behavior for deployment manifests.
| Field | What it does |
|---|---|
| Manifest Branch Name | The Git branch that is checked out from the manifest repository. It defaults to the branch configured for the repository. |
Cluster Autoscale Timeout #
Configures the timeout behavior for Kubernetes workload autoscaling.
| Field | What it does |
|---|---|
| Autoscale Timeout Flag / Autoscale Timeout | The wait limit, in seconds, for pod autoscaling. |
| Minimum Replica Timeout Flag / Minimum Replica Timeout | The wait limit for reaching the minimum replica count. |
Restart Pod on Each Deployment #
Configures pod restart behavior after deployments.
No editable fields are shown here. The switch is under Change Freeze Approve, in the Security, Audit and Network document.
Concurrent Promote #
Configures workspace isolation for concurrent promotions.
| Field | What it does |
|---|---|
| Concurrent Promote Enable | Runs each promotion in its own isolated workspace. |
Read more: Promote
Pod Terminal Policy #
Configures the command-access policies for pod terminal sessions.
| Field | What it does |
|---|---|
| Enable Command Execution | Allows terminal access to running containers. |
| Command Restriction Method | How commands are restricted: Allow or Block. It decides how the expression fields below are applied. |
| Starts With / Ends With / Contains / Matches Expression (Regex) | The patterns that match the commands to restrict. Enter comma-separated values, for example rm,sudo,apt in Starts With Expression. |
Read more: Service Monitoring
Figure 4: Pod Terminal Policy setting
Multi-Namespace Selection #
Configures the selection and use of multiple Kubernetes namespaces at the environment level.
| Field | What it does |
|---|---|
| Enable Multi-Namespace Select | Lets an environment use multiple Kubernetes namespaces. |
Read more: Namespace
Canary Pre Check #
Configures when the canary pre-deployment check is applied.
| Field | What it does |
|---|---|
| Disable Canary Pre-Checks Globally | Skips the canary pre-checks for all applications. |
| Applications with Canary Pre-Checks Disabled | Skips the pre-checks only for the listed applications. It is used when the global switch is off. |
Read more: Canary Setup and Pipeline
Redeploy Namespace on Token Refresh #
Configures namespace redeployment after registry credentials change.
| Field | What it does |
|---|---|
| Redeploy Namespaces on Token/Credentials Update | Redeploys the namespaces of a registry after its token or credentials change. |
Read more: Container Registries
2. BP Versioning Management #
Figure 5: BP Versioning Management, Configurations table
Support CD Versioning #
Configures the versioning behavior for CD details. It tracks deployment versions and maintains controlled release histories.
| Field | What it does |
|---|---|
| CD Versioning Enable | Tracks changes to deployment (CD) configurations, for auditing and history. |
Support CI Versioning #
Configures the versioning behavior for CI details. It tracks and manages build versions across the CI pipeline.
| Field | What it does |
|---|---|
| CI Versioning Enable | Tracks changes to build (CI) configurations, for auditing and history. |
BuildPiper Versioning #
Configures BuildPiper-managed versioning and its governance. It tracks version information across the platform, with approval rules.
| Field | What it does |
|---|---|
| Enable BuildPiper Versioning | Generates and maintains version information for the supported build and deployment operations. |
| Enable BuildPiper Versioning Approval | Requires approval before version metadata is committed to the versioning repository. |
| BP Versioning Approval Kind List | The entity types that need approval before a commit. The options are BPServiceCI, BPServiceCD, BPPipeline, BPConfigmap, BPSecret and BPServiceCdHPA. |
| BP Versioning Repo Name | The Git repository that stores the versioning metadata and history. |
| BP Versioning Repo Branch | The branch of that repository where version commits go. |
3. Database #
Figure 6: Database, Configurations table
Database Management #
Configures the supported database management and tuning options. It lists the database parameters that the database management module supports.
| Field | What it does |
|---|---|
| PostgreSQL Supported Global Parameter List | The PostgreSQL global parameters that are available in the database management module. |
| PostgreSQL Supported Performance Parameter List | The PostgreSQL performance-tuning parameters that are available in the module. |
4. Application Level Settings #
Figure 7: Application Level Settings, Configurations table
Pin Application #
Controls the option to pin applications for quick access.
No editable fields are shown here. The switch is under Pin Micro Services, in the Integrations and Feature Flags document.
Clone Env Settings #
Chooses which settings are copied when an environment is cloned.
| Field | What it does |
|---|---|
| Clone Configuration DB and Middleware Types | The configuration types that are copied when an environment is cloned, such as secrets, ConfigMaps and pipelines. |
Read more: Environment Clone
5. Service Level Settings #
Figure 8: Service Level Settings, Configurations table
Business Function #
Controls whether a service needs a business function.
| Field | What it does |
|---|---|
| Business Function Required for Services | Requires a business function to be set when a service is created or configured. |
Restrict Services #
Limits the number of services.
| Field | What it does |
|---|---|
| Restrict Services | Limits how many services can be created in an application. |