Kubernetes Java クライアント

Kubernetes API の Java クライアント。

クライアントのバージョニング

Java クライアントは Semantic Versioning を使用しています。メジャーバージョン番号は、新しい Kubernetes リリースバージョン（以下の表参照）のためにクライアントを再生成するたびに増加します。その際、新しい API が追加され、生成された Kubernetes API スタブに破壊的な変更が加えられる可能性があります。メジャーバージョンアップ時は、破壊的な変更に備えてください。

インストール

Java クライアントライブラリをローカルの Maven リポジトリにインストールするには、次のコマンドを実行します。

git clone --recursive https://github.com/kubernetes-client/java
cd java
mvn install

詳細は公式ドキュメントを参照してください。

Maven ユーザー

プロジェクトの POM に次の依存関係を追加します。

<dependency>
    <groupId>io.kubernetes</groupId>
    <artifactId>client-java</artifactId>
    <version>8.0.2</version>
</dependency>

Gradle ユーザー

compile 'io.kubernetes:client-java:8.0.2'

その他

まず、次のコマンドを実行して JAR を生成します。

git clone --recursive https://github.com/kubernetes-client/java
cd java/kubernetes
mvn package

その後、以下の JAR を手動でインストールします。

• target/client-java-api-8.0.3-SNAPSHOT.jar
• target/lib/*.jar

例

一般的なユースケース向けにいくつかの例を用意しました。以下に示します。

• 設定:
  • InClusterClientExample: Kubernetes クラスター内部で実行中にクライアントを設定します。
  • KubeConfigFileClientExample: 外部から Kubernetes クラスターにアクセスするためのクライアントを設定します。
• 基本:
  • SimpleExample: クライアントの使用方法を示す最小限の簡単な例。
  • ProtoExample: protobuf シリアライゼーションプロトコルでペイロードを送受信します。
  • (5.0.0+) PatchExample: サポートされている様々なパッチ形式でリソースオブジェクトをパッチします。kubectl patch と同等。
  • FluentExample: 流れるようなビルダースタイルで任意のリソースを構築します。
  • YamlExample: Yaml でリソースをロードまたはダンプする推奨方法。
• ストリーミング:
  • WatchExample: 特定のリソースからの Watch イベントを購読します。kubectl get <resource> -w と同等。
  • LogsExample: 実行中のコンテナからログを取得します。kubectl logs と同等。
  • ExecExample: 実行中のコンテナとの "exec" セッションを確立します。kubectl exec と同等。
  • PortForwardExample: ローカルポートを Pod のポートにマッピングします。kubectl port-forward と同等。
  • AttachExample: 既存のコンテナ内で実行中のプロセスにアタッチします。kubectl attach と同等。
  • CopyExample: コンテナとの間でファイルやディレクトリをコピーします。kubectl cp と同等。
  • WebSocketsExample: 特定のリソースに対して任意の WebSocket セッションを確立します。
• 高度: (注: 以下の例には client-java-extended モジュールが必要です）
  • (5.0.0+) InformerExample: リソースを list-watch し、ローカルキャッシュに通知を反映する informer を構築します。
  • (5.0.0+) PagerExample: サーバーサイドの負荷やネットワーク輻輳を軽減するためのページネーション（list リクエストのみ）をサポートします。
  • (6.0.0+) ControllerExample: 1つ以上のリソースを list-watch して世界の状態を調整するコントローラーを構築します。
  • (6.0.0+) LeaderElectionExample: HA コントローラーの実装に役立つリーダー選出ユーティリティです。
  • (9.0.0+) SpringIntegrationControllerExample: Spring フレームワークのビーンインジェクションに基づく Kubernetes コントローラーの構築。
  • (9.0.0+) GenericKubernetesClientExample: CRD を含む任意の Kubernetes タイプのための汎用クライアントインターフェースを構築します。

すべてのポッドを一覧表示:

import io.kubernetes.client.openapi.ApiClient;
import io.kubernetes.client.openapi.ApiException;
import io.kubernetes.client.openapi.Configuration;
import io.kubernetes.client.openapi.apis.CoreV1Api;
import io.kubernetes.client.openapi.models.V1Pod;
import io.kubernetes.client.openapi.models.V1PodList;
import io.kubernetes.client.util.Config;

import java.io.IOException;

public class Example {
    public static void main(String[] args) throws IOException, ApiException{
        ApiClient client = Config.defaultClient();
        Configuration.setDefaultApiClient(client);

        CoreV1Api api = new CoreV1Api();
        V1PodList list = api.listPodForAllNamespaces(null, null, null, null, null, null, null, null, null);
        for (V1Pod item : list.getItems()) {
            System.out.println(item.getMetadata().getName());
        }
    }
}

namespace オブジェクトの watch:

import com.google.gson.reflect.TypeToken;
import io.kubernetes.client.openapi.ApiClient;
import io.kubernetes.client.openapi.ApiException;
import io.kubernetes.client.openapi.Configuration;
import io.kubernetes.client.openapi.apis.CoreV1Api;
import io.kubernetes.client.openapi.models.V1Namespace;
import io.kubernetes.client.util.Config;
import io.kubernetes.client.util.Watch;

import java.io.IOException;

public class WatchExample {
    public static void main(String[] args) throws IOException, ApiException{
        ApiClient client = Config.defaultClient();
        Configuration.setDefaultApiClient(client);

        CoreV1Api api = new CoreV1Api();