Kubernetes部署的输出说明
dok8s的Python项目详细描述
dok8s公司
dok8s:Kubernetes部署的输出说明。在
目录
用例
以表格格式收集和导出Kubernetes部署的信息(例如组件、资源和docker映像/标记)。
输入:部署文件(YAML定义的集合)。
输出:漂亮的打印表格数据。在
要求
- 解析以下Kubernetes组件:
ConfigMap
,Deployment
,Ingress
,PersistentVolumeClaim
,Secret
,Service
,StatefulSet
。在 - 收集相关信息:
kind
,metadata name
,data filenames
,(init) containers
,hosts / rules
,storage name / size
,ports
,cpu/memory requests/limits
- 生产就绪代码。在
假设
- 解析的Kubernetes组件包含在official python Kubernetes client
设计
此项目基于CLI界面。在
示例输出
输入
{yama19}文件
输出
组件
Component | Value | Details |
---|---|---|
ClusterRole | cluster-autoscaler | -- |
ClusterRoleBinding | cluster-autoscaler | -- |
Deployment | cluster-autoscaler | cluster-autoscaler |
Role | cluster-autoscaler | -- |
RoleBinding | cluster-autoscaler | -- |
ServiceAccount | cluster-autoscaler | -- |
资源
^{tb2}$Docker图像
Platform/Service | Name | Image | Version |
---|---|---|---|
cluster-autoscaler | cluster-autoscaler | k8s.gcr.io/cluster-autoscaler | v1.14.7 |
配置
应用程序的行为可以通过环境变量进行配置。在
Environment Variable | Description | Type | Default Value |
---|---|---|---|
^{ | Level of logging - overrides verbose/quiet flag | string | - |
^{ | Directory to save logs | string | - |
^{ | Directory to save any output (bin) | string | bin |
发展
配置本地开发
本地运行
在终端上,运行以下命令(在项目的根目录上执行):
- 激活项目环境:
$ . ./scripts/helpers/environment.sh
- 使用
poetry
:$ dok8s
贡献
[不可用]
测试
(CI/CD的一部分)
[正在工作。。。]在
要运行测试,请打开终端并运行以下命令(在项目的根目录上执行):
- 激活项目环境:
$ . ./scripts/helpers/environment.sh
- 运行pytest:
$ make test
- 检查测试覆盖率:
$ make test-coverage
版本控制
增加版本号:$ poetry version {bump rule}
其中有效的通气规则为:
- 补丁
- 小调
- 少校
- 预赛
- 普雷米诺
- 前主
- 预释放
变更日志
使用CHANGELOG.md
跟踪此包的演变。
文件顶部的[UNRELEASED]
标记应该一直在那里记录工作,直到发布发生。在
工作应记录在以下子标题之一下:
- 已添加
- 改变
- 固定的
- 已删除
在版本中,应将以下格式的版本添加到文件中所有当前未发布的更改。## [major.minor.patch] - YYYY-MM-DD
部署
Pip包
在终端上,运行以下命令(在项目的根目录上执行):
- 激活项目环境:
$ . ./scripts/helpers/environment.sh
- 构建pip包:
$ make build-package
- 要发布pip包(需要向PyPi提供凭据):
$ make publish-package
Docker图像
在根目录下执行(在以下根目录上运行):
- 激活项目环境:
$ . ./scripts/helpers/environment.sh
- 要构建docker映像:
$ make build-docker
生产
对于生产,使用Docker映像。 此图片在docker hub上公开发布。在
- 第一次从docker hub拉取图像:
$ docker pull nichelia/dok8s:{version}
- 通过docker运行执行CLI:
$ docker run --rm -it -v ~/dok8s_bin:/tmp/bin nichelia/dok8s:{version} {command} -d /tmp/bin -o {filename}
将应用程序挂载到根目录下。要解析的kubernetesyaml文件应该包含在这个目录中。在
在哪里rsion是发布的应用程序版本
- 项目
标签: