Meshery Catalog 实战:导入并部署 Simple MySQL Pod 设计模式
Meshery Catalog 实战:导入并部署 Simple MySQL Pod 设计模式
本篇技术指南聚焦 Meshery 开源仓库中的目录(Catalog)设计模式 Simple MySQL Pod,它是一条 type: deployment 的部署类设计,用于在 Kubernetes 集群中快速拉起一个携带环境变量配置的 MySQL Pod。文章将完整拆解该目录条目的元数据含义、其背后的设计文件(designs.meshery.io/v1beta1 规范)中组件与关系的结构、以及如何通过 mesheryctl design import / deploy / apply 将其落地到真实集群。读完本文,你将掌握 Meshery 设计文件(Design)的组成单元、关系(Relationship)机制,并能熟练用命令行导入并部署此类 Catalog 设计。
从目录条目说起:Simple MySQL Pod 的元数据
仓库中的目录条目文档 68a67a3a-eb39-472e-8d9c-a3b34fa23a71.md 采用 Hugo 的 Front Matter 格式,本身是连接 Meshery Catalog 与具体设计文件的“索引卡”。其中几个字段直接决定了该设计在 Catalog 中的分类与可检索性:
| 字段 | 值 | 含义 |
|---|---|---|
name |
Simple MySQL Pod |
设计的展示名称 |
type |
deployment |
目录分类为“部署”类设计 |
compatibility |
mysql-operator |
兼容/配套的模型标注 |
publishedVersion |
0.0.1 |
目录条目发布版本 |
patternId |
68a67a3a-eb39-472e-8d9c-a3b34fa23a71 |
设计全局唯一 ID |
patternInfo |
Testing patterns |
用途说明(测试用设计) |
patternCaveats |
None |
使用注意项(无) |
downloadLink |
68a67a3a-eb39-472e-8d9c-a3b34fa23a71/design.yml |
指向实际设计文件 |
image |
/assets/images/logos/service-mesh-pattern.svg |
Catalog 展示图 |
配套的 artifacthub-pkg.yml 提供了包级元数据,其中最关键的是安装命令字段:
name: simple-mysql-pod
displayName: Simple MySQL Pod
description: Testing patterns
license: Apache-2.0
install: mesheryctl design import -f
也就是说,官方推荐的消费方式就是通过 mesheryctl design import -f <file> 将设计导入 Meshery,再部署到集群。下面我们把这条“索引卡”指向的设计文件本身逐层拆开。
设计文件结构:designs.meshery.io/v1beta1
真正的设计内容位于 design.yml,其顶层声明的 schema 为 designs.meshery.io/v1beta1,内部由两大块组成:
- components:设计中的全部资源组件与注解组件;
- relationships:组件之间由 Meshery 关系引擎派生的关联定义。
设计内部版本号为 0.0.133(version 字段),id 与目录条目保持一致。整份设计由 4 个组件构成:
| 组件(displayName) | kind | model | 说明 |
|---|---|---|---|
NodeGroupInventoryWallet |
NodeGroupInventoryWallet(core.meshery.io/v1alpha1) |
meshery-core 0.7.2 | 注解组件,dependsOn: ["mysql-pod-sg"] |
container-bwy |
Container(core.meshery.io/v1alpha1) |
meshery-core 0.7.2 | 容器抽象注解组件 |
default |
Namespace(v1) |
kubernetes | 目标命名空间 |
mysql-pod-sg |
Pod(v1) |
kubernetes | 实际部署的 MySQL Pod |
组件块遵循 components.meshery.io/v1beta1 的 schema,每个组件都携带 format: JSON、status: enabled 以及完整的样式(styles)元数据,例如 Pod 组件会引用 ui/public/static/img/meshmodels/kubernetes/color/pod-color.svg 等图标资源,这是 Meshery 可视化画布渲染的依据。
核心配置:MySQL Pod 的容器规格
设计中最具实操价值的部分是 mysql-pod-sg 这个 Pod 组件的 configuration 字段,它等价于一个精简后的 Kubernetes Pod 声明:
{
"spec": {
"containers": [
{
"name": "mysql-container-sg",
"image": "mysql:5.6",
"imagePullPolicy": "IfNotPresent",
"env": [
{ "name": "MYSQL_ROOT_PASSWORD", "value": "strongpassword" }
]
}
]
},
"metadata": {
"labels": {},
"namespace": "default",
"annotations": {}
}
}
逐项拆解:
- 镜像
mysql:5.6:固定版本的 MySQL 官方镜像。需要注意 5.6 属于较老的生命周期版本,生产环境请按需替换为受支持的版本,这里作为测试设计保留原始取值。 imagePullPolicy: IfNotPresent:节点本地已有镜像则不重新拉取,节省带宽与启动时间。- 环境变量
MYSQL_ROOT_PASSWORD=strongpassword:MySQL 官方镜像要求通过该环境变量指定 root 密码。作为测试设计,这里明文写死了弱密码,部署后应立即修改或改用 Secret 挂载。
该 Pod 被放置于 default 命名空间,labels 与 annotations 均为空,等待后续通过配置或关系进行填充。
Relationships:关系引擎如何自动编排
Simple MySQL Pod 设计的价值不止于“一个 Pod 声明”,更在于它演示了 Meshery 的关系(Relationship)机制——部署时无需手动拼装,关系引擎会根据匹配规则自动补齐配置。该设计包含三类 hierarchical 关系,schema 为 relationships.meshery.io/v1alpha3:
1. parent / inventory(Pod → Namespace)
将 Pod 的 configuration.metadata.namespace 以 replace 策略写入 Namespace 组件,同时把 Namespace 的 displayName 作为 Patcher 回填。效果:Pod 自动归属到 default 命名空间。
2. parent / alias(Container → Pod)
这是“容器别名”关系:meshery-core 模型下的 Container 组件(container-bwy)与 kubernetes 模型下的 Pod 组件建立映射,mutatedRef 与 mutatorRef 都指向 configuration.spec.containers[0],patch 策略为 replace。效果:画布上配置的容器抽象,会被替换进 Pod 的第一个容器槽位,即最终的 mysql-container-sg。
3. sibling / matchlabels(注解组件与 Pod、Container 之间)
通过 configuration.metadata.labels 的 refs 匹配建立“兄弟”关系,用于让画布上的注解节点(如 NodeGroupInventoryWallet)与真实工作负载形成关联视图。
这类“以声明定义组件、以规则自动连接”的方式,正是 Meshery 设计(Design)与普通 Kubernetes Manifest 的本质区别:Manifest 需要手动写全每个字段,而 Design 可以依赖关系引擎在导入/部署时完成配置缝合。
导入、部署与应用到集群
导入设计
按照 artifacthub-pkg.yml 给出的安装方式,导入本设计:
mesheryctl design import -f docs/data/catalog/68a67a3a-eb39-472e-8d9c-a3b34fa23a71/0.0.1/design.yml
import 子命令支持 -f(文件或 URL)、-s(源类型)、-n(设计名称)三个参数,源码定义见 import.go。源类型可取值包括 Helm Chart、Kubernetes Manifest、Meshery Design、Docker Compose,内部会归一化映射到对应枚举。若 -f 指向本地文件,则读取文件内容并组装请求体;若指向 URL,则组装 URL 载荷,最终统一 POST 到服务端 /api/pattern/import 接口(见 import.go)。
请求体通过 schema 生成的联合类型 MesheryPatternImportRequestBody 构造,文件分支必须携带驼峰命名的 fileName 字段——import_test.go 中的回归测试专门断言了这一点,如果退回旧版下划线命名 file_name,服务端会因 oneOf 不匹配而拒绝请求("Invalid design import request")。
部署设计
导入后有两种部署路径:
- 按名称部署已保存的设计(deploy.go 的
-f省略时走搜索流程):
mesheryctl design apply "Simple MySQL Pod"
apply 会先通过 GET /api/pattern?populate=pattern_file&search=<name> 检索设计,解析出 PatternFile 后 POST /api/pattern/deploy(见 apply.go)。
- 直接部署文件(deploy 子命令):
mesheryctl design deploy -f <design.yml 路径> -s "Meshery Design"
deploy 的流程是先导入、再部署:RunE 中调用 importPattern 完成导入,随后将解析出的 PatternFile 序列化为 YAML 载荷发送到 /api/pattern/deploy(见 deploy.go)。若多个同名设计命中搜索,CLI 会以交互方式列出索引供选择(multiplepatternsConfirmation)。若仅想部署而不保存设计,可加 --skip-save 标志直接读取文件。
部署后的校验
部署完成后,可以在 Meshery UI 的画布上看到 mysql-pod-sg Pod 及其 default 命名空间归属;在集群侧可通过 kubectl get pod -n default 验证 Pod 状态与镜像版本。由于设计采用了 MYSQL_ROOT_PASSWORD 明文环境变量,建议在验证完毕后删除该设计(mesheryctl design delete)或改用 Kubernetes Secret 存放凭据。
结语与扩展阅读
Simple MySQL Pod 看似只是一个“测试用”的轻量目录条目,却完整覆盖了 Meshery 设计体系的三个关键概念:组件(Component)声明配置、关系(Relationship)自动补全、CLI 导入部署闭环。如果你需要继续深挖,可以在仓库中对照以下内容:
以此设计为样板,你可以轻松在 Meshery 中构建自己的 MySQL 工作负载(例如换成 mysql:8.0 镜像、添加持久卷声明或 Secret 化密码),并借助关系引擎自动完成命名空间与容器的配置编排。