使用现有OBS部署Kubernetes PVC

应用场景

云容器引擎(Cloud Container Engine,CCE)是一个高可靠高性能的企业级容器管理服务,支持Kubernetes社区原生应用和工具。持久化卷声明(Persistent Volume Claim,PVC)是Kubernetes中用于请求存储资源的抽象接口,允许Pod通过声明的方式请求存储资源,而无需关心底层存储的具体实现。对象存储服务(Object Storage Service,OBS)是华为云提供的高可用、高可靠、高性能、安全、低成本的对象存储服务,可以作为Kubernetes集群的持久化存储后端。

通过将OBS桶作为Kubernetes的持久化存储,可以为容器应用提供可扩展、高可用的存储解决方案。这种方式特别适合需要共享存储、大容量存储或跨可用区数据复制的应用场景。本最佳实践将介绍如何使用Terraform自动化部署一个通过OBS管理PVC的完整方案,包括可用区、实例规格的查询,以及VPC、子网、弹性公网IP、CCE集群、节点、OBS桶等基础设施的创建,以及Kubernetes Secret、Persistent Volume、Persistent Volume Claim和Deployment的创建。

相关资源/数据源

本最佳实践涉及以下主要资源和数据源:

数据源

资源

资源/数据源依赖关系

操作步骤

1. 脚本准备

在指定工作空间中准备好用于编写当前最佳实践脚本的TF文件(如main.tf),确保其中(也可以是其他同级目录下的TF文件)包含部署资源所需的provider版本声明和华为云鉴权信息。 配置介绍参考部署华为云资源前的准备工作一文中的介绍。

2. 配置Kubernetes Provider

由于本最佳实践需要使用Kubernetes provider来创建Kubernetes资源,需要在providers.tf文件中配置Kubernetes provider。在providers.tf文件中添加以下脚本:

参数说明

  • host:Kubernetes API服务器的地址,如果指定了EIP地址则使用该值,否则引用弹性公网IP资源(huaweicloud_vpc_eip.test[0])的地址,端口为5443

  • cluster_ca_certificate:集群CA证书,从CCE集群资源(huaweicloud_cce_cluster.test)的证书信息中获取并解码

  • client_certificate:客户端证书,从CCE集群资源(huaweicloud_cce_cluster.test)的证书信息中获取并解码

  • client_key:客户端密钥,从CCE集群资源(huaweicloud_cce_cluster.test)的证书信息中获取并解码

注意:Kubernetes provider需要访问CCE集群的API服务器,因此需要配置正确的集群地址和证书信息。这些信息可以从CCE集群资源中获取。

3. 通过数据源查询PVC资源创建所需的可用区

在TF文件(如main.tf)中添加以下脚本以告知Terraform进行一次数据源查询,其查询结果用于创建PVC相关资源:

参数说明

  • count:数据源的创建数,用于控制是否执行可用区列表查询数据源,仅当 var.availability_zone 为空时创建数据源(即执行可用区列表查询)

4. 创建VPC资源(可选)

在TF文件中添加以下脚本以告知Terraform创建VPC资源(如果未指定VPC ID和子网ID):

参数说明

  • count:资源的创建数,用于控制是否创建VPC资源,仅当 var.vpc_idvar.subnet_id 都为空时创建VPC资源

  • name:VPC的名称,通过引用输入变量 vpc_name 进行赋值

  • cidr:VPC的CIDR块,通过引用输入变量 vpc_cidr 进行赋值,默认为"192.168.0.0/16"

5. 创建VPC子网资源(可选)

在TF文件中添加以下脚本以告知Terraform创建VPC子网资源(如果未指定子网ID):

参数说明

  • count:资源的创建数,用于控制是否创建VPC子网资源,仅当 var.subnet_id 为空时创建VPC子网资源

  • vpc_id:子网所属的VPC ID,如果指定了VPC ID则使用该值,否则引用VPC资源(huaweicloud_vpc.test[0])的ID进行赋值

  • name:子网的名称,通过引用输入变量 subnet_name 进行赋值

  • cidr:子网的CIDR块,如果指定了子网CIDR则使用该值,否则基于VPC的CIDR块通过 cidrsubnet 函数自动计算

  • gateway_ip:子网的网关IP,如果指定了网关IP则使用该值,否则根据子网CIDR或自动计算的子网CIDR通过 cidrhost 函数自动计算

  • availability_zone:子网所在的可用区,如果指定了可用区则使用该值,否则使用可用区列表查询数据源的第一个可用区

6. 创建弹性公网IP资源(可选)

在TF文件中添加以下脚本以告知Terraform创建弹性公网IP资源(如果未指定EIP地址):

参数说明

  • count:资源的创建数,用于控制是否创建弹性公网IP资源,仅当 var.eip_address 为空时创建弹性公网IP资源

  • publicip:公网IP配置块

    • type:公网IP类型,通过引用输入变量 eip_type 进行赋值,默认为"5_bgp"表示全动态BGP

  • bandwidth:带宽配置块

    • name:带宽的名称,通过引用输入变量 bandwidth_name 进行赋值

    • size:带宽大小(Mbps),通过引用输入变量 bandwidth_size 进行赋值,默认为5

    • share_type:带宽共享类型,通过引用输入变量 bandwidth_share_type 进行赋值,默认为"PER"表示独享

    • charge_mode:带宽计费模式,通过引用输入变量 bandwidth_charge_mode 进行赋值,默认为"traffic"表示按流量计费

7. 创建CCE集群资源

在TF文件中添加以下脚本以告知Terraform创建CCE集群资源:

参数说明

  • name:CCE集群的名称,通过引用输入变量 cluster_name 进行赋值

  • flavor_id:CCE集群的规格ID,通过引用输入变量 cluster_flavor_id 进行赋值,默认为"cce.s1.small"表示小规格集群

  • cluster_version:CCE集群的版本,通过引用输入变量 cluster_version 进行赋值,如果为null则使用最新版本

  • cluster_type:CCE集群的类型,通过引用输入变量 cluster_type 进行赋值,默认为"VirtualMachine"表示虚拟机类型

  • container_network_type:容器网络类型,通过引用输入变量 container_network_type 进行赋值,默认为"overlay_l2"表示L2网络

  • vpc_id:VPC ID,如果指定了VPC ID则使用该值,否则引用VPC资源(huaweicloud_vpc.test[0])的ID进行赋值

  • subnet_id:子网ID,如果指定了子网ID则使用该值,否则引用VPC子网资源(huaweicloud_vpc_subnet.test[0])的ID进行赋值

  • eip:弹性公网IP地址,如果指定了EIP地址则使用该值,否则引用弹性公网IP资源(huaweicloud_vpc_eip.test[0])的地址进行赋值

  • authentication_mode:集群的认证模式,通过引用输入变量 authentication_mode 进行赋值,默认为"rbac"表示基于角色的访问控制

  • delete_all:是否在终止时删除所有资源,通过引用输入变量 delete_all_resources_on_terminal 进行赋值,默认为"true"表示删除所有资源

  • enterprise_project_id:企业项目ID,通过引用输入变量 enterprise_project_id 进行赋值,默认为"0"表示默认企业项目

8. 通过数据源查询节点资源创建所需的实例规格

在TF文件中添加以下脚本以告知Terraform查询符合条件的实例规格:

参数说明

  • count:数据源的查询数,用于控制是否查询实例规格信息,仅当 var.node_flavor_id 为空时查询实例规格信息

  • performance_type:性能类型,通过引用输入变量 node_performance_type 进行赋值,默认为"general"表示通用型

  • cpu_core_count:CPU核心数,通过引用输入变量 node_cpu_core_count 进行赋值,默认为4核

  • memory_size:内存大小(GB),通过引用输入变量 node_memory_size 进行赋值,默认为8GB

  • availability_zone:实例规格所在的可用区,如果指定了可用区则使用该值,否则使用可用区列表查询数据源的第一个可用区

9. 创建密钥对资源

在TF文件中添加以下脚本以告知Terraform创建密钥对资源:

参数说明

  • name:密钥对的名称,通过引用输入变量 keypair_name 进行赋值

10. 创建CCE节点资源

在TF文件中添加以下脚本以告知Terraform创建CCE节点资源:

参数说明

  • cluster_id:节点所属的CCE集群ID,引用CCE集群资源(huaweicloud_cce_cluster.test)的ID进行赋值

  • name:节点的名称,通过引用输入变量 node_name 进行赋值

  • flavor_id:节点的规格ID,如果指定了节点规格ID则使用该值,否则根据计算规格列表查询数据源的返回结果进行赋值

  • availability_zone:节点所在的可用区,如果指定了可用区则使用该值,否则使用可用区列表查询数据源的第一个可用区

  • key_pair:节点使用的密钥对名称,引用密钥对资源(huaweicloud_kps_keypair.test)的名称进行赋值

  • root_volume:根卷配置块

    • volumetype:根卷类型,通过引用输入变量 root_volume_type 进行赋值,默认为"SATA"

    • size:根卷大小(GB),通过引用输入变量 root_volume_size 进行赋值,默认为40GB

  • data_volumes:数据卷配置块(动态块),根据输入变量 data_volumes_configuration 动态创建

    • volumetype:数据卷类型,通过引用输入变量中的数据卷配置进行赋值

    • size:数据卷大小(GB),通过引用输入变量中的数据卷配置进行赋值

11. 创建OBS桶资源

在TF文件中添加以下脚本以告知Terraform创建OBS桶资源:

参数说明

  • bucket:OBS桶的名称,通过引用输入变量 bucket_name 进行赋值

  • multi_az:是否启用多可用区,通过引用输入变量 bucket_multi_az 进行赋值,默认为true表示启用多可用区

12. 创建Kubernetes Secret资源

在TF文件中添加以下脚本以告知Terraform创建Kubernetes Secret资源:

参数说明

  • metadata:元数据配置块

    • name:Secret的名称,通过引用输入变量 secret_name 进行赋值

    • namespace:Secret所在的命名空间,通过引用输入变量 namespace_name 进行赋值,默认为"default"

    • labels:Secret的标签,通过引用输入变量 secret_labels 进行赋值,默认为包含"secret.kubernetes.io/used-by"标签

  • data:Secret的数据,通过引用输入变量 secret_data 进行赋值,包含OBS访问密钥和密钥

  • type:Secret的类型,通过引用输入变量 secret_type 进行赋值,默认为"cfe/secure-opaque"

  • lifecycle:生命周期配置块,用于忽略data参数的更改,因为Secret的数据可能会在外部被修改

13. 创建Kubernetes Persistent Volume资源

在TF文件中添加以下脚本以告知Terraform创建Kubernetes Persistent Volume资源:

参数说明

  • metadata:元数据配置块

    • name:Persistent Volume的名称,通过引用输入变量 pv_name 进行赋值

    • annotations:注解,包含CSI provisioner的身份标识

  • spec:规格配置块

    • access_modes:访问模式列表,通过引用输入变量 pv_access_modes 进行赋值,默认为["ReadWriteMany"]表示多节点读写

    • capacity:容量配置块

      • storage:存储大小,通过引用输入变量 pv_storage 进行赋值,默认为"1Gi"

    • persistent_volume_source:持久化卷源配置块

      • csi:CSI配置块

        • driver:CSI驱动,通过引用输入变量 pv_driver 进行赋值,默认为"obs.csi.everest.io"

        • fs_type:文件系统类型,通过引用输入变量 pv_fstype 进行赋值,默认为"s3fs"

        • volume_handle:卷句柄,引用OBS桶资源(huaweicloud_obs_bucket.test)的桶名称进行赋值

        • volume_attributes:卷属性,包含CSI provisioner身份标识、OBS卷类型、region和企业项目ID

        • node_publish_secret_ref:节点发布密钥引用配置块,引用Kubernetes Secret资源(kubernetes_secret.test)的名称和命名空间

    • persistent_volume_reclaim_policy:回收策略,通过引用输入变量 pv_reclaim_policy 进行赋值,默认为"Retain"表示保留

    • storage_class_name:存储类名称,通过引用输入变量 pv_storage_class_name 进行赋值,默认为"csi-obs"

14. 创建Kubernetes Persistent Volume Claim资源

在TF文件中添加以下脚本以告知Terraform创建Kubernetes Persistent Volume Claim资源:

参数说明

  • metadata:元数据配置块

    • name:Persistent Volume Claim的名称,通过引用输入变量 pvc_name 进行赋值

    • namespace:Persistent Volume Claim所在的命名空间,通过引用输入变量 namespace_name 进行赋值

    • annotations:注解,包含存储provisioner、OBS卷类型、文件系统类型、Secret引用和企业项目ID

  • spec:规格配置块

    • access_modes:访问模式列表,通过引用输入变量 pv_access_modes 进行赋值

    • resources:资源请求配置块

      • requests:资源请求,包含存储大小请求

        • storage:存储大小,通过引用输入变量 pv_storage 进行赋值

    • storage_class_name:存储类名称,通过引用输入变量 pv_storage_class_name 进行赋值

    • volume_name:卷名称,引用Kubernetes Persistent Volume资源(kubernetes_persistent_volume.test)的名称进行赋值

15. 创建Kubernetes Deployment资源

在TF文件中添加以下脚本以告知Terraform创建Kubernetes Deployment资源:

参数说明

  • metadata:元数据配置块

    • name:Deployment的名称,通过引用输入变量 deployment_name 进行赋值

    • namespace:Deployment所在的命名空间,通过引用输入变量 namespace_name 进行赋值

  • spec:规格配置块

    • replicas:Pod副本数,通过引用输入变量 deployment_replicas 进行赋值,默认为2

    • selector:选择器配置块,用于选择Pod

      • match_labels:匹配标签,包含应用名称标签

    • template:Pod模板配置块

      • metadata:Pod元数据配置块

        • labels:Pod标签,包含应用名称标签

      • spec:Pod规格配置块

        • container:容器配置块(动态块),根据输入变量 deployment_containers 动态创建

          • name:容器名称,通过引用输入变量中的容器配置进行赋值

          • image:容器镜像,通过引用输入变量中的容器配置进行赋值

          • volume_mount:卷挂载配置块(动态块),根据输入变量中的容器卷挂载配置动态创建

            • name:卷名称,通过引用输入变量 deployment_volume_name 进行赋值,默认为"pvc-obs-volume"

            • mount_path:挂载路径,通过引用输入变量中的卷挂载配置进行赋值

        • image_pull_secrets:镜像拉取密钥配置块(动态块),根据输入变量 deployment_image_pull_secrets 动态创建

          • name:密钥名称,通过引用输入变量中的镜像拉取密钥配置进行赋值

        • volume:卷配置块

          • name:卷名称,通过引用输入变量 deployment_volume_name 进行赋值

          • persistent_volume_claim:持久化卷声明配置块

            • claim_name:声明名称,引用Kubernetes Persistent Volume Claim资源(kubernetes_persistent_volume_claim.test)的名称进行赋值

  • depends_on:显式依赖,确保CCE节点资源创建完成后再创建Deployment

16. 预设资源部署所需的入参(可选)

本实践中,部分资源、数据源使用了输入变量对配置内容进行赋值,这些输入参数在后续部署时需要手工输入。 同时,Terraform提供了通过tfvars文件预设这些配置的方法,可以避免每次执行时重复输入。

在工作目录下创建terraform.tfvars文件,示例内容如下:

使用方法

  1. 将上述内容保存为工作目录下的terraform.tfvars文件(该文件名可使用户在执行terraform命令时自动导入该tfvars文件中的内容,其他命名则需要在tfvars前补充.auto定义,如variables.auto.tfvars

  2. 根据实际需要修改参数值

  3. 执行terraform planterraform apply时,Terraform会自动读取该文件中的变量值

除了使用terraform.tfvars文件外,还可以通过以下方式设置变量值:

  1. 命令行参数:terraform apply -var="vpc_name=my-vpc" -var="subnet_name=my-subnet"

  2. 环境变量:export TF_VAR_vpc_name=my-vpc

  3. 自定义命名的变量文件:terraform apply -var-file="custom.tfvars"

注意:如果同一个变量通过多种方式进行设置,Terraform会按照以下优先级使用变量值:命令行参数 > 变量文件 > 环境变量 > 默认值。

17. 初始化并应用Terraform配置

完成以上脚本配置后,执行以下步骤来创建资源:

  1. 运行 terraform init 初始化环境

  2. 运行 terraform plan 查看资源创建计划

  3. 确认资源计划无误后,运行 terraform apply 开始创建通过OBS管理PVC的完整方案

  4. 运行 terraform show 查看已创建的通过OBS管理PVC的完整方案

参考信息

Last updated