Walrus 入门教程:如何创建模板以沉淀可复用的团队最佳实践
模板是 Walrus 的核心功能之一,模板创建完成后用户可以重复使用,并在使用过程中逐渐沉淀研发和运维团队的最佳实践,进一步简化服务及资源的部署。用户可以使用 HCL 语言自定义创建模板,也可以一键复用 Terraform 社区中上万个成熟的 Module。在本文中,我们将以阿里云 EC2 为例,介绍如何创建 Walrus 阿里云 EC2 模板并使用它在阿里云上创建 ECS 实例服务。
前提条件
- 一个用于存储模板的 GitHub 仓库。
- 部署 Walrus(https://seal-io.github.io/docs/zh/deploy/standalone)。
在 GitHub 上创建仓库
在 GitHub 上创建你自己的新仓库,这里我们使用仓库 demo(https://github.com/walrus-catalog-demo/demo)
将仓库克隆到你的本机。
git clone git@github.com:walrus-catalog-demo/demo.git
创建模板文件
- 进入克隆的仓库目录。
cd demo
在目录中创建如下文件:
- demo
- main.tf
- outputs.tf
- variables.tf
- README.md
main.tf文件定义了要创建的资源,这里我们为模板定义了一个阿里云 ECS 实例的资源。
resource "alicloud_instance" "example" {
instance_name = "demo-instance"
instance_type = var.instance_type
image_id = var.image_id
system_disk_category = var.system_disk_category
system_disk_size = var.system_disk_size
internet_charge_type = var.internet_charge_type
internet_max_bandwidth_out = var.internet_max_bandwidth_out
vswitch_id = data.alicloud_vswitches.default.vswitches.0.id
host_name = var.hostname
key_name = "seal-demo"
security_groups = [
data.alicloud_security_groups.default.groups.0.id
]
}
data "alicloud_vpcs" "default" {
name_regex = "default"
}
data "alicloud_vswitches" "default" {
vpc_id = data.alicloud_vpcs.default.vpcs.0.id
}
data "alicloud_security_groups" "default" {
name_regex = "default"
}
resource "null_resource" "health_check" {
depends_on = [
alicloud_instance.example,
]
}
variables.tf文件定义了模板中使用的变量,Walrus 将使用这些变量为用户生成模板填写表单。
Walrus 通过 @label和 @group注释来定义变量的标签和组。可选的@options 注释用于定义变量的下拉选项, 如果没有定义 @options注释,则该变量将在表单中显示为文本框。关于模板变量注释的更多详细信息可以在此链接(https://seal-io.github.io/docs/zh/operation/template#variable-style-extension)查看。
在这个例子中,我们定义了两个组: 基础和高级,它们将在创建服务的模板表单中以两个选项卡的形式显示。
# @label "实例规格"
# @group "基础"
variable "instance_type" {
description = "The instance type of the ECS instance"
default = "ecs.s6-c1m2.small"
}
# @label "VM镜像id"
# @group "基础"
variable "image_id" {
description = "The ID of the image used to launch the ECS instance"
default = "ubuntu_18_04_x64_20G_alibase_20230208.vhd"
}
# @label "系统磁盘类型"
# @group "基础"
# @options ["ephemeral_ssd", "cloud_efficiency", "cloud_ssd", "cloud_essd", "cloud", "cloud_auto"]
variable "system_disk_category" {
description = "The category of the system disk"
default = "cloud_efficiency"
}
# @label "系统盘大小"
# @group "基础"
variable "system_disk_size" {
description = "The size of the system disk, value range: [20, 500]"
default = 40
}
# @label "主机名"
# @group "基础"
variable "hostname" {
type = string
description = "The hostname of the ECS instance"
default = ""
}
# @label "网络计费类型"
# @group "高级"
# @options ["PayByTraffic", "PayByBandwidth"]
variable "internet_charge_type" {
description = "The billing method of the public network bandwidth"
default = "PayByTraffic"
}
# @label "最大出口带宽(MB)"
# @group "高级"
variable "internet_max_bandwidth_out" {
description = "The maximum outbound bandwidth of the public network"
default = 5
}
outputs.tf文件定义了模板的输出,它们将在服务创建后作为服务的输出参数查看,并且可以被其他服务引用。
output "public_ip" {
value = alicloud_instance.example.public_ip
}
output "primary_ip_address" {
value = alicloud_instance.example.primary_ip_address
}
README.md文件是模板的描述。在使用此模板创建服务时,我们可以在模板详情页面查看该模板的具体功能参数及定义。这里我们可以使用工具 terraform-docs来生成模板的描述。
terraform-docs markdown . > README.md
生成的README.md文件如下:
## Requirements
No requirements.
## Providers
| Name | Version |
|------|---------|
| <a name="provider_alicloud"></a> [alicloud](#provider\_alicloud) | n/a |
| <a name="provider_null"></a> [null](#provider\_null) | n/a |
## Modules
No modules.
## Resources
| Name | Type |
|------|------|
| [alicloud_instance.example](https://registry.terraform.io/providers/hashicorp/alicloud/latest/docs/resources/instance) | resource |
| [null_resource.health_check](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |
| [alicloud_security_groups.default](https://registry.terraform.io/providers/hashicorp/alicloud/latest/docs/data-sources/security_groups) | data source |
| [alicloud_vpcs.default](https://registry.terraform.io/providers/hashicorp/alicloud/latest/docs/data-sources/vpcs) | data source |
| [alicloud_vswitches.default](https://registry.terraform.io/providers/hashicorp/alicloud/latest/docs/data-sources/vswitches) | data source |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_hostname"></a> [hostname](#input\_hostname) | The hostname of the ECS instance | `string` | `""` | no |
| <a name="input_image_id"></a> [image\_id](#input\_image\_id) | The ID of the image used to launch the ECS instance | `string` | `"ubuntu_18_04_x64_20G_alibase_20230208.vhd"` | no |
| <a name="input_instance_type"></a> [instance\_type](#input\_instance\_type) | The instance type of the ECS instance | `string` | `"ecs.s6-c1m2.small"` | no |
| <a name="input_internet_charge_type"></a> [internet\_charge\_type](#input\_internet\_charge\_type) | The billing method of the public network bandwidth | `string` | `"PayByTraffic"` | no |
| <a name="input_internet_max_bandwidth_out"></a> [internet\_max\_bandwidth\_out](#input\_internet\_max\_bandwidth\_out) | The maximum outbound bandwidth of the public network | `number` | `5` | no |
| <a name="input_system_disk_category"></a> [system\_disk\_category](#input\_system\_disk\_category) | The category of the system disk | `string` | `"cloud_efficiency"` | no |
| <a name="input_system_disk_size"></a> [system\_disk\_size](#input\_system\_disk\_size) | The size of the system disk, value range: [20, 500] | `number` | `40` | no |
## Outputs
| Name | Description |
|------|-------------|
| <a name="output_primary_ip_address"></a> [primary\_ip\_address](#output\_primary\_ip\_address) | n/a |
| <a name="output_public_ip"></a> [public\_ip](#output\_public\_ip) | n/a |
提交模板版本
git add .
git commit -m "add template files"
git push -u origin main
为模板创建一个标签作为版本。
git tag v0.0.1
git push --tags
在 Walrus 上创建模板
在浏览器中打开 Walrus 并登录。
转到
运维中心下的模板管理,使用我们刚刚创建的模板新建一个模板,这里我们将模板命名为aliyun-ec2。

导入任务完成后,模板将显示在模板列表中,我们可以看到模板版本为刚刚创建的版本 v0.0.1。

在
运维中心的连接器下添加阿里云连接器。配置阿里云连接器到环境.
使用模板
aliyun-ec2创建一个服务, 表单组和标签的渲染是根据上述模板中定义的变量注释自动生成的。

服务创建后,我们可以看到服务的详情和模板的输出

在阿里云控制台检查 ECS 实例,我们可以看到 ECS 实例已成功创建。

Walrus 入门教程:如何创建模板以沉淀可复用的团队最佳实践的更多相关文章
- SharePoint 2013 入门教程之创建页面布局及页面
在SharePoint的使用过程中,页面布局和页面时很重要的两个概念,主要用于数据个性化展示,下面,我们简单介绍一下SharePoint的页面布局和页面的个性化. 一. SharePoint页面模型概 ...
- 无废话SharePoint入门教程三[创建网站集和网站]
一.前言 前两篇文章讲解了什么是SharePoint,并且介绍了在SharePoint中一些常用的概念.但概念终究是概念,我们还是要脚踏实地的去动手实践.下面的文章对于了解SharePoint的人来说 ...
- ActiveReports 报表控件官方中文入门教程 (2)-创建、数据源、浏览以及发布
本篇文章将阐述首次使用 ActiveReports 报表控件 的方法,包括添加报表文件.绑定数据源以及如何发布报表等内容. ActiveReports 报表控件官方中文入门教程 (1)-安装.激活以及 ...
- mySQL学习入门教程——2.创建表
二.创建表 一.创建数据表的SQL语句模型(弱类型)CREATE TABLE [IF NOT EXISTS] 表名称(字段名1 列的类型[属性][索引],字段名2 列的类型[属性][索引],-字段名n ...
- [SharePoint 2013 入门教程 2 ] 创建WEB应用程序,网站集,网站
SharePoint 2013 的 Hello World 由大到小 创建WEB应用程序(老母),网站集(儿子),网站(孙子) 直接确定,其余都默认 填入标题,选好模板.网站集 儿子就有了. 点击页 ...
- 使用 ADD-ON SDK 开发 基于 Html JQuery 和 CSS 的 firefox 插件入门教程1: 创建一个简单的 Add-on
[本文转载自http://sixpoint.me/942/implementing-simple-addon/] 实现一个简单的插件 教程的这个部分带你使用 SDK 来实现, 运行并打包一个插件. 这 ...
- WCF入门教程2——创建第一个WCF程序
本节目标 掌握接口 理解契约式编程 创建宿主程序 创建客户端程序访问服务 什么是接口 认识一下接口 必须知道的接口特性 接口不可以被实例化(常作为类型使用) 实现类必须实现接口的所有方法(抽象类除外) ...
- SharePoint 2013 入门教程之创建及修改母版页
在SharePoint 2013中,微软提供了根据HTML页面转换Master页的方法,并支持单项同步,但是这样的更新,并不完善,会使一些功能造成丢失,所以,了解Master结构的人,尽量直接去修改M ...
- 无废话SharePoint入门教程五[创建SharePoint页面布局]
一.前言 文章成体系,如果有不明白的地方请查看前面的文章. 二.目录 1.创建页面布局 2.首次使用页面布局 3.修改页面布局 4.使用页面布局 5.最终效果 1.创建页面布局 (1)打开设计管理器, ...
- 无废话SharePoint入门教程四[创建SharePoint母版页]
一.前言 文章成体系,如果有不明白的地方请查看前面的文章. 二.目录 1.创建HTML页面 2.将HTML文件转换为SharePoint母版页 3.在 SPD中修改母版页“PlaceHolderMai ...
随机推荐
- K8S 组合命令
强制删除namespace kubectl get namespace [namespace-name] -o json | tr -d "\n" | sed "s/\& ...
- k8s-服务网格实战-入门Istio
背景 终于进入大家都比较感兴趣的服务网格系列了,在前面已经讲解了: 如何部署应用到 kubernetes 服务之间如何调用 如何通过域名访问我们的服务 如何使用 kubernetes 自带的配置 Co ...
- JUC并发编程学习笔记(八)读写锁
读写锁 ReadWriteLock ReadWriteLock只存在一个实现类那就是ReentrantReadWriteLock,他可以对锁实现更加细粒化的控制 读的时候可以有多个阅读器线程同时参与, ...
- STM32CUBEIDE中 Debug 和 Release 的作用/区别/使用场景
基本主流IDE都有该功能选项例如Keil MDK, IAR, Eclipse, VS等, 这里使用STM32CUBEIDE来举例 创建STM32CUBEIDE工程后默认有2个目标选项 Debug / ...
- Spring Cloud Seata 系列:Seata-Server (1.7.1)安装与配置(集成 Nacos)
目录 一.简介 术语 事务模式 XA 模式 AT 模式 TCC 模式 Sage 模式 说明 二.Seata Server 存储模式 1.file 模式 ①修改application.xml ②启动Se ...
- preparedStatement.setString()方法
PreparedStatement作用:PreparedStatement是预编译的,对于批量处理可以大大提高效率. 也叫JDBC存储过程. 1.预编译sql语句,效率高 2.安全,避免sql注入 3 ...
- 【scikit-learn基础】--『数据加载』之真实数据集
上一篇介绍了scikit-learn中的几个玩具数据集,本篇介绍scikit-learn提供的一些真实的数据集.玩具数据集:scikit-learn 基础(01)--『数据加载』之玩具数据集 1. 获 ...
- 光学测量 PPG
参考来源:ADI官网技术文章.知乎(hxl695822705.KingPo-张超.深圳加1健康科技 ) 现状 PPG测量心率.血氧的技术距今发展快100年,影响心率.血氧测量准确度的因素主要有心率传感 ...
- 通过 VS Code 优雅地编辑 Pod 内的代码(非 NodePort)
目录 1. 概述 2. NodePort 方式 3. Ingress 方式 4. 救命稻草 5. 其他 1. 概述 今天聊点啥呢,话说,你有没有想过怎样用 VS Code 连上 K8s 集群内的某个 ...
- 一招MAX降低10倍,现在它是我的了
一.背景 性能优化是一场永无止境的旅程. 到家门店系统,作为到家核心基础服务之一,门店C端接口有着调用量高,性能要求高的特点. C端服务经过演进,核心接口先查询本地缓存,如果本地缓存没有命中,再查询R ...