Skip to main content
Hay disponible una nueva versión de este producto.
Se proporciona el idioma español mediante traducción automática para su comodidad. En caso de alguna inconsistencia, el inglés precede al español.

Administra los hooks de ejecución de Trident Protect

PDF

Un gancho de ejecución es una acción personalizada que puedes configurar para que se ejecute junto con una operación de protección de datos de una app gestionada. Por ejemplo, si tienes una app de base de datos, puedes usar un gancho de ejecución para pausar todas las transacciones de la base de datos antes de una instantánea y reanudar las transacciones después de que la instantánea esté completa. Esto garantiza instantáneas consistentes con las aplicaciones.

Tipos de hooks de ejecución

Trident Protect admite los siguientes tipos de ganchos de ejecución, según cuándo pueden ejecutarse:

  • Previa a la instantánea

  • Posterior a la instantánea

  • Previa a la copia de seguridad

  • Posterior a la copia de seguridad

  • Post-restauración

  • Después de la conmutación por error

Orden de ejecución

Cuando se ejecuta una operación de protección de datos, los eventos de hook de ejecución ocurren en el siguiente orden:

  1. Cualquier gancho personalizado aplicable de ejecución previa a la operación se ejecuta en los contenedores apropiados. Puedes crear y ejecutar tantos ganchos personalizados de ejecución previa a la operación como necesites, pero el orden de ejecución de estos ganchos antes de la operación no está garantizado ni es configurable.

  2. Ocurre la congelación del sistema de archivos, si aplica. "Conoce más sobre cómo configurar la congelación del sistema de archivos con Trident Protect".

  3. Se realiza la operación de protección de datos.

  4. Los sistemas de archivos congelados se descongelan, si aplica.

  5. Todos los hooks personalizados de ejecución post-operación aplicables se ejecutan en los contenedores apropiados. Puedes crear y ejecutar tantos hooks personalizados de ejecución post-operación como necesites, pero el orden de ejecución de estos hooks después de la operación no está garantizado ni es configurable.

Si creas varios ganchos de ejecución del mismo tipo (por ejemplo, pre-snapshot), el orden de ejecución de esos ganchos no está garantizado. Sin embargo, el orden de ejecución de ganchos de diferentes tipos sí está garantizado. Por ejemplo, este es el orden de ejecución de una configuración que tiene todos los diferentes tipos de ganchos:

  1. Ganchos previos a la instantánea ejecutados

  2. Ganchos post-snapshot ejecutados

  3. Ganchos previos a la copia de seguridad ejecutados

  4. Ganchos posteriores a la copia de seguridad ejecutados

Nota El ejemplo de orden anterior solo se aplica cuando ejecutas una copia de seguridad que no usa una instantánea existente.
Nota Siempre debes probar tus scripts de ganchos de ejecución antes de habilitarlos en un entorno de producción. Puedes usar el comando 'kubectl exec' para probar cómodamente los scripts. Después de habilitar los ganchos de ejecución en un entorno de producción, prueba las instantáneas y copias de seguridad resultantes para asegurarte de que son consistentes. Puedes hacer esto clonando la app en un espacio de nombres temporal, restaurando la instantánea o copia de seguridad y luego probando la app.
Nota Si un hook de ejecución previo a la instantánea añade, cambia o elimina recursos de Kubernetes, esos cambios se incluyen en la instantánea o backup y en cualquier operación de restauración posterior.

Notas importantes sobre los ganchos de ejecución personalizados

Ten en cuenta lo siguiente al planificar los hooks de ejecución para tus apps.

  • Un gancho de ejecución debe usar un script para realizar acciones. Muchos ganchos de ejecución pueden hacer referencia al mismo script.

  • Trident Protect requiere que los scripts que usan los hooks de ejecución estén escritos en formato de scripts de shell ejecutables.

  • El tamaño del script está limitado a 96KB.

  • Trident Protect utiliza la configuración de los execution hook y cualquier criterio de coincidencia para determinar qué hooks son aplicables a una operación de snapshot, backup o restore.

Nota Debido a que los ganchos de ejecución a menudo reducen o deshabilitan por completo la funcionalidad de la aplicación contra la que se ejecutan, siempre debes intentar minimizar el tiempo que tardan en ejecutarse tus ganchos de ejecución personalizados. Si inicias una operación de copia de seguridad o instantánea con ganchos de ejecución asociados pero luego la cancelas, los ganchos aún pueden ejecutarse si la operación de copia de seguridad o instantánea ya ha comenzado. Esto significa que la lógica utilizada en un gancho de ejecución posterior a la copia de seguridad no puede asumir que la copia de seguridad se completó.

Filtros de ejecución hook

Cuando añades o editas un gancho de ejecución para una aplicación, puedes añadir filtros al gancho de ejecución para gestionar en qué contenedores coincidirá el gancho. Los filtros son útiles para aplicaciones que usan la misma imagen de contenedor en todos los contenedores, pero podrían usar cada imagen para un propósito diferente (como Elasticsearch). Los filtros te permiten crear escenarios donde los ganchos de ejecución se ejecutan en algunos, pero no necesariamente en todos los contenedores idénticos. Si creas varios filtros para un solo gancho de ejecución, se combinan con un operador lógico AND. Puedes tener hasta 10 filtros activos por gancho de ejecución.

Cada filtro que añades a un gancho de ejecución usa una expresión regular para hacer coincidir los contenedores en tu clúster. Cuando un gancho coincide con un contenedor, el gancho ejecutará su script asociado en ese contenedor. Las expresiones regulares para los filtros usan la sintaxis Regular Expression 2 (RE2), que no permite crear un filtro que excluya contenedores de la lista de coincidencias. Para información sobre la sintaxis que Trident Protect admite para expresiones regulares en los filtros de ganchos de ejecución, consulta "Compatibilidad con la sintaxis de Regular Expression 2 (RE2)".

Nota Si añades un filtro de espacio de nombres a un gancho de ejecución que se ejecuta después de una operación de restauración o clonación, y el origen y el destino de la restauración o clonación están en espacios de nombres diferentes, el filtro de espacio de nombres solo se aplica al espacio de nombres de destino.

Ejemplos de execution hook

Visita el "Proyecto NetApp Verda GitHub" para descargar ganchos de ejecución reales para apps populares como Apache Cassandra y Elasticsearch. También puedes ver ejemplos y obtener ideas para estructurar tus propios ganchos de ejecución personalizados.

Crear un gancho de ejecución

Puedes crear un gancho de ejecución personalizado para una app usando Trident Protect. Necesitas tener permisos de Owner, Admin o Member para crear ganchos de ejecución.

Usa un CR
Pasos

  1. Crea el archivo de recurso personalizado (CR) y asígnale el nombre trident-protect-hook.yaml.

  2. Configura los siguientes atributos para que coincidan con tu entorno de Trident Protect y la configuración del clúster:

    • metadata.name: (Required) El nombre de este recurso personalizado; elige un nombre único y sensato para tu entorno.

    • spec.applicationRef: (Required) el nombre de Kubernetes de la aplicación para la que quieres ejecutar el gancho de ejecución.

    • spec.stage: (Obligatorio) una cadena que indica en qué etapa de la acción debe ejecutarse el gancho de ejecución. Valores posibles:

      • Pre

      • Publicar

    • spec.action: (Required) Una cadena que indica qué acción realizará el gancho de ejecución, suponiendo que coincida cualquier filtro de gancho de ejecución especificado. Valores posibles:

      • Snapshot

      • Copia de seguridad

      • Restaurar

      • Conmutación por error

    • spec.enabled: (Opcional) Indica si este execution hook está habilitado o deshabilitado. Si no se especifica, el valor predeterminado es true.

    • spec.hookSource: (Required) Una cadena que contiene el script de hook codificado en base64.

    • spec.timeout: (Opcional) Un número que define cuánto tiempo en minutos se permite que se ejecute el hook de ejecución. El valor mínimo es 1 minuto y el valor por defecto es 25 minutos si no se especifica.

    • spec.arguments: (Opcional) Una lista YAML de argumentos que puedes especificar para el gancho de ejecución.

    • spec.matchingCriteria: (Opcional) Una lista opcional de pares clave-valor de criterios, cada par constituye un filtro de gancho de ejecución. Puedes añadir hasta 10 filtros por gancho de ejecución.

    • spec.matchingCriteria.type: (Opcional) una cadena que identifica el tipo de filtro de gancho de ejecución. Valores posibles:

      • ContainerImage

      • ContainerName

      • PodName

      • PodLabel

      • NamespaceName

    • spec.matchingCriteria.value: (Opcional) Una cadena o expresión regular que identifica el valor del filtro de ejecución.

      Ejemplo de YAML:

    apiVersion: protect.trident.netapp.io/v1
kind: ExecHook
metadata:
  name: example-hook-cr
  namespace: my-app-namespace
  annotations:
    astra.netapp.io/astra-control-hook-source-id: /account/test/hookSource/id
spec:
  applicationRef: my-app-name
  stage: Pre
  action: Snapshot
  enabled: true
  hookSource: IyEvYmluL2Jhc2gKZWNobyAiZXhhbXBsZSBzY3JpcHQiCg==
  timeout: 10
  arguments:
    - FirstExampleArg
    - SecondExampleArg
  matchingCriteria:
    - type: containerName
      value: mysql
    - type: containerImage
      value: bitnami/mysql
    - type: podName
      value: mysql
    - type: namespaceName
      value: mysql-a
    - type: podLabel
      value: app.kubernetes.io/component=primary
    - type: podLabel
      value: helm.sh/chart=mysql-10.1.0
    - type: podLabel
      value: deployment-type=production

  3. Después de rellenar el archivo CR con los valores correctos, aplica el CR:

    kubectl apply -f trident-protect-hook.yaml
Usa la CLI
Pasos

  1. Crea el gancho de ejecución, sustituyendo los valores entre corchetes por información de tu entorno. Por ejemplo:

    tridentctl-protect create exechook <my_exec_hook_name> --action <action_type> --app <app_to_use_hook> --stage <pre_or_post_stage> --source-file <script-file> -n <application_namespace>

Ejecuta manualmente un gancho de ejecución

Puedes ejecutar manualmente un gancho de ejecución con fines de prueba o si necesitas volver a ejecutar el gancho manualmente después de un fallo. Necesitas tener permisos de Owner, Admin o Member para ejecutar manualmente ganchos de ejecución.

Ejecutar manualmente un hook de ejecución consiste en dos pasos básicos:

  1. Crea una copia de seguridad de recursos, que recoge los recursos y crea una copia de seguridad de ellos, determinando dónde se ejecutará el hook

  2. Ejecuta el hook de ejecución contra la copia de seguridad

Paso 1: crea una copia de seguridad de los recursos
Usa un CR
Pasos

  1. Crea el archivo de recurso personalizado (CR) y asígnale el nombre trident-protect-resource-backup.yaml.

  2. Configura los siguientes atributos para que coincidan con tu entorno de Trident Protect y la configuración del clúster:

    • metadata.name: (Required) El nombre de este recurso personalizado; elige un nombre único y sensato para tu entorno.

    • spec.applicationRef: (Required) El nombre de Kubernetes de la aplicación para la que crear la copia de seguridad de recursos.

    • spec.appVaultRef: (Required) el nombre del AppVault donde se almacena el contenido de la copia de seguridad.

    • spec.appArchivePath: la ruta dentro de AppVault donde se almacena el contenido de la copia de seguridad. Puedes usar el siguiente comando para encontrar esta ruta:

      kubectl get backups <BACKUP_NAME> -n my-app-namespace -o jsonpath='{.status.appArchivePath}'

      Ejemplo de YAML:

    ---
apiVersion: protect.trident.netapp.io/v1
kind: ResourceBackup
metadata:
  name: example-resource-backup
spec:
  applicationRef: my-app-name
  appVaultRef: my-appvault-name
  appArchivePath: example-resource-backup

  3. Después de rellenar el archivo CR con los valores correctos, aplica el CR:

    kubectl apply -f trident-protect-resource-backup.yaml
Usa la CLI
Pasos

  1. Crea el backup, reemplazando los valores entre corchetes con información de tu entorno. Por ejemplo:

    tridentctl protect create resourcebackup <my_backup_name> --app <my_app_name> --appvault <my_appvault_name> -n <my_app_namespace> --app-archive-path <app_archive_path>

  2. Consulta el estado de la copia de seguridad. Puedes usar este comando de ejemplo repetidamente hasta que la operación termine:

    tridentctl protect get resourcebackup -n <my_app_namespace> <my_backup_name>

  3. Verifica que la copia de seguridad se realizó correctamente:

    kubectl describe resourcebackup <my_backup_name>
Paso 2: ejecuta el gancho de ejecución
Usa un CR
Pasos

  1. Crea el archivo de recurso personalizado (CR) y asígnale el nombre trident-protect-hook-run.yaml.

  2. Configura los siguientes atributos para que coincidan con tu entorno de Trident Protect y la configuración del clúster:

    • metadata.name: (Required) El nombre de este recurso personalizado; elige un nombre único y sensato para tu entorno.

    • spec.applicationRef: (Obligatorio) asegúrate de que este valor coincide con el nombre de la aplicación del CR ResourceBackup que creaste en el paso 1.

    • spec.appVaultRef: (Obligatorio) Asegúrate de que este valor coincide con el appVaultRef del ResourceBackup CR que creaste en el paso 1.

    • spec.appArchivePath: asegúrate de que este valor coincide con el appArchivePath del CR ResourceBackup que creaste en el paso 1.

      kubectl get backups <BACKUP_NAME> -n my-app-namespace -o jsonpath='{.status.appArchivePath}'

    • spec.action: (Required) Una cadena que indica qué acción realizará el gancho de ejecución, suponiendo que coincida cualquier filtro de gancho de ejecución especificado. Valores posibles:

      • Snapshot

      • Copia de seguridad

      • Restaurar

      • Conmutación por error

    • spec.stage: (Required) Una cadena que indica en qué etapa de la acción debe ejecutarse el gancho de ejecución. Esta ejecución de gancho no ejecutará ganchos en ninguna otra etapa. Valores posibles:

      • Pre

      • Publicar

        Ejemplo de YAML:

    ---
apiVersion: protect.trident.netapp.io/v1
kind: ExecHooksRun
metadata:
  name: example-hook-run
spec:
  applicationRef: my-app-name
  appVaultRef: my-appvault-name
  appArchivePath: example-resource-backup
  stage: Post
  action: Failover

  3. Después de rellenar el archivo CR con los valores correctos, aplica el CR:

    kubectl apply -f trident-protect-hook-run.yaml
Usa la CLI
Pasos

  1. Crea la solicitud para ejecutar manualmente el gancho:

    tridentctl protect create exechooksrun <my_exec_hook_run_name> -n <my_app_namespace> --action snapshot --stage <pre_or_post> --app <my_app_name> --appvault <my_appvault_name> --path <my_backup_name>

  2. Comprueba el estado de la ejecución del hook de ejecución. Puedes ejecutar este comando repetidamente hasta que se complete la operación:

    tridentctl protect get exechooksrun -n <my_app_namespace> <my_exec_hook_run_name>

  3. Describe el objeto exechooksrun para ver los detalles finales y el estado:

    kubectl -n <my_app_namespace> describe exechooksrun <my_exec_hook_run_name>