Vishwakarma 项目教程

Vishwakarma 项目教程

vishwakarma Terraform modules to create a self-hosting Kubernetes cluster on opinionated Cloud Platform. 项目地址: https://gitcode.com/gh_mirrors/vi/vishwakarma

1. 项目的目录结构及介绍

Vishwakarma 项目的目录结构如下：

vishwakarma/
├── CHANGELOG.md
├── CHANGELOG-pre-v1.0.0.md
├── LICENSE
├── Makefile
├── README.md
├── circleci/
├── docs/
│   └── variables/
│       └── aws/
├── examples/
│   └── kubernetes-cluster/
├── github/
├── modules/
│   ├── aws/
│   │   ├── elastikube/
│   │   ├── kube-worker/
│   │   └── network/
│   └── test/
├── test/
└── tools/

目录结构介绍

• CHANGELOG.md: 记录项目的变更日志。
• CHANGELOG-pre-v1.0.0.md: 记录版本 1.0.0 之前的变更日志。
• LICENSE: 项目的开源许可证文件，采用 Apache-2.0 许可证。
• Makefile: 项目的 Makefile 文件，用于自动化构建和部署。
• README.md: 项目的介绍文件，包含项目的基本信息和使用说明。
• circleci/: 包含 CircleCI 的配置文件，用于持续集成和持续部署。
• docs/: 包含项目的文档，特别是变量文档。
• examples/: 包含项目的示例配置，特别是 Kubernetes 集群的示例。
• github/: 包含 GitHub 相关的配置文件，如 GitHub Actions 的配置。
• modules/: 包含 Terraform 模块，用于创建 AWS 资源。
• test/: 包含项目的测试代码。
• tools/: 包含项目使用的工具和脚本。

2. 项目的启动文件介绍

Vishwakarma 项目的启动文件主要是 Makefile 和 README.md。

Makefile

Makefile 文件用于自动化项目的构建、测试和部署。通过运行 make 命令，可以执行以下任务：

• make init: 初始化 Terraform 模块并安装所需的插件。
• make apply: 应用 Terraform 配置，创建 AWS 资源。
• make destroy: 销毁已创建的 AWS 资源。

README.md

README.md 文件是项目的介绍文件，包含以下内容：

• 项目的基本信息和功能介绍。
• 项目的安装和使用说明。
• 项目的依赖和要求。
• 项目的贡献指南和变更日志。

3. 项目的配置文件介绍

Vishwakarma 项目的主要配置文件位于 examples/kubernetes-cluster/ 目录下。

main.tf

main.tf 是 Terraform 的主配置文件，定义了项目的资源和模块。主要内容包括：

• provider: 定义 AWS 提供者。
• module: 定义 Terraform 模块，包括网络、控制平面和 worker 节点。
• variable: 定义输入变量，如 AWS 区域、VPC ID 等。

variables.tf

variables.tf 文件定义了项目的输入变量，包括：

• aws_region: AWS 区域。
• vpc_id: VPC ID。
• key_pair_name: SSH 密钥对名称。
• cluster_name: Kubernetes 集群名称。

outputs.tf

outputs.tf 文件定义了项目的输出变量，包括：

• kubeconfig: Kubernetes 配置文件路径。
• cluster_endpoint: Kubernetes 集群的 API 端点。

通过这些配置文件，用户可以自定义和配置 Vishwakarma 项目，以满足不同的需求。

vishwakarma Terraform modules to create a self-hosting Kubernetes cluster on opinionated Cloud Platform. 项目地址: https://gitcode.com/gh_mirrors/vi/vishwakarma