如果您正在使用 Layer5 产品,或者喜欢该项目,请 ★ 此仓库以表示您的支持!🤩
关于 Layer5
Layer5 的云原生应用和基础设施管理软件使工程师能够从基础设施中获得更多。我们拥抱由_开发者_定义的基础设施。我们赋能开发者改变编写应用的方式,支持_运维人员_重新思考如何运行现代基础设施,并使_产品负责人_重新获得对产品组合的完全控制权。
欢迎贡献
✔️ Join any or all of the weekly meetings on community calendar.
✔️ Watch community meeting recordings.
✔️ Access the Community Drive by completing the Community Member Form.
✔️ Discuss in the Community Forum.
✔️ Explore more in the Community Handbook.
构建文档
使用 Golang 构建文档
如果您的本地开发环境已安装受支持的 Golang 版本(v1.21.0+),接下来您需要安装扩展版 Hugo,因为它具备必要的 SCSS/SASS 支持。在此处查找所有 Hugo 软件包:
现在要在本地设置并运行该站点,请执行:
make setupmake site- visit http://localhost:1313
如果你从 GitHub 拉取新代码,你偶尔需要再次运行 make setup。否则,每次运行站点时都没有必要重新运行 make setup,你只需运行 make site 即可启动它,并在你进行和保存站点编辑时自动重新加载。
使用 Docker 构建文档
在本地运行站点很简单。只要您已安装 Docker,克隆此仓库,运行 make docker,然后访问 http://localhost:1313。
[!IMPORTANT]
这需要 Docker Desktop 版本 4.24 或更高版本,或带有 Docker Compose 版本 2.22 或更高版本的 Docker Engine。
贡献指南
--> 请参阅 https://docs.layer5.io/contributing <-- 获取详细的贡献指南。
文档结构
以下是 Layer5 文档的高层大纲和信息架构。
目标: 为从新手到专家贡献者的多样化受众提供全面、有序且易于访问的文档。
目标受众:
- 角色: 初学者、开发者、管理员、运维人员、安全专家、贡献者、所有经验水平的用户。
- 需求: 多样化 - 学习基础知识、管理任务、理解高级概念、贡献代码。
Cloud Section: Information Architecture
入门指南
- 创建账户
- 创建您的第一个 Designs
概念
Layer5 Cloud 概念及其相互关系的概述。
身份
- 组织: 组织,管理组织权限
- 团队: 团队,管理团队权限
- 用户: 用户管理,管理用户权限
安全
- 令牌: API 令牌用于对 Layer5 Cloud 的 REST API 进行身份验证。
- 密钥链:密钥链是密钥的集合
- 密钥:密钥是访问控制的基本单元
- 角色:角色将权限映射到用户。
目录
Cloud Catalog 是一个基于 Web 的公共目录,旨在促进常见云原生架构和设计模式的轻松共享和发现。
工作区
工作区作为您团队工作的虚拟空间。
教程
- Kanvas 快照
- 共享工作区
- 识别用户和贡献者里程碑
自托管
将您的 Kanvas 设计保留在工作场所内部。需要时,可从 Layer5 获取远程支持。
参考
用于扩展 Layer5 Cloud 的低级 ReST API 参考。
Kanvas 部分:信息架构
开始使用设计
- 从模式开始: 模式是一种实体,用于增强已部署的设计实例的操作行为。
- 创建关系: 关系用于识别和促进组件之间的谱系。
- 处理组件: 组件代表生态系统中的实体,暴露底层平台的功能。
- 从零开始: 强调您执行的每个操作背后的系统行为。
探索 Designer
- 审查设计: 学习如何利用 Kanvas 的 Designer 模式中的评论来增强协作并简化设计审查。
- 白板: Kanvas 中的白板和自由绘制
- 导出设计: 如何导出您的设计以用于备份、共享或离线使用。
处理组件
设计是对您的 Kubernetes 基础设施应如何配置的描述性、声明性表征
导航 Operator
Operator 模式用于操作您的 Kubernetes 集群和云原生基础设施。
核心任务
- 白板: Kanvas Designer 支持自由设计,这意味着您可以自定义图表的外观和布局,没有任何约束。
- 部署设计: 验证设计、取消部署设计、部署设计、克隆设计
参考
- Keyboard Shortcuts: 学习 Kanvas 的键盘快捷键,以提升您的设计体验。
- Troubleshooting Kanvas: 学习如何排查 Kanvas 的问题
我们的项目由社区驱动,并欢迎协作。👍 请务必查看 Layer5 Community Welcome Guide,以了解可供您使用的资源。您还可以加入我们的 Slack 参与其中。
找到你的 MeshMate
MeshMates 是经验丰富的 Layer5 社区成员,他们将帮助你熟悉环境、发现活跃项目并拓展你的社区网络。 今天就成为一名 Meshtee 吧!
了解更多关于 Layer5 community 的信息。
✔️ Join any or all of the weekly meetings on Community calendar.
✔️ Watch community meeting recordings.
✔️ Access the Community Drive by completing the Community Member Form.
✔️ Discuss in the Community Forum.
✔️ Explore more in the Community Handbook.
不知道从哪里开始? 获取一个带有 help-wanted 标签的开放 issue。
