README
¶
API Server
Nautes 的设计是遵循了 GitOps 的最佳实践，将用户应用环境以及 Nautes 自身环境的声明均存储在版本库中。声明数据分为两类：密钥数据是存储在 Vault 中，其他数据是存储在 Git（目前只支持 GitLab）仓库中，API Server 项目则是提供了一组用于操作这些声明数据的 REST API。
功能简介
API Server 提供的 API 分为两类：租户侧和用户侧。
| 分类 | 功能 | 描述 |
|---|---|---|
| 租户侧 | 集群 | 租户管理集群注册或删除用户集群的接口，集群包括宿主集群和运行时集群，也包括物理集群和虚拟集群，使用此接口的用户需要对租户配置库有写权限。 |
| 用户侧 | 产品 | Product Provider（目前只支持 GitLab）的产品维护接口，产品在 GitLab 中唯一对应一个 Group，使用此接口的用户只需一个 GitLab 账号，无需其他权限。 |
| 用户侧 | 项目 | 产品中项目的维护接口，项目的元数据存储在 GitLab 中，使用此接口的用户只需一个 GitLab 账号，无需其他权限。 |
| 用户侧 | 代码库 | 产品中代码库的维护接口，代码库的元数据存储在 GitLab 中，代码库在 GitLab 中唯一对应一个 Project，使用此接口的用户只需一个 GitLab 账号，无需其他权限。 |
| 用户侧 | 环境 | 产品中环境的维护接口，环境的元数据存储在 GitLab 中，使用此接口的用户只需一个 GitLab 账号，无需其他权限。 |
| 用户侧 | 部署运行时 | 产品中部署运行时的维护接口，部署运行时的元数据存储在 GitLab 中，使用此接口的用户只需一个 GitLab 账号，无需其他权限。 |
| 用户侧 | 项目流水线运行时 | 项目中流水线运行时的维护接口，流水线运行时的元数据存储在 GitLab 中，使用此接口的用户只需一个 GitLab 账号，无需其他权限。 |
API文档
如果您是在本地启动 API Server 的服务，可以通过下面的地址访问 swagger-ui 风格的 API 文档。
https://$api-server:$port/q/swagger-ui
您也可以通过在线文档浏览 API 的定义。
快速开始
准备
安装以下工具，并配置 GOBIN 环境变量：
1、准备一个 kubernetes 实例，复制 kubeconfig 文件到 {$HOME}/.kube/config
创建 nautes-configs 配置文件
kubectl create cm nautes-configs -n nautes
2、访问其他组件的证书
默认情况下，安装环境完成后，在/opt/nautes/out/pki目录下会生成用于存在访问其他组件的证书和签发证书的CA，请检查该目录下是否包含api-server.key，ca.crt等证书文件
3、设置环境变量
api-server会根据一份资源布局配置文件来校验和生成资源。本地开发时，可以通过设置环境变量的方式启动项目，该文件位于当前项目下的 pkg/nodestree/sample/resources.yaml
export RESOURCES_LAYOUT = ${workspaceFolder}/pkg/nodestree/sample/resources.yaml
构建
make build
运行
kratos run
单元测试
go test -v ./...
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
cmd
|
|
|
manager
command
|
|
|
internal
|
|
|
biz
Package biz is a generated GoMock package.
|
Package biz is a generated GoMock package. |
|
pkg
|
|
|
cluster
Package cluster is a generated GoMock package.
|
Package cluster is a generated GoMock package. |
|
gitlab
Package gitlab is a generated GoMock package.
|
Package gitlab is a generated GoMock package. |
|
kubernetes
Package inspection is a generated GoMock package.
|
Package inspection is a generated GoMock package. |
|
nodestree
Package nodestree is a generated GoMock package.
|
Package nodestree is a generated GoMock package. |
|
validate
Package validate_test is a generated GoMock package.
|
Package validate_test is a generated GoMock package. |
|
util
|
|
Click to show internal directories.
Click to hide internal directories.