Merge pull request #1 from workhardliuzheng/main

feature: add ros template、doc、config of mysql-ack-manage-service
aliyun-computenest · May 13, 2024 · c739166 · c739166
2 parents bc0c0ed + 4348daa
commit c739166
Show file tree

Hide file tree

Showing 28 changed files with 718 additions and 0 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -0,0 +1,22 @@
+
+name: build
+on:
+  push:
+    branches:
+      - main
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs
+      - run: pip install mkdocs-aliyun-computenest
+      - run: mkdocs gh-deploy --force --clean --verbose
+      - run: |
+          full_repo_name="${{ github.repository }}"
+          repo_name=${full_repo_name#*/}
+          curl -X POST -H "Content-Type: application/json" -d "{"ServiceDocRepoNames":["${repo_name}"]}" "http://1119821156893882.eventbridge.ap-southeast-1.aliyuncs.com/webhook/putEvents?token=d7ae8f64e0ce42c7b757f9013e3bbd13920fe8ea7c2b4d2cb3d2e8e9dfbd4230afc9f9dfb37448448e416da1a85dc2fc81627b00fecd4909bb47e536833d1bae"
+  
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+.idea/
+.DS_Store
+docs/.DS_Store
diff --git a/config.yaml b/config.yaml
@@ -0,0 +1,138 @@
+Service:
+  RegionId: cn-hangzhou
+  DeployType: ros
+  TenantType: SingleTenant
+  DeployMetadata:
+    AllowedRegions:
+      - cn-hangzhou
+      - cn-hongkong
+    ServiceInstanceNameRule:
+      Prefix: mysql
+    SupplierDeployMetadata:
+      RoleName: ${RoleName}
+      UserType: Aliyun
+      SupplierTemplateConfigs:
+        - Name: mysql
+          AllowedRegions:
+            - ${RegionId}
+          Url: 'templates/template.yaml'
+          PredefinedParameters:
+            - Name: 低配版
+              Description: 1副本，20G
+              Parameters:
+                Storage: 20
+                Replicas: 1
+              Type: Normal
+              OrderList:
+                - Storage
+                - Replicas
+            - Name: 基础版
+              Description: 2副本，40G
+              Parameters:
+                Storage: 40
+                Replicas: 2
+              Type: Normal
+              OrderList:
+                - Storage
+                - Replicas
+            - Name: 高配版
+              Description: 2副本，80G
+              Parameters:
+                Storage: 80
+                Replicas: 2
+              Type: Normal
+              OrderList:
+                - Storage
+                - Replicas
+          HiddenParameterKeys:
+            - ClusterId
+            - ConfigParam
+            - Replicas
+          ParameterMappings:
+            - ParameterKey: RegionId
+              ParameterMappingKeys:
+                - ClusterId
+              ParameterValueMapping:
+                ${RegionId}:
+                  Parameters:
+                    ClusterId: ${ClusterId}
+    TemplateConfigs:
+      - Name: mysql
+        AllowedRegions:
+          - ${RegionId}
+  OperationMetadata:
+    ParameterConfigs:
+      - TemplateName: mysql
+        Parameters:
+          max_allowed_packet:
+            Type: String
+            Description: mysql服务器允许最大接收数的据包大小
+            Default: '16M'
+            ConstraintDescription: 8M~512M
+          max_connections:
+            Type: Number
+            Description: 最大连接数
+            Default: '512'
+            ConstraintDescription: 256~1024
+          max_user_connections:
+            Type: Number
+            Default: '48'
+            Description: 用户最大的连接数
+            ConstraintDescription: 32~64
+          thread_cache_size:
+            Type: Number
+            Default: '16'
+            Description: 线程缓存
+            ConstraintDescription: 8,16,32,64
+        Metadata:
+          ParameterGroups:
+            - Parameters:
+                - max_allowed_packet
+                - max_connections
+                - max_user_connections
+                - thread_cache_size
+              TemplateParameter: ConfigParam
+              DefaultValue: |-
+                [mysqld]
+                bind-address=*
+                default_storage_engine=InnoDB
+                binlog_format=row
+                innodb_autoinc_lock_mode=2
+                datadir=/data1/mysql
+                socket=/data1/mysql/mysql.sock
+                max_allowed_packet  = 256M
+                max_connections  = 512
+                max_user_connections = 50
+                thread_cache_size = 16
+                symbolic-links=0
+                sql_mode=NO_ENGINE_SUBSTITUTION,STRICT_TRANS_TABLES
+
+                [client]
+                port=3306
+                socket=/data1/mysql/mysql.sock
+              Formatter: cnf
+              FormatterConfig:
+                SectionName: mysqld
+    StatusOperationConfigs:
+      - TemplateName: mysql
+        DeployScene: ACK
+        Parameters:
+          - Replicas
+        SupportOperations:
+          - Start
+          - Stop
+          - Restart
+    PrometheusIntegrationType: cn-mariadb
+    PrometheusConfigMap:
+      mysql:
+        EnablePrometheus: true
+        GrafanaDashBoardTitle: MySQL Exporter Quickstart and Dashboard
+        GrafanaDashBoardUrl: https://g.console.aliyun.com/d/549c2bf8936f7767ea6ac47c47b00f2a/mysql-exporter-quickstart-and-dashboard?orgId=355401&refresh=10s&var-datasource=cloud-product-prometheus_cn-hongkong_cn-mariadb_1563457855438522_135830&var-job=All&var-instance=All
+  ServiceType: managed
+  ServiceInfo:
+    Locale: zh-CN
+    ShortDescription: Mysql ACK容器多租户yaml部署
+    Image: 'icons/mysql_log.jpeg'
+    Name: Mysql ACK容器yaml部署
+  ShareType: Public
+  ApprovalType: Manual
diff --git a/docs/architecture.png b/docs/architecture.png
diff --git a/docs/deploy_1.png b/docs/deploy_1.png
diff --git a/docs/deploy_2.png b/docs/deploy_2.png
diff --git a/docs/deploy_3.png b/docs/deploy_3.png
diff --git a/docs/deploy_4.png b/docs/deploy_4.png
diff --git a/docs/deploy_5.png b/docs/deploy_5.png
diff --git a/docs/deploy_6.png b/docs/deploy_6.png
diff --git a/docs/deploy_7.png b/docs/deploy_7.png
diff --git a/docs/deploy_8.png b/docs/deploy_8.png
diff --git a/docs/deploy_9.png b/docs/deploy_9.png
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,173 @@
+# 服务模板说明文档
+
+## 服务说明
+
+本文介绍容器服务部署mysql实现托管版多租户的流程，本示例对应的Git仓库地址为：[mysql-managed-ack-demo](https://github.com/aliyun-computenest/mysql-managed-ack-demo)。
+
+根据该服务模板构建的服务默认包含三种套餐：
+
+| 套餐名  | 副本数 | 数据卷容量              |  
+|--------|-----|------------------|
+| 低配版 | 1   | ESSD云盘 20GiB PL0 | 
+| 基础版 | 2   | ESSD云盘 40GiB PL0 | 
+| 高配版 | 2   | ESSD云盘 80GiB PL0 |
+
+本示例创建过程大约持续1分钟，当服务变成待提交后构建成功。
+
+## 服务使用前提准备
+无
+
+## 服务架构
+
+本部署架构为ACK多租户部署，架构如下图所示：
+1. 使用ingress根据域名路由到各个租户的mysql
+2. 每个租户一个k8s namespace，用namespace隔离
+3. mysql使用yaml部署
+
+![architecture.png](architecture.png)
+
+## 开启Prometheus监控配置
+该服务支持配置Prometheus监控，服务实例部署成功后，服务商及其租户都能在控制台查看监控大盘, 开启Prometheus监控需要以下配置**(每个集群配置一次即可**)
+### ACK集群中修改Prometheus的配置【需手动配置】
+1. 到[容器服务控制台](https://cs.console.aliyun.com/)找到自己的集群，修改集群中prom-agent的启动参数，在“arms-prom”的namespace下找到名为“arms-prometheus
+   -ack-arms-prometheus”的Deployment，点击"查看yaml"，
+   ![prom-1.png](prom-1.png)
+   找到启动参数，添加一行以下内容后，点击"更新"
+```yaml
+--nslabelSelector=tenant_userid,tenant_clusterid,tenant_token
+```
+如下图所示:
+![prom-2.png](prom-2.png)
+2.到[ARMS控制台](https://arms.console.aliyun.com/) 找到ACK集群对应的Promethues实例，也可以在容器控制台跳转到对应的Promethues实例，如下图所示：
+![prom-3.png](prom-3.png)
+修改Promethues实例的"服务发现"配置，开启自动同步集群内ServiceMonitor，如下图所示：
+![prom-4.png](prom-4.png)
+配置Promethues实例的采集规则，如下图所示，点击"编辑Prometheus.yaml"
+![prom-5.png](prom-5.png)
+添加以下内容，将下边这段内容中值替换后，添加到Prometheus.yaml中
+```yaml
+remote_write:
+  - basic_auth:
+      password: fake-AK-secret #服务商的AK信息
+      username: fake-AK-id
+    url: http://xxxx  #当前Prometheus实例的remoteWrite内网地址
+```
+其中username和password的值替换为您实际的AK信息，url的值替换为当前Prometheus实例的remoteWrite内网地址，可以在以下位置得到。
+![prom-6.png](prom-6.png)
+Prometheus.yaml示例如下：
+![prom-7.png](prom-7.png)
+### 模板中添加租户标签
+该服务的架构为用namespace隔离各个租户的资源，为了区分各个租户的监控指标，需要给每个namespace打上租户标签，租户标签内容如下：
+```yaml
+tenant_userid: '{{ aliUid }}'
+tenant_clusterid: '{{ tenantClusterId }}'
+tenant_token: '{{ tenantToken }}'
+tenant_cloudproductcode: '{{ tenantCloudProductCode }}'
+```
+该示例服务模板中已经正确配置该租户标签，可直接使用，无需重新配置。示例如下：
+```yaml
+ ClusterNameSpaceApplication:
+    Type: ALIYUN::CS::ClusterApplication
+    Properties:
+      YamlContent:
+        Fn::Sub:
+          - |
+            apiVersion: v1
+            kind: Namespace
+            metadata:
+              name: '${Name}'
+              labels:
+                tenant_userid: '{{ aliUid }}'
+                tenant_clusterid: '{{ tenantClusterId }}'
+                tenant_token: '{{ tenantToken }}'
+                tenant_cloudproductcode: '{{ tenantCloudProductCode }}'
+          - Name: '{{ serviceInstanceId }}'
+```
+### 配置产品标识和对应的大盘链接
+托管版多租服务使用计算巢提供的Prometheus能力，需要设置服务标识和监控大盘信息：
+1. 服务标识：表示服务在监控系统中的唯一标识，该服务中使用"cn-mariadb"为服务标识，**cn-mariadb用于测试**，所有服务共享使用该产品标识。目前cn-mariadb
+   已开通杭州和香港两个地域，支持在这个两个地域下测试。**若需要使用专用服务标识，详情可以通过工单或钉钉交流群咨询计算巢开发同学。**
+2. 监控大盘设置包括监控大盘标题和Grafana大盘链接，监控大盘信息与服务标识是对应关系，在服务标识为cn-mariadb时，大盘标题默认为：MySQL Exporter Quickstart and
+   Dashboard，大盘链接也是固定内容，无需修改。**如需要修改大盘信息，详情可以通过工单或钉钉交流群咨询计算巢开发同学**。
+   该示例服务中已经配置好了监控大盘信息，无需修改，保持默认即可，配置示例如下：
+   ![prom-8.jpg](prom-8.jpg)
+
+## 服务构建计费说明
+
+测试本服务构建无需任何费用，创建服务实例涉及的费用参考下文"服务实例计费说明"。
+
+## RAM账号所需权限
+
+本服务需要对ECS、VPC等资源进行访问和创建操作，若您使用RAM用户创建服务实例，需要在创建服务实例前，对使用的RAM用户的账号添加相应资源的权限。添加RAM权限的详细操作，请参见[为RAM用户授权](https://help.aliyun.com/document_detail/121945.html)。所需权限如下表所示。
+
+| 权限策略名称                          | 备注                     |
+|---------------------------------|------------------------|
+| AliyunCSFullAccess             | 管理容器服务服务（CS）的权限       |
+| AliyunROSFullAccess             | 管理资源编排服务（ROS）的权限       |
+| AliyunComputeNestUserFullAccess | 管理计算巢服务（ComputeNest）的用户侧权限 |
+| AliyunComputeNestSupplierFullAccess | 管理计算巢服务（ComputeNest）的服务商侧权限 |
+| AliyunARMSFullAccess | 管理业务实时监控服务（ARMS）的权限 |
+
+
+## 服务实例计费说明
+
+测试本服务在计算巢上的费用主要涉及：
+
+- 导入的ACK集群的费用
+- 在ACK集群新建的磁盘、网络等费用
+
+
+## 服务实例部署流程
+
+
+### 部署参数说明
+
+| 参数组         | 参数项         | 说明                                            |
+|-------------|-------------|-----------------------------------------------|
+| 服务实例        | 服务实例名称      | 长度不超过64个字符，必须以英文字母开头，可包含数字、英文字母、短划线（-）和下划线（_） |
+|             | 地域          | 服务实例部署的地域                                     |
+|             | 可用区         | mysql数据卷的可用区                                     |
+|             | 数据库root账号密码 | 各个租户的数据库管理密码                                  |
+
+### 部署步骤
+
+0. 部署链接
+   ![deploye_1.png](deploy_1.png)
+1. 单击部署链接，进入服务实例部署界面，根据界面提示，填写参数完成部署
+   ![deploy_2.png](deploy_2.png)
+2. 参数填写完成后可以看到对应询价明细，确认参数后点击**下一步：确认订单**
+3. 确认订单完成后同意服务协议并点击**立即创建**
+   进入待部署阶段。
+   ![deploy_3.png](deploy_3.png)
+4. 在用户侧进入待部署状态后需要服务商同意用户的部署
+   ![deploy_4.png](deploy_4.png)
+   ![deploy_5.png](deploy_5.png)
+5. 等待部署完成后就可以开始使用服务，通过Endpoint即可访问mysql
+   ![deploy_9.png](deploy_9.png)
+6. 部署成功后，用户侧和服务商都可以在控制台查看监控大盘
+   用户侧：
+   ![prom-9.png](prom-9.png)
+7. 用户可根据自己的需求修改mysql的配置参数，进入实例详情，点击修改参数：
+   ![deploy_6.png](deploy_6.png)
+   修改完成后，点击保存，大致需要耗时1分钟左右
+   ![deploy_7.png](deploy_7.png)
+   修改完成后如下图所示
+   ![deploy_8.png](deploy_8.png)
+
+# 更多功能
+
+## 计量计费
+
+[自定义服务架构图](https://help.aliyun.com/zh/compute-nest/customize-a-service-architecture?spm=a2c4g.11186623.0.0.56e736bfyUdlFm])
+
+[服务文档上线流程](https://help.aliyun.com/zh/compute-nest/use-cases/publish-documents-to-compute-nest?spm=a2c4g.313309.0.i0])
+
+[将服务上架云市场并上到云市场售卖](https://help.aliyun.com/zh/compute-nest/publish-a-service-to-alibaba-cloud-marketplace?spm=a2c4g.11186623.0.i7])
+
+## 服务配置
+
+[创建代运维服务完成实例运维](https://help.aliyun.com/zh/compute-nest/create-a-hosted-operations-and-maintenance-service?spm=a2c4g.11186623.0.i24#task-2167552])
+
+[创建包含变配功能的服务](https://help.aliyun.com/zh/compute-nest/use-cases/create-a-service-that-supports-specification-changes-and-change-the-specifications-of-a-service-instance?spm=a2c4g.11186623.0.i3])
+
+[创建包含服务升级功能的服务](https://help.aliyun.com/zh/compute-nest/upgrade-a-service-instance?spm=a2c4g.11186623.0.i17#task-2236803)
diff --git a/docs/prom-1.png b/docs/prom-1.png
diff --git a/docs/prom-2.png b/docs/prom-2.png
diff --git a/docs/prom-3.png b/docs/prom-3.png
diff --git a/docs/prom-4.png b/docs/prom-4.png
diff --git a/docs/prom-5.png b/docs/prom-5.png
diff --git a/docs/prom-6.png b/docs/prom-6.png
diff --git a/docs/prom-7.png b/docs/prom-7.png
diff --git a/docs/prom-8.jpg b/docs/prom-8.jpg
diff --git a/docs/prom-9.png b/docs/prom-9.png
diff --git a/icons/css/custom.css b/icons/css/custom.css
@@ -0,0 +1,4 @@
+img {
+    max-width: 100%; /* 设置图片的最大宽度为屏幕宽度的百分比 */
+    height: auto; /* 自动保持宽高比 */
+}
diff --git a/icons/mysql_log.jpeg b/icons/mysql_log.jpeg
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,5 @@
+site_name: Aliyun 计算巢 x Demo
+theme:
+  name: aliyuncomputenest
+extra_css:
+  - css/custom.css
diff --git a/parameters.yaml b/parameters.yaml
@@ -0,0 +1,42 @@
+ROSTemplateFormatVersion: '2015-09-01'
+# 定义参数
+Parameters:
+  RegionId:
+    Type: String
+    AssociationProperty: ALIYUN::ECS::RegionId
+    Label:
+      en: region id
+      zh-cn: 部署地域
+    AllowedValues:
+      - cn-hangzhou
+      - cn-hongkong
+  RoleName:
+    Type: String
+    AssociationProperty: ALIYUN::RAM::Service::Role
+    AssociationPropertyMetadata:
+      Service: supplier.computenest.aliyuncs.com
+    Description: 请前往RAM控制台创建角色，角色需拥有上述模板定义的资源所需的创建权限。<a href='https://help.aliyun.com/zh/compute-nest/create-a-compute-nest-ram-role-and-grant-permissions-to-the-role' target='_blank'><b> 查看文档</b><font color='blue'></a>
+  # 可用区
+  ClusterId:
+    Type: String
+    AssociationProperty: ALIYUN::CS::Cluster::ClusterId
+    AssociationPropertyMetadata:
+      RegionId: ${RegionId}
+    Label:
+      en: cluster id
+      zh-cn: 容器服务集群ID
+Metadata:
+  ALIYUN::ROS::Interface:
+    # 定义资源分组，创建服务实例时，同一分组的参数分布在一起
+    ParameterGroups:
+      - Parameters:
+          - RegionId
+          - RoleName
+        Label:
+          en: Basic Configuration
+          zh-cn: 基础配置
+      - Parameters:
+          - ClusterId
+        Label:
+          en: Cluster Configuration
+          zh-cn: 集群配置