Usa el controlador de CSI de Persistent Disk de Compute Engine

Google Kubernetes Engine (GKE) proporciona una forma sencilla de implementar y administrar de forma automática el controlador de interfaz de almacenamiento de contenedores (CSI) del disco persistente de Compute Engine en tus clústeres.

La versión del controlador de CSI del disco persistente de Compute Engine está vinculada a los números de la versión de GKE. La versión del controlador de CSI del disco persistente de Compute Engine suele ser el controlador más reciente disponible en el momento en que se lanza la versión de GKE. Los controladores se actualizan de forma automática cuando el clúster se actualiza al último parche de GKE.

Ventajas

El uso del controlador de CSI del disco persistente de Compute Engine proporciona los siguientes beneficios:

  • Esto permite la implementación y la administración automáticas del controlador del disco persistente sin tener que configurarlo de forma manual.
  • Puedes usar claves de encriptación administradas por el cliente (CMEK). Estas se usan para encriptar las claves de encriptación de datos que encriptan tus datos. Para obtener más información sobre CMEK en GKE, consulta Usa CMEK.
  • Puedes usar instantáneas de volumen con el controlador de CSI del disco persistente de Compute Engine. Las instantáneas de volumen te permiten crear una copia del volumen en un momento específico. Puedes usar esta copia para hacer que un volumen vuelva a su estado anterior o con el fin de aprovisionar un volumen nuevo.
  • Puedes usar la clonación de volúmenes con el controlador de CSI del disco persistente de Compute Engine en clústeres que ejecutan la versión 1.22 de GKE y, luego, la clonación de volúmenes posterior te permite crear un duplicado de tu volumen en un específico en un momento determinado, aprovisionados con todos los datos del volumen de origen.
  • La corrección de errores y la actualización de funciones se lanzan de forma independiente de las actualizaciones secundarias de Kubernetes. Por lo general, este programa de lanzamiento da como resultado una cadencia de actualización más rápida.

Requisitos

Para usar el controlador de CSI de disco persistente de Compute Engine, los clústeres deben tener las siguientes versiones:

  • Clústeres de Linux: GKE versión 1.14 o superior.
  • Clústeres de Windows: GKE versión 1.18 o superior.

En la versión 1.22 y en las posteriores, la Migración de CSI está habilitada. En cambio, los volúmenes existentes que usan el proveedor gce-pd se migran para comunicarse a través de controladores de CSI. No se requieren cambios en ninguna StorageClass. El proveedor de gce-pd aún no admite funciones como CMEK, instantáneas de volumen o clonación de volúmenes. Debes usar el proveedor de pd.csi.storage.gke.io en la StorageClass para habilitar estas funciones.

Para usar el controlador de CSI de disco persistente de Compute Engine con Workload Identity, los clústeres deben usar las siguientes versiones:

  • Clústeres de Linux: GKE versión 1.16 o superior.
  • Clústeres de Windows: GKE versión 1.20.8-gke.900 o superior.

Habilita el controlador de CSI de disco persistente de Compute Engine en un clúster nuevo

Para crear un clúster Standard con una versión en la que el controlador de CSI de disco persistente de Compute Engine no esté habilitada de forma automática, puedes usar Google Cloud CLI o la consola de Google Cloud.

Para habilitar el controlador en la creación del clúster, completa los siguientes pasos:

gcloud

gcloud container clusters create CLUSTER-NAME \
    --addons=GcePersistentDiskCsiDriver \
    --cluster-version=VERSION

Reemplaza lo siguiente:

  • CLUSTER-NAME: El nombre de tu clúster.
  • VERSION: el número de versión de GKE. Debes seleccionar la versión 1.14 o una versión posterior para usar esta característica.

Para ver la lista completa de marcas, consulta la documentación de gcloud container clusters create.

Console

  1. Ve a la página de Google Kubernetes Engine en la consola de Cloud.

    Ir a Google Kubernetes Engine

  2. Haz clic en Crear.

  3. En la sección Estándar, haz clic en Configurar.

  4. Configura el clúster como quieras.

  5. En el panel de navegación, en Clúster, haz clic en Funciones.

  6. Selecciona la casilla de verificación Habilita el controlador de CSI de Persistent Disk para Compute Engine.

  7. Haga clic en Crear.

Después de habilitar el controlador CSI del disco persistente de Compute Engine, puedes usarlo en volúmenes de Kubernetes con el nombre de controlador y aprovisionador: pd.csi.storage.gke.io.

Habilita el controlador de CSI de disco persistente de Compute Engine en un clúster existente

Para habilitar el controlador de CSI de disco persistente de Compute Engine en clústeres estándar existentes, usa Google Cloud CLI o la consola de Google Cloud.

Para habilitar el controlador en un clúster existente, completa los siguientes pasos:

gcloud

gcloud container clusters update CLUSTER-NAME \
   --update-addons=GcePersistentDiskCsiDriver=ENABLED

Reemplaza CLUSTER-NAME por el nombre del clúster existente.

Console

  1. Ve a la página de Google Kubernetes Engine en la consola de Cloud.

    Ir a Google Kubernetes Engine

  2. En la lista de clústeres, haz clic en el nombre del clúster que deseas modificar.

  3. En Funciones junto al campo Controlador de CSI del disco persistente de Compute Engine, haz clic en Edita el controlador de CSI de Compute Engine.

  4. Selecciona la casilla de verificación Habilitar el controlador de CSI de Persistent Disk de Compute Engine.

  5. Haz clic en Save Changes.

Inhabilita el controlador de CSI de disco persistente de Compute Engine

Puedes inhabilitar el controlador de CSI del disco persistente de Compute Engine para clústeres estándar mediante Google Cloud CLI o la consola de Google Cloud.

Si inhabilitas el controlador, no se finalizarán los Pods que usen PersistentVolumes pertenecientes al controlador. Además, fallará el inicio de todos los Pods nuevos que intenten usar esos PersistentVolumes.

Para inhabilitar el controlador en un clúster Estándar existente, completa los siguientes pasos:

gcloud

gcloud container clusters update CLUSTER-NAME \
    --update-addons=GcePersistentDiskCsiDriver=DISABLED

Reemplaza CLUSTER-NAME por el nombre del clúster existente.

Console

  1. Ve a la página de Google Kubernetes Engine en la consola de Cloud.

    Ir a Google Kubernetes Engine

  2. En la lista de clústeres, haz clic en el nombre del clúster que deseas modificar.

  3. En Funciones junto al campo Controlador de CSI del disco persistente de Compute Engine, haz clic en Edita el controlador de CSI de Compute Engine.

  4. Selecciona la casilla de verificación Habilita el controlador de CSI de disco persistente de Compute Engine.

  5. Haz clic en Save Changes.

Usa el controlador de CSI de disco persistente de Compute Engine para clústeres de Linux

En las siguientes secciones, se describe el proceso típico para usar un volumen de Kubernetes respaldado por un controlador de CSI en GKE. Estas secciones son específicas para clústeres que usan Linux.

Crea un StorageClass

Después de habilitar el controlador CSI del disco persistente de Compute Engine, GKE instala de forma automática las siguientes StorageClasses:

  • standard-rwo, con disco persistente balanceado
  • premium-rwo, con disco persistente SSD

Para los clústeres Autopilot, la StorageClass predeterminada es standard-rwo, que usa el controlador de CSI del disco persistente de Compute Engine. Para los clústeres estándar, la StorageClass predeterminada usa el complemento de volumen gcePersistentDisk en árbol de Kubernetes.

Para encontrar el nombre de la StorageClass instalada, ejecuta el siguiente comando:

kubectl get sc

También puedes instalar una StorageClass diferente que use el controlador de CSI del disco persistente de Compute Engine. Para ello, agrega pd.csi.storage.gke.io en el campo del aprovisionador.

Por ejemplo, puedes crear un StorageClass mediante el siguiente archivo llamado pd-example-class.yaml:

apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
  name: pd-example
provisioner: pd.csi.storage.gke.io
volumeBindingMode: WaitForFirstConsumer
allowVolumeExpansion: true
parameters:
  type: pd-balanced

Cualquier tipo de disco persistente se puede especificar en el parámetro type (por ejemplo, pd-ssd, pd-standard o pd-balanced).

Después de crear el archivo pd-example-class.yaml, ejecuta el siguiente comando:

kubectl create -f pd-example-class.yaml

Crea una PersistentVolumeClaim

Puedes crear una PersistentVolumeClaim que haga referencia a la StorageClass del controlador de CSI del disco persistente de Compute Engine.

En el siguiente archivo, llamado pvc-example.yaml, se usa la clase de almacenamiento standard-rwo instalada previamente:

kind: PersistentVolumeClaim
apiVersion: v1
metadata:
  name: podpvc
spec:
  accessModes:
  - ReadWriteOnce
  storageClassName: standard-rwo
  resources:
    requests:
      storage: 6Gi

Después de crear el manifiesto de PersistentVolumeClaim, ejecuta el siguiente comando:

kubectl create -f pvc-example.yaml

En la StorageClass instalada previamente (standard-rwo), volumeBindingMode se configura como WaitForFirstConsumer. Cuando volumeBindingMode se establece como WaitForFirstConsumer, el PersistentVolume no se aprovisiona hasta que se programa un Pod que haga referencia a la PersistentVolumeClaim. Si volumeBindingMode en la StorageClass se configura como Immediate (o se omite), se aprovisiona un PersistentVolume respaldado por un disco persistente luego de que se crea la PersistentVolumeClaim.

Crea un Pod que consuma el volumen

Cuando uses Pods con PersistentVolumes, te recomendamos usar un controlador de carga de trabajo (como Deployment o StatefulSet). Si bien no se suele usar un Pod independiente, en el siguiente ejemplo, se usa uno para mayor simplicidad.

En el siguiente ejemplo, se consume el volumen que creaste en la sección anterior:

apiVersion: v1
kind: Pod
metadata:
  name: web-server
spec:
  containers:
   - name: web-server
     image: nginx
     volumeMounts:
       - mountPath: /var/lib/www/html
         name: mypvc
  volumes:
   - name: mypvc
     persistentVolumeClaim:
       claimName: podpvc
       readOnly: false

Usa el controlador de CSI de disco persistente de Compute Engine para clústeres de Windows

En las siguientes secciones, se describe el proceso típico para usar un volumen de Kubernetes respaldado por un controlador de CSI en GKE. Estas secciones son específicas para clústeres que usan Windows.

Asegúrate de que se cumplan estas condiciones:

  • La versión del clúster es 1.19.7-gke.2000, 1.20.2-gke.2000 o superior.
  • Las versiones de nodo son 1.18.12-gke.1203, 1.19.6-gke.800 o superiores.

Crea un StorageClass

Crear una StorageClass para Windows es muy similar a hacerlo en Linux. Debes tener en cuenta que la StorageClass instalada de forma predeterminada no funcionará para Windows porque el tipo de sistema de archivos es diferente. El controlador de CSI de disco persistente de Compute Engine para Windows requiere NTFS como tipo de sistema de archivos.

Por ejemplo, puedes crear una StorageClass mediante el siguiente archivo llamado pd- windows-class.yaml. Asegúrate de agregar csi.storage.k8s.io/fstype: NTFS a la lista de parámetros:

apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
  name: pd-sc-windows
provisioner: pd.csi.storage.gke.io
volumeBindingMode: WaitForFirstConsumer
allowVolumeExpansion: true
parameters:
  type: pd-balanced
  csi.storage.k8s.io/fstype: NTFS

Crea una PersistentVolumeClaim

Después de crear una StorageClass para Windows, puedes crear un PersistentVolumeClaim que haga referencia a esa StorageClass:

kind: PersistentVolumeClaim
apiVersion: v1
metadata:
  name: podpvc-windows
spec:
  accessModes:
  - ReadWriteOnce
  storageClassName: pd-sc-windows
  resources:
    requests:
      storage: 6Gi

Crea un Pod que consuma el volumen

En el siguiente ejemplo, se consume el volumen que creaste en la tarea anterior:

apiVersion: v1
kind: Pod
metadata:
  name: web-server
spec:
  nodeSelector:
    kubernetes.io/os: windows
  containers:
    - name: iis-server
      image: mcr.microsoft.com/windows/servercore/iis
      ports:
      - containerPort: 80
      volumeMounts:
      - mountPath: /var/lib/www/html
        name: mypvc
  volumes:
    - name: mypvc
      persistentVolumeClaim:
        claimName: podpvc-windows
        readOnly: false

Usa el controlador de CSI de disco persistente de Compute Engine con tipos de sistema de archivos no predeterminados

El tipo de sistema de archivos predeterminado para los discos persistentes de Compute Engine en GKE es ext4. También puedes usar el tipo de almacenamiento xfs siempre que la imagen de tu nodo lo admita. Consulta Compatibilidad de controladores de almacenamiento para obtener una lista de controladores compatibles por imagen de nodo.

En el siguiente ejemplo, se muestra cómo usar xfs como el tipo de sistema de archivos predeterminado en lugar de ext4 con el controlador de CSI del disco persistente de Compute Engine.

Crea un StorageClass

  1. Guarda el siguiente manifiesto YAML como un archivo llamado pd-xfs-class.yaml.

    apiVersion: storage.k8s.io/v1
    kind: StorageClass
    metadata:
      name: xfs-class
    provisioner: pd.csi.storage.gke.io
    parameters:
      type: pd-standard
      csi.storage.k8s.io/fstype: xfs
    volumeBindingMode: WaitForFirstConsumer
    
  2. Aplica el manifiesto

    kubectl apply -f pd-xfs-class.yaml
    

Crea una PersistentVolumeClaim

  1. Guarda el siguiente manifiesto como pd-xfs-pvc.yaml:

    apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
      name: xfs-pvc
    spec:
      storageClassName: xfs-class
      accessModes:
        - ReadWriteOnce
      resources:
        requests:
          storage: 10Gi
    
  2. Aplica el manifiesto

    kubectl apply -f pd-xfs-pvc.yaml
    

Crea un Pod que consuma el volumen

  1. Guarda el siguiente manifiesto como pd-xfs-pod.yaml:

    apiVersion: v1
    kind: Pod
    metadata:
      name: pd-xfs-pod
    spec:
      containers:
      - name: cloud-sdk
        image: google/cloud-sdk:slim
        args: ["sleep","3600"]
        volumeMounts:
        - mountPath: /xfs
          name: xfs-volume
      volumes:
      - name: xfs-volume
        persistentVolumeClaim:
          claimName: xfs-pvc
    
  2. Aplica el manifiesto

    kubectl apply -f pd-xfs-pod.yaml
    

Verifica que el volumen se haya activado de forma correcta

  1. Abre una sesión de shell en el Pod:

    kubectl exec -it pd-xfs-pod -- /bin/bash
    
  2. Busca particiones xfs:

    df -aTh --type=xfs
    

    El resultado debería ser similar al ejemplo siguiente:

    Filesystem     Type  Size  Used Avail Use% Mounted on
    /dev/sdb       xfs    30G   63M   30G   1% /xfs
    

Visualiza los registros del controlador de CSI de Persistent Disk para Compute Engine

Puedes usar Cloud Logging para ver eventos relacionados con el controlador de CSI de Persistent Disk para Compute Engine. Los registros pueden ayudarte a solucionar problemas.

Para obtener más información sobre Cloud Logging, consulta Visualiza los registros de GKE.

Para ver los registros del controlador de CSI de Persistent Disk para Compute Engine, completa los siguientes pasos:

  1. Ve a la página Cloud Logging en la consola de Cloud.

    Ir a Cloud Logging

  2. Ejecute la siguiente consulta:

     resource.type="k8s_container"
     resource.labels.project_id="PROJECT_ID"
     resource.labels.location="LOCATION"
     resource.labels.cluster_name="CLUSTER_NAME"
     resource.labels.namespace_name="kube-system"
     resource.labels.container_name="gce-pd-driver"
    

    Reemplaza lo siguiente:

    • PROJECT_ID: nombre del proyecto.
    • LOCATION: la región o zona de Compute Engine del clúster.
    • CLUSTER_NAME: El nombre de tu clúster.

Problemas conocidos

Debido a una restricción de 128 caracteres en la especificación de ID de nodo de la CSI y la forma en que GKE genera nombres de instancias, puede que la instalación del controlador de CSI del disco persistente de Compute Engine falle en clústeres de GKE nuevos y existentes en determinados grupos de nodos. Para obtener más información, consulta este problema de GitHub.

Este problema se solucionó en las siguientes versiones:

  • 1.16.15-gke.1700 y posteriores
  • 1.17.9-6300 y posteriores
  • 1.18.6-4801 y posteriores

Si usas un clúster con una versión anterior, actualiza a una de las versiones enumeradas para resolver el problema.

¿Qué sigue?