Deployed Resource State Stream | Machani Robotics SDK

curl -X POST https://api.machanirobotics.com/v1/management/deployment/state:deployedResourceStateStream \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "resources": {
    "kubernetes": [
      {
        "namespace": "production",
        "pods": [
          {
            "status": {
              "phase": "Running",
              "conditions": [
                {
                  "type": 1,
                  "status": 1,
                  "lastProbeTime": "2024-04-20T10:15:00Z",
                  "lastTransitionTime": "2024-04-20T10:10:00Z",
                  "reason": "ContainersReady",
                  "message": "All containers are ready"
                }
              ],
              "message": "Pod is running smoothly",
              "reason": "Running",
              "initContainerStatuses": [
                {
                  "dnsLabel": "init-db-migration",
                  "state": {
                    "waiting": {
                      "reason": "ImagePullBackOff",
                      "message": "Back-off pulling image"
                    },
                    "running": {
                      "startTime": "2024-04-20T09:50:00Z"
                    },
                    "terminated": {
                      "exitCode": 0,
                      "signal": 0,
                      "reason": "Completed",
                      "message": "Init container completed successfully",
                      "startTime": "2024-04-20T09:45:00Z",
                      "finishTime": "2024-04-20T09:50:00Z"
                    }
                  },
                  "lastState": {
                    "waiting": {
                      "reason": "CrashLoopBackOff",
                      "message": "Back-off restarting failed container"
                    },
                    "running": {
                      "startTime": "2024-04-20T09:40:00Z"
                    },
                    "terminated": {
                      "exitCode": 1,
                      "signal": 0,
                      "reason": "Error",
                      "message": "Init container crashed",
                      "startTime": "2024-04-20T09:35:00Z",
                      "finishTime": "2024-04-20T09:40:00Z"
                    }
                  },
                  "ready": true,
                  "restartCount": 2,
                  "image": "docker.io/machani/init-db:1.0.0",
                  "started": true
                }
              ],
              "containerStatuses": [
                {
                  "dnsLabel": "app-server",
                  "state": {
                    "waiting": {
                      "reason": "ContainerCreating",
                      "message": "Waiting for container to start"
                    },
                    "running": {
                      "startTime": "2024-04-20T10:00:00Z"
                    },
                    "terminated": {
                      "exitCode": 0,
                      "signal": 0,
                      "reason": "Completed",
                      "message": "Container terminated normally",
                      "startTime": "2024-04-20T09:00:00Z",
                      "finishTime": "2024-04-20T09:30:00Z"
                    }
                  },
                  "lastState": {
                    "waiting": {
                      "reason": "CrashLoopBackOff",
                      "message": "Back-off restarting failed container"
                    },
                    "running": {
                      "startTime": "2024-04-20T08:50:00Z"
                    },
                    "terminated": {
                      "exitCode": 1,
                      "signal": 0,
                      "reason": "Error",
                      "message": "Container crashed due to OOM",
                      "startTime": "2024-04-20T08:45:00Z",
                      "finishTime": "2024-04-20T08:50:00Z"
                    }
                  },
                  "ready": true,
                  "restartCount": 3,
                  "image": "docker.io/machani/app-server:2.3.1",
                  "started": true
                }
              ]
            }
          }
        ],
        "services": [
          {
            "spec": {
              "ports": [
                {
                  "dnsLabel": "http",
                  "protocol": "TCP",
                  "port": 80,
                  "targetPort": 8080,
                  "nodePort": 30080
                }
              ],
              "clusterIp": "10.96.0.1",
              "type": 2,
              "externalIps": [
                "192.168.1.100"
              ],
              "externalReference": ""
            }
          }
        ],
        "deployments": [
          {
            "status": {
              "replicas": 5,
              "updatedReplicas": 5,
              "readyReplicas": 5,
              "availableReplicas": 5,
              "unavailableReplicas": 0,
              "conditions": [
                {
                  "type": 1,
                  "status": 1,
                  "lastUpdateTime": "2024-04-20T10:00:00Z",
                  "lastTransitionTime": "2024-04-20T09:55:00Z",
                  "reason": "NewReplicaSetAvailable",
                  "message": "ReplicaSet \"app-server-12345\" has successfully progressed."
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

Streams status of deployed resources

Request

This endpoint expects an object.

kubernetesResourceslist of stringsOptional

The kind names of the kubernetes resources whose state is required. If empty, the states of all supported resources will be streamed.

Response

resourcesobject

Resources that were deployed

Errors

400

Bad Request Error