写点什么

Kubernetes 官方 java 客户端之六:OpenAPI 基本操作

作者:程序员欣宸
  • 2022 年 4 月 03 日
  • 本文字数:4520 字

    阅读完需:约 15 分钟

Kubernetes官方java客户端之六:OpenAPI基本操作

欢迎访问我的 GitHub

这里分类和汇总了欣宸的全部原创(含配套源码):https://github.com/zq2599/blog_demos

概览

  1. 本文是《Kubernetes 官方 java 客户端》系列的第六篇,以下提到的 java 客户端都是指 client-jar.jar

  2. 前文《Kubernetes官方java客户端之五:proto基本操作 》已经提到,java 客户端的基本功能由两个主要脉络组成,第一个是 proto,主要功能是使用 ProtoClient 类提供的增删改查接口,这些接口用到的入参和返回对象所涉及到的 java 类,都是通过 K8S 的 protobuf 生成的;

  3. 除了使用 ProtoClient 对 K8S 资源进行增删改查,还提供了另一种更强大的方式:OpenAPI,本章咱们就来一起学习 OpenAPI 相关的操作;

K8S 的 OpenAPI

1. 先抛开 java 客户端不提,咱们来看看 K8S 本身的 OpenAPI,地址是:https://kubernetes.io/zh/docs/concepts/overview/kubernetes-api/ ,关键信息如下图所示,可见 K8S 提供了 OpenAPI 规范:


2. 如果您想查看当前 K8S 环境的 OpenAPI 规范,请打开 K8S 环境的/etc/kubernetes/manifests/kube-apiserver.yaml 文件,增加下图红框中的内容:


3. 修改完毕后请稍候,系统会根据文件的变化自动更新(千万不要执行 kubectl apply -f kube-apiserver.yaml,这会导致新建 api-server 的 pod,由于端口占用而启动失败);

4. 假设宿主机 IP 地址是 192.168.50.135,那么在浏览器上访问:http://192.168.50.135:8080/openapi/v2,就能得到所有 OpenAPI 信息如下图:


5. 上图的原始数据没有可读性,复制到在线 JSON 格式化网站,得到的内容如下图,例如查询 pod 列表的 API 信息已经非常详细了:


6. 以上就是对 K8S 的 OpenAPI 简介,接下来回到 java 客户端本身,看看它提供了哪些 OpenAPI 相关的能力;

java 客户端的 OpenAPI

1. 打开 java 客户端工程的源码如下图,红框 1 就是和 OpenAPI 相关的子工程,提供服务的功能类都在红框 2 的 package 中,也就是说,依靠红框 2 中的 API 以及红框 3 中的数据结构,我们可以完成大部分 K8S 资源控制相关的操作:


2. 打开常用的 CoreV1Api.java,如下图红框,顶部的注释已经说明了一切:这些代码都是工具生成的(至于如何生成就不在本文中讨论了):


3. 如果您下载了 java 客户端源码,可以在 client-java-api 这个子工程中看到完整的 OpenAPI 接口文档:


4. 前文《Kubernetes官方java客户端之五:proto基本操作 》的代码中,咱们尝试过获取 pod 列表,但是 ProtoClient 的已有 API 不支持提交更详细的业务参数,此时选择 OpenAPI 接口即可输入详细的业务参数,接口详细信息可以在文档中查到,还带有完整的 demo 代码,如下图所示:


5. 上图中的 listNamespacedPod 接口有两个重要参数:fieldSelector labelSelector,这是过滤用的,详细的用法请参考 K8S 官方文档,地址是:https://kubernetes.io/docs/concepts/overview/working-with-objects/ ,如下图红框:


6. 弄清楚了 K8S 的 OpenAPI 规范,以及 java 客户端依据此规范生成的 API 服务,还有详细的接口文档在手,可以编码实战了;

源码下载

  1. 如果您不想编码,可以在 GitHub 下载所有源码,地址和链接信息如下表所示(https://github.com/zq2599/blog_demos):


  1. 这个 git 项目中有多个文件夹,本章的应用在 kubernetesclient 文件夹下,如下图红框所示:

开始编码

  1. 打开《Kubernetes官方java客户端之一:准备 》中创建的 kubernetesclient 工程,在里面新建子工程 openapi,其 pom.xml 内容如下,要注意的是 spring-boot-starter-json 已经被排除,因此序列化工具会变为 Gson(原本默认是 jackson):

<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">    <modelVersion>4.0.0</modelVersion>
<parent> <groupId>com.bolingcavalry</groupId> <artifactId>kubernetesclient</artifactId> <version>1.0-SNAPSHOT</version> <relativePath>../pom.xml</relativePath> </parent>
<groupId>com.bolingcavalry</groupId> <artifactId>openapi</artifactId> <version>0.0.1-SNAPSHOT</version> <name>openapi</name> <description>Demo project for openapi client</description> <packaging>jar</packaging>
<dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-json</artifactId> </exclusion> </exclusions> </dependency>
<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency>
<dependency> <groupId>io.kubernetes</groupId> <artifactId>client-java</artifactId> </dependency>
</dependencies>
<build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> <version>2.3.0.RELEASE</version> </plugin> </plugins> </build>
</project>
复制代码
  1. 新增 OpenAPIDemoApplication.java,这是新工程的引导类,也有两个 web 接口,一个创建 namespace,另一个按照 namespace 查询 pod 列表,关键位置已添加了注释,就不多赘述了:

package com.bolingcavalry.openapi;
import com.google.gson.GsonBuilder;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.openapi.models.V1NamespaceBuilder;import io.kubernetes.client.openapi.models.V1PodList;import io.kubernetes.client.util.ClientBuilder;import io.kubernetes.client.util.KubeConfig;import lombok.extern.slf4j.Slf4j;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.web.bind.annotation.PathVariable;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RequestMethod;import org.springframework.web.bind.annotation.RestController;
import javax.annotation.PostConstruct;import java.io.FileReader;
@SpringBootApplication@RestController@Slf4jpublic class OpenAPIDemoApplication {
public static void main(String[] args) { SpringApplication.run(OpenAPIDemoApplication.class, args); }
/** * 默认的全局设置 * @return * @throws Exception */ @PostConstruct private void setDefaultApiClient() throws Exception { // 存放K8S的config文件的全路径 String kubeConfigPath = "/Users/zhaoqin/temp/202007/05/config"; // 以config作为入参创建的client对象,可以访问到K8S的API Server ApiClient client = ClientBuilder .kubeconfig(KubeConfig.loadKubeConfig(new FileReader(kubeConfigPath))) .build();
// 创建操作类 Configuration.setDefaultApiClient(client); }
@RequestMapping(value = "/openapi/createnamespace/{namespace}", method = RequestMethod.GET) public V1Namespace createnamespace(@PathVariable("namespace") String namespace) throws Exception {
CoreV1Api coreV1Api = new CoreV1Api();
V1Namespace v1Namespace = new V1NamespaceBuilder() .withNewMetadata() .withName(namespace) .endMetadata() .build();
V1Namespace ns = coreV1Api.createNamespace(v1Namespace, null, null, null);
// 使用Gson将集合对象序列化成JSON,在日志中打印出来 log.info("ns info \n{}", new GsonBuilder().setPrettyPrinting().create().toJson(ns));
return ns; }

@RequestMapping(value = "/openapi/pods/{namespace}", method = RequestMethod.GET) public V1PodList pods(@PathVariable("namespace") String namespace) throws ApiException {
CoreV1Api apiInstance = new CoreV1Api();
// String | If 'true', then the output is pretty printed. String pretty = null;
// 订阅事件相关的参数,这里用不上 Boolean allowWatchBookmarks = false;
// 连续查找的标志,类似于翻页 String _continue = null;
// 字段选择器 String fieldSelector = "status.phase=Running";
// 根据标签过滤 // String labelSelector = "component=kube-apiserver"; String labelSelector = null;
Integer limit = null; String resourceVersion = null; Integer timeoutSeconds = null; Boolean watch = false;
V1PodList v1PodList = apiInstance.listNamespacedPod(namespace, pretty, allowWatchBookmarks, _continue, fieldSelector, labelSelector, limit, resourceVersion, timeoutSeconds, watch);
// 使用Gson将集合对象序列化成JSON,在日志中打印出来 log.info("pod info \n{}", new GsonBuilder().setPrettyPrinting().create().toJson(v1PodList));
return v1PodList; }
}
复制代码

3. 将 OpenAPIDemoApplication 运行起来,先测试创建 namespace 的服务,在浏览器访问:http://localhost:8080/openapi/createnamespace/dddeeefff ,浏览器返回信息如下图:


4. SSH 登录 K8S 主机,执行命令查看 namespace,如下图红框,已经创建成功


5. 再试试 Pod 列表,地址是 :http://localhost:8080/openapi/pods/kube-system ,如下图:


- 至此,OpenAPI 接口的实践就完成了,现在已将 java 客户端的最基本的功能都实践过了,接下来的文章咱们将开始学习精彩的高级功能;

欢迎关注 InfoQ:程序员欣宸

学习路上,你不孤单,欣宸原创一路相伴...

发布于: 刚刚阅读数: 3
用户头像

搜索"程序员欣宸",一起畅游Java宇宙 2018.04.19 加入

前腾讯、前阿里员工,从事Java后台工作,对Docker和Kubernetes充满热爱,所有文章均为作者原创,个人Github:https://github.com/zq2599/blog_demos

评论

发布
暂无评论
Kubernetes官方java客户端之六:OpenAPI基本操作_四月月更_程序员欣宸_InfoQ写作平台