Rotazione delle credenziali di Cassandra in Hashicorp Vault

Panoramica

Questa funzionalità consente agli amministratori di piattaforma di:

  • Ruota le credenziali di Cassandra in Hashicorp Vault.
  • Ripristina le credenziali Cassandra precedenti in Vault in caso di problemi durante la rotazione delle password.
  • Ruota la password di Cassandra per una regione alla volta, in modo da garantire un impatto minimo sulla disponibilità del servizio e mantenere il controllo sul processo di rotazione.
  • Monitorare l'inizio, l'avanzamento e il completamento della rotazione per una singola regione.

Questa funzionalità è disponibile in Apigee Hybrid 1.13.1 e versioni successive.

Prima di iniziare

Prima di configurare la rotazione delle credenziali:

  • Esegui il backup del tuo database Cassandra. Questo backup serve a garantire il recupero delle credenziali pre-ruotate.
  • Assicurati che il cluster sia in uno stato integro (ovvero che tutte le risorse Apigee siano in esecuzione e che non siano in attesa modifiche dello stato).

Configurazione di una singola regione

  1. Crea una nuova risorsa Kubernetes SecretProviderClass nello spazio dei nomi Apigee per le nuove credenziali Cassandra. Per un modello da utilizzare, consulta Archiviazione dei secret Cassandra in Hashicorp Vault. In questo modo, un ruolo Vault può accedere ai secret all'interno degli spazi dei nomi Kubernetes.
  2. Crea una nuova risorsa personalizzata SecretRotation utilizzando il seguente modello:
    # rotation.yaml
    
    apiVersion: apigee.cloud.google.com/v1alpha1
    kind: SecretRotation
    metadata:
      name: ROTATION_PROCESS_NAME
      namespace: APIGEE_NAMESPACE
    spec:
      organizationId: ORG_NAME
      rotationId: ROTATION_ID
      timeoutMinutes: 480 # optional. overrides the default (480m == 8hr).
                          # less than or equal to 0 means infinite timeout.
      precheck: true
      cassandra:
        oldSecretProviderClass: OLD_SPC_NAME
        newSecretProviderClass: NEW_SPC_NAME
        jobType: ROTATE
    
    • ROTATION_PROCESS_NAME: un nome univoco per il job di rotazione. Dovrai impostare metadata.name su un valore univoco per il job di precontrollo della rotazione e di nuovo per il job di rotazione. Ad esempio sr-1-precheck seguito da sr-1.
    • ROTATION_ID: imposta spec.rotationId su un identificatore personalizzato, ad esempio rotation-1-precheck.
    • NEW_SPC_NAME: imposta spec.cassandra.newSecretProviderClass sul nome della classe del nuovo provider di secret creato nel passaggio precedente.
    • OLD_SPC_NAME: imposta spec.cassandra.oldSecretProviderClass sul nome dell'SPC attualmente utilizzato dal ApigeeDatastore.
  3. Attiva il job di precontrollo della rotazione applicando il file rotation.yaml.
    kubectl -n APIGEE_NAMESPACE apply -f rotation.yaml
  4. Controlla lo stato del job per verificare quando il job di precontrollo è stato completato.
    kubectl -n APIGEE_NAMESPACE get job sr-(rotationId)-(rotate|rollback|cleanup)-job
  5. Una volta completato il job di precontrollo della rotazione, modifica il valore di metadata.name e imposta spec.precheck su false. Applica di nuovo il file per eseguire la rotazione.
    kubectl -n APIGEE_NAMESPACE apply -f rotation.yaml
  6. Una volta completato il job di rotazione e dopo che hai convalidato il flusso del traffico, esegui la pulizia del processo con i due passaggi seguenti:
    1. Aggiorna il valore di metadata.name e imposta spec.cassandra.jobType su CLEANUP.
    2. Attiva il job di pulizia applicando il file.
      kubectl -n APIGEE_NAMESPACE apply -f rotation.yaml

    Al termine del job di pulizia, il processo di rotazione è completato.

  7. Esegui il backup del database Cassandra. Questo backup serve a garantire il recupero delle credenziali dopo la rotazione.
  8. Elimina le credenziali, il ruolo e i criteri Cassandra precedenti da Vault.

Configurazione multiregione

Le procedure di configurazione per più regioni sono suddivise in due sezioni: configurazione per la prima regione e configurazione per le regioni rimanenti.

  1. Completa i seguenti passaggi nella prima regione prima di iniziare le regioni successive.
    1. Crea una nuova risorsa Kubernetes SecretProviderClass nello spazio dei nomi APIGEE_NAMESPACE per le nuove credenziali Cassandra. Per un modello da utilizzare, consulta Archiviare i secret di Cassandra in Hashicorp Vault. In questo modo, un ruolo Vault può accedere ai secret all'interno degli spazi dei nomi Kubernetes.
    2. Crea una nuova risorsa personalizzata SecretRotation utilizzando il seguente modello:
      # rotation.yaml
      
      apiVersion: apigee.cloud.google.com/v1alpha1
      kind: SecretRotation
      metadata:
        name: ROTATION_PROCESS_NAME
        namespace: APIGEE_NAMESPACE
      spec:
        organizationId: ORG_NAME
        rotationId: ROTATION_ID
        timeoutMinutes: -1 # this value is required and should not be changed.
        precheck: true
        cassandra:
          oldSecretProviderClass: OLD_SPC_NAME
          newSecretProviderClass: NEW_SPC_NAME
          jobType: ROTATE
      
      • ROTATION_PROCESS_NAME: un nome univoco per il job di rotazione. Dovrai impostare metadata.name su un valore univoco per il job di precontrollo della rotazione e di nuovo per il job di rotazione. Ad esempio sr-1-precheck seguito da sr-1.
      • ROTATION_ID: imposta spec.rotationId su un identificatore personalizzato, ad esempio rotation-1-precheck.
      • NEW_SPC_NAME: imposta spec.cassandra.newSecretProviderClass sul nome della classe del nuovo provider di secret creato nel passaggio precedente.
      • OLD_SPC_NAME: imposta spec.cassandra.oldSecretProviderClass sul nome dell'SPC attualmente utilizzato dal ApigeeDatastore.
    3. Attiva il job di precontrollo della rotazione applicando il file rotation.yaml.
      kubectl -n APIGEE_NAMESPACE apply -f rotation.yaml
    4. Controlla lo stato del job per verificare quando il job di precontrollo è stato completato.
      kubectl -n APIGEE_NAMESPACE get job sr-(rotationId)-(rotate|rollback|cleanup)-job
    5. Al termine del job di precontrollo della rotazione:
      • Modifica il valore di metadata.name, ad esempio da sr-1-precheck a sr-1.
      • Imposta spec.precheck su false per disattivare il precontrollo ed eseguire la rotazione.
      • Imposta spec.rotationId su un nuovo identificatore, ad esempio rotation-1.
    6. Applica nuovamente il file per eseguire la rotazione.
      kubectl -n APIGEE_NAMESPACE apply -f rotation.yaml
    7. Controlla lo stato di SecretRotation e attendi che sia complete.
      kubectl -n APIGEE_NAMESPACE get sr SR_NAME
  2. In ogni regione successiva, completa i seguenti passaggi:
    1. Crea una nuova risorsa Kubernetes SecretProviderClass nel tuo spazio dei nomi Apigee per le nuove credenziali Cassandra. Per un modello da utilizzare, consulta Archiviazione dei secret Cassandra in Hashicorp Vault. Questa definizione deve essere la stessa del passaggio 1a.
    2. Aggiorna il overrides.yaml e imposta cassandra.auth.secretProviderClass in modo che corrisponda al valore di spec.cassandra.newSecretProviderClass nel file rotation.yaml.
      cassandra:
        auth:
          secretProviderClass: NEW_SPC_NAME
    3. Applica il grafico degli operatori:
      helm upgrade operator apigee-operator/ \
        --namespace APIGEE_NAMESPACE \
        --atomic \
        -f OVERRIDES_FILE
    4. Verrà creato un nuovo ReplicaSet. Verifica che i nuovi pod controller-manager utilizzino il nuovo SPC:
      export POD=NEW_CONTROLLER_MANAGER_POD_NAME
      kubectl -n APIGEE_NAMESPACE get pods $POD -o jsonpath='{.spec.volumes[?(@.name=="apigee-external-secrets")].csi.volumeAttributes.secretProviderClass}'
      

      Il risultato dovrebbe corrispondere al valore impostato per spec.cassandra.newSecretProviderClass in rotation.yaml, ad esempio:

      kubectl -n apigee get pods $POD -o jsonpath='{.spec.volumes[?(@.name=="apigee-external-secrets")].csi.volumeAttributes.secretProviderClass}'
      
      my-new-spc
    5. Applica il grafico del datastore:
      helm upgrade datastore apigee-datastore/ \
        --namespace APIGEE_NAMESPACE \
        --atomic \
        -f OVERRIDES_FILE
    6. Il datastore entrerà in uno stato di rilascio. Attendi fino al termine del rilascio del datastore e che è in esecuzione.
      kubectl -n APIGEE_NAMESPACE get apigeedatastore DATASTORE_NAME

      DATASTORE_NAME è default nella maggior parte delle installazioni.

    7. Verifica che i nuovi pod del datastore utilizzino il nuovo SPC:
      export POD=NEW_DATASTORE_POD_NAME
      kubectl -n APIGEE_NAMESPACE get pods $POD -o jsonpath='{.spec.volumes[?(@.name=="apigee-external-secrets")].csi.volumeAttributes.secretProviderClass}'
      

      Il risultato deve corrispondere al valore impostato per spec.cassandra.newSecretProviderClass in rotation.yaml, ad esempio:

      kubectl -n apigee get pods $POD -o jsonpath='{.spec.volumes[?(@.name=="apigee-external-secrets")].csi.volumeAttributes.secretProviderClass}'
      
      my-new-spc
    8. Attendi il completamento del rilascio dell'organizzazione e degli ambienti e il ritorno allo stato di esecuzione.
      kubectl -n APIGEE_NAMESPACE get apigeeorg ORG_NAME
      kubectl -n APIGEE_NAMESPACE get apigeeenv ENV_NAME
    9. Verifica che i nuovi pod MART, di runtime e di sincronizzazione utilizzino il nuovo SPC:
      export POD=NEW_MART_POD_NAME
      kubectl -n APIGEE_NAMESPACE get pods $POD -o jsonpath='{.spec.volumes[?(@.name=="apigee-external-secrets")].csi.volumeAttributes.secretProviderClass}'
      export POD=NEW_RUNTIME_POD_NAME
      kubectl -n APIGEE_NAMESPACE get pods $POD -o jsonpath='{.spec.volumes[?(@.name=="apigee-external-secrets")].csi.volumeAttributes.secretProviderClass}'
      export POD=NEW_SYNCHRONIZER_POD_NAME
      kubectl -n APIGEE_NAMESPACE get pods $POD -o jsonpath='{.spec.volumes[?(@.name=="apigee-external-secrets")].csi.volumeAttributes.secretProviderClass}'
      

      Il risultato deve corrispondere al valore impostato per spec.cassandra.newSecretProviderClass in rotation.yaml, ad esempio:

      kubectl -n apigee get pods $POD -o jsonpath='{.spec.volumes[?(@.name=="apigee-external-secrets")].csi.volumeAttributes.secretProviderClass}'
      
      my-new-spc
  3. Dopo aver completato i passaggi in ogni regione e aver verificato che il traffico continua a scorrere correttamente, ripulisci la procedura nella prima regione con i seguenti due passaggi:
    1. Nella prima regione, aggiorna il valore di metadata.name e imposta spec.cassandra.jobType su CLEANUP.
    2. Attiva il job di pulizia applicando il file.
      kubectl -n APIGEE_NAMESPACE apply -f rotation.yaml
    3. Controlla lo stato del job e osserva i relativi log per verificare quando il job di pulizia è stato completato.

    Al termine del job di pulizia, il processo di rotazione risulta completato.

  4. Esegui il backup del database Cassandra. Questo backup serve a garantire il recupero delle credenziali dopo la rotazione.
  5. Elimina le credenziali, il ruolo e il criterio precedenti di Cassandra da Vault.