kubernetes之Python客戶端介紹

IT那活兒發(fā)布于2023-01-11 13:19 / 2833人閱讀

點(diǎn)擊上方“IT那活兒”公眾號(hào)，關(guān)注后了解更多內(nèi)容，不管IT什么活兒，干就完了?。?！

Kubernetes（以下簡(jiǎn)稱k8s）是一個(gè)用于自動(dòng)化部署、擴(kuò)展和管理容器化應(yīng)用的開源系統(tǒng)。

k8s在正常運(yùn)行時(shí)的大部分操作都可以通過(guò)kubectl命令行接口或類似kubeadm之類的命令行工具進(jìn)行執(zhí)行，根據(jù)文檔，這些工具背后實(shí)際上調(diào)用的是k8s提供的api，這些 api也供應(yīng)用程序和開發(fā)人員調(diào)用其功能，由于k8s的api是基于REST思想設(shè)計(jì)的，因此為了使用的不同的操作，可能需要使用不同的HTTP請(qǐng)求。

例如：從k8s獲取信息的話需要使用GET請(qǐng)求，需要在k8s上創(chuàng)建資源的話需要使用POST請(qǐng)求，刪除資源需要使用DELETE請(qǐng)求；同時(shí)還需要構(gòu)建完整的HTTP請(qǐng)求，這可能需要占用不少時(shí)間。

為了方便快速的調(diào)用k8s的api，官方和社區(qū)維護(hù)了多個(gè)編程語(yǔ)言的客戶端，在使用這些客戶端時(shí)，我們并不需要自己實(shí)現(xiàn)API調(diào)用和“請(qǐng)求/響應(yīng)”類型，從而使自己的工作重心落在重要的部分。

圖片來(lái)源于網(wǎng)絡(luò)

Python的k8s客戶端是以python包的形式提供的，開源地址（https://github.com/kubernetes-client/python），可以通過(guò)pip命令下載安裝。

直接通過(guò) PyPI下載安裝
pip install kubernetes
從源碼安裝
git clone –-recursive https://github.com /kubernetes-client/python.git cd python python setup.py install

配置kubernetes api

//導(dǎo)入包：

from kubernetes import client
from pprint import pprint //優(yōu)化輸出

//配置信息：

k8s_api_url="YOUR_API_URL"
k8s_api_token="YOUR_API_TOKEN"

//初始化客戶端：

k8s_api_conf=kubernetes.client.Configuration()
k8s_api_conf.host=k8s_api_url //配置url
k8s_api_conf.verify_ssl=False //關(guān)閉SSL驗(yàn)證，可選擇
k8s_api_conf.api_key = {"authorization": "Bearer " + k8s_api_token} //配置token
k8s_api_client=client.ApiClient(k8s_api_conf) //創(chuàng)建客戶端

常用資源接口實(shí)例化

kubernetes的api接口極為豐富，本次僅介紹常用操作和會(huì)涉及到的類和方法，全部的接口文檔可以在官方API文檔（https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md）處找到。

namespace、pod、node和service相關(guān),使用CoreV1Api類實(shí)例
k8s_api_client_core=client.CoreV1Api(k8s_api_client
deployment相關(guān)，使用AppsV1Api類實(shí)例
k8s_api_client_apps=client.AppsV1Api(k8s_api_client
ingress相關(guān)，使用NetworkingV1beta1Api類實(shí)例
k8s_api_client_networking=client.NetworkingV1beta1Api(k8s_api_client)

常用操作

1）查看namespace

使用list_namespace方法
//可選參數(shù)：
//pretty str 如果值為"true"，則美化輸出
//limit int 限制輸出數(shù)量
//timeout_second int 超時(shí)時(shí)間
try：

api_response=k8s_api_client_core.list_namespace(pretty="true")
   pprint(api_response)
exception Exceptions as e:
   print(e)

//使用read_namespace方法
//必要參數(shù)：
//name str namespace名
//可選參數(shù)：
//pretty str 如果值為"true"，則美化輸出
try:

api_response=k8s_api_client_core.read_namespace(name,pretty="true")
   pprint(api_response)
exception Exceptions as e:
   print(e)

2）創(chuàng)建namespace

//使用create_namespace方法
//必要參數(shù):
//body   V1Namespace   創(chuàng)建的namespace描述
//可選參數(shù):
//pretty   str 如果值為"true"，則美化輸出
//dry_run   str 如果存在此參所則表示試運(yùn)行，有效值為"ALL"
//field_manager str 該參數(shù)是與進(jìn)行這些更改的參與者或?qū)嶓w關(guān)聯(lián)的名稱。該值的長(zhǎng)度必須小于或等于128個(gè)字符，并且僅包含可打印字符
body=client.V1Namespace() //創(chuàng)建body
try：

api_response=k8s_api_client_core.create_namespace(body,pretty="true")
   pprint(api_response)
exception Exceptions as e:
   print(e)

3）刪除namespace

//使用delete_namespace方法
//必要參數(shù):
//name   str 刪除的namespace名
//可選參數(shù):
//pretty   str 如果值為"true"，則美化輸出
//dry_run   str 如果存在此參所則表示試運(yùn)行，有效值為"ALL"
//grace_period_seconds   int 表示延遲多少秒執(zhí)行，非負(fù)數(shù)，當(dāng)為0時(shí)立即執(zhí)行
try:

api_response=k8s_api_client_core.delete_namespace(name,pretty="true")
   pprint(api_response)
exception Exceptions as e:
   print(e)

4）查看pod

//使用list_namespaced_pod方法
//必要參數(shù):
//namespace   str namespace名
//可選參數(shù):
//pretty   str 如果值為"true"，則美化輸出
//limit   int 限制輸出數(shù)量
//timeout_second int 超時(shí)時(shí)間
try:

api_response=k8s_api_client_core.list_namespaced_pod(namespace,pretty="true")
   pprint(api_response)
exception Exceptions as e:
   print(e)

//使用list_pod_for_all_namespaces方法
//可選參數(shù)：
//pretty str 如果值為"true"，則美化輸出
//limit int 限制輸出數(shù)量
//timeout_second int 超時(shí)時(shí)間
try:

api_response=k8s_api_client_core.list_pod_for_all_namespaces(pretty="true")
   pprint(api_response)
exception Exceptions as e:
   print(e)

//使用read_namespaced_pod方法
//必要參數(shù):
//name   str pod名
//namespace    str namespace名
//可選參數(shù):
//pretty   str 如果值為"true"，則美化輸出
try:

api_response=k8s_api_client_core.read_namespaced_pod(name,namespace,pretty="true")
   pprint(api_response)
exception Exceptions as e:
   print(e)

5）查看node

//使用list_node方法
//可選參數(shù):
//pretty str 如果值為"true"，則美化輸出
//limit int 限制輸出數(shù)量
//timeout_second int 超時(shí)時(shí)間
try:

api_response=k8s_api_client_core.list_node(pretty="true")
   pprint(api_response)
exception Exceptions as e:
   print(e)

//使用read_node方法
//必要參數(shù):
//name str node名
//可選參數(shù):
//pretty str 如果值為"true"，則美化輸出
try:

api_response=k8s_api_client_core.read_node(name,pretty="true")
   pprint(api_response)
exception Exceptions as e:
   print(e)

6）查看deployment

//使用list_namespaced_deployment方法
//必要參數(shù):
//namespace   str namespace名
//可選參數(shù):
//pretty   str 如果值為"true"，則美化輸出
//limit   int 限制輸出數(shù)量
//timeout_second int 超時(shí)時(shí)間
try:

api_response=k8s_api_client_apps.list_namespaced_deployment(namespace,pretty="true")
   pprint(api_response)
exception Exceptions as e:
   print(e)

//使用list_deployment_for_all_namespaces方法
//可選參數(shù):
//pretty   str 如果值為"true"，則美化輸出
//limit    int 限制輸出數(shù)量
//timeout_second int 超時(shí)時(shí)間
try:

api_response=k8s_api_client_apps.list_deployment_for_all_namespaces(pretty="true")
   pprint(api_response)
exception Exceptions as e:
   print(e)

//使用read_namespaced_deployment方法
//必要參數(shù):
//name   str deployment名
//namespace   str namespace名
//可選參數(shù):
//pretty   str 如果值為"true"，則美化輸出
try:

api_response=k8s_api_client_apps.read_namespaced_deployment(name,namespace,pretty="true")
   pprint(api_response)
exception Exceptions as e:
   print(e)

7）刪除deployment

//使用delete_namespaced_deployment方法
//必要參數(shù):
//name   str deployment名
//namespace   str namespace名
//可選參數(shù):
//pretty   str 如果值為"true"，則美化輸出
//dry_run   str 如果存在此參所則表示試運(yùn)行，有效值為"ALL"
//grace_period_seconds int 表示延遲多少秒執(zhí)行，非負(fù)數(shù)，當(dāng)為0時(shí)立即執(zhí)行
try:

api_response=k8s_api_client_apps.delete_namespaced_deployment(name,namespace,pretty="true")
   pprint(api_response)
exception Exceptions as e:
   print(e)

8）刪除pod/重啟pod

//使用delete_namespaced_pod方法
//必要參數(shù):
//name?    ?str pod名
//namespace    str namespace名
//可選參數(shù):
//pretty    str 如果值為"true"，則美化輸出
//dry_run   str 如果存在此參所則表示試運(yùn)行，有效值為"ALL"
//grace_period_seconds int 表示延遲多少秒執(zhí)行，非負(fù)數(shù)，當(dāng)為0時(shí)立即執(zhí)行
try:

api_response=k8s_api_client_core.delete_namespaced_pod(name,namespace,pretty="true")
   pprint(api_response)
exception Exceptions as e:
   print(e)

9）修改deployment配置

//使用replace_namespaced_deployment方法
//必要參數(shù):
//name    str     deployment名
//namespace    str    namespace名
//body     V1Deployment 修改后的配置
//可選參數(shù):
//pretty   str   如果值為"true"，則美化輸出
//dry_run    str   如果存在此參所則表示試運(yùn)行，有效值為"ALL"
//field_manager   str   該參數(shù)是與進(jìn)行這些更改的參與者或?qū)嶓w關(guān)聯(lián)的名稱。該值的長(zhǎng)度必須小于或等于128個(gè)字符，并且僅包含可打印字符
try:

//先獲取當(dāng)前的deployment配置
   body=k8s_api_client_apps.read_namespaced_deployment(name,namespace,pretty="true")
   //修改deployment
   some_change()
   //替換deployment配置
   api_response=k8s_api_client_apps.replace_namespaced_deployment(name,namespace,body,pretty="true")
   pprint(api_response)
exception Exceptions as e:
   print(e)