Kubernetes Java 클라이언트

kubernetes API용 Java 클라이언트입니다.

클라이언트 버저닝

Java 클라이언트는 Semantic Versioning을 사용합니다. 새 Kubernetes 릴리스 버전에 맞춰 클라이언트를 재생성할 때마다 주 버전 번호를 올립니다(아래 표 참조). 이때 새로운 API가 추가되고 생성된 Kubernetes API 스텁(Stub)에 호환성이 깨지는 변경(breaking changes)이 있을 수 있습니다. 주 버전을 업그레이드할 때는 잠재적인 호환성 변경에 대비하세요.

설치

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: fluent 빌더 스타일로 임의의 리소스를 구성합니다.
  • YamlExample: YAML에서 리소스를 로드하거나 덤프하는 권장 방법.
• 스트리밍:
  • WatchExample: 특정 리소스의 watch 이벤트를 구독합니다. kubectl get <resource> -w와 동일합니다.
  • LogsExample: 실행 중인 컨테이너의 로그를 가져옵니다. kubectl logs와 동일합니다.
  • ExecExample: 실행 중인 컨테이너와 "exec" 세션을 수립합니다. kubectl exec와 동일합니다.
  • PortForwardExample: 로컬 포트를 포드의 포트에 매핑합니다. kubectl port-forward와 동일합니다.
  • AttachExample: 기존 컨테이너 내부에서 이미 실행 중인 프로세스에 연결합니다. kubectl attach와 동일합니다.
  • CopyExample: 컨테이너와 파일 및 디렉터리를 서로 복사합니다. kubectl cp와 동일합니다.
  • WebSocketsExample: 특정 리소스에 임의의 웹소켓 세션을 수립합니다.
• 고급: (참고: 다음 예제는 client-java-extended 모듈이 필요합니다.）
  • (5.0.0+) InformerExample: 리소스를 list-watch하고 알림을 로컬 캐시에 반영하는 인포머(informer)를 구축합니다.
  • (5.0.0+) PagerExample: 서버 측 부하/네트워크 혼잡을 완화하기 위해 페이지네이션(목록 요청에만 해당)을 지원합니다.
  • (6.0.0+) ControllerExample: 하나 이상의 리소스를 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());
        }
    }
}

네임스페이스 객체 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();