# aliyun-ros-awesome

**Repository Path**: oschina/aliyun-ros-awesome

## Basic Information

- **Project Name**: aliyun-ros-awesome
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 0
- **Created**: 2024-06-19
- **Last Updated**: 2024-07-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# [ROS](https://ros.console.aliyun.com/cn-beijing/stacks/create) 模板指南

# 介绍

**资源编排服务 ROS（Resource Orchestration Service）**
是阿里云提供的一项简化云计算资源管理和采用基础设施即代码（IaC）设计理念的自动化部署服务。开发者和管理员可以编写模板，在模板中定义所需的阿里云资源（例如：ECS 实例、RDS 数据库实例）、资源间的依赖关系等。ROS 的编排引擎将根据模板自动完成所有资源的创建和配置，从而实现云上资源的自动化部署。

# 如何编写模板

请阅读 [模板编写快速入门](https://help.aliyun.com/zh/ros/template-writing-quick-start)。此文档以创建专有网络（VPC）和交换机（vSwitch）为例介绍如何编写模板。

为了能够写出高质量的综合性的模板，可参考如下示例：

- [模板示例 1：部署单点 WordPress 网站](部署单点WordPress网站.md)
- [模板示例 2：部署高可用 WordPress 网站](部署高可用WordPress网站.md)

对于大多数只需部署在虚拟机中的项目来说，只需要将模板示例 1 中的命令执行部分替换为本项目的部署脚本，即可完成模板的编写。

您可以在 **[ROS 控制台](https://ros.console.aliyun.com/cn-beijing/stacks/create)** 或本地文本编辑器中编写模板。

# 如何测试模板

编写好模板后，请阅读[资源栈快速入门](https://help.aliyun.com/zh/ros/getting-started)，此文档将介绍如何使用模板创建云资源。

其中，**资源栈** 是针对 ROS 资源的管理单元。您可通过模板来创建、更新和删除资源栈，从而创建、更新和删除一组资源（即模板中定义的资源）。

# 为模板加上标签

为了能够统计模板所创建的资源数据，需要在模板的最后加上 **标签** 信息，形如：

    Metadata:
      ALIYUN::ROS::Interface:
        TemplateTags:
        - acs:developer:gitee:<描述模板用途>

**标签书写规则：**

1. 请务必编写 `TemplateTags`。

2. 将 "**<**描述模板用途**\>**" 处，替换成你的专属标签，按照"您的手机尾号-模板用途"来编写，如，你的手机尾号是 1234，该模板是用来部署 WordPress 网站，标签内容是：`acs:developer:gitee:1234-部署WordPress网站`。

# 为项目添加自动化部署链接

在完成模板的编写和测试后，为了能让更多的用户在云上自动化部署本项目，只需执行如下几个步骤：

1. 将模板（比如template.yml）上传到项目中，参考下图点击【原始数据】，自动打开新页签并复制此URL，它就是模板地址（比如 `https://gitee.com/demo-user/demo-project/raw/master/template.yml`

![](assets/raw-template.jpg)

2. 拼接用于自动化部署的链接，格式为 `https://ros.console.aliyun.com/region/stacks/create?hideStepRow=true&hideStackConfig=true&disableRollback=false&isSimplified=true&disableNarue&productNavBar=disabled&templateUrl=上一步的模板地址`。比如 `https://ros.console.aliyun.com/region/stacks/create?hideStepRow=true&hideStackConfig=true&disableRollback=false&isSimplified=true&disableNarue&productNavBar=disabled&templateUrl=https://gitee.com/demo-user/demo-project/raw/master/template.yml` 。

3. 在项目 `REAME.md` 添加部署章节，引导用户进行自动化部署。例如：

```text
 ## 在阿里云上部署

 1. 单击[一键部署](https://第2步的自动化部署链接)，在顶部导航栏选择地域。

 2. 在配置页面按需选择和配置参数。

 3. 当资源栈信息页面的状态显示为创建成功时表示一键部署完成。
```