org.apache.flink.kubernetes.kubeclient.resources.KubernetesPod Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flink-kubernetes Show documentation
There is a newer version: 2.0-preview1
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.kubernetes.kubeclient.resources;

import org.apache.flink.annotation.VisibleForTesting;

import io.fabric8.kubernetes.api.model.ContainerStateTerminated;
import io.fabric8.kubernetes.api.model.Pod;

import java.util.Objects;
import java.util.stream.Collectors;

/** Represent KubernetesPod resource in kubernetes. */
public class KubernetesPod extends KubernetesResource {

    public KubernetesPod(Pod pod) {
        super(pod);
    }

    public String getName() {
        return this.getInternalResource().getMetadata().getName();
    }

    public boolean isTerminated() {
        if (getInternalResource().getStatus() != null) {
            final boolean podFailed =
                    PodPhase.Failed.name().equals(getInternalResource().getStatus().getPhase());
            final boolean containersFailed =
                    getInternalResource().getStatus().getContainerStatuses().stream()
                            .anyMatch(
                                    e ->
                                            e.getState() != null
                                                    && e.getState().getTerminated() != null);
            return containersFailed || podFailed;
        }
        return false;
    }

    public boolean isScheduled() {
        if (getInternalResource().getStatus() != null) {
            return getInternalResource().getStatus().getConditions().stream()
                    .anyMatch(
                            e ->
                                    Objects.equals(e.getType(), "PodScheduled")
                                            && Objects.equals(e.getStatus(), "True"));
        }
        return false;
    }

    public String getTerminatedDiagnostics() {
        final StringBuilder sb = new StringBuilder();
        sb.append("Pod terminated, container termination statuses: [");
        if (getInternalResource().getStatus() != null) {
            sb.append(
                    getInternalResource().getStatus().getContainerStatuses().stream()
                            .filter(
                                    containerStatus ->
                                            containerStatus.getState() != null
                                                    && containerStatus.getState().getTerminated()
                                                            != null)
                            .map(
                                    (containerStatus) -> {
                                        final ContainerStateTerminated containerStateTerminated =
                                                containerStatus.getState().getTerminated();
                                        return String.format(
                                                "%s(exitCode=%d, reason=%s, message=%s)",
                                                containerStatus.getName(),
                                                containerStateTerminated.getExitCode(),
                                                containerStateTerminated.getReason(),
                                                containerStateTerminated.getMessage());
                                    })
                            .collect(Collectors.joining(",")));
        }
        sb.append("]");
        if (PodPhase.Failed.name().equals(getInternalResource().getStatus().getPhase())) {
            sb.append(
                    String.format(
                            ", pod status: %s(reason=%s, message=%s)",
                            getInternalResource().getStatus().getPhase(),
                            getInternalResource().getStatus().getReason(),
                            getInternalResource().getStatus().getMessage()));
        }
        return sb.toString();
    }

    /** The phase of a Pod, high-level summary of where the Pod is in its lifecycle. */
    @VisibleForTesting
    enum PodPhase {
        Pending,
        Running,
        Succeeded,
        Failed,
        Unknown
    }
}