DOCKERIMAGE: Docker Image
A Docker container image with its tag, build configuration, security scan results, and deployment tracking across environments.
DOCKERIMAGE 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 DOCKERIMAGE.Entity properties
| Property | Value |
|---|---|
| Entity code | DOCKERIMAGE |
| Display name | Docker Image |
| Plural | Docker Images |
| Level | 420 |
Use cases
DOCKERIMAGE is the container image catalogue entry. It captures the image name, tag, registry (objectLookup to DOCKERREGISTRY), full qualified name, and SHA256 digest. Image Details records description, base image lineage, architecture multiselect (amd64, arm64, etc.), OS, size, and layer count -- metadata essential for multi-arch builds and image optimisation. Status tracks the image lifecycle (Active, Deprecated, Archived, Building, Failed, Scanning) with timestamps for creation, push, and last pull plus usage counters. The Build panel stores the Dockerfile content alongside build arguments, context, target stage, platform targets, and cache sources, making the image reproducible without access to the source repo. Configuration captures runtime defaults (entrypoint, cmd, working dir, user, shell, env vars, exposed ports, volumes, healthcheck) as defined in the image. Labels and Metadata stores OCI labels, maintainer, vendor (objectLookup to VEN), version, and license. Security provides vulnerability scanning results with severity breakdown (critical/high/medium/low), signature verification, trusted registry status, and compliance classification. Dependencies records runtime dependencies, installed packages, linked services, and config requirements. The Deployments related-list links to K8SWORKLOAD by container image, showing where the image is running. Tags & Versions provides tag history and auto-tagging configuration. CI/CD tracks the build pipeline, git source, triggers, and build history. Monitoring captures pull rate, storage, network transfer, and cache efficiency.
Fields
Image Information
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | e.g., nginx, redis, mysql |
tag | text | Yes | e.g., latest, 1.21.0, stable |
registry | reference → DOCKERREGISTRY | Registry. | |
fullImageName | text | registry/namespace/name:tag Read only. | |
imageId | text | SHA256 digest Read only. |
Image Details
| Field | Type | Required | Notes |
|---|---|---|---|
description | text (multi-line) | Image purpose and contents | |
baseImage | text | Parent image | |
architecture | multiselect | Architecture. | |
os | enum | Valid ids: 1 (linux), 2 (windows), 3 (darwin). | |
size | number | Size (MB). Read only. | |
layers | number | Layers. Read only. |
Status & Usage
| Field | Type | Required | Notes |
|---|---|---|---|
status | enum | Yes | Valid ids: 1 (Active), 2 (Deprecated), 3 (Archived), 4 (Building), 5 (Failed), 6 (Scanning). |
createdDate | datetime | Created Date. Read only. | |
pushedDate | datetime | Pushed Date. Read only. | |
lastPulled | datetime | Last Pulled. Read only. | |
pullCount | number | Pull Count. Read only. | |
deploymentCount | number | Active Deployments. Read only. | |
targetCluster | reference → K8SCLUSTER | Target Cluster. | |
targetNamespace | reference → K8SNAMESPACE | Target Namespace. |
Dockerfile
| Field | Type | Required | Notes |
|---|---|---|---|
dockerfile | text (multi-line) | Dockerfile content | |
dockerfilePath | text | Path in repository |
Build Configuration
| Field | Type | Required | Notes |
|---|---|---|---|
buildArgs | text (multi-line) | ARG key=value pairs | |
buildContext | text | Build context path | |
targetStage | text | Multi-stage build target | |
buildPlatforms | text (multi-line) | Target platforms for multi-arch | |
cacheFrom | text (multi-line) | Images to use as cache |
Runtime Configuration
| Field | Type | Required | Notes |
|---|---|---|---|
entrypoint | text | Container entrypoint | |
cmd | text | Default command | |
workingDir | text | Working Directory. | |
user | text | Run as user | |
shell | text | Default shell |
Environment & Ports
| Field | Type | Required | Notes |
|---|---|---|---|
env | text (multi-line) | Default ENV vars (JSON) | |
exposedPorts | text (multi-line) | Container ports (JSON) | |
volumes | text (multi-line) | Volume mount points | |
healthcheck | text (multi-line) | Health check configuration (JSON) |
Image Labels
| Field | Type | Required | Notes |
|---|---|---|---|
labels | text (multi-line) | Image labels (JSON) | |
annotations | text (multi-line) | Additional metadata (JSON) | |
maintainer | text | Maintainer. | |
vendor | reference → VEN | Vendor. | |
version | text | Version. | |
license | text | License. |
Security Scanning
| Field | Type | Required | Notes |
|---|---|---|---|
scanEnabled | boolean | Security Scan Enabled. | |
lastScanDate | datetime | Last Scan Date. Read only. | |
vulnerabilities | text (multi-line) | Known vulnerabilities (JSON) Read only. | |
criticalCount | number | Critical. Read only. | |
highCount | number | High. Read only. | |
mediumCount | number | Medium. Read only. | |
lowCount | number | Low. Read only. |
Security Configuration
| Field | Type | Required | Notes |
|---|---|---|---|
signatureVerified | boolean | Signature Verified. Read only. | |
signedBy | text | Signed By. Read only. | |
trustedRegistry | boolean | From Trusted Registry. | |
complianceStatus | enum | Valid ids: 1 (Compliant), 2 (Non-compliant), 3 (Exempt), 4 (Unknown). | |
securityPolicies | text (multi-line) | Applied security policies | |
allowedNamespaces | multiselect | Allowed Namespaces. |
Image Dependencies
| Field | Type | Required | Notes |
|---|---|---|---|
dependencies | text (multi-line) | Required runtime dependencies | |
packages | text (multi-line) | Package list from scan Read only. | |
linkedServices | multiselect | Required external services | |
configRequirements | text (multi-line) | Required configs/secrets |
Version History
| Field | Type | Required | Notes |
|---|---|---|---|
tagHistory | text (multi-line) | Historical tags for this image Read only. | |
latestTag | text | Latest Tag. Read only. | |
stableTag | text | Stable Tag. Read only. | |
developmentTag | text | Development Tag. Read only. | |
autoTag | boolean | Auto-tagging Enabled. | |
tagPattern | text | Semantic versioning pattern |
Build Pipeline
| Field | Type | Required | Notes |
|---|---|---|---|
gitRepo | text (URL) | Git Repository. | |
gitBranch | text | Git Branch. | |
gitCommit | text | Git Commit. Read only. | |
buildPipeline | text | Build Pipeline. | |
buildTrigger | enum | Valid ids: 1 (Manual), 2 (Git Push), 3 (Pull Request), 4 (Schedule), 5 (Webhook). |
Build History
| Field | Type | Required | Notes |
|---|---|---|---|
lastBuildTime | datetime | Last Build. Read only. | |
lastBuildStatus | enum | Valid ids: 1 (Success), 2 (Failed), 3 (In Progress), 4 (Cancelled). | |
buildDuration | number | Build Duration (min). Read only. | |
buildCount | number | Total Builds. Read only. | |
buildHistory | text (multi-line) | Build History. Read only. |
Usage Metrics
| Field | Type | Required | Notes |
|---|---|---|---|
pullRate | number | Pull Rate (per day). Read only. | |
storageUsed | number | Storage Used (MB). Read only. | |
networkTransfer | number | Network Transfer (GB). Read only. | |
cacheHitRate | gauge | Cache Hit Rate %. Read only. | |
avgPullTime | number | Avg Pull Time (sec). Read only. | |
avgBuildTime | number | Avg Build Time (min). Read only. | |
failureRate | gauge | Failure Rate %. Read only. | |
availability | gauge | Availability %. Read only. |
Relationships
- Lookup:
registry(reference →DOCKERREGISTRY). - Lookup:
targetCluster(reference →K8SCLUSTER). - Lookup:
targetNamespace(reference →K8SNAMESPACE). - Lookup:
vendor(reference →VEN). - Related list:
K8SWORKLOAD, related list.
Creating a Docker Image via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "DOCKERIMAGE",
"level": 420,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example name",
"tag": "Example value",
"status": "1",
"description": "Example value"
}
Listing Docker Images records
GET /v1/entities/DOCKERIMAGE/SUB:<your-sub-id>