Configura períodos de mantenimiento

En esta página, se explica cómo definir los períodos de mantenimiento de las instancias de Cloud Data Fusion.

Los períodos de mantenimiento son compatibles con las instancias de Cloud Data Fusion en las versiones 6.8.0 y posteriores.

Acerca de los períodos de mantenimiento

Un período de mantenimiento en Cloud Data Fusion es un período en el que le permites realizar operaciones de mantenimiento, lo que reduce el riesgo de interrupciones del servicio durante las horas pico de uso. Programar períodos de mantenimiento durante las horas de baja actividad o los momentos en los que tu actividad es menor minimiza su impacto en tus instancias de Cloud Data Fusion y en las ejecuciones de tus canalizaciones.

Configurar períodos de mantenimiento te permite controlar cuándo ocurren las operaciones de mantenimiento en tu instancia:

  • Si se define el período de mantenimiento, Cloud Data Fusion realiza las operaciones de mantenimiento dentro de los períodos definidos.
  • Si no se define el período de mantenimiento, este se puede realizar en cualquier momento.

Información acerca de las operaciones de mantenimiento

Para garantizar la seguridad y el cumplimiento del sistema, Cloud Data Fusion realiza operaciones de mantenimiento regulares. Estas operaciones incluyen la aplicación de actualizaciones críticas y parches de seguridad para mitigar las vulnerabilidades y proteger los datos del usuario. Los períodos de mantenimiento programados garantizan que las actualizaciones se apliquen de manera eficiente, lo que preserva la integridad del sistema y minimiza las interrupciones en las instancias y las ejecuciones de canalización.

  • Cuando configures los períodos de mantenimiento, debes asignar al menos 12 horas por semana para las operaciones de mantenimiento. Cada ventana debe ser de entre 4 y 12 horas.

  • Durante las horas del período de mantenimiento, es posible que se vean afectadas algunas operaciones. Te recomendamos que establezcas períodos de mantenimiento durante los momentos de menor uso. La operación de mantenimiento puede afectar a Cloud Data Fusion de las siguientes maneras:

    • Es posible que la interfaz de Cloud Data Fusion Studio no esté disponible temporalmente.
    • Es posible que la ejecución de la canalización se vea afectada, lo que provocará una falla.
    • Es posible que los servicios de Cloud Data Fusion estén inactivos temporalmente, lo que provocará que fallan las llamadas a la API.
    • Es posible que las instancias no funcionen por completo durante hasta una hora durante el período de mantenimiento. Te recomendamos que configures ventanas de mantenimiento cuando tus canalizaciones no estén en ejecución o no estén programadas para ejecutarse.

Especifica los períodos de mantenimiento mientras creas una instancia

Console

Para establecer el período de mantenimiento cuando creas una instancia, sigue estos pasos:

  1. Ve a la página Instancias de Cloud Data Fusion y haz clic en Crear instancia.

    Crea una instancia

  2. Ingresa un Nombre de la instancia y una Edición. Para obtener más información sobre cada campo, consulta Crea una instancia.
  3. Expande la sección Opciones avanzadas.
  4. Expande la sección Mantenimiento y sigue estos pasos:
    1. Selecciona la casilla de verificación Habilitar período de mantenimiento.
    2. En el campo Hora de inicio, ingresa una hora en un formato compatible.
    3. En la lista Zona horaria, selecciona una zona horaria.
    4. En las listas Días y Duración, selecciona los días de la semana y la duración del período. Para obtener más información sobre estos parámetros de configuración, consulta Acerca de las operaciones de mantenimiento.
    5. Haz clic en Crear.

Para obtener más información, consulta Configura la recurrencia y los horarios de los períodos de mantenimiento (RRULE).

API de REST

  1. Establece la configuración de Instance con la API de instance.create:
{
  "name": string,
  "description": string,
  …
  …
  "maintenancePolicy": {
    "maintenanceWindow": {
      "recurringTimeWindow": {
        "window": {
            "startTime": "START_TIME",
            "endTime": "END_TIME"
        },
        "recurrence": "MAINTENANCE_RECURRENCE"
      }
    },
  }
}

Reemplaza lo siguiente:

  • START_TIME: Hora de inicio del período, en formato RFC 3339.
  • END_TIME: La hora de finalización del período, en formato RFC 3339.

  • MAINTENANCE_RECURRENCE: Es una RRULE para la recurrencia del período de mantenimiento. Cloud Data Fusion solo admite los siguientes formatos:

    • FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA o BYDAY=SU,MO,TU,WE,TH,FR,SA,MO;FREQ=WEEKLY. Esto especifica la recurrencia semanal del período en los días seleccionados, a partir de startTime y durante la duración especificada.

Para obtener más información, consulta Configura la recurrencia y los horarios de los períodos de mantenimiento (RRULE).

En el siguiente ejemplo, se crea una instancia con un período de mantenimiento de seis horas entre las 10 a.m. y las 4 p.m. (UTC) los sábados y domingos de cada semana. Para obtener más información, consulta la documentación de la API de instancias.

// POST https://datafusion.googleapis.com/v1/projects/example-project/locations/us-central1/instances?instanceID=example-instance

{
  "maintenancePolicy": {
      "maintenanceWindow": {
          "recurringTimeWindow": {
              "window": {
                  "startTime": "2024-01-01T10:00:00Z",
                  "endTime": "2024-01-01T16:00:00Z",
              },
              "recurrence": "FREQ=WEEKLY;BYDAY=SA,SU"
          }
      },
  }
}

gcloud

Puedes especificar el período de mantenimiento mientras creas una instancia con el comando gcloud beta data-fusion instances create.

Se deben definir los siguientes parámetros para un período de mantenimiento:

  • --maintenance-window-start establece la hora de inicio del período.
  • --maintenance-window-end establece la hora de finalización del período.
  • --maintenance-window-recurrence establece una RRULE para la recurrencia del período de mantenimiento.
gcloud beta data-fusion instances create INSTANCE_NAME \
    --project=PROJECT_NAME \
    --location=LOCATION \
    --maintenance-window-start=START_TIME \
    --maintenance-window-end=END_TIME \
    --maintenance-window-recurrence=MAINTENANCE_RECURRENCE

Reemplaza lo siguiente:

  • INSTANCE_NAME: El nombre de la instancia.
  • PROJECT_NAME: el nombre del proyecto.
  • LOCATION: Es el nombre de la región de la instancia.
  • START_TIME: La hora de inicio del período en el formato de entrada de fecha y hora. Solo se usa la hora especificada del día, se ignora la fecha especificada.
  • END_TIME: la hora de finalización del período en el formato de entrada de fecha y hora. Solo se usa la hora especificada del día, se ignora la fecha especificada. La fecha y hora especificadas deben ser posteriores a la hora de inicio.

  • MAINTENANCE_RECURRENCE: Es una RRULE para la recurrencia del período de mantenimiento. Cloud Data Fusion solo admite los siguientes formatos:

    • FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA o BYDAY=SU,MO,TU,WE,TH,FR,SA,MO;FREQ=WEEKLY. Esto especifica la recurrencia semanal del período en los días seleccionados, a partir de la hora --maintenance-window-start y durante la duración especificada.

Para obtener más información, consulta Configura la recurrencia y los horarios de los períodos de mantenimiento (RRULE).

Con el siguiente comando, se crea una instancia con un período de mantenimiento de seis horas entre las 12 p.m. y las 6 p.m. (UTC) los sábados y domingos de cada semana.

gcloud beta data-fusion instances create example-instance \
    --project='example-project' \
    --location='us-east1' \
    --maintenance-window-start='2024-01-01T12:00:00Z' \
    --maintenance-window-end='2024-01-01T18:00:00Z' \
    --maintenance-window-recurrence='FREQ=WEEKLY;BYDAY=SA,SU'

Actualiza los períodos de mantenimiento de una instancia

Console

Para actualizar el período de mantenimiento de una instancia existente en la consola de Google Cloud, sigue estos pasos:

  1. Ve a la página de Instancias de Cloud Data Fusion.

    Ir a Instancias

  2. Haz clic en el nombre de la instancia para ver sus detalles.

  3. En la página Detalles de la instancia, navega al campo Ventana de mantenimiento y haz clic en Editar.

  4. Los campos de la ventana de mantenimiento se abren en el modo de edición. Actualiza los valores según sea necesario:

    1. Selecciona la casilla de verificación Habilitar período de mantenimiento.
    2. En el campo Hora de inicio, ingresa una hora en un formato compatible.
    3. En la lista Zona horaria, selecciona una zona horaria.
    4. En las listas Días y Duración, selecciona los días de la semana y la duración del período. Para obtener más información sobre estos parámetros de configuración, consulta Acerca de las operaciones de mantenimiento.

  5. Haz clic en Guardar.

Para obtener más información, consulta Configura la recurrencia y los horarios de los períodos de mantenimiento (RRULE).

API de REST

En el caso de las instancias existentes, actualiza los períodos de mantenimiento con la solicitud a la API de instances.patch. Esto anula la configuración existente del período de mantenimiento, si está presente. De lo contrario, se establece una configuración nueva, como se menciona en el cuerpo de la solicitud.

Crea una solicitud a la API de la siguiente manera:

  1. En el parámetro updateMask, especifica la máscara maintenance_policy.
  2. En el cuerpo de la solicitud, especifica el período de mantenimiento en la configuración de la política de mantenimiento:
{
  "maintenancePolicy": {
    "maintenanceWindow": {
        "recurringTimeWindow": {
          "window": {
              "startTime": "START_TIME",
              "endTime": "END_TIME"
          },
          "recurrence": "MAINTENANCE_RECURRENCE"
        }
    },
  }
}

Para obtener más información, consulta Configura la recurrencia y los horarios de los períodos de mantenimiento (RRULE).

En el siguiente ejemplo, se actualiza la configuración de la política de mantenimiento de la instancia con un período de mantenimiento de cuatro horas entre las 11 a.m. y las 3 p.m. (UTC) los viernes, sábados y domingos de cada semana.

// PATCH https://datafusion.googleapis.com/v1/projects/example-project/locations/us-central1/instances/example-instance?updateMask=maintenance_policy

{
"maintenancePolicy": {
  "maintenanceWindow": {
    "recurringTimeWindow": {
      "window": {
          "startTime": "2024-01-01T11:00:00Z",
          "endTime": "2024-01-01T15:00:00Z",
        },
      "recurrence": "FREQ=WEEKLY;BYDAY=FR,SA,SU"
    }
  },
}
}

gcloud

Puedes actualizar el período de mantenimiento de una instancia con el comando gcloud beta data-fusion instances update.

Se deben definir los siguientes parámetros para un período de mantenimiento:

  • --maintenance-window-start establece la hora de inicio del período.
  • --maintenance-window-end establece la hora de finalización del período.
  • --maintenance-window-recurrence establece una RRULE para la recurrencia del período de mantenimiento.
gcloud beta data-fusion instances update INSTANCE_NAME \
    --project=PROJECT_NAME \
    --location=LOCATION \
    --maintenance-window-start=START_TIME \
    --maintenance-window-end=END_TIME \
    --maintenance-window-recurrence=MAINTENANCE_RECURRENCE

Reemplaza lo siguiente:

  • INSTANCE_NAME: El nombre de la instancia.
  • PROJECT_NAME: el nombre del proyecto.
  • LOCATION: Es el nombre de la región de la instancia.
  • START_TIME: La hora de inicio del período en el formato de entrada de fecha y hora. Solo se usa la hora especificada del día, se ignora la fecha especificada.
  • END_TIME: la hora de finalización del período en el formato de entrada de fecha y hora. Solo se usa la hora especificada del día, se ignora la fecha especificada. La fecha y hora especificadas deben ser posteriores a la hora de inicio.

  • MAINTENANCE_RECURRENCE: Es una RRULE para la recurrencia del período de mantenimiento. Cloud Data Fusion solo admite los siguientes formatos:

    • FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA o BYDAY=SU,MO,TU,WE,TH,FR,SA,MO;FREQ=WEEKLY. Esto especifica la recurrencia semanal del período en los días seleccionados, a partir de la hora --maintenance-window-start y durante la duración especificada.

El siguiente comando actualiza la instancia example-instance con un período de mantenimiento de seis horas entre las 12 p.m. y las 6 p.m. (UTC) los sábados y domingos de cada semana.

gcloud beta data-fusion instances update example-instance \
    --project='example-project' \
    --location='us-east1' \
    --maintenance-window-start='2024-01-01T12:00:00Z' \
    --maintenance-window-end='2024-01-01T18:00:00Z' \
    --maintenance-window-recurrence='FREQ=WEEKLY;BYDAY=SA,SU'

Configura los horarios y la recurrencia del período de mantenimiento (RRULE)

Cuando configuras las horas de inicio y finalización del período de mantenimiento, se ignoran los componentes de fecha de las marcas de tiempo proporcionadas. Solo se consideran la hora del día y la duración entre la hora de inicio y la de finalización. Los horarios se almacenan en UTC, pero puedes usar UTC o la compensación de tu zona horaria cuando programes períodos de mantenimiento con la API de REST o la CLI de gcloud.

Cuando configures la recurrencia, ten en cuenta que RRULE sigue los días de UTC, por lo que debes ajustarla según corresponda si tu zona horaria es diferente. Por ejemplo, si tu zona horaria es PDT (UTC-7) y quieres que un período de mantenimiento comience a las 9:00 p.m. de los miércoles en tu zona horaria (que corresponde a las 4:00 a.m. UTC de los jueves), especifica TH en lugar de WE en la opción BYDAY de RRULE.

Quita el período de mantenimiento de una instancia

Console

Para quitar la ventana de mantenimiento de una instancia existente en la consola de Google Cloud, sigue estos pasos:

  1. Ve a la página de Instancias de Cloud Data Fusion.

    Ir a Instancias

  2. Haz clic en el nombre de la instancia para ver sus detalles.

  3. En la página Detalles de la instancia, navega al campo Ventana de mantenimiento y haz clic en Editar.

  4. Para quitar el período de mantenimiento de la instancia, desmarca la casilla de verificación Habilitar período de mantenimiento.

  5. Haz clic en Guardar.

API de REST

Para quitar el período de mantenimiento de una instancia, pasa un objeto de política de mantenimiento vacío en el cuerpo de la solicitud.

// PATCH https://datafusion.googleapis.com/v1/projects/example-project/locations/us-central1/instances/example-instance?updateMask=maintenance_policy

{
    "maintenancePolicy": {}
}

gcloud

Para quitar el período de mantenimiento de una instancia, usa el comando gcloud beta data-fusion instances update con la marca --clear-maintenance-window.

gcloud beta data-fusion instances update INSTANCE_NAME \
    --project=PROJECT_NAME \
    --location=LOCATION \
    --clear-maintenance-window

Reemplaza lo siguiente:

  • INSTANCE_NAME: El nombre de la instancia.
  • PROJECT_NAME: el nombre del proyecto.
  • LOCATION: Es el nombre de la región de la instancia.

¿Qué sigue?