Deployment canary su GKE e cluster GKE collegati utilizzando il networking basato sui servizi

Questo documento descrive come configurare e utilizzare i deployment canary per eseguire il deployment delle applicazioni in cluster GKE o GKE collegati utilizzando Cloud Deploy con il networking basato sui servizi.

Un deployment canary è un'implementazione progressiva di una nuova versione dell'applicazione, in cui aumenti gradualmente la percentuale di traffico inviato alla nuova versione, monitorando al contempo le prestazioni dell'applicazione. In questo modo puoi rilevare potenziali problemi in anticipo e ridurre al minimo l'impatto sugli utenti.

Come funzionano i deployment canary per i cluster GKE e GKE collegati con il networking basato sui servizi

  1. Fornisci il nome della risorsa Deployment e della risorsa Service.

  2. Cloud Deploy crea un'altra risorsa Deployment, con il nome del deployment attuale più -canary.

Anche i secret e i ConfigMap vengono copiati e rinominati con -canary.

  1. Cloud Deploy modifica il servizio per regolare il selettore in modo da selezionare i pod nel deployment attuale e i pod canary.

    Cloud Deploy calcola il numero di pod da utilizzare per il canary in base al calcolo descritto nella sezione relativa al provisioning dei pod. Questo calcolo varia a seconda che tu abiliti o disabiliti l'overprovisioning dei pod.

    Se passiamo alla fase stable, Cloud Deploy aggiunge le etichette da utilizzare per trovare i pod, in modo che siano disponibili per le esecuzioni canary successive.

    Cloud Deploy crea un deployment che include la percentuale di pod specifica della fase, aggiornandola per ogni fase. Questa operazione viene eseguita calcolando il numero di pod come percentuale del numero originale di pod. Ciò può comportare una suddivisione del traffico non precisa. Se hai bisogno di una suddivisione precisa del traffico, puoi ottenerla utilizzando l'API Gateway.

  2. Durante la fase stable, il deployment -canary viene ridotto a zero e il deployment originale viene sostituito con il nuovo deployment.

    Cloud Deploy non modifica il deployment originale fino alla fase stable, a meno che tu non disabiliti l'overprovisioning.

Cloud Deploy esegue il provisioning dei pod per raggiungere il più possibile la percentuale canary richiesta. Questo si basa sul numero di pod, non sul traffico verso i pod. Se vuoi che il canary sia basato sul traffico, devi utilizzare l'API Gateway.

Per il canary basato sulla rete GKE, puoi abilitare o disabilitare l'overprovisioning dei pod. Le sezioni seguenti descrivono come Cloud Deploy calcola il numero di pod di cui eseguire il provisioning per il deployment canary per ogni fase canary.

Provisioning dei pod con l'overprovisioning abilitato

L'abilitazione dell'overprovisioning (disablePodOverprovisioning: false) consente a Cloud Deploy di creare un numero sufficiente di pod aggiuntivi per eseguire la percentuale canary desiderata, in base al numero di pod che eseguono il deployment esistente. La seguente formula mostra come Cloud Deploy calcola il numero di pod di cui eseguire il provisioning per il deployment canary per ogni fase canary, quando l'overprovisioning dei pod è abilitato:

math.Ceil( percentage * ReplicaCountOfDeploymentOnCluster / (100-percentage))

Con questa formula, il conteggio delle repliche attuale (il numero di pod che hai già, prima di questo canary) viene moltiplicato per la percentuale canary per la fase e il risultato viene diviso per (100 meno la percentuale).

Ad esempio, se hai già 4 pod e la fase canary è del 50%, il numero di pod canary è 4. (Il risultato di 100-percentage viene utilizzato come percentuale: 100-50=50, trattato come .50.)

L'overprovisioning dei pod è il comportamento predefinito.

Provisioning dei pod con l'overprovisioning disabilitato

Puoi disabilitare l'overprovisioning (disablePodOverprovisioning: true), per assicurarti che Cloud Deploy non aumenti il conteggio delle repliche.

La seguente formula mostra come Cloud Deploy calcola il provisioning dei pod per il deployment canary per ogni fase canary, quando l'overprovisioning dei pod è disabilitato:

math.Ceil( (ReplicaCountOfDeploymentOnCluster + ReplicaCountOfCanaryDeploymentOnCluster) * percentage)

In questa formula, ReplicaCountOfCanaryDeploymentOnCluster esiste solo se era già presente una fase canary. Se questa è la prima fase canary, non esiste ReplicaCountOfCanaryDeploymentOnCluster.

Se inizi con 4 pod, questo numero viene moltiplicato per la percentuale canary (ad esempio, 50% o .5) per ottenere 2. Quindi il deployment originale viene ridotto a 2 e vengono creati 2 nuovi pod per il deployment canary. Se poi hai una fase canary del 75%, hai 2 (deployment originale) +2 (prima fase canary), *.75, per ottenere 3 pod canary e 1 pod che esegue il deployment originale.

Utilizzando Cloud Deploy, puoi configurare i deployment canary in cluster GKE e GKE collegati in una o più fasi.

Le istruzioni riportate qui includono solo ciò che è specifico della configurazione canary. Il documento Eseguire il deployment in un cluster Google Kubernetes Engine contiene le istruzioni generali per configurare ed eseguire la pipeline di deployment.

Assicurati di disporre delle autorizzazioni necessarie.

Oltre alle altre autorizzazioni di Identity and Access Management necessarie per l'utilizzo di Cloud Deploy, devi disporre delle seguenti autorizzazioni per eseguire azioni aggiuntive che potrebbero essere necessarie per un deployment canary:

  • clouddeploy.rollouts.advance
  • clouddeploy.rollouts.ignoreJob
  • clouddeploy.rollouts.cancel
  • clouddeploy.rollouts.retryJob
  • clouddeploy.jobRuns.get
  • clouddeploy.jobRuns.list
  • clouddeploy.jobRuns.terminate

Per saperne di più sui ruoli disponibili che includono queste autorizzazioni, consulta Ruoli e autorizzazioni IAM.

Prepara il file skaffold.yaml

Il file skaffold.yaml definisce la modalità di rendering e deployment dei manifest Kubernetes. Per un deployment canary in cluster GKE o GKE collegati, assicurati che punti correttamente ai manifest e definisca gli artefatti di build necessari. Non è richiesta alcuna configurazione speciale specifica per il canary all'interno di skaffold.yaml oltre a quella necessaria per un deployment standard. Puoi utilizzare i profili Skaffold per gestire diverse varianti di manifest per le fasi canary personalizzate.

Prepara i manifest Kubernetes

I manifest Kubernetes devono includere sia una risorsa Deployment sia una risorsa Service. Il Service deve definire un selector che corrisponda alle etichette dei pod gestiti dal Deployment. L'etichetta predefinita che Cloud Deploy cerca è app, ma può essere configurata nella pipeline.

Configura un canary automatico

Configura un canary automatico direttamente nella definizione della pipeline di distribuzione per una fase specifica di cluster GKE o GKE collegati utilizzando il networking dei servizi Kubernetes standard.

Nella fase della pipeline, includi una proprietà strategy, come segue:

serialPipeline:
  stages:
  - targetId: prod
    profiles: []
    strategy:
      canary:
        runtimeConfig:
          kubernetes:
            serviceNetworking:
              service: "SERVICE_NAME"
              deployment: "DEPLOYMENT_NAME"
              podSelectorLabel: "LABEL"
        canaryDeployment:
          percentages: [PERCENTAGES]
          verify:
            tasks: []
          predeploy:
            tasks: []
          postdeploy:
            tasks: []

In questa configurazione...

  • SERVICE_NAME è il nome del servizio Kubernetes, definito nel manifest.

  • DEPLOYMENT_NAME è il nome del deployment Kubernetes, definito nel manifest.

  • LABEL è un'etichetta del selettore pod. Deve corrispondere al selettore di etichette nel servizio Kubernetes definito nel manifest. Questo è facoltativo. Il valore predefinito è app.

  • PERCENTAGES è un elenco di valori di percentuale separati da virgole che rappresentano gli incrementi canary, ad esempio [5, 25, 50].

    Inoltre, non include 100, perché il deployment al 100% è presupposto nel canary ed è gestito dalla fase stable.

  • Puoi abilitare la verifica del deployment configurando la sezione verify. In questo caso, viene abilitato un job verify in ogni fase.

  • Puoi abilitare gli hook predeploy configurando la predeploy sezione. In questo caso, viene aggiunto un job predeploy alla prima fase canary.

  • Puoi abilitare gli hook postdeploy configurando la postdeploy sezione. In questo caso, viene aggiunto un job postdeploy alla fase stabile.

Configura un canary automatico personalizzato

Un canary automatico personalizzato combina la definizione di fasi personalizzate (nomi, percentuali, profili, verifica, hook) con la gestione automatica del traffico di Cloud Deploy per cluster GKE o GKE collegati. Definisci le fasi, ma Cloud Deploy gestisce la manipolazione delle risorse sottostanti in base alle percentuali e alla runtimeConfig scelta.

Per configurare un canary automatico personalizzato, includi sia una sezione runtimeConfig con serviceNetworking sia la sezione customCanaryDeployment (che definisce phaseConfigs) all'interno del blocco strategy.canary. Cloud Deploy utilizza i profili Skaffold specificati per il rendering, ma regola automaticamente il traffico in base alla runtimeConfig e alle percentuali di fase.

serialPipeline:
  stages:
  - targetId: gke-prod
    profiles: []
    strategy:
      canary:
        # Include runtimeConfig for automatic traffic management
        runtimeConfig:
          kubernetes:
            serviceNetworking:
              service: "my-app"
              deployment: "my-deployment"
        # Include customCanaryDeployment for phase customization
        customCanaryDeployment:
          phaseConfigs:
          - phaseId: "warmup"
            percentage: 10
            profiles: ["profile-a"] # Profile used for rendering this phase
            verify:
              tasks: []
          - phaseId: "scaling"
            percentage: 50
            profiles: ["profile-b"] # Different profile for this phase
            verify:
              tasks: []
          - phaseId: "stable"
            percentage: 100
            profiles: ["profile-b"] # Can reuse profiles
            verify:
              tasks: []

Esegui il canary di cluster GKE o GKE collegati

  1. Registra la pipeline e le destinazioni: applica i file di configurazione della pipeline di distribuzione e della destinazione di cluster GKE o GKE collegati.

    
    gcloud deploy apply --file=delivery-pipeline.yaml --region=REGION
    gcloud deploy apply --file=gke-targets.yaml --region=REGION
    

    La pipeline di distribuzione include la configurazione canary automatica o personalizzata per il runtime scelto.

  2. Crea una release: avvia il deployment, fornendo il nome dell'immagine.

    
    gcloud deploy releases create RELEASE_NAME \
                                    --delivery-pipeline=PIPELINE_NAME \
                                    --region=REGION
      # e.g., --images=my-cloudrun-service=gcr.io/my-project/my-app:v1.1
      # Add --skaffold-file or --source if not using default Skaffold config discovery
    

    La pipeline di distribuzione identificata da PIPELINE_NAME contiene la configurazione canary automatica o personalizzata descritta in questo documento.

  3. Avanza il canary:

    gcloud CLI

    gcloud deploy rollouts advance ROLLOUT_NAME \
                                --release=RELEASE_NAME \
                                --delivery-pipeline=PIPELINE_NAME \
                                --region=REGION
    

    Dove:

    ROLLOUT_NAME è il nome dell'implementazione attuale che stai portando alla fase successiva.

    RELEASE_NAME è il nome della release di cui fa parte questa implementazione.

    PIPELINE_NAME è il nome della pipeline di distribuzione che stai utilizzando per gestire il deployment di questa release.

    REGION è il nome della regione in cui è stata creata la release, ad esempio us-central1. Campo obbligatorio.

    Per saperne di più sul comando gcloud deploy rollouts advance, consulta la documentazione di riferimento di Google Cloud SDK.

    Google Cloud Console

    1. Apri la pagina Pipeline di distribuzione.

    2. Fai clic sulla pipeline visualizzata nell'elenco delle pipeline di distribuzione.

      La pagina dei dettagli della pipeline di distribuzione mostra una rappresentazione grafica dell'avanzamento della pipeline di distribuzione.

    3. Nella scheda Implementazioni, in Dettagli della pipeline di distribuzione, fai clic sul nome dell'implementazione.

      Viene visualizzata la pagina dei dettagli dell'implementazione.

      Dettagli dell'implementazione nella console Google Cloud

      Tieni presente che in questo esempio l'implementazione ha una fase canary-50 e una fase stable. La tua implementazione potrebbe avere più fasi o fasi diverse.

    4. Fai clic su Avanza implementazione.

      L'implementazione viene portata alla fase successiva.

Fasi ignorate

Se esegui il deployment di un canary e l'applicazione non è ancora stata sottoposta a deployment in quel runtime, Cloud Deploy salta la fase canary ed esegue la fase stabile. Per scoprire perché ciò accade, consulta la sezione Saltare le fasi la prima volta.

Passaggi successivi