From 2e71caf47ebb6fab629a94a811192458326778f6 Mon Sep 17 00:00:00 2001 From: Haitao Pan Date: Sun, 28 Jun 2026 12:10:18 +0800 Subject: [PATCH] docs: rewrite READMEs in xworkspace-console style --- README.md | 184 ++++++++++++--------------------------------------- README.zh.md | 59 +++++++++++++++++ 2 files changed, 102 insertions(+), 141 deletions(-) create mode 100644 README.zh.md diff --git a/README.md b/README.md index bba1d70b..ab8ae98d 100644 --- a/README.md +++ b/README.md @@ -1,157 +1,59 @@ -# 🌐 CloudNativeSuite -Cloud-Neutral · Cloud-Agnostic · AI-Enhanced Infrastructure Platform +[🇺🇸 English](README.md) | [🇨🇳 中文](README.zh.md) ---- +# AI Workspace Infrastructure Modules (iac_modules) -
-🇨🇳 中文版 README（展开查看） +`iac_modules` is the core Infrastructure-as-Code (IaC) repository for the AI Workspace ecosystem. It provides cloud-neutral, multi-cloud GitOps orchestrations, standard Terraform/Terragrunt modules, and automated deployment pipelines for establishing a resilient, scalable AI infrastructure platform. -
+## About -# 🌐 CloudNativeSuite -云中立 · 多云敏捷 · AI 驱动的基础设施平台 +- **Cloud-Neutral by Design**: Consistent resource abstraction across AWS, GCP, Azure, Alibaba Cloud, and Vultr. +- **GitOps Orchestration**: Automated multi-environment pipelines for bootstrap, landing zone, and account matrices. +- **VPN Overlay & Networking**: Includes configurations for establishing secure `vpn-overlay` (WireGuard, Xray) connections. +- **Standardized HCL**: A robust library of pre-configured `terraform-hcl-standard` modules for compute, networking, and security. -CloudNativeSuite 是一个以 **Cloud-Neutral（云中立）** 为核心理念构建的现代开源平台， -旨在为工程团队提供 **多云 GitOps 编排、可观测性、开发者加速与智能运维分析** 的统一解决方案。 +## Start TLDR -平台由五大核心项目构成： +> **Note:** These modules are designed to be consumed by CI/CD pipelines (e.g., GitHub Actions) and orchestration tools rather than being run entirely manually. ---- +### Prerequisites -## 🧩 项目仓库（Repositories） +Ensure you have the following installed if you plan to run modules locally: +- Terraform >= 1.5.0 +- Terragrunt >= 0.50.0 +- Cloud Provider CLIs (AWS CLI, gcloud, etc.) -| 项目名 | 描述 | -|--------|-------------| -| **Modern-Container-Application-Reference-Architecture** | 云中立架构示例，构建多云/混合环境的现代应用参考体系 | -| **XControl** | X 系列工具的统一 Demo 控制台 | -| **XStream** | 面向开发者的智能网络加速器 | -| **XScopeHub** | 基于 OpenTelemetry 的可观测性与 AI-Ops 分析平台 | -| **XCloudFlow** | 多云 GitOps 资源编排与自动部署引擎 | +### Usage ---- +1. Multi-cloud Pipelines: +Refer to the `.github/workflows` directory for automated matrices: +```bash +.github/workflows/iac-pipeline-mutli-cloud-bootstrap.yaml +.github/workflows/iac-pipeline-mutli-cloud-landingzone-baseline.yaml +``` -## 🚀 核心能力 +2. Standard Terraform Modules: +Navigate to the module directory and initialize: +```bash +cd terraform-hcl-standard/ +terraform init +terraform plan +``` -### ☁️ Cloud-Neutral 多云中立 -- 任意云环境一致使用 -- 跨区域/跨云迁移无缝切换 -- 统一资源模型（Cloud-Agnostic） +3. Setup VPN Overlay: +```bash +cd vpn-overlay/ +# Follow specific instructions for wireguard or xray setup +``` -### 🔁 GitOps 统一工作流 -- 多环境自动化部署 -- 自动生成、同步与调度 CloudFlow Pipelines -- 持续交付与状态漂移检测 +## Repository Structure -### 🔭 可观测性 + AI-Ops -- Metrics / Logs / Traces 全栈观察 -- 自动基线分析、智能告警 -- AI 式根因推理与修复建议 +- `terraform-hcl-standard/`: Core, reusable Terraform modules. +- `vpn-overlay/`: Secure networking and overlay configurations. +- `.github/workflows/`: GitOps pipelines and CI/CD matrices. +- `scripts/`: Helper scripts for environment setup and deployment. +- `example/`: Example implementations and reference architectures. -### ⚡ 开发者效率提升 -- XStream 加速 GitHub / DockerHub / AI API -- 智能路由 & Zero-Trust 通道 -- 低开销、高可靠网络体验 +## Docs / Links -### 🧩 统一控制平面 -- 通过 XControl 一站式查看、管理与演示 -- 展示 CloudFlow、ScopeHub、XStream 的协同工作流 - ---- - -## 🌟 使用场景（Use Cases） - -- 多云 GitOps 编排与自动部署 -- Cloud-Neutral 应用落地架构 -- AI 增强可观测性（智能诊断与自动分析） -- 大规模节点自动化/初始化 -- 开发者跨境网络加速 - ---- - -## 🌐 官方网站 - -https://www.svc.plus/ - ---- - -欢迎参与共建，一起打造下一代 Cloud-Neutral 工程体系。 - -
- ---- - -
-🇺🇸 English Version README (Click to expand) - -
- -# 🌐 CloudNativeSuite -Cloud-Neutral · Multi-Cloud Ready · AI-Enhanced Infrastructure Platform - -CloudNativeSuite is an open platform designed around the principle of **Cloud-Neutral** infrastructure — -helping teams deploy, observe, accelerate, and operate workloads consistently across any cloud environment. - -The platform consists of five core projects: - ---- - -## 🧩 Repositories - -| Project | Description | -|--------|-------------| -| **Modern-Container-Application-Reference-Architecture** | Reference architecture for cloud-neutral multi-cloud application stacks | -| **XControl** | Unified demo & control plane for all X-Series tools | -| **XStream** | Developer network accelerator | -| **XScopeHub** | Observability suite powered by OpenTelemetry and AI-Ops analytics | -| **XCloudFlow** | Multi-cloud GitOps orchestrator for automated deployment pipelines | - ---- - -## 🚀 Core Capabilities - -### ☁️ Cloud-Neutral by Design -- Consistent experience across AWS, GCP, Azure, Alibaba Cloud, and on-prem -- Cross-cloud/cross-region migration without vendor lock-in -- Unified resource abstraction - -### 🔁 GitOps Orchestration -- Automated multi-environment deployments -- Cross-cloud CloudFlow pipelines -- Continuous delivery with drift detection - -### 🔭 Observability & AI-Ops -- Full-stack telemetry: metrics, logs, traces -- Automated anomaly detection -- AI-powered diagnostics and root-cause reasoning - -### ⚡ Developer Productivity -- XStream accelerates GitHub / DockerHub / AI APIs -- Reality routing & zero-trust tunnels -- Designed for high-latency or restricted networks - -### 🧩 Unified Control Plane -- XControl provides a consistent UI for demos & orchestration -- Shows how CloudFlow, ScopeHub, and XStream operate together end-to-end - ---- - -## 🌟 Use Cases - -- Multi-cloud GitOps orchestration -- Cloud-neutral architecture patterns -- AI-driven observability & diagnostics -- Distributed node automation -- Developer network acceleration - ---- - -## 🌐 Official Website - -https://www.svc.plus/ - ---- - -Contributions are welcome — -help us build the future of Cloud-Neutral Infrastructure. - -
+- [Official Website](https://www.svc.plus/) +- [CloudNativeSuite Documentation](https://github.com/ai-workspace-infra) diff --git a/README.zh.md b/README.zh.md new file mode 100644 index 00000000..13e5ba39 --- /dev/null +++ b/README.zh.md @@ -0,0 +1,59 @@ +[🇺🇸 English](README.md) | [🇨🇳 中文](README.zh.md) + +# AI Workspace Infrastructure Modules (iac_modules) + +`iac_modules` 是 AI Workspace 生态系统的核心基础设施即代码 (IaC) 仓库。它提供云中立的多云 GitOps 编排、标准的 Terraform/Terragrunt 模块，以及自动化的部署流水线，旨在构建弹性、可扩展的 AI 基础设施平台。 + +## 关于 (About) + +- **云中立设计 (Cloud-Neutral)**：跨 AWS、GCP、Azure、阿里云和 Vultr 等环境提供一致的资源抽象。 +- **GitOps 编排**：自动化的多环境流水线，支持引导层 (Bootstrap)、登陆区 (Landing Zone) 和多云账户矩阵。 +- **VPN Overlay 与网络**：包含建立安全 `vpn-overlay`（WireGuard、Xray）连接的配置。 +- **标准化 HCL 代码**：为计算、网络和安全提供强大且预配置的 `terraform-hcl-standard` 模块库。 + +## 快速开始 (Start TLDR) + +> **注意：** 这些模块主要设计供 CI/CD 流水线（例如 GitHub Actions）和编排工具调用，而不是完全通过手动运行。 + +### 前置依赖 (Prerequisites) + +如果计划在本地运行模块，请确保安装了以下工具： +- Terraform >= 1.5.0 +- Terragrunt >= 0.50.0 +- 云服务商 CLI 工具 (AWS CLI, gcloud 等) + +### 使用 (Usage) + +1. 多云流水线 (Multi-cloud Pipelines)： +请参考 `.github/workflows` 目录中自动化的矩阵配置： +```bash +.github/workflows/iac-pipeline-mutli-cloud-bootstrap.yaml +.github/workflows/iac-pipeline-mutli-cloud-landingzone-baseline.yaml +``` + +2. 标准 Terraform 模块： +进入模块目录并初始化： +```bash +cd terraform-hcl-standard/ +terraform init +terraform plan +``` + +3. 配置 VPN Overlay： +```bash +cd vpn-overlay/ +# 根据具体说明进行 wireguard 或 xray 配置 +``` + +## 仓库结构 (Repository Structure) + +- `terraform-hcl-standard/`: 核心且可重用的 Terraform 模块。 +- `vpn-overlay/`: 安全网络与覆盖网络配置。 +- `.github/workflows/`: GitOps 流水线和 CI/CD 矩阵。 +- `scripts/`: 环境搭建与部署的辅助脚本。 +- `example/`: 示例实现与参考架构。 + +## 文档 / 链接 (Docs / Links) + +- [官方网站](https://www.svc.plus/) +- [CloudNativeSuite 文档](https://github.com/ai-workspace-infra)