Installa AlloyDB Omni utilizzando l'orchestratore RPM

Select a documentation version:

Questa pagina descrive come installare lo stack software AlloyDB Omni e i relativi componenti di gestione utilizzando l'orchestratore AlloyDB Omni.

Prima di iniziare

Prima di installare i componenti, assicurati di aver completato i seguenti prerequisiti:

  • Installa l'orchestratore: assicurati che la raccolta Ansible o l'interfaccia a riga di comando dell'orchestratore AlloyDB Omni sia installata sul nodo di controllo.
  • Provisioning delle macchine: devi aver eseguito il provisioning delle macchine virtuali RHEL9 in base all'architettura scelta, ad esempio standalone o ad alta affidabilità.
  • Configura la rete e il firewall: assicurati che tutte le porte richieste siano aperte tra i nodi. Sono incluse 5432 per il traffico del database, 2379/2380 per etcd e le porte di gestione 6703, 6702 e 6700 utilizzate da Cluster Manager e Node Manager.
  • Controlla le dipendenze dei pacchetti software: se gestisci i pacchetti software tramite un repository Yum privato, segui le istruzioni di gestione del repository per includere i file RPM dipendenti nel repository.

Prepara l'inventario delle specifiche di deployment

L'orchestratore utilizza un file di specifiche di deployment in formato di inventario Ansible per comprendere la topologia del cluster. Crea un file denominato deployment_spec.yaml con i dettagli del nodo.

alloydbomni:
  vars:
    cluster_manager:
      name: "MANAGEMENT_CLUSTER_NAME"
    etcd:
      setup: SETUP_ETCD
      config_forcewrite: FORCE_OVERWRITE_ETCD
      # version: ETCD_VERSION  # Optional: defaults to the latest version
      # repo_url: ETCD_REPOSITORY_URL  # Optional
      # repo_gpg_key_url: GPG_KEY  # Optional
    alloydbomni:
      major_version: "PG_VERSION" # Mandatory: for example, 18
      # version: ALLOYDB_OMNI_VERSION    # Optional: defaults to the latest version
      # repo_url: ALLOYDB_OMNI_COMMON_REPOSITORY_URL     # Optional
      # repo_gpg_key_url: GPG_KEY  # Optional
    alloydbomni_monitor:
      # version: ALLOYDB_OMNI_MONITOR_VERSION    # Optional: defaults to the latest version
      # repo_url: ALLOYDB_OMNI_COMMON_REPOSITORY_URL   # Optional
      # repo_gpg_key_url: GPG_KEY  # Optional
    alloydbomni_cluster_manager:
      # version: ALLOYDB_OMNI_CLUSTER_MANAGER_VERSION      # Optional: defaults to the latest version
      # repo_url: ALLOYDB_OMNI_ORCHESTRATOR_REPOSITORY_URL # Optional
      # repo_gpg_key_url: GPG_KEY  # Optional
    alloydbomni_node_manager:
      # version: ALLOYDB_OMNI_NODE_MANAGER_VERSION         # Optional: defaults to the latest version
      # repo_url: ALLOYDB_OMNI_ORCHESTRATOR_REPOSITORY_URL # Optional
      # repo_gpg_key_url: GPG_KEY  # Optional
    pgbouncer:
      # version: ALLOYDB_OMNI_PGBOUNCER_VERSION    # Optional
      # repo_url: ALLOYDB_OMNI_COMMON_REPOSITORY_URL   # Optional
      # repo_gpg_key_url: GPG_KEY  # Optional
    pgbackrest:
      # version: ALLOYDB_OMNI_PGBACKREST_VERSION   # Optional
      # repo_url: ALLOYDB_OMNI_COMMON_REPOSITORY_URL   # Optional
      # repo_gpg_key_url: GPG_KEY  # Optional

  children:
    primary_instance_nodes:
      hosts:
        DB_HOST_1:
        DB_HOST_2:
        DB_HOST_3:
    load_balancer_nodes:    # Optional. Host group for load balancer. If empty, no load balancer is configured.
      hosts:
        LB_HOST_1:
        LB_HOST_2:
    etcd_nodes:     # Optional: Host group where etcd is set up
      hosts:
        ETCD_HOST_1:
        ETCD_HOST_2:
        ETCD_HOST_3:
    cluster_manager_nodes:    # Optional: Host group for cluster manager
      hosts:
        CM_HOST_1:
        CM_HOST_2:
        CM_HOST_3:

Sostituisci quanto segue:

  • MANAGEMENT_CLUSTER_NAME: il nome del cluster di gestione. Può essere lo stesso del nome del cluster di database se sono installati sugli stessi nodi, ad esempio my-management-cluster.
  • SETUP_ETCD: specifica se l'orchestratore deve configurare e avviare il cluster etcd. Se impostato su true, l'orchestratore esegue la configurazione e l'inizializzazione iniziale di etcd sui nodi etcd designati. Se non sono definiti nodi etcd in deployment_spec, per impostazione predefinita etcd viene configurato sui nodi di Cluster Manager. Questo parametro corrisponde alla chiave etcd.setup nelle specifiche di deployment.
  • FORCE_OVERWRITE_ETCD: determina se sostituire un file di configurazione etcd esistente durante la procedura di configurazione. Imposta su true per sovrascrivere il file di configurazione esistente sui nodi di destinazione; in caso contrario, imposta su false(valore predefinito) per mantenere la configurazione esistente ed evitare interruzioni impreviste del servizio.
  • ETCD_VERSION: la versione del pacchetto etcd da installare, ad esempio 3.4.13.
  • ETCD_REPOSITORY_URL: l'URL del repository contenente gli RPM etcd.
  • PG_VERSION: la versione principale di PostgreSQL dell'installazione di AlloyDB Omni, ad esempio 18.
  • ALLOYDB_OMNI_VERSION: la versione del motore del database AlloyDB Omni da installare, ad esempio 18.1.0. Se omesso, l'orchestratore installa l'ultima versione disponibile.
  • ALLOYDB_OMNI_COMMON_REPO_URL: l'URL del repository comune contenente gli RPM di AlloyDB Omni, monitor, PgBouncer e pgBackRest.
  • GPG_KEY: la posizione della chiave pubblica di Google per la verifica di GNU Privacy Guard (GPG), ad esempio https://dl.google.com/linux/linux_signing_key.pub. Può essere impostato anche come percorso se la chiave viene scaricata in un file su tutte le VM, ad esempio /tmp/linux_signing_key.pub.
  • ALLOYDB_OMNI_MONITOR_VERSION: la versione del pacchetto di monitoraggio AlloyDB Omni da installare. Il valore predefinito è l'ultima versione disponibile.
  • ALLOYDB_OMNI_CLUSTER_MANAGER_VERSION: la versione di AlloyDB Omni Cluster Manager da installare. Se omesso, l'orchestratore installa l'ultima versione disponibile.
  • ALLOYDB_OMNI_ORCHESTRATOR_REPO_URL: l'URL del repository contenente gli RPM di AlloyDB Omni Cluster Manager e Node Manager.
  • ALLOYDB_OMNI_NODE_MANAGER_VERSION: la versione di AlloyDB Omni Node Manager da installare. Se omesso, l'orchestratore installa l'ultima versione disponibile.
  • ALLOYDB_OMNI_PGBOUNCER_VERSION: la versione del pacchetto PgBouncer da installare.
  • ALLOYDB_OMNI_PGBACKREST_VERSION: la versione del pacchetto pgBackRest da installare.
  • DB_HOST_1, DB_HOST_2, DB_HOST_3: gli indirizzi IP o i nomi di dominio completi (FQDN) delle macchine virtuali designate come nodi di database.
  • LB_HOST_1, LB_HOST_2: gli indirizzi IP o i nomi di dominio completi (FQDN) delle macchine virtuali designate come nodi del bilanciatore del carico.
  • ETCD_HOST_1, ETCD_HOST_2, ETCD_HOST_3: gli indirizzi IP o i nomi di dominio completi delle macchine virtuali designate come nodi etcd.
  • CM_HOST_1, CM_HOST_2, CM_HOST_3: gli indirizzi IP o i nomi di dominio completi delle macchine virtuali designate come nodi di Cluster Manager.

Installa i componenti

Puoi installare i componenti AlloyDB Omni e le relative dipendenze utilizzando Ansible o installando manualmente i pacchetti software su ogni nodo.

Installa i componenti AlloyDB Omni utilizzando Ansible

Il metodo di installazione consigliato è l'utilizzo del ruolo Ansible fornito.

  1. Crea un playbook denominato install.yaml che faccia riferimento al ruolo di installazione della raccolta dell'orchestratore.

      - name: Install AlloyDB Omni cluster components
        hosts: all
        vars:
          ansible_become: true
          ansible_user: SSH_USER
          ansible_ssh_private_key_file: SSH_KEY_PATH
        roles:
          - role: google.alloydbomni_orchestrator.install
    

    Sostituisci quanto segue:

    • SSH_USER: il nome utente che utilizzi per connetterti ai nodi del cluster tramite SSH.
    • SSH_KEY_PATH: il percorso del file della chiave privata SSH sul nodo di controllo, ad esempio ~/.ssh/id_rsa.
  2. Esegui il playbook utilizzando il file di inventario per scaricare e installare gli RPM su tutti i nodi specificati.

      ansible-playbook -i deployment_spec.yaml install.yaml
    

Installa manualmente i componenti AlloyDB Omni

Se non utilizzi Ansible, devi installare manualmente gli RPM su ogni nodo del cluster.

  • REPO_GPG_KEY: la posizione della chiave pubblica di Google per la verifica di GNU Privacy Guard (GPG), ad esempio https://dl.google.com/linux/linux_signing_key.pub. Può essere impostato anche come percorso se la chiave viene scaricata in un file su tutte le VM, ad esempio file:///tmp/linux_signing_key.pub.

Installa i componenti AlloyDB Omni sui nodi etcd

  1. Su tutti i nodi etcd, crea un file di configurazione del repository YUM denominato /etc/yum.repos.d/alloydb-etcd.repo:

    [etcd]
    name=AlloyDB Omni ETCD
    baseurl=ETCD_REPOSITORY_URL
    enabled=1
    repo_gpgcheck=0
    gpgcheck=1
    gpgkey=REPO_GPG_KEY
    
  2. Installa etcd:

    sudo dnf install -y etcd
    
  3. Avvia etcd modificando il file di configurazione. Devi avviare etcd prima di installare i componenti AlloyDB Omni.

    Su etcd_nodes, modifica /etc/etcd/etcd.conf:

    ETCD_NAME=ETCD_HOST
    ETCD_DATA_DIR=/var/lib/etcd/data
    ETCD_LISTEN_PEER_URLS=https://ETCD_HOST_IP:2380,https://127.0.0.1:2380
    ETCD_LISTEN_CLIENT_URLS=https://ETCD_HOST_IP:2379,https://127.0.0.1:2379
    ETCD_INITIAL_ADVERTISE_PEER_URLS=https://ETCD_HOST_IP:2380
    ETCD_ADVERTISE_CLIENT_URLS=https://ETCD_HOST_IP:2379
    
    ETCD_INITIAL_CLUSTER=ETCD_HOST_1=https://ETCD_HOST_IP_1:2380,ETCD_HOST_2=https://ETCD_HOST_IP_2:2380,ETCD_HOST_3=https://ETCD_HOST_IP_3:2380
    
    ETCD_INITIAL_CLUSTER_STATE=new
    ETCD_INITIAL_CLUSTER_TOKEN=CLUSTER_NAME
    ETCD_ENABLE_V2=true
    
    ETCD_CLIENT_CERT_AUTH=true
    ETCD_TRUSTED_CA_FILE=/var/lib/etcd/ssl/etcd-ca.crt
    ETCD_CERT_FILE=/var/lib/etcd/ssl/etcd-tls.crt
    ETCD_KEY_FILE=/var/lib/etcd/ssl/etcd-tls.key
    ETCD_PEER_CLIENT_CERT_AUTH=true
    ETCD_PEER_TRUSTED_CA_FILE=/var/lib/etcd/ssl/etcd-ca.crt
    ETCD_PEER_CERT_FILE=/var/lib/etcd/ssl/etcd-tls.crt
    ETCD_PEER_KEY_FILE=/var/lib/etcd/ssl/etcd-tls.key
    

    Dove:

    • ETCD_HOST: host etcd attuale.
    • ETCD_HOST_IP: indirizzo IP dell'host etcd attuale.
    • ETCD_HOST_1: il nome del primo nodo nel cluster etcd.
    • ETCD_HOST_IP_1: l'indirizzo IP del primo nodo nel cluster etcd.
    • ETCD_HOST_2: il nome del secondo nodo nel cluster etcd.
    • ETCD_HOST_IP_2: l'indirizzo IP del secondo nodo nel cluster etcd.
    • ETCD_HOST_3: il nome del terzo nodo nel cluster etcd.
    • ETCD_HOST_IP_3: l'indirizzo IP del terzo nodo nel cluster etcd.
    • CLUSTER_NAME: il nome del cluster come da control plane.
  4. Configura il firewall per consentire la comunicazione TCP sulle porte 2379 e 2380.

  5. Avvia etcd:

    sudo systemctl enable etcd
    sudo systemctl start etcd
    

Installa i componenti AlloyDB Omni sui nodi di Cluster Manager

  1. Su tutti i nodi di Cluster Manager, crea un file di configurazione del repository YUM denominato /etc/yum.repos.d/alloydb-orchestrator.repo:

    [alloydbomni_orchestrator]
    name=AlloyDB Omni Orchestrator
    baseurl=ALLOYDB_OMNI_ORCHESTRATOR_REPOSITORY_URL
    enabled=1
    repo_gpgcheck=0
    gpgcheck=1
    gpgkey=REPO_GPG_KEY
    
  2. Installa Cluster Manager:

    sudo dnf install -y alloydbomni_cluster_manager
    
  3. Avvia Cluster Manager:

    sudo systemctl enable alloydbomni_cluster_manager
    sudo systemctl start alloydbomni_cluster_manager
    

Installa i componenti AlloyDB Omni sui nodi di database

  1. Su tutti i nodi di database, crea un file di configurazione del repository YUM denominato /etc/yum.repos.d/alloydb-omni.repo:

    [alloydbomni_core]
    name=AlloyDB Omni Core
    baseurl=ALLOYDB_OMNI_REPOSITORY_URL
    enabled=1
    repo_gpgcheck=0
    gpgcheck=1
    gpgkey=REPO_GPG_KEY
    
    [alloydbomni_common]
    name=AlloyDB Omni Common
    baseurl=ALLOYDB_OMNI_COMMON_REPOSITORY_URL
    enabled=1
    repo_gpgcheck=0
    gpgcheck=1
    gpgkey=REPO_GPG_KEY
    priority=1
    
    [alloydbomni_orchestrator]
    name=AlloyDB Omni Orchestrator
    baseurl=ALLOYDB_OMNI_ORCHESTRATOR_REPOSITORY_URL
    enabled=1
    repo_gpgcheck=0
    gpgcheck=1
    gpgkey=REPO_GPG_KEY
    
  2. Installa i componenti:

    sudo dnf install -y alloydbomniPG_VERSION alloydbomni_monitor alloydbomni_node_manager pgbackrest
    
  3. Avvia Node Manager:

    sudo systemctl enable alloydbomni_node_manager
    sudo systemctl start alloydbomni_node_manager
    
  4. (Facoltativo) Se non utilizzi nodi del bilanciatore del carico separati, installa pgbouncer e keepalived:

    sudo dnf install -y pgbouncer keepalived
    

Installa i componenti AlloyDB Omni sui nodi del bilanciatore del carico

  1. Su tutti i nodi del bilanciatore del carico, crea un file di configurazione del repository YUM denominato /etc/yum.repos.d/alloydb-omni-lb.repo:

    [pgbouncer]
    name=AlloyDB Omni Common
    baseurl=ALLOYDB_OMNI_COMMON_REPOSITORY_URL
    enabled=1
    repo_gpgcheck=0
    gpgcheck=1
    gpgkey=REPO_GPG_KEY
    priority=1
    
    [alloydbomni_node_manager]
    name=AlloyDB Omni Orchestrator
    baseurl=ALLOYDB_OMNI_ORCHESTRATOR_REPOSITORY_URL
    enabled=1
    repo_gpgcheck=0
    gpgcheck=1
    gpgkey=REPO_GPG_KEY
    
  2. Installa i componenti del bilanciatore del carico:

    sudo dnf install -y alloydbomni_node_manager keepalived pgbouncer haproxy
    
  3. Avvia Node Manager:

    sudo systemctl enable alloydbomni_node_manager
    sudo systemctl start alloydbomni_node_manager
    

Riepilogo dei componenti AlloyDB Omni installati

La procedura di installazione esegue il deployment di diversi pacchetti RPM chiave a seconda del tipo di nodo:

Tipo di nodo Componenti installati Note
Nodi dell'istanza principale alloydbomniPG_VERSION, alloydbomni_monitor, alloydbomni_node_manager, pgbouncer, pgbackrest Componenti per il motore del database, il monitoraggio e la gestione.
Nodi del bilanciatore del carico haproxy Facoltativo. L'installazione viene ignorata se i nodi del bilanciatore del carico non sono disponibili.
Nodi di Cluster Manager alloydbomni_cluster_manager Può essere installato sui nodi di database se non sono disponibili nodi dedicati. Se i nodi di Cluster Manager non sono specificati, il componente di Cluster Manager viene installato su primary_instance_nodes.
Nodi etcd etcd Può essere installato sui nodi di Cluster Manager, se necessario. Se i nodi etcd non sono specificati, etcd viene installato su cluster_manager_nodes.

Disinstalla i componenti

Se devi rimuovere l'installazione di AlloyDB Omni dal tuo ambiente, ad esempio per dismettere un cluster o per prepararti a una reinstallazione pulita, puoi disinstallare tutti i componenti software. Puoi disinstallare AlloyDB Omni utilizzando Ansible o rimuovendo manualmente gli RPM da ogni nodo.

Disinstalla i componenti AlloyDB Omni utilizzando Ansible

Per rimuovere i componenti dello stack software AlloyDB Omni utilizzando Ansible, utilizza il file di inventario esistente e un playbook che faccia riferimento al ruolo google.alloydbomni_orchestrator.uninstall.

  1. Crea un playbook denominato uninstall.yaml.

    - name: Uninstall AlloyDB Omni cluster
      hosts: all
      vars:
        ansible_become: true
        ansible_user: SSH_USER
        ansible_ssh_private_key_file: SSH_KEY_PATH
      roles:
        - role: google.alloydbomni_orchestrator.uninstall
    

    Sostituisci quanto segue:

    • SSH_USER: il nome utente che utilizzi per connetterti ai nodi del cluster tramite SSH.
    • SSH_KEY_PATH: il percorso del file della chiave privata SSH sul nodo di controllo, ad esempio ~/.ssh/id_rsa.
  2. Esegui il playbook. Devi passare cleanup_data=true e cleanup_config=true come variabili extra per rimuovere i file di configurazione e la directory dei dati.

    ansible-playbook -i deployment_spec.yaml uninstall.yaml -e "cleanup_data=true cleanup_config=true"
    

Disinstalla manualmente i componenti AlloyDB Omni

Se utilizzi l'interfaccia a riga di comando dell'orchestratore AlloyDB Omni, devi rimuovere manualmente gli RPM da ogni nodo.

  1. Su tutti i nodi di database, esegui questo comando:

    sudo dnf remove -y alloydbomni_node_manager alloydbomniPG_VERSION alloydbomni_monitor pgbackrest keepalived pgbouncer
    
  2. Su tutti i nodi del bilanciatore del carico, esegui questo comando:

    sudo dnf remove -y alloydbomni_node_manager keepalived haproxy pgbouncer
    
  3. Su tutti i nodi di Cluster Manager, esegui questo comando:

    sudo dnf remove -y alloydbomni_cluster_manager
    
  4. (Facoltativo) Su tutti i nodi etcd, esegui questo comando per disinstallare etcd e pulire i dati etcd:

    sudo dnf remove -y etcd
    sudo rm -rf /var/lib/etcd/data
    

Passaggi successivi