hub / github.com/kubesphere/kubekey
github.com/kubesphere/kubekey @v4.0.5 sqlite
12,363 symbols
33,056 edges
216 files
1,006 documented · 8%
README
English | 中文
👋 欢迎使用KubeKey!
KubeKey 是一个开源的轻量的任务流程执行工具。提供了一种灵活、快速的方式来安装kubernetes。
KubeKey 通过了 CNCF kubernetes 一致性认证
对比3.x新特性
- 从kubernetes生命周期管理工具扩展为任务执行工具(流程设计参考Ansible)
- 支持多种方式管理任务模版：git，本地等。
- 支持多种节点连接方式。包括：local、ssh、kubernetes、prometheus。
- 支持云原生方式自动化批量任务管理
- 高级特性：UI页面（暂未开放）
获取 KubeKey
方式一：Release 页面
在 Release 页面获取对应的二进制文件。
方式二：执行脚本
curl -sfL https://get-kk.kubesphere.io | sh -
| 原文件 | 解压后文件 |
|---|---|
| kubekey-v4.x.x-linux-amd64.tar.gz | kk：为 KubeKey 的二进制文件 |
| web-installer.tgz | dist：Web 页面资源。 |
host-check.yaml，kubernetes，kubesphere：任务模板文件。
schema：配置文件。
README.md：安装说明文档。 | | package.sh | 离线安装包的构建脚本。 |
快速开始
方式一：命令行
./kk create cluster
方式二：Web 页面
UI 页面仅在 v4.0.0 及以上版本提供支持
./kk web --schema-path web-installer/schema --ui-path web-installer/dist
文档导航
Extension points exported contracts — how you extend this code
Manager (Interface)Manager defines the interface for different types of managers that can run operations [6 implementers]
pkg/manager/manager.go
Controller (Interface)
Controller should add in ctrl.manager [6 implementers]
cmd/controller-manager/app/options/controller_manager.go
Connector (Interface)
Connector is the interface for connecting to a remote host. It abstracts the operations required to interact with differ [5 …
pkg/connector/connector.go
Executor (Interface)
Executor all task in playbook [4 implementers]
pkg/executor/executor.go
ResourceStorage (Interface)
ResourceStorage defines the storage and metadata interface for a REST resource. Each resource type (Task, Inventory, Pla [3 …
pkg/proxy/resources/resource.go
Source (Interface)
Source is the source from which config is loaded. [2 implementers]
pkg/variable/source/source.go
Project (Interface)
Project represent location of actual project. get project file should base on it [1 implementers]
pkg/project/project.go
ModuleExecFunc (FuncType)
ModuleExecFunc defines the function signature for executing a module.
pkg/modules/internal/options.go
Core symbols most depended-on inside this repo
Ocalled by 1459
config/swagger-ui/swagger-ui-bundle.js
i
called by 1411
config/swagger-ui/swagger-ui-bundle.js
i
called by 1307
config/swagger-ui/swagger-ui-es-bundle.js
push
called by 1081
config/swagger-ui/swagger-ui-bundle.js
get
called by 961
config/swagger-ui/swagger-ui-bundle.js
get
called by 961
config/swagger-ui/swagger-ui-es-bundle.js
push
called by 736
config/swagger-ui/swagger-ui-es-bundle.js
s
called by 728
config/swagger-ui/swagger-ui-es-bundle-core.js
Shape
Languages
TypeScript90%
Go10%
Python1%
Modules by API surface
config/swagger-ui/swagger-ui-es-bundle.js4,343 symbols
config/swagger-ui/swagger-ui-bundle.js4,343 symbols
config/swagger-ui/swagger-ui-es-bundle-core.js1,111 symbols
config/swagger-ui/swagger-ui.js925 symbols
config/swagger-ui/swagger-ui-standalone-preset.js373 symbols
api/capkk/infrastructure/v1beta1/zz_generated.deepcopy.go34 symbols
api/core/v1/zz_generated.deepcopy.go30 symbols
pkg/proxy/internal/file_storage.go28 symbols
pkg/proxy/response.go25 symbols
pkg/project/project.go21 symbols
pkg/connector/prometheus_connector.go21 symbols
pkg/proxy/transport.go19 symbols
Dependencies from manifests, versioned
cel.dev/exprv0.25.1 · 1×
dario.cat/mergov1.0.1 · 1×
github.com/Masterminds/goutilsv1.1.1 · 1×
github.com/Masterminds/semver/v3v3.4.0 · 1×
github.com/Masterminds/sprig/v3v3.3.0 · 1×
github.com/Microsoft/go-winiov0.6.2 · 1×
github.com/ProtonMail/go-cryptov1.1.6 · 1×
github.com/antlr4-go/antlr/v4v4.13.0 · 1×
github.com/asaskevich/govalidatorv0.0.0-2023030114320 · 1×
github.com/beorn7/perksv1.0.1 · 1×
github.com/blang/semver/v4v4.0.0 · 1×
github.com/cenkalti/backoff/v4v4.3.0 · 1×
For agents
$ claude mcp add kubekey \
-- python -m otcore.mcp_server <graph>