Configurer un équilibreur de charge pour AlloyDB Omni sur Kubernetes

Sélectionnez une version de la documentation :

Pour exposer votre cluster de bases de données AlloyDB Omni à des clients extérieurs à votre cluster Kubernetes, vous pouvez configurer un service LoadBalancer dans le fichier manifeste DBCluster. Ce document s'adresse aux administrateurs de bases de données et aux opérateurs Kubernetes qui gèrent les déploiements AlloyDB Omni sur Kubernetes et doivent personnaliser le comportement de l'équilibreur de charge.

Lorsque vous activez le trafic entrant externe dans votre fichier manifeste DBCluster, l'opérateur Kubernetes AlloyDB Omni crée un objet Kubernetes Service de type LoadBalancer. Différentes plates-formes Kubernetes utilisent des annotations personnalisées pour contrôler les propriétés de l'équilibreur de charge, telles que l'attribution d'adresses IP internes ou externes. AlloyDB Omni vous permet de spécifier ces annotations dans le champ spec.primarySpec.dbLoadBalancerOptions.annotations de votre fichier manifeste DBCluster. Lorsque vous créez ou mettez à jour le cluster de bases de données avec spec.allowExternalIncomingTraffic défini sur true, l'opérateur AlloyDB Omni applique ces annotations au champ metadata.annotations de l'objet LoadBalancer Service.

Configurer un équilibreur de charge à l'aide de la spécification de base de données

Vous pouvez configurer des annotations d'équilibreur de charge personnalisées en définissant le champ dbLoadBalancerOptions dans la section spec.primarySpec de votre fichier manifeste DBCluster.

Kubernetes

Les annotations définissent le type et les propriétés de l'objet d'équilibreur de charge Service dans votre environnement Kubernetes. Consultez la documentation de votre plate-forme Kubernetes ou de votre implémentation d'équilibreur de charge pour identifier les clés et les valeurs d'annotation compatibles.

Pour créer un cluster de bases de données avec des annotations d'équilibreur de charge personnalisées et autoriser le trafic entrant provenant de l'extérieur du cluster Kubernetes, appliquez le fichier manifeste suivant :

kubectl apply -f - <<EOF
apiVersion: v1
kind: Secret
metadata:
  name: db-pw-DB_CLUSTER_NAME
  namespace: NAMESPACE
type: Opaque
data:
  DB_CLUSTER_NAME: "ENCODED_PASSWORD"
---
apiVersion: alloydbomni.dbadmin.goog/v1
kind: DBCluster
metadata:
  name: DB_CLUSTER_NAME
  namespace: NAMESPACE
spec:
  databaseVersion: "18.4.0"
  primarySpec:
    adminUser:
      passwordRef:
        name: db-pw-DB_CLUSTER_NAME
    resources:
      memory: 5Gi
      cpu: 1
      disks:
      - name: DataDisk
        size: 10Gi
    dbLoadBalancerOptions:
      annotations:
        ANNOTATION_KEY: "ANNOTATION_VALUE"
  allowExternalIncomingTraffic: true
EOF

Remplacez les éléments suivants :

  • DB_CLUSTER_NAME : nom de votre cluster de bases de données, par exemple my-db-cluster.
  • NAMESPACE : espace de noms Kubernetes de votre cluster de bases de données.
  • ENCODED_PASSWORD : mot de passe de l'utilisateur administrateur postgres, encodé sous forme de chaîne base64.
  • ANNOTATION_KEY et ANNOTATION_VALUE : clé d'annotation de l'équilibreur de charge et valeur de chaîne compatibles avec votre environnement Kubernetes. Placez la valeur entre guillemets doubles, même pour les valeurs booléennes ou numériques telles que "true". Vous pouvez spécifier une ou plusieurs paires clé-valeur sous annotations.

Dans le fichier manifeste :

  • ANNOTATION_KEY: "ANNOTATION_VALUE" : spécifie une annotation personnalisée que l'opérateur AlloyDB Omni ajoute à l'objet d'équilibreur de charge Service pour votre cluster de bases de données.
  • allowExternalIncomingTraffic: true : définit le champ allowExternalIncomingTraffic sur true pour autoriser le trafic entrant provenant de l'extérieur du cluster Kubernetes.

Obtenir les détails du cluster de bases de données et de la connectivité

Kubernetes

Pour vérifier que la ressource de cluster de bases de données est à l'état Ready, exécutez la commande suivante :

kubectl get dbclusters.alloydbomni.dbadmin.goog -n NAMESPACE -w

Remplacez NAMESPACE par l'espace de noms Kubernetes de votre cluster de bases de données.

Le résultat ressemble à ce qui suit :

NAME               PRIMARYENDPOINT   PRIMARYPHASE   DBCLUSTERPHASE
DB_CLUSTER_NAME    10.95.0.84        Ready          DBClusterReady

Pour vérifier que votre annotation personnalisée et le point de terminaison externe attribué existent sur l'objet d'équilibreur de charge Service, exécutez la commande suivante :

kubectl get svc LOAD_BALANCER_SERVICE_NAME -n NAMESPACE -o yaml

Remplacez les éléments suivants :

  • LOAD_BALANCER_SERVICE_NAME : nom de l'objet Service LoadBalancer géré par l'opérateur. Pour le point de terminaison principal en lecture-écriture, l'opérateur AlloyDB Omni nomme ce Service al-DB_CLUSTER_NAME-rw-elb (vous pouvez également lister les objets Service en exécutant kubectl get svc -n NAMESPACE).
  • NAMESPACE : nom de l'espace de noms Kubernetes pour votre objet Service d'équilibreur de charge.

Le résultat ressemble à ce qui suit :

apiVersion: v1
kind: Service
metadata:
  annotations:
    ANNOTATION_KEY: "ANNOTATION_VALUE"
  creationTimestamp: "2024-02-22T15:26:18Z"
  finalizers:
  - service.kubernetes.io/load-balancer-cleanup
  labels:
    alloydbomni.internal.dbadmin.goog/dbcluster: DB_CLUSTER_NAME
    alloydbomni.internal.dbadmin.goog/dbcluster-ns: NAMESPACE
  name: LOAD_BALANCER_SERVICE_NAME
  namespace: NAMESPACE
  ownerReferences:
  - apiVersion: alloydbomni.dbadmin.goog/v1
    blockOwnerDeletion: true
    controller: true
    kind: DBCluster
    name: DB_CLUSTER_NAME
    uid: 2dd76c9f-7698-4210-be41-6d2259840a85
  resourceVersion: "33628320"
  uid: 1f45362b-6d6f-484d-ad35-11c14e91933e
spec:
  allocateLoadBalancerNodePorts: true
  clusterIP: 10.60.4.76
  clusterIPs:
  - 10.60.4.76
  externalTrafficPolicy: Cluster
  internalTrafficPolicy: Cluster
  ipFamilies:
  - IPv4
  ipFamilyPolicy: SingleStack
  ports:
  - name: db
    nodePort: 31453
    port: 5432
    protocol: TCP
    targetPort: 5432
  selector:
    alloydbomni.internal.dbadmin.goog/dbcluster: DB_CLUSTER_NAME
    alloydbomni.internal.dbadmin.goog/dbcluster-ns: NAMESPACE
    alloydbomni.internal.dbadmin.goog/task-type: database
    dbs.internal.dbadmin.goog/ha-role: Primary
  sessionAffinity: None
  type: LoadBalancer
status:
  loadBalancer:
    ingress:
    - ip: 10.95.0.84

Le résultat inclut les champs suivants :

  • metadata.annotations : contient l'annotation ANNOTATION_KEY: "ANNOTATION_VALUE" que vous avez configurée dans votre fichier manifeste DBCluster.
  • status.loadBalancer.ingress : affiche le point de terminaison externe attribué à l'objet d'équilibreur de charge Service. Selon votre environnement Kubernetes, le contrôleur d'équilibreur de charge renseigne soit ip (qui correspond à la valeur PRIMARYENDPOINT de votre cluster de base de données), soit hostname (pour les équilibreurs de charge basés sur le DNS, comme sur AWS EKS, où status.primary.endpoints sur DBCluster enregistre le nom d'hôte et le port).

Étapes suivantes