CONTAINERRUNTIME: Container Runtime
The CONTAINERRUNTIME entity stores container runtimes. A running container instance on a host, tracking its lifecycle, resource usage, networking, storage, and health status.
CONTAINERRUNTIME 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 CONTAINERRUNTIME.Entity properties
| Property | Value |
|---|---|
| Entity code | CONTAINERRUNTIME |
| Display name | Container Runtime |
| Plural | Container Runtimes |
| Level | 423 |
Use cases
CONTAINERRUNTIME represents an actual running container as opposed to DOCKERIMAGE (the template) or K8SWORKLOAD (the Kubernetes abstraction). It captures the container ID, image (objectLookup to DOCKERIMAGE), host (objectLookup to COMPINV for the physical/virtual machine), and runtime status (Running, Stopped, Paused, Restarting, Created, Exited, Dead, Removing).
Fields
Container Information
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Container Name |
containerId | text | Container ID. Read-only | |
image | reference → DOCKERIMAGE | Yes | Image |
host | reference → COMPINV | Host | |
workload | reference → K8SWORKLOAD | K8s Workload | |
k8sNamespace | reference → K8SNAMESPACE | K8s Namespace | |
status | enum | Yes | Status. Valid ids: 1 (Running), 2 (Stopped), 3 (Paused), 4 (Restarting), 5 (Created), 6 (Exited), 7 (Dead), 8 (Removing). |
Runtime Configuration
| Field | Type | Required | Notes |
|---|---|---|---|
runtime | enum | Container Runtime. Valid ids: 1 (Docker), 2 (containerd), 3 (CRI-O), 4 (Podman), 5 (rkt), 6 (LXC). | |
restartPolicy | enum | Restart Policy. Valid ids: 1 (No), 2 (Always), 3 (On-failure), 4 (Unless-stopped). | |
restartCount | number | Restart Count. Read-only | |
maxRestarts | number | Max Restarts | |
privileged | boolean | Privileged | |
readOnly | boolean | Read-only Root |
Lifecycle
| Field | Type | Required | Notes |
|---|---|---|---|
createdDate | datetime | Created. Read-only | |
startedDate | datetime | Started. Read-only | |
finishedDate | datetime | Finished. Read-only | |
uptime | text | Uptime. Read-only | |
exitCode | number | Exit Code. Read-only | |
pid | number | Process ID. Read-only |
Resource Limits
| Field | Type | Required | Notes |
|---|---|---|---|
cpuLimit | number | CPU cores | |
cpuRequest | number | CPU cores | |
memoryLimit | number | Memory Limit (MB) | |
memoryRequest | number | Memory Request (MB) | |
memorySwap | number | Memory + Swap (MB) | |
sharedMemory | number | Shared Memory (MB) | |
diskQuota | number | Disk Quota (GB) | |
pidsLimit | number | PIDs Limit |
Resource Usage
| Field | Type | Required | Notes |
|---|---|---|---|
cpuUsage | text | CPU Usage %. Read-only | |
cpuThrottle | text | CPU Throttle %. Read-only | |
memoryUsage | text | Memory Usage %. Read-only | |
memoryUsedMB | number | Memory Used (MB). Read-only | |
diskUsed | number | Disk Used (GB). Read-only | |
networkIn | number | Network In (MB). Read-only | |
networkOut | number | Network Out (MB). Read-only | |
processCount | number | Process Count. Read-only |
Network Configuration
| Field | Type | Required | Notes |
|---|---|---|---|
networkMode | enum | Network Mode. Valid ids: 1 (Bridge), 2 (Host), 3 (None), 4 (Container), 5 (Custom). | |
hostname | text | Hostname | |
domainName | text | Domain Name | |
ipAddress | text | IP Address. Read-only | |
macAddress | text | MAC Address | |
dnsServers | text (multi-line) | One per line |
Port Mappings
| Field | Type | Required | Notes |
|---|---|---|---|
portMappings | text (multi-line) | host:container port mappings (JSON) | |
exposedPorts | text (multi-line) | Container exposed ports | |
networkAliases | text (multi-line) | Network-scoped aliases | |
extraHosts | text (multi-line) | Additional host entries |
Volume Mounts
| Field | Type | Required | Notes |
|---|---|---|---|
volumes | text (multi-line) | Volume mount configurations (JSON) | |
binds | text (multi-line) | Host path bindings | |
tmpfs | text (multi-line) | Temporary filesystem mounts |
Storage Configuration
| Field | Type | Required | Notes |
|---|---|---|---|
storageDriver | enum | Storage Driver. Valid ids: 1 (overlay2), 2 (aufs), 3 (devicemapper), 4 (btrfs), 5 (zfs), 6 (vfs). | |
readOnlyRootfs | boolean | Read-only Root FS | |
volumesFrom | text | Inherit volumes from containers | |
workingDir | text | Working Directory |
Environment Configuration
| Field | Type | Required | Notes |
|---|---|---|---|
environment | text (multi-line) | Container environment (JSON) | |
envFile | text (multi-line) | Environment file paths | |
user | text | User:Group | |
workingDirectory | text | Working Directory | |
entrypoint | text | Entrypoint | |
command | text | Command | |
labels | text (multi-line) | Container labels (JSON) |
Security Context
| Field | Type | Required | Notes |
|---|---|---|---|
securityOpts | text (multi-line) | Security options (JSON) | |
capabilities | text (multi-line) | Linux capabilities (JSON) | |
apparmor | text | AppArmor Profile | |
selinux | text | SELinux Context | |
noNewPrivileges | boolean | No New Privileges | |
userNamespace | boolean | User Namespace |
Runtime Security
| Field | Type | Required | Notes |
|---|---|---|---|
seccompProfile | text | Seccomp Profile | |
devices | text (multi-line) | Allowed devices (JSON) | |
ulimits | text (multi-line) | Resource limits (JSON) | |
sysctls | text (multi-line) | Kernel parameters (JSON) | |
cgroupParent | text | Cgroup Parent |
Health Check
| Field | Type | Required | Notes |
|---|---|---|---|
healthcheck | text (multi-line) | Health check configuration (JSON) | |
healthStatus | enum | Health Status. Valid ids: 1 (Healthy), 2 (Unhealthy), 3 (Starting), 4 (None). | |
healthCheckInterval | number | Check Interval (sec) | |
healthCheckTimeout | number | Check Timeout (sec) | |
healthCheckRetries | number | Retries | |
healthCheckStartPeriod | number | Start Period (sec) | |
lastHealthCheck | datetime | Last Health Check. Read-only | |
failingStreak | number | Failing Streak. Read-only |
Container Logs
| Field | Type | Required | Notes |
|---|---|---|---|
logDriver | enum | Log Driver. Valid ids: 1 (json-file), 2 (syslog), 3 (journald), 4 (gelf), 5 (fluentd), 6 (awslogs), 7 (splunk), 8 (none). | |
logOptions | text (multi-line) | Log driver options (JSON) | |
logs | text (multi-line) | Recent Logs. Read-only | |
logSize | number | Log Size (MB). Read-only | |
maxLogSize | number | Max Log Size (MB) |
Container Events
| Field | Type | Required | Notes |
|---|---|---|---|
events | text (multi-line) | Container lifecycle events. Read-only | |
lastEvent | datetime | Last Event. Read-only | |
startCount | number | Start Count. Read-only | |
stopCount | number | Stop Count. Read-only | |
errorCount | number | Error Count. Read-only |
Performance Metrics
| Field | Type | Required | Notes |
|---|---|---|---|
cpuPercent | text | CPU %. Read-only | |
memoryPercent | text | Memory %. Read-only | |
diskIORead | number | Disk Read (MB/s). Read-only | |
diskIOWrite | number | Disk Write (MB/s). Read-only | |
networkRxRate | number | Network RX (MB/s). Read-only | |
networkTxRate | number | Network TX (MB/s). Read-only | |
blockIORead | number | Block IO Read. Read-only | |
blockIOWrite | number | Block IO Write. Read-only |
Container Actions
| Field | Type | Required | Notes |
|---|---|---|---|
actionButtons | text (multi-line) | Start, Stop, Restart, Pause, Kill, Remove. Read-only | |
lastAction | text | Last Action. Read-only | |
lastActionTime | datetime | Last Action Time. Read-only | |
executionHistory | text (multi-line) | Commands executed in container. Read-only |
Relationships
- Lookups:
imagepoints at aDOCKERIMAGErecord;hostpoints at aCOMPINVrecord;workloadpoints at aK8SWORKLOADrecord;k8sNamespacepoints at aK8SNAMESPACErecord.
Creating a Container Runtime via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "CONTAINERRUNTIME",
"level": 423,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example value",
"image": "",
"status": "1",
"k8sNamespace": ""
}
Listing Container Runtimes
GET /v1/entities/CONTAINERRUNTIME/SUB