Merge pull request #33 from renoki-co/feature/status

[feature] Status Checks

Author: rennokki

docs/kinds/Deployment.md

@@ -110,3 +110,23 @@ foreach ($dep->getPods() as $pod) {
     // $pod->logs()
 }
 ```
+
+### Deployment Status
+
+The Status API is available to be accessed for fresh instances:
+
+```php
+$dep->refresh();
+
+$dep->getReadyReplicasCount();
+$dep->getDesiredReplicasCount();
+$dep->getUnavailableReplicasCount();
+```
+
+You can check if all the pods within the Deployment are running:
+
+```php
+if ($dep->allPodsAreRunning()) {
+    //
+}
+```

docs/kinds/Job.md

@@ -135,3 +135,36 @@ foreach ($job->getPods() as $pod) {
     // $pod->logs()
 }
 ```
+
+### Job Status
+
+The Status API is available to be accessed for fresh instances:
+
+```php
+$job->refresh();
+
+$job->getActivePodsCount();
+$job->getFailedPodsCount();
+$job->getSuccededPodsCount();
+```
+
+You can check if the job completed:
+
+```php
+if ($job->hasCompleted()) {
+    //
+}
+```
+
+You can retrieve the `null`/`\DateTime` instance for start and end times for the job:
+
+```php
+$start = $job->getStartTime();
+$end = $job->getCompletionTime();
+```
+
+You can also retrieve the amount of time the job ran for:
+
+```php
+$seconds = $job->getDurationInSeconds();
+```

docs/kinds/Namespace.md

@@ -17,3 +17,23 @@ $ns = $cluster->namespace()
 ```php
 $ns = $cluster->getNamespaceByName('staging');
 ```
+
+### Namespace Status
+
+The Status API is available to be accessed for fresh instances:
+
+```php
+$ns->refresh();
+
+if ($ns->isActive()) {
+    //
+}
+```
+
+You can also check if the namespace is terminating:
+
+```php
+if ($ns->isTerminating()) {
+    //
+}
+```

docs/kinds/PersistentVolume.md

@@ -85,3 +85,23 @@ Dot notation is supported:
 ```php
 $pv->getSpec('some.nested.path', []);
 ```
+
+### Persistent Volume Status
+
+The Status API is available to be accessed for fresh instances:
+
+```php
+$pv->refresh();
+
+if ($pv->isAvailable()) {
+    //
+}
+```
+
+You can also check if the PV is bound:
+
+```php
+if ($pv->isBound()) {
+    //
+}
+```

docs/kinds/PersistentVolumeClaim.md

@@ -74,3 +74,23 @@ Dot notation is supported:
 ```php
 $pvc->getSpec('some.nested.path', []);
 ```
+
+### Persistent Volume Claim Status
+
+The Status API is available to be accessed for fresh instances:
+
+```php
+$pvc->refresh();
+
+if ($pvc->isAvailable()) {
+    //
+}
+```
+
+You can also check if the PVC is bound:
+
+```php
+if ($pvc->isBound()) {
+    //
+}
+```

docs/kinds/Pod.md

@@ -135,3 +135,67 @@ $pod->watchLogs(function ($line) {
     // with the given line.
 });
 ```
+
+### Pod Status
+
+The Status API is available to be accessed for fresh instances:
+
+```php
+$pod->refresh();
+
+$pod->getPodIps();
+$pod->getHostIp();
+$pod->getQos();
+```
+
+You can also check if the pod is running
+
+```php
+if ($pod->isRunning()) {
+    //
+}
+```
+
+For [Job](Job.md) support, you may also check if the pod ran successfully:
+
+```php
+foreach ($job->getPods() as $pod) {
+    if ($pod->isSuccessful()) {
+        //
+    }
+}
+```
+
+You can check the container statuses:
+
+```php
+foreach ($pod->getContainerStatuses() as $container) {
+    // $container->getName();
+}
+
+foreach ($pod->getInitContainerStatuses() as $container) {
+    // $container->getName();
+}
+```
+
+You may also get a container by its name:
+
+```php
+$mysql = $pod->getContainer('mysql');
+$busybox = $pod->getInitContainer('busybox');
+
+// $mysql->getName();
+// $busybox->getName();
+```
+
+Check if the containers are ready:
+
+```php
+if ($pod->containersAreReady()) {
+    //
+}
+
+if ($pod->initContainersAreReady()) {
+    //
+}
+```

docs/kinds/StatefulSet.md

@@ -126,3 +126,23 @@ foreach ($sts->getPods() as $pod) {
     // $pod->logs()
 }
 ```
+
+### StatefulSet Status
+
+The Status API is available to be accessed for fresh instances:
+
+```php
+$sts->refresh();
+
+$sts->getCurrentReplicasCount();
+$sts->getReadyReplicasCount();
+$sts->getDesiredReplicasCount();
+```
+
+You can check if all the pods within the StatefulSet are running:
+
+```php
+if ($sts->allPodsAreRunning()) {
+    //
+}
+```

src/Instances/Container.php

@@ -53,6 +53,16 @@ public function addPort(int $containerPort, string $protocol = 'TCP', string $na
         return $this->setAttribute('ports', $ports);
     }
 
+    /**
+     * Check if the container is ready.
+     *
+     * @return bool
+     */
+    public function isReady(): bool
+    {
+        return $this->getAttribute('ready', false);
+    }
+
     /**
      * Get the instance as an array.
      *

src/Kinds/K8sDeployment.php

@@ -109,4 +109,68 @@ public function podsSelector(): array
             'deployment-name' => $this->getName(),
         ];
     }
+
+    /**
+     * Get the deployment conditions.
+     *
+     * @return array
+     */
+    public function getConditions(): array
+    {
+        return $this->getAttribute('status.conditions', []);
+    }
+
+    /**
+     * Get the available replicas.
+     *
+     * @return int
+     */
+    public function getAvailableReplicasCount(): int
+    {
+        return $this->getAttribute('status.availableReplicas', 0);
+    }
+
+    /**
+     * Get the ready replicas.
+     *
+     * @return int
+     */
+    public function getReadyReplicasCount(): int
+    {
+        return $this->getAttribute('status.readyReplicas', 0);
+    }
+
+    /**
+     * Get the total desired replicas.
+     *
+     * @return int
+     */
+    public function getDesiredReplicasCount(): int
+    {
+        return $this->getAttribute('status.replicas', 0);
+    }
+
+    /**
+     * Get the total unavailable replicas.
+     *
+     * @return int
+     */
+    public function getUnavailableReplicasCount(): int
+    {
+        return $this->getAttribute('status.unavailableReplicas', 0);
+    }
+
+    /**
+     * Check if all scheduled pods are running.
+     *
+     * @return bool
+     */
+    public function allPodsAreRunning(): bool
+    {
+        $pods = $this->getPods();
+
+        return $pods->count() > 0 && $pods->reject(function ($pod) {
+            return $pod->isReady();
+        })->isEmpty();
+    }
 }