Usar Terraform

Para configurar Terraform en tu entorno aislado de Google Distributed Cloud (GDC), debes descargarlo y configurarlo para que gestione los recursos de Kubernetes.

Este documento está dirigido a todos los grupos de audiencia que necesiten configurar Terraform para gestionar sus flujos de trabajo de hardware y software aislados. Para obtener más información, consulta la documentación sobre las audiencias de GDC aislado.

Antes de empezar

  • Descarga Terraform 1.6.3 o una versión posterior en tu estación de trabajo siguiendo la documentación proporcionada por HashiCorp: https://developer.hashicorp.com/terraform/install. La configuración de backend de este documento usa ajustes que no se admiten en versiones anteriores de Terraform.

  • Comprueba que tienes un segmento de almacenamiento de GDC. Si no tienes un segmento de almacenamiento, crea uno. Para obtener más información, consulta el artículo Crear segmentos de almacenamiento.

  • Asegúrate de que tu sistema pueda reconocer el certificado de la autoridad de certificación (AC) que usa el almacén de objetos.

  • Instala la CLI gdcloud. Para obtener más información, consulta Usar la CLI gdcloud.

  • Genera el archivo kubeconfig para el servidor de la API o el clúster que aloja los recursos que quieres gestionar con Terraform. Para obtener más información, consulta Obtener un archivo kubeconfig.

Configurar Terraform

Para configurar Terraform en tu entorno de GDC, sigue estos pasos:

  1. En tu módulo de Terraform o en la colección de archivos de Terraform de tu estación de trabajo, crea el archivo main.tf y añade la siguiente configuración:

    terraform {
      backend "s3" {
        bucket = "BUCKET_FQN"
        key = "TF_STATE_PATH"
        region = "ZONE"
        endpoints = {
          s3 = "BUCKET_ENDPOINT"
        }
        use_path_style = true
        access_key = "ACCESS_KEY"
        secret_key = "SECRET_KEY"
        skip_credentials_validation = true
        skip_requesting_account_id = true
        skip_metadata_api_check = true
        skip_region_validation = true
        skip_s3_checksum = true
      }
    }
    

    Haz los cambios siguientes:

    • BUCKET_FQN: el valor status.fullyQualifiedName del recurso personalizado Bucket. Por ejemplo, aabc2z8-platform-terraform-state.

    • TF_STATE_PATH: la ruta del archivo de estado de Terraform que se almacenará en el segmento de almacenamiento. Por ejemplo, main.tfstate.

    • ZONE: la zona del recurso personalizado de Bucket (status.region). Por ejemplo, zone1. Terraform requiere un valor de región, pero el almacén de objetos de GDC no lo comprueba.

    • BUCKET_ENDPOINT: el valor status.endpoint del recurso personalizado Bucket. Por ejemplo, https://objectstorage.org-1.zone1.google.gdch.test.

    • ACCESS_KEY: la clave de acceso adquirida del secreto que contiene tus credenciales de acceso. Para obtener más información sobre cómo adquirir la clave de acceso, consulta Obtener credenciales de acceso a un segmento. El valor del secreto está codificado en Base64. Descodifícalo antes de usarlo.

    • SECRET_KEY: la clave secreta obtenida del secreto que contiene tus credenciales de acceso. Para obtener más información sobre cómo adquirir la clave secreta, consulta el artículo Obtener credenciales de acceso a segmentos. El valor del secreto está codificado en Base64. Descodifícalo antes de usarlo.

    El almacén de objetos de GDC es compatible con S3, pero no es AWS. El resto de los ajustes configuran el backend para el almacenamiento que no sea de AWS S3:

    • use_path_style: usa el direccionamiento de segmentos de estilo de ruta para el almacén de objetos de GDC.

    • skip_credentials_validation y skip_requesting_account_id: impiden que Terraform llame a AWS STS y AWS IAM. GDC no ofrece esos servicios.

    • skip_metadata_api_check: impide que Terraform consulte el servicio de metadatos de AWS EC2.

    • skip_region_validation: te permite usar el nombre de la zona como región.

    • skip_s3_checksum: impide que Terraform solicite una suma de comprobación SHA-256 cuando sube el archivo de estado.

  2. Inicializa tu archivo de estado de Terraform en el segmento de almacenamiento que has especificado en el paso anterior:

    terraform init
    
  3. Despliega el recurso de rol de clúster crd-viewer y vincúlalo a tu cuenta de usuario:

    kubectl apply --kubeconfig KUBECONFIG -f - <<EOF
    apiVersion: rbac.authorization.k8s.io/v1
    kind: ClusterRole
    metadata:
      name: crd-viewer
    rules:
    - apiGroups: ["apiextensions.k8s.io"]
      resources: ["customresourcedefinitions"]
      verbs: ["get", "list", "watch"]
    ---
    apiVersion: rbac.authorization.k8s.io/v1
    kind: ClusterRoleBinding
    metadata:
      name: crd-viewer-binding
    subjects:
    - kind: User
      name: USER_EMAIL
    roleRef:
      kind: ClusterRole
      name: crd-viewer
      apiGroup: rbac.authorization.k8s.io
    EOF
    

    Haz los cambios siguientes:

    • KUBECONFIG: el archivo kubeconfig del servidor de la API o del clúster que aloja los recursos que gestionas con Terraform.

    • USER_EMAIL: el correo del usuario al que se vinculará el rol.

    Despliega el rol crd-viewer en cada servidor de la API o clúster en el que quieras usar Terraform.

  4. En el archivo main.tf, inserta el siguiente bloque required_providers:

    terraform {
      required_providers {
        kubernetes = {
          source = "hashicorp/kubernetes"
          version = ">=2.24.0"
        }
      }
    }
    

    Esta configuración instala el proveedor de Kubernetes para aprovisionar y gestionar recursos de Kubernetes en tu entorno de GDC.

  5. Inicializa tu directorio de trabajo de Terraform para instalar el proveedor:

    terraform init
    

Siguientes pasos