K8SCLUSTER: K8s Cluster
A Kubernetes cluster representing the top-level compute environment with its nodes, networking, storage, and monitoring configuration.
Default definition. This article describes the default
K8SCLUSTER 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 K8SCLUSTER.Entity properties
| Property | Value |
|---|---|
| Entity code | K8SCLUSTER |
| Display name | K8s Cluster |
| Plural | K8s Clusters |
| Level | 400 |
Use cases
K8SCLUSTER is the root entity in the Kubernetes hierarchy. It captures the physical and logical topology of a cluster including provider (EKS, AKS, GKE, on-prem), Kubernetes version, and environment classification (prod, staging, dev). The General panel groups identity, access/connectivity (API endpoint, auth methods, RBAC), and a read-only resource summary so operators see capacity at a glance.
Fields
Cluster Information
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Cluster Name. |
environment | enum | Yes | Valid ids: 1 (Production), 2 (Staging), 3 (Development), 4 (Test), 5 (DR). |
provider | enum | Yes | Valid ids: 1 (AWS EKS), 2 (Azure AKS), 3 (Google GKE), 4 (On-Premise), 5 (OpenShift), 6 (Rancher), 7 (Other). |
region | text | Region/Location. | |
kubernetesVersion | text | Yes | Kubernetes Version. |
status | enum | Yes | Valid ids: 1 (Active), 2 (Maintenance), 3 (Degraded), 4 (Failed), 5 (Provisioning), 6 (Decommissioned). |
Access & Connectivity
| Field | Type | Required | Notes |
|---|---|---|---|
apiEndpoint | text (URL) | Yes | API Endpoint. |
dashboardUrl | text (URL) | Dashboard URL. | |
authMethod | array of enums | Valid ids: 1 (Certificate), 2 (Token), 3 (OIDC), 4 (LDAP), 5 (SAML). | |
rbacEnabled | boolean | RBAC Enabled. | |
podSecurityPolicy | boolean | Pod Security Policy. | |
networkPolicy | boolean | Network Policies Enabled. |
Resource Summary
| Field | Type | Required | Notes |
|---|---|---|---|
nodeCount | number | Total Nodes. | |
namespaceCount | number | Namespaces. | |
podCount | number | Total Pods. | |
serviceCount | number | Services. | |
cpuTotal | number | Total CPU (cores). | |
memoryTotal | number | Total Memory (GB). | |
storageTotal | number | Total Storage (GB). |
Node Configuration
| Field | Type | Required | Notes |
|---|---|---|---|
masterNodes | number | Master Nodes. | |
workerNodes | number | Worker Nodes. | |
nodeInstanceType | text | Node Instance Type. | |
nodeOS | text | Node OS. | |
containerRuntime | enum | Valid ids: 1 (containerd), 2 (Docker), 3 (CRI-O). | |
autoScaling | boolean | Auto Scaling Enabled. | |
minNodes | number | Min Nodes. | |
maxNodes | number | Max Nodes. |
Networking
| Field | Type | Required | Notes |
|---|---|---|---|
cniPlugin | enum | Valid ids: 1 (Calico), 2 (Flannel), 3 (Weave), 4 (Cilium), 5 (AWS VPC CNI), 6 (Azure CNI). | |
serviceCIDR | text | Service CIDR. | |
podCIDR | text | Pod CIDR. | |
ingressController | array of enums | Valid ids: 1 (NGINX), 2 (Traefik), 3 (HAProxy), 4 (AWS ALB), 5 (Istio). | |
loadBalancerType | text | Load Balancer Type. |
Storage Configuration
| Field | Type | Required | Notes |
|---|---|---|---|
storageClasses | array of enums | Valid ids: 1 (gp2), 2 (gp3), 3 (io1), 4 (standard), 5 (premium), 6 (local-ssd), 7 (nfs). | |
defaultStorageClass | text | Default Storage Class. | |
csiDrivers | array of enums | Valid ids: 1 (AWS EBS), 2 (Azure Disk), 3 (GCE PD), 4 (Ceph), 5 (NetApp). |
Monitoring & Logging
| Field | Type | Required | Notes |
|---|---|---|---|
monitoringStack | array of enums | Valid ids: 1 (Prometheus), 2 (Grafana), 3 (AlertManager), 4 (Datadog), 5 (New Relic), 6 (CloudWatch). | |
loggingStack | array of enums | Valid ids: 1 (Elasticsearch), 2 (Fluentd), 3 (Fluent Bit), 4 (Kibana), 5 (Loki), 6 (CloudWatch Logs). |
Service Mesh & Security
| Field | Type | Required | Notes |
|---|---|---|---|
serviceMesh | enum | Valid ids: 1 (None), 2 (Istio), 3 (Linkerd), 4 (Consul Connect), 5 (AWS App Mesh). | |
securityTools | array of enums | Valid ids: 1 (Falco), 2 (OPA), 3 (Twistlock), 4 (Aqua), 5 (Sysdig). |
Cost Information
| Field | Type | Required | Notes |
|---|---|---|---|
estimatedMonthlyCost | number | Est. Monthly Cost. | |
actualMonthlyCost | number | Actual Monthly Cost. | |
costCenter | text | Cost Center. |
Additional panels
- Dashboard panel attached.
- Dashboard panel attached.
Relationships
- Related lists:
K8SNAMESPACE,K8SPV.
Creating a K8s Cluster via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "K8SCLUSTER",
"level": 400,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"environment": "1",
"provider": "1",
"kubernetesVersion": "..."
}Listing K8s Clusters
# All records in your tenant
GET /v1/entities/K8SCLUSTER/SUB:<your-sub-id>