Instala AlloyDB Omni en Kubernetes

Selecciona una versión de la documentación:

En esta página, se proporciona una descripción general del operador de Kubernetes de AlloyDB Omni, con instrucciones para usarlo y, así, implementar AlloyDB Omni en un clúster de Kubernetes. En esta página, se supone que tienes conocimientos básicos sobre el funcionamiento de Kubernetes.

Si deseas obtener instrucciones para instalar AlloyDB Omni en un entorno Linux estándar, consulta Instala AlloyDB Omni.

Descripción general

Para implementar AlloyDB Omni en un clúster de Kubernetes, instala el operador de AlloyDB Omni, una extensión de la API de Kubernetes proporcionada por Google.

Para configurar y controlar un clúster de base de datos de AlloyDB Omni basado en Kubernetes, debes vincular archivos de manifiesto declarativos con la utilidad kubectl, al igual que con cualquier otra implementación basada en Kubernetes.

Imagen base

A partir de la versión 1.5.0, las imágenes de Kubernetes del operador de AlloyDB Omni se compilan sobre la imagen base universal (UBI) 9 de Red Hat. Esta transición mejora la seguridad, la coherencia y el cumplimiento de tus implementaciones.

Compatibilidad con el operador de AlloyDB Omni 1.1.0 (y versiones posteriores)

La versión 1.1.0 del operador de AlloyDB Omni no es compatible con las versiones 15.5.3 y 15.5.4 de AlloyDB Omni. Si usas una de estas versiones de AlloyDB Omni, es posible que recibas un error similar al siguiente:

Error from server (Forbidden): error when creating "[...]/dbcluster.yaml": admission webhook "vdbcluster.alloydbomni.dbadmin.goog" denied the request: unsupported database version 15.5.3

Antes de comenzar

Antes de instalar AlloyDB Omni en un clúster de Kubernetes con el operador de AlloyDB Omni, asegúrate de cumplir con los siguientes requisitos.

Elige una opción de descarga o instalación

Cuando administras cargas de trabajo en un clúster genérico de Kubernetes, puedes usar Helm o OLM. Helm es un administrador de paquetes universal que usa gráficos de Helm para instalar cualquier carga de trabajo, incluidos los operadores, en todas las variantes de Kubernetes. En cambio, OLM, la opción estándar y preferida en las plataformas de OpenShift, administra los ciclos de vida de los operadores con paquetes de OLM especializados.

Según tu entorno y tus herramientas, elige uno de los siguientes métodos de implementación:

Medios Ubicaciones de descarga y guías de instalación Implementación en
Operador de AlloyDB Omni con gráfico de Helm Instala AlloyDB Omni en Kubernetes Tu propio entorno de contenedores de Kubernetes (por ejemplo, en instalaciones locales, nubes públicas, GKE, Amazon EKS y Azure AKS)

Nota: Si tus herramientas de CD (entrega continua) están integradas con Helm, usa esta opción.
Operador de AlloyDB Omni con paquete de OLM OperatorHub.io Tu propio entorno de contenedores de Kubernetes (por ejemplo, en las instalaciones, en nubes públicas, en Google Kubernetes Engine, en Amazon EKS y en Azure AKS)

Para usar un paquete de OLM, instala OLM en el clúster de Kubernetes antes de instalar el operador. Puedes obtener más información sobre OLM en olm.operatorframework.io.

Nota: Si tus herramientas de CD (entrega continua) ya usan OLM, elige esta opción.
Operador de OpenShift con paquete de OLM Consola web de Openshift Container Platform Entorno de OpenShift

OpenShift, una variante de Kubernetes, usa OLM como su método estándar integrado para empaquetar e implementar operadores.

Verifica el acceso

Verifica que tengas acceso a lo siguiente:

Cumple con los requisitos de hardware y software

Cada nodo del clúster de Kubernetes debe tener lo siguiente:

  • Al menos dos CPUs x86 o AMD64
  • Al menos 8 GB de RAM
  • Versión 4.18 o posterior del kernel de Linux
  • El grupo de control (cgroup) v2 está habilitado.

Instala el operador de AlloyDB Omni

Puedes instalar el operador de AlloyDB Omni con diferentes métodos, incluidos Helm y Operator Lifecycle Manager (OLM).

Helm

Para instalar el operador de AlloyDB Omni, sigue estos pasos:

  1. Define las siguientes variables de entorno: 
    export HELM_PATH=$(curl https://storage.googleapis.com/alloydb-omni-operator/latest)
export OPERATOR_VERSION="${HELM_PATH%%/*}"
  2. Descarga el operador de AlloyDB Omni: 
    curl -X GET -o "./alloydbomni-operator-${OPERATOR_VERSION}.tgz" "https://storage.googleapis.com/storage/v1/b/alloydb-omni-operator/o/$(echo ${HELM_PATH} | sed 's/\//%2F/g')?alt=media"
  3. Instala el operador de AlloyDB Omni: 
    helm install alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \
--create-namespace \
--namespace alloydb-omni-system \
--atomic \
--timeout 5m

    Si la instalación se realiza correctamente, se muestra el siguiente resultado:

    NAME: alloydbomni-operator
LAST DEPLOYED: CURRENT_TIMESTAMP
NAMESPACE: alloydb-omni-system
STATUS: deployed
REVISION: 1
TEST SUITE: None
  4. Para realizar la limpieza, borra el archivo de instalación del operador de AlloyDB Omni que descargaste. El archivo se llama alloydbomni-operator-VERSION_NUMBER.tgz y se encuentra en tu directorio de trabajo actual.

OLM

Para instalar el operador de AlloyDB Omni con Operator Lifecycle Manager, sigue estos pasos:

  1. Ve a la página Operador de AlloyDB Omni.

  2. Haz clic en Instalar. Si aún no lo hiciste, sigue las instrucciones para instalar solo el operador de OLM y el catálogo de OperatorHub.io.

  3. Crea el espacio de nombres alloydb-omni-system si aún no existe.

    kubectl create ns alloydb-omni-system

  4. Configura el OLM OperatorGroup para asegurarte de que el operador tenga alcance de clúster.

    kubectl apply -f - <<EOF
apiVersion: operators.coreos.com/v1
kind: OperatorGroup
metadata:
  name: operator-sdk-og
  namespace: alloydb-omni-system
spec:
  upgradeStrategy: Default
EOF

  5. Instala el operador con un recurso de suscripción de OLM.

    kubectl apply -f - <<EOF
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: my-alloydb-omni-operator
  namespace: alloydb-omni-system
spec:
  channel: stable
  name: alloydb-omni-operator
  source: operatorhubio-catalog
  sourceNamespace: olm
EOF

  6. Instala el certificado predeterminado ClusterIssuer. Este paso es opcional si usas emisores de certificados personalizados.

    kubectl apply -f - <<EOF
apiVersion: cert-manager.io/v1
kind: ClusterIssuer
metadata:
  name: alloydbomni-selfsigned-cluster-issuer
spec:
  selfSigned: {}
EOF

OLM

Para instalar el operador de AlloyDB Omni en tu entorno de Red Hat OpenShift con OLM, accede a tu consola web de Red Hat OpenShift.

  1. Selecciona Operators > OperatorHub.

  2. Busca el operador de AlloyDB Omni con el campo de búsqueda.

  3. En el panel del operador de AlloyDB Omni, haz clic en Install.

  4. Instala el certificado predeterminado ClusterIssuer. Este paso es opcional si usas emisores de certificados personalizados.

    kubectl apply -f - <<EOF
apiVersion: cert-manager.io/v1
kind: ClusterIssuer
metadata:
  name: alloydbomni-selfsigned-cluster-issuer
spec:
  selfSigned: {}
EOF

Configura el almacenamiento conectado de GDC

Para instalar el operador de AlloyDB Omni en GDC connected, debes seguir pasos adicionales para configurar el almacenamiento, ya que los clústeres de GDC connected no establecen una clase de almacenamiento predeterminada. Debes establecer una clase de almacenamiento predeterminada antes de crear un clúster de base de datos de AlloyDB Omni.

Para aprender a configurar Symcloud Storage como la clase de almacenamiento predeterminada, consulta Cómo configurar Symcloud Storage como la clase de almacenamiento predeterminada.

Para obtener más información sobre cómo cambiar el valor predeterminado de todas las demás clases de almacenamiento, consulta Cambia el recurso StorageClass predeterminado.

Crea un clúster de base de datos

Un clúster de base de datos de AlloyDB Omni contiene todos los recursos de almacenamiento y procesamiento necesarios para ejecutar un servidor de AlloyDB Omni, incluido el servidor principal, las réplicas y todos tus datos.

Para crear un clúster de base de datos de AlloyDB Omni, sigue estos pasos:

  1. Crea un espacio de nombres dedicado para tu clúster de base de datos. Esto mejora el aislamiento y la seguridad.

    kubectl create namespace DB_CLUSTER_NAMESPACE

    Reemplaza DB_CLUSTER_NAMESPACE por el espacio de nombres en el que deseas crear el clúster de base de datos, por ejemplo, my-db-cluster-namespace.

  2. Crea un archivo de manifiesto llamado db-cluster.yaml con el siguiente contenido. Este manifiesto define tanto el secreto para la contraseña de la base de datos como el recurso DBCluster en sí.

    apiVersion: v1
kind: Secret
metadata:
  name: db-pw-DB_CLUSTER_NAME
  namespace: DB_CLUSTER_NAMESPACE
type: Opaque
data:
  DB_CLUSTER_NAME: "ENCODED_PASSWORD"
---
apiVersion: alloydbomni.dbadmin.goog/v1
kind: DBCluster
metadata:
  name: DB_CLUSTER_NAME
  namespace: DB_CLUSTER_NAMESPACE
spec:
  databaseVersion: "15.12.0"
  primarySpec:
    adminUser:
      passwordRef:
        name: db-pw-DB_CLUSTER_NAME
    resources:
      cpu: CPU_COUNT
      memory: MEMORY_SIZE
      disks:
      - name: DataDisk
        size: DISK_SIZE

    Reemplaza lo siguiente:

    • DB_CLUSTER_NAME: Es el nombre de este clúster de base de datos, por ejemplo, my-db-cluster.

    • ENCODED_PASSWORD: Es la contraseña de acceso a la base de datos del rol de usuario postgres predeterminado, codificada como una cadena base64 (por ejemplo, Q2hhbmdlTWUxMjM= para ChangeMe123).

    • CPU_COUNT: Es la cantidad de CPU disponibles para cada instancia de base de datos en este clúster de base de datos.

    • MEMORY_SIZE: Es la cantidad de memoria por instancia de base de datos de este clúster de base de datos. Recomendamos establecer este valor en 8 gigabytes por CPU. Por ejemplo, si estableciste cpu en 2 anteriormente en este manifiesto, te recomendamos que establezcas memory en 16Gi.

    • DISK_SIZE: Es el tamaño del disco por instancia de base de datos, por ejemplo, 10Gi.

  3. Aplica el manifiesto a tu clúster de Kubernetes:

    kubectl apply -f db-cluster.yaml

Después de aplicar este manifiesto, tu clúster de Kubernetes contendrá un clúster de base de datos de AlloyDB Omni con la configuración de memoria, CPU y almacenamiento especificada. Para establecer una conexión de prueba con el nuevo clúster de base de datos, consulta Conéctate con psql preinstalado.

Para obtener más información sobre los manifiestos de Kubernetes y cómo aplicarlos, consulta Administración de recursos.

¿Qué sigue?