Glossary

Core Concepts

Agent

A software component installed on deployment targets that receives and executes deployment tasks. Agents communicate with the orchestrator via mTLS and execute deployments locally on the target.

Approval

A human decision to authorize a promotion request. Approvals may require multiple approvers and enforce separation of duties.

Approval Policy

Rules defining who can approve promotions to specific environments, including required approval counts and SoD requirements.

Blue-Green Deployment

A deployment strategy using two identical production environments. Traffic switches from “blue” (current) to “green” (new) after validation.

Canary Deployment

A deployment strategy that gradually rolls out changes to a small subset of targets before full deployment, allowing validation with real traffic.

Channel

A version stream for components (e.g., “stable”, “beta”, “nightly”). Each channel tracks the latest compatible version.

Component

A deployable unit mapped to a container image repository. Components have versions tracked via digest.

Compose Lock

A Docker Compose file with all image references pinned to specific digests, ensuring reproducible deployments.

Connector

A plugin that integrates Release Orchestrator with external systems (registries, CI/CD, notifications, etc.).

Decision Record

An immutable record of all gate evaluations and conditions considered when making a promotion decision.

Deployment Job

A unit of work representing the deployment of a release to an environment. Contains multiple deployment tasks.

Deployment Task

A single target-level deployment operation within a deployment job.

Digest

A cryptographic hash (SHA-256) that uniquely identifies a container image. Format: sha256:abc123...

Drift

A mismatch between the expected deployed version (from version sticker) and the actual running version on a target.

Environment

A logical grouping of deployment targets representing a stage in the promotion pipeline (e.g., dev, staging, production).

Evidence Packet

An immutable, cryptographically signed record of deployment decisions and outcomes for audit purposes.

Freeze Window

A time period during which deployments to an environment are blocked (e.g., holiday code freeze).

Gate

A checkpoint in the promotion workflow that must pass before deployment proceeds. Types include security gates, approval gates, and custom policy gates.

Promotion

The process of moving a release from one environment to another, subject to gates and approvals.

Release

A versioned bundle of component digests representing a deployable unit. Releases are immutable once created.

Rolling Deployment

A deployment strategy that updates targets in batches, maintaining availability throughout the process.

Rollback

The process of reverting to a previous release version when a deployment fails or causes issues.

Security Gate

An automated gate that evaluates security policies (vulnerability thresholds, compliance requirements) before allowing promotion.

Separation of Duties (SoD)

A security principle requiring that the person who requests a promotion cannot be the same person who approves it.

Step

A single unit of work within a workflow template. Steps have types (deploy, approve, notify, etc.) and can have dependencies.

Target

A specific deployment destination (host, service, container) within an environment.

Tenant

An isolated organizational unit with its own environments, releases, and configurations. Multi-tenancy ensures data isolation.

Version Map

A mapping of image tags to digests for a component, allowing tag-based references while maintaining digest-based deployments.

Version Sticker

Metadata placed on deployment targets indicating the currently deployed release and digest.

Workflow

A DAG (Directed Acyclic Graph) of steps defining the deployment process, including gates, approvals, and verification.

Workflow Template

A reusable workflow definition that can be customized for specific deployment scenarios.

Module Abbreviations

AbbreviationFull NameDescription
INTHUBIntegration HubExternal system integration
ENVMGREnvironment ManagerEnvironment and target management
RELMANRelease ManagementComponent and release management
WORKFLWorkflow EngineWorkflow execution
PROMOTPromotion & ApprovalPromotion and approval handling
DEPLOYDeployment ExecutionDeployment orchestration
AGENTSDeployment AgentsAgent management
PROGDLProgressive DeliveryA/B and canary releases
RELEVIRelease EvidenceAudit and compliance
PLUGINPlugin InfrastructurePlugin system

Deployment Strategies

StrategyDescription
All-at-onceDeploy to all targets simultaneously
RollingDeploy in batches with availability
CanaryGradual rollout with metrics validation
Blue-GreenParallel environment with traffic switch

Status Values

Promotion Status

StatusDescription
pendingPromotion created, not yet evaluated
pending_approvalWaiting for human approval
approvedApproved, ready for deployment
rejectedRejected by approver
deployingDeployment in progress
completedSuccessfully deployed
failedDeployment failed
cancelledCancelled by user

Deployment Job Status

StatusDescription
pendingJob created, not started
preparingGenerating artifacts
runningTasks executing
completingVerifying deployment
completedSuccessfully completed
failedDeployment failed
rolling_backRollback in progress
rolled_backRollback completed

Agent Status

StatusDescription
onlineAgent connected and healthy
offlineAgent not connected
degradedAgent connected but reporting issues

Target Health Status

StatusDescription
healthyTarget responding correctly
unhealthyTarget failing health checks
unknownHealth status not determined

API Error Codes

CodeDescription
RELEASE_NOT_FOUNDRelease ID does not exist
ENVIRONMENT_NOT_FOUNDEnvironment ID does not exist
PROMOTION_BLOCKEDPromotion blocked by gate or freeze
APPROVAL_REQUIREDPromotion requires approval
INSUFFICIENT_APPROVALSNot enough approvals
SOD_VIOLATIONSeparation of duties violated
FREEZE_WINDOW_ACTIVEEnvironment in freeze window
SECURITY_GATE_FAILEDSecurity requirements not met
NO_AGENT_AVAILABLENo agent available for target
DEPLOYMENT_IN_PROGRESSAnother deployment running
ROLLBACK_NOT_POSSIBLENo previous version to rollback to

Integration Types

TypeCategoryDescription
docker-registryRegistryDocker Registry v2
ecrRegistryAWS ECR
acrRegistryAzure Container Registry
gcrRegistryGoogle Container Registry
harborRegistryHarbor Registry
gitlab-ciCI/CDGitLab CI/CD
github-actionsCI/CDGitHub Actions
jenkinsCI/CDJenkins
slackNotificationSlack
teamsNotificationMicrosoft Teams
emailNotificationEmail (SMTP)
hashicorp-vaultSecretsHashiCorp Vault
prometheusMetricsPrometheus

Workflow Step Types

TypeCategoryDescription
approvalControlWait for human approval
waitControlWait for duration
conditionControlBranch based on condition
parallelControlExecute children in parallel
security-gateGateEvaluate security policy
custom-gateGateCustom OPA policy
freeze-checkGateCheck freeze windows
deploy-dockerDeployDeploy single container
deploy-composeDeployDeploy Compose stack
health-checkVerifyHTTP/TCP health check
smoke-testVerifyRun smoke tests
notifyNotifySend notification
webhookIntegrationCall external webhook
trigger-ciIntegrationTrigger CI pipeline
rollbackRecoveryRollback deployment

Security Terms

TermDescription
mTLSMutual TLS - both client and server authenticate with certificates
JWTJSON Web Token - used for API authentication
RBACRole-Based Access Control
OPAOpen Policy Agent - policy evaluation engine
SoDSeparation of Duties
PEPPolicy Enforcement Point

References