Usa instantáneas de volumen

En Google Kubernetes Engine (GKE), puedes usar la función de instantánea de volumen de Kubernetes para volúmenes persistentes en los clústeres de GKE.

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 para aprovisionar un volumen nuevo.

A partir de la versión 1.17 o posterior de GKE, puedes aprovisionar y adjuntar instantáneas de volumen con los siguientes componentes:

Requisitos

Para usar instantáneas de volumen en GKE, debes cumplir con los siguientes requisitos:

Antes de comenzar

Antes de comenzar, asegúrate de haber realizado las siguientes tareas:

  • Asegúrate de que habilitaste la API de Google Kubernetes Engine.
    • Habilitar la API de Google Kubernetes Engine
  • Asegúrate de que instalaste el SDK de Cloud.
  • Establece la configuración predeterminada de la herramienta de línea de comandos de gcloud para tu proyecto mediante uno de los siguientes métodos:
    • Usa gcloud init si deseas ver una explicación sobre cómo configurar los valores predeterminados del proyecto.
    • Usa gcloud config para configurar el ID, la zona y la región del proyecto de manera individual.

    gcloud init

    1. Ejecuta gcloud init y sigue las instrucciones:

      gcloud init

      Si usas SSH en un servidor remoto, usa la marca --console-only para evitar que el comando abra un navegador:

      gcloud init --console-only
    2. Sigue las instrucciones para autorizar a la herramienta de gcloud a usar tu cuenta de Google Cloud.
    3. Crea una configuración nueva o selecciona una existente.
    4. Elige un proyecto de Google Cloud.
    5. Elige una zona de Compute Engine predeterminada.
    6. Elige una región de Compute Engine predeterminada.

    gcloud config

    1. Establece tu ID del proyecto predeterminado:
      gcloud config set project PROJECT_ID
    2. Configura la región de Compute Engine predeterminada (por ejemplo, us-central1): 
      gcloud config set compute/region COMPUTE_REGION
    3. Configura la zona de Compute Engine predeterminada (por ejemplo, us-central1-c): 
      gcloud config set compute/zone COMPUTE_ZONE
    4. Actualiza gcloud a la versión más reciente:
      gcloud components update

    Cuando configuras las ubicaciones predeterminadas, puedes evitar errores en la herramienta gcloud como el siguiente: One of [--zone, --region] must be supplied: Please specify location.

Crea y usa una instantánea de volumen

En los ejemplos de este documento, se muestra cómo hacer las siguientes tareas:

  1. Crear un PersistentVolumeClaim y Deployment.
  2. Agregar un archivo al recurso PersistentVolume que usa el Deployment.
  3. Crear un VolumeSnapshotClass para configurar la instantánea.
  4. Crear una instantánea de volumen del PersistentVolume.
  5. Borrar el archivo de prueba.
  6. Restablecer el PersistentVolume en la instantánea que creaste.
  7. Verificar que la restauración funcionó.

Para usar una instantánea de volumen, debes completar los siguientes pasos:

  1. Crea un objeto VolumeSnapshotClass a fin de especificar el controlador CSI y la política de eliminación para tu instantánea.
  2. Crea un objeto VolumeSnapshot para solicitar una instantánea de un PersistentVolumeClaim existente.
  3. Haz referencia a VolumeSnapshot en una PersistentVolumeClaim para restablecer un volumen en esa instantánea o crear un volumen nuevo con la instantánea.

Crea un PersistentVolumeClaim y un Deployment

  1. Para crear el objeto PersistentVolumeClaim, guarda el siguiente manifiesto como my-pvc.yaml:

    apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: my-pvc
spec:
  storageClassName: standard-rwo
  accessModes:
  - ReadWriteOnce
  resources:
    requests:
      storage: 1Gi

    Para spec.storageClassName, puedes especificar cualquier clase de almacenamiento que use un controlador CSI compatible. En este ejemplo, se usa la clase de almacenamiento standard-rwo instalada de forma predeterminada con el controlador CSI del disco persistente de Compute Engine. Para obtener más información, consulta Usa el controlador CSI del disco persistente de Compute Engine.

  2. Aplica el manifiesto

    kubectl apply -f my-pvc.yaml

  3. Para crear un Deployment, guarda el siguiente manifiesto como my-deployment.yaml:

    apiVersion: apps/v1
kind: Deployment
metadata:
  name: hello-app
spec:
  selector:
    matchLabels:
      app: hello-app
  template:
    metadata:
      labels:
        app: hello-app
    spec:
      containers:
      - name: hello-app
        image: google/cloud-sdk:slim
        args: [ "sleep", "3600" ]
        volumeMounts:
        - name: sdk-volume
          mountPath: /usr/share/hello/
      volumes:
      - name: sdk-volume
        persistentVolumeClaim:
          claimName: my-pvc

  4. Aplica el manifiesto

    kubectl apply -f my-deployment.yaml

  5. Verifica el estado del Deployment:

    kubectl get deployment hello-app

    Es posible que el Deployment tarde un poco en estar listo. Puedes ejecutar el comando anterior hasta que veas un resultado similar al siguiente:

    NAME        READY   UP-TO-DATE   AVAILABLE   AGE
hello-app   1/1     1            1           2m55s

Agrega un archivo de prueba al volumen

  1. Enumera los Pods en el Deployment:

    kubectl get pods -l app=hello-app

    El resultado es similar a este:

    NAME                         READY   STATUS    RESTARTS   AGE
hello-app-6d7b457c7d-vl4jr   1/1     Running   0          2m56s

  2. Crea un archivo de prueba en un pod:

    kubectl exec POD_NAME \
    -- sh -c 'echo "Hello World!" > /usr/share/hello/hello.txt'

    Reemplaza POD_NAME con el nombre del pod.

  3. Verifica que el archivo exista:

    kubectl exec POD_NAME \
    -- sh -c 'cat /usr/share/hello/hello.txt'

    El resultado es similar al siguiente:

    Hello World!

Crea un objeto VolumeSnapshotClass

Crea un objeto VolumeSnapshotClass a fin de especificar el controlador CSI y deletionPolicy para la instantánea de volumen. Puedes hacer referencia a objetos VolumeSnapshotClass cuando creas objetos VolumeSnapshot.

  1. Guarda el siguiente manifiesto como volumesnapshotclass.yaml. Puedes usar las versiones v1beta1 o v1 de la API, según la versión de GKE en tu clúster.

    v1beta1

    Usa la versión de la API v1beta1 para clústeres que ejecutan las versiones 1.21 o anteriores.

    apiVersion: snapshot.storage.k8s.io/v1beta1
kind: VolumeSnapshotClass
metadata:
  name: my-snapshotclass
driver: pd.csi.storage.gke.io
deletionPolicy: Delete

    v1

    Usa la versión de la API v1 para clústeres que ejecutan la versión 1.21 o posterior.

    apiVersion: snapshot.storage.k8s.io/v1
kind: VolumeSnapshotClass
metadata:
  name: my-snapshotclass
driver: pd.csi.storage.gke.io
deletionPolicy: Delete

    En este ejemplo:

    • El controlador de CSI usa el campo driver para aprovisionar la instantánea. En este ejemplo, pd.csi.storage.gke.io usa el controlador CSI del disco persistente de Compute Engine.

    • El campo deletionPolicy le indica a GKE qué hacer con el objeto VolumeSnapshotContent y la instantánea subyacente cuando se borra el objeto VolumeSnapshot vinculado. Especifica Delete para borrar el objeto VolumeSnapshotContent y la instantánea subyacente. Especifica Retain si deseas conservar VolumeSnapshotContent y la instantánea subyacente.

    Para usar una ubicación de almacenamiento personalizada, agrega un parámetro storage-locations a la clase de instantánea. Para usar este parámetro, tus clústeres deben usar la versión 1.21 o posterior.

    apiVersion: snapshot.storage.k8s.io/v1
kind: VolumeSnapshotClass
metadata:
  name: my-snapshotclass
parameters:
  storage-locations: us-east2
driver: pd.csi.storage.gke.io
deletionPolicy: Delete

  2. Aplica el manifiesto

    kubectl apply -f volumesnapshotclass.yaml

Crea una VolumeSnapshot

Un objeto VolumeSnapshot es una solicitud de una instantánea de un objeto PersistentVolumeClaim existente. Cuando creas un objeto VolumeSnapshot, GKE lo crea y lo vincula de forma automática con un objeto VolumeSnapshotContent, que es un recurso en el clúster similar a un objeto PersistentVolume.

  1. Guarda el siguiente manifiesto como volumesnapshot.yaml. Puedes usar la versión de API v1beta1 o v1.

    v1beta1

    Usa la versión de la API v1beta1 para clústeres que ejecutan las versiones 1.21 o anteriores.

    apiVersion: snapshot.storage.k8s.io/v1beta1
kind: VolumeSnapshot
metadata:
  name: my-snapshot
spec:
  volumeSnapshotClassName: my-snapshotclass
  source:
    persistentVolumeClaimName: my-pvc

    v1

    Usa la versión de la API v1 para clústeres que ejecutan la versión 1.21 o posterior.

    apiVersion: snapshot.storage.k8s.io/v1
kind: VolumeSnapshot
metadata:
  name: my-snapshot
spec:
  volumeSnapshotClassName: my-snapshotclass
  source:
    persistentVolumeClaimName: my-pvc

  2. Aplica el manifiesto

    kubectl apply -f volumesnapshot.yaml

    Después de crear una instantánea de volumen, GKE crea un objeto VolumeSnapshotContent correspondiente en el clúster. Este objeto almacena la instantánea y las vinculaciones de objetos VolumeSnapshot. No se interactúa directamente con los objetos VolumeSnapshotContents.

  3. Confirma que GKE creó el objeto VolumeSnapshotContents:

    kubectl get volumesnapshotcontents

    El resultado es similar a este:

    NAME                                               AGE
snapcontent-cee5fb1f-5427-11ea-a53c-42010a1000da   55s

Después de crear el contenido de la instantánea de volumen, el controlador CSI que especificaste en VolumeSnapshotClass crea una instantánea en el sistema de almacenamiento correspondiente. Una vez que GKE crea una instantánea en el sistema de almacenamiento y la vincula a un objeto de VolumeSnapshot del clúster, la instantánea está lista para usarse. Para verificar el estado, ejecuta el siguiente comando:

kubectl get volumesnapshot \
  -o custom-columns='NAME:.metadata.name,READY:.status.readyToUse'

Si la instantánea está lista para usarse, el resultado es similar al siguiente:

NAME               READY
my-snapshot        true

Borra el archivo de prueba

  1. Borra el archivo de prueba que creaste:

    kubectl exec POD_NAME \
    -- sh -c 'rm /usr/share/hello/hello.txt'

  2. Verifica que el archivo ya no exista:

    kubectl exec POD_NAME \
    -- sh -c 'cat /usr/share/hello/hello.txt'

    El resultado es similar al siguiente:

    cat: /usr/share/hello/hello.txt: No such file or directory

Restablece la instantánea de volumen

Puedes hacer referencia a una VolumeSnapshot en un PersistentVolumeClaim para aprovisionar un volumen nuevo con datos de un volumen existente o restablecer un volumen a un estado que capturaste en la instantánea.

Para hacer referencia a una VolumeSnapshot en un PersistentVolumeClaim, agrega el campo dataSource a tu PersistentVolumeClaim.

En este ejemplo, debes hacer referencia a la VolumeSnapshot que creaste en un PersistentVolumeClaim nueva y actualizar el Deployment para que use la reclamación nueva.

  1. Guarda el siguiente manifiesto como pvc-restore.yaml:

    apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: pvc-restore
spec:
  dataSource:
    name: my-snapshot
    kind: VolumeSnapshot
    apiGroup: snapshot.storage.k8s.io
  storageClassName: standard-rwo
  accessModes:
    - ReadWriteOnce
  resources:
    requests:
      storage: 1Gi

  2. Aplica el manifiesto

    kubectl apply -f pvc-restore.yaml

  3. Actualiza el archivo my-deployment.yaml para usar el PersistentVolumeClaim nuevo:

    ...
volumes:
- name: my-volume
  persistentVolumeClaim:
    claimName: pvc-restore

  4. Aplica el manifiesto actualizado:

    kubectl apply -f my-deployment.yaml

Verifica que la instantánea se haya restablecido correctamente

  1. Obtén el nombre del pod nuevo que GKE crea para la implementación actualizada:

     kubectl get pods -l app=hello-app

Verifica que el archivo de prueba exista:

   kubectl exec NEW_POD_NAME \
       -- sh -c 'cat /usr/share/hello/hello.txt'

Reemplaza NEW_POD_NAME con el nombre del pod de GKE nuevo creado.

El resultado es similar a este:

   Hello World!

Limpia

Sigue estos pasos para evitar que se apliquen cargos a tu cuenta de Google Cloud por los recursos que usaste en esta página.

  1. Borra VolumeSnapshot:

    kubectl delete volumesnapshot my-snapshot

  2. Borra VolumeSnapshotClass:

    kubectl delete volumesnapshotclass my-snapshotclass

  3. Borra la implementación:

    kubectl delete deployments hello-app

  4. Borra los objetos PersistentVolumeClaim:

    kubectl delete pvc my-pvc pvc-restore

¿Qué sigue?