python-operation-scripts/python-kubernetes/deployment-statefulset-manager-GUI.py at main · hangx969/python-operation-scripts · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Kubernetes Deployment 和 StatefulSet 副本数管理图形界面工具

功能描述:
    本脚本提供基于 Tkinter 的图形用户界面，用于管理 Kubernetes 集群中的 Deployment 和 StatefulSet 资源。
    主要功能是动态调整这些工作负载的副本数量，支持跨命名空间的资源管理，
    为 Kubernetes 运维人员提供直观便捷的扩缩容操作工具。

技术实现:
    - 使用 Tkinter 构建桌面图形用户界面
    - 使用 Kubernetes Python Client 与 K8s API Server 交互
    - 采用 grid() 布局管理器组织界面元素
    - 使用 trace_add() 实现下拉菜单的联动更新
    - 通过 patch API 实现资源的动态更新

界面组件设计:
    1. 命名空间下拉菜单 - 选择目标命名空间
    2. 资源类型下拉菜单 - 选择 Deployment 或 StatefulSet
    3. 资源名称下拉菜单 - 显示选定类型的具体资源
    4. 副本数输入框 - 输入目标副本数量
    5. 提交按钮 - 执行副本数更新操作
"""

import tkinter as tk
from tkinter import messagebox, scrolledtext
from kubernetes import client, config

# 加载k8s kubeconfig
# 注意打包成程序的时候这里最好用绝对路径
config.load_config(config_file='tkinter/kubeconfig-local')

# 创建api对象
apps_v1 = client.AppsV1Api()
core_v1 = client.CoreV1Api()

# 获取集群namespace
def get_namespace():
    # list_namespace返回的是对象，包含所有ns的属性
    # .items是转成列表，可以直接遍历每一个ns的json属性
    return [ns.metadata.name for ns in core_v1.list_namespace().items]

# 获取集群deployment和statefulset
def get_resources(namespace):
    deployments = apps_v1.list_namespaced_deployment(namespace=namespace).items
    statefulsets = apps_v1.list_namespaced_stateful_set(namespace=namespace).items
    # 把deployment和statefulset的name分别放进列表
    deployment_list = [ d.metadata.name for d in deployments ]
    statefulset_list = [ s.metadata.name for s in statefulsets ]
    return deployment_list, statefulset_list

# 更新资源名称下拉菜单。当用户选择了namespace和resource type后，自动列出这个namespace中的deployment或者statefulset
def update_resources_menu(*args):
    # 从下拉菜单变量获取到选择好的namespace和resource type
    namespace = ns_var.get().strip()
    resource_type = resource_type_var.get().strip()
    # 从函数里拿到所有的deployment和sts列表
    deployment_list, statefulset_list = get_resources(namespace)
    # 清空resource name下拉菜单
    resource_name_menu['menu'].delete(0, 'end')

    # 分deployment和statefulset两种情况分别更新下拉菜单
    if resource_type == 'Deployment':
        # 设定reosurce_name_var的默认值显示
        # 列表长度大于零说明有对应资源
        if len(deployment_list) > 0:
            # 先设默认值
            resource_name_var.set(deployment_list[0])
        else:
            # 列表为空说明对应namespace没这种资源，变量返回空值。不显示。
            resource_name_var.set('')
        # 往下拉菜单中添加所有resource name
        for name in deployment_list:
            # ['menu‘]访问OptionMenu的菜单部分，add_command添加菜单元素，label指定新条目的值，setit将label的值赋值给变量
            resource_name_menu['menu'].add_command(label=name, command=tk._setit(resource_name_var, name))

    elif resource_type == 'Statefulset':
        if len(statefulset_list) > 0:
            resource_name_var.set(statefulset_list[0])
        else:
            resource_name_var.set('')
        for name in statefulset_list:
            resource_name_menu['menu'].add_command(label=name, command=tk._setit(resource_name_var, name))

# 更新副本数
def update_replicas():
    # 从下拉菜单获取值
    namespace = ns_var.get().strip()
    resource_type = resource_type_var.get().strip()
    resoruce_name = resource_name_var.get().strip()
    # 获取用户输入的replica
    replicas = replicas_entry.get().strip()
    # 验证replicas是否是整数
    try:
        replicas = int(replicas)
    except ValueError as e:
        messagebox.showerror('Error', "Replicas is not valid, please input an int")
    # 分别更新deployment和sts
    try:
        if resource_type == 'Deployment':
            deployment = apps_v1.list_namespaced_deployment(name=resoruce_name, namespace=namespace)
            deployment.spec.replicas = replicas
            apps_v1.patch_namespaced_deployment(name=resoruce_name, namespace=namespace, body=deployment)
            messagebox.showinfo('Update finished', f"Deployment {resoruce_name} in namespace {namespace} has been updated to replicas {replicas}\n")
        elif resource_type == 'Statefulset':
            statefulset = apps_v1.list_namespaced_stateful_set(name=resoruce_name, namespace=namespace)
            statefulset.spec.replicas = replicas
            apps_v1.patch_namespaced_stateful_set(name=resoruce_name, namespace=namespace, body=statefulset)
            messagebox.showinfo('Update finished', f"Statefulset {resoruce_name} in namespace {namespace} has been updated to replicas {replicas}\n")
    except client.ApiException as e:
        messagebox.showerror("Error:", f"{str(e)}")

if __name__ == '__main__':
    root = tk.Tk()
    root.title("Kubernetes deployment and statefulset management")

    # 获取namespace列表
    valid_ns_list = get_namespace()
    # namespace下拉菜单的文本标签
    tk.Label(root, text='Namespace:').grid(row=0, column=0, padx=10, pady=10)
    # 创建一个字符串变量，是根据用户选择动态更新的
    ns_var = tk.StringVar(root)
    # 默认值为namespace列表首元素
    ns_var.set(valid_ns_list[0])
    # 定义下拉菜单，* 是解包操作符，用于将列表中的每个元素作为单独的参数传递给OptionMenu。这些选项就会在下拉菜单中以供选择
    ns_menu = tk.OptionMenu(root, ns_var, *valid_ns_list)
    ns_menu.grid(row=0, column=1, padx=10, pady=10)

    # 资源类型下拉菜单
    tk.Label(root, text='Resource Type:').grid(row=1, column=0, padx=10, pady=10)
    resource_type_var = tk.StringVar(root)
    resource_type_var.set("Deployment")
    resource_type_menu = tk.OptionMenu(root, resource_type_var, "Deployment", "Statefulset")
    resource_type_menu.grid(row=1, column=1, padx=10, pady=10)

    # 资源名称文本标签和下拉菜单标签
    tk.Label(root, text='Resource Name:').grid(row=2, column=0, padx=10, pady=10)
    resource_name_var = tk.StringVar(root)
    resource_name_menu = tk.OptionMenu(root, resource_name_var, '')
    resource_name_menu.grid(row=2, column=1, padx=10, pady=10)

    # 当ns_var和resource_type_var发生写入时，调用指定的回调函数，更新资源名称下拉菜单内容
    ns_var.trace_add('write', update_resources_menu)
    resource_type_var.trace_add('write', update_resources_menu)

    # 输入副本数的窗口
    tk.Label(root, text='Replicas').grid(row=3, column=5, padx=10, pady=10)
    replicas_entry = tk.Entry(root)
    replicas_entry.grid(row=3, column=1, padx=10, pady=10)

    # 提交按钮。点击提交，触发更新副本数的函数
    submit_button = tk.Button(root, text='Submit', command=update_replicas)
    submit_button.grid(row=4, column=1, padx=10, pady=10)

    # 在程序启动时就 根据默认值填充资源列表，从而确保用户在第一次操作时能看到可选的资源。
    update_resources_menu()
    tk.mainloop()