DOCKERBUILD: Docker Build
A Docker image build execution recording the pipeline run, source commit, build steps, test results, and output artifacts.
DOCKERBUILD definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches DOCKERBUILD.Entity properties
| Property | Value |
|---|---|
| Entity code | DOCKERBUILD |
| Display name | Docker Build |
| Plural | Docker Builds |
| Level | 422 |
Use cases
DOCKERBUILD represents a single build execution, distinct from DOCKERIMAGE which is the resulting artifact. The General panel links to the target DOCKERIMAGE (objectLookup), captures build number, status (Pending, Running, Success, Failed, Cancelled, Timeout), git repository/branch/commit, Dockerfile path, build context, and trigger type. Build Timing records start/end times, duration, queue time, build agent, and who triggered it -- essential for CI/CD pipeline analytics. Build Steps captures the pipeline as JSON with pre-build and post-build steps, enabling complex multi-stage workflows. Build Arguments handles Docker build args, multi-stage target, platform selection for multi-arch builds, environment variables, secrets, and SSH keys. Cache & Optimization configures BuildKit, cache sources/destinations, cache mode, layer squashing, parallel builds, and resource limits (CPU, memory, timeout), because build performance directly impacts developer productivity. Output records the destination registry (objectLookup to DOCKERREGISTRY), output tags, push status, image size, and layer count, plus artifacts like SBOM and build attestations for supply chain security. Testing covers unit, integration, security, smoke, and performance tests with pass/fail/skip counts and code coverage. Security provides vulnerability scanning with severity counts, signing configuration, and security policy enforcement. Logs stores the complete build output and error logs. Notifications configures per-build alerting. Metrics tracks build resource consumption and efficiency.
Fields
Build Information
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Build Name. |
targetImage | reference → DOCKERIMAGE | Yes | Target Image. |
buildNumber | number | Build Number. Read only. | |
buildId | text | Build ID. Read only. | |
status | enum | Yes | Valid ids: 1 (Pending), 2 (Running), 3 (Success), 4 (Failed), 5 (Cancelled), 6 (Timeout). |
Build Configuration
| Field | Type | Required | Notes |
|---|---|---|---|
gitRepository | text (URL) | Yes | Git Repository. |
gitBranch | text | Git Branch. | |
gitCommit | text | Git Commit. | |
dockerfilePath | text | Path to Dockerfile | |
buildContext | text | Build context directory | |
triggerType | enum | Valid ids: 1 (Manual), 2 (Git Push), 3 (Pull Request), 4 (Tag), 5 (Schedule), 6 (API), 7 (Webhook). | |
targetCluster | reference → K8SCLUSTER | Deploy to Cluster. | |
targetNamespace | reference → K8SNAMESPACE | Deploy to Namespace. |
Build Timing
| Field | Type | Required | Notes |
|---|---|---|---|
startTime | datetime | Start Time. Read only. | |
endTime | datetime | End Time. Read only. | |
duration | number | Duration (min). Read only. | |
queueTime | number | Queue Time (min). Read only. | |
buildAgent | text | Build Agent. Read only. | |
triggeredBy | reference → user | Triggered By. Read only. |
Build Pipeline
| Field | Type | Required | Notes |
|---|---|---|---|
buildSteps | text (multi-line) | Build pipeline steps (JSON) | |
preBuildSteps | text (multi-line) | Steps before Docker build | |
postBuildSteps | text (multi-line) | Steps after Docker build | |
currentStep | text | Current Step. Read only. | |
totalSteps | number | Total Steps. Read only. |
Build Arguments
| Field | Type | Required | Notes |
|---|---|---|---|
buildArgs | text (multi-line) | Docker build arguments (JSON) | |
buildTarget | text | Multi-stage target | |
buildPlatform | multiselect | Build Platforms. |
Environment Variables
| Field | Type | Required | Notes |
|---|---|---|---|
envVars | text (multi-line) | Build environment (JSON) | |
secrets | text (multi-line) | Secret references | |
sshKeys | text (multi-line) | SSH agent forwarding |
Build Optimization
| Field | Type | Required | Notes |
|---|---|---|---|
cacheEnabled | boolean | Cache Enabled. | |
cacheFrom | text (multi-line) | Images to use as cache sources | |
cacheTo | text | Cache export destination | |
cacheMode | enum | Valid ids: 1 (Min), 2 (Max), 3 (Inline), 4 (Registry). | |
buildKit | boolean | BuildKit Enabled. | |
squash | boolean | Squash Layers. | |
parallelBuilds | number | Parallel Builds. | |
cpuLimit | number | CPU cores | |
memoryLimit | number | Memory Limit (GB). | |
timeout | number | Timeout (min). |
Build Output
| Field | Type | Required | Notes |
|---|---|---|---|
outputRegistry | reference → DOCKERREGISTRY | Output Registry. | |
outputTags | text (multi-line) | Tags to apply to built image | |
pushEnabled | boolean | Auto Push. | |
pushStatus | enum | Valid ids: 1 (Not Pushed), 2 (Pushing), 3 (Pushed), 4 (Failed). | |
imageSize | number | Image Size (MB). Read only. | |
layerCount | number | Layer Count. Read only. |
Artifacts
| Field | Type | Required | Notes |
|---|---|---|---|
artifacts | text (multi-line) | Additional artifacts produced | |
sbom | text (multi-line) | Software Bill of Materials | |
attestations | text (multi-line) | Build attestations | |
exportPath | text | Local export path |
Build Testing
| Field | Type | Required | Notes |
|---|---|---|---|
testEnabled | boolean | Testing Enabled. | |
testType | multiselect | Test Types. | |
testResults | text (multi-line) | Test Results. Read only. | |
testsPassed | number | Tests Passed. Read only. | |
testsFailed | number | Tests Failed. Read only. | |
testsSkipped | number | Tests Skipped. Read only. | |
codeCoverage | gauge | Code Coverage %. Read only. |
Security Scanning
| Field | Type | Required | Notes |
|---|---|---|---|
securityScan | boolean | Security Scan Enabled. | |
scanResults | text (multi-line) | Scan Results. Read only. | |
criticalVulns | number | Critical. Read only. | |
highVulns | number | High. Read only. | |
mediumVulns | number | Medium. Read only. | |
lowVulns | number | Low. Read only. | |
securityPolicies | text (multi-line) | Applied security policies | |
signImage | boolean | Sign Image. | |
signingKey | text | Signing Key. |
Build Logs
| Field | Type | Required | Notes |
|---|---|---|---|
buildLog | text (multi-line) | Complete build output Read only. | |
errorLog | text (multi-line) | Error messages Read only. | |
logSize | number | Log Size (KB). Read only. | |
downloadLog | text (URL) | Download Log. Read only. |
Build Notifications
| Field | Type | Required | Notes |
|---|---|---|---|
notifyOnComplete | boolean | Notify on Complete. | |
notifyOnFailure | boolean | Notify on Failure. | |
notifyChannels | multiselect | Notification Channels. | |
notifyRecipients | text (multi-line) | Notification recipients | |
webhookURL | text (URL) | Webhook URL. | |
slackChannel | text | Slack Channel. | |
teamsChannel | text | Teams Channel. |
Build Metrics
| Field | Type | Required | Notes |
|---|---|---|---|
cpuUsage | gauge | CPU Usage %. Read only. | |
memoryUsage | gauge | Memory Usage %. Read only. | |
diskIO | number | Disk I/O (MB/s). Read only. | |
networkIO | number | Network I/O (MB/s). Read only. | |
cacheHitRate | gauge | Cache Hit Rate %. Read only. | |
layerReuse | gauge | Layer Reuse %. Read only. | |
buildEfficiency | gauge | Build Efficiency %. Read only. | |
cost | number | Build Cost. Read only. |
Relationships
- Lookup:
targetImage(reference →DOCKERIMAGE). - Lookup:
targetCluster(reference →K8SCLUSTER). - Lookup:
targetNamespace(reference →K8SNAMESPACE). - Lookup:
outputRegistry(reference →DOCKERREGISTRY).
Creating a Docker Build via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "DOCKERBUILD",
"level": 422,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example name",
"targetImage": "",
"status": "1",
"gitRepository": "https://example.com"
}
Listing Docker Builds records
GET /v1/entities/DOCKERBUILD/SUB:<your-sub-id>