Informazioni su Skaffold

1. Obiettivi

Skaffold è uno strumento che gestisce il flusso di lavoro per la creazione, il push e il deployment dell'applicazione. Puoi utilizzare Skaffold per configurare facilmente uno spazio di lavoro di sviluppo locale, semplificare il ciclo di sviluppo interno e integrarti con altri strumenti come Kustomize e Helm per gestire i manifest di Kubernetes.

In questo tutorial esaminerai alcuni concetti di base di Skaffold, lo utilizzerai per automatizzare il ciclo di sviluppo interno e poi eseguirai il deployment di un'applicazione.

Imparerai a:

  • Configura e abilita Skaffold per lo sviluppo locale
  • Crea ed esegui una semplice applicazione Golang
  • Gestire il deployment delle applicazioni locali con Skaffold
  • Esegui il rendering dei manifest e il deployment dell'applicazione

2. Prima di iniziare

Preparare il workspace

  1. Apri l'editor di Cloud Shell visitando il seguente URL:
https://shell.cloud.google.com

Consenti i cookie di terze parti. Fai clic su "Il sito non funziona" e poi su "Consenti cookie".

7b702066a2135a3d.png

3394f82132eb4fd4.png

  1. Se non l'hai ancora fatto, clona l'origine dell'applicazione nella finestra del terminale con il seguente comando:
git clone https://github.com/GoogleCloudPlatform/software-delivery-workshop.git
  1. Passa alla directory del repository clonato:
cd software-delivery-workshop/labs/understanding-skaffold/getting-started
  1. Imposta l'area di lavoro Cloud Shell sulla directory corrente eseguendo questo comando:
cloudshell workspace .

Preparazione del progetto

  1. Assicurati che il progetto Google Cloud sia impostato correttamente eseguendo questo comando:
gcloud config set project {{project-id}}

3. Iniziare a utilizzare Skaffold

  1. Esegui questo comando per creare il file di configurazione Skaffold di primo livello, skaffold.yaml:
cat <<EOF > skaffold.yaml
apiVersion: skaffold/v2beta21
kind: Config
metadata:
  name: getting-started-kustomize
build:
  tagPolicy:
    gitCommit:
      ignoreChanges: true
  artifacts:
  - image: skaffold-kustomize
    context: app
    docker:
      dockerfile: Dockerfile
deploy:
  kustomize:
    paths:
    - overlays/dev
profiles:
- name: staging
  deploy:
    kustomize:
      paths:
      - overlays/staging
- name: prod
  deploy:
    kustomize:
      paths:
      - overlays/prod
EOF
  1. Apri il file skaffold.yaml nel riquadro IDE. Questo è il file di configurazione di primo livello che definisce la pipeline Skaffold.

Nota il formato YAML simile a Kubernetes e le seguenti sezioni nel file YAML:

  • build
  • deploy
  • profiles

Queste sezioni definiscono come devono essere compilate e implementate l'applicazione, nonché i profili per ogni target di deployment.

Puoi scoprire di più sull'elenco completo delle fasi di Skaffold nella documentazione relativa alle fasi della pipeline Skaffold.

4. Build

La sezione build contiene la configurazione che definisce come deve essere creata l'applicazione. In questo caso, puoi vedere la configurazione per la gestione dei tag git, nonché una sezione artifacts che definisce le immagini container che compongono l'applicazione.

Inoltre, in questa sezione puoi vedere il riferimento a Dockerfile da utilizzare per creare le immagini. Skaffold supporta anche altri strumenti di build come Jib, Maven, Gradle, Buildpacks, Bazel nativi del cloud e script personalizzati. Per saperne di più su questa configurazione, consulta la documentazione relativa alla build di Skaffold.

5. Esegui il deployment

La sezione deploy contiene la configurazione che definisce la modalità di deployment dell'applicazione. In questo caso, puoi vedere un esempio di deployment predefinito che configura Skaffold per utilizzare lo strumento Kustomize.

Lo strumento Kustomize fornisce funzionalità per generare manifest Kubernetes combinando un insieme di file YAML di componenti comuni (nella directory base) con una o più "sovrapposizioni" che in genere corrispondono a una o più destinazioni di deployment, in genere dev, test, staging e production o simili.

In questo esempio puoi vedere due overlay per tre target: dev, staging e prod. L'overlay dev verrà utilizzato durante lo sviluppo locale, mentre gli overlay staging e prod verranno utilizzati durante il deployment con Skaffold.

6. Profili

La sezione profiles contiene la configurazione che definisce le configurazioni di build, test e deployment per contesti diversi. Contesti diversi sono in genere ambienti diversi nella pipeline di deployment dell'applicazione, come staging o prod in questo esempio. Ciò significa che puoi gestire facilmente i manifest il cui contenuto deve essere diverso per i diversi ambienti di destinazione, senza ripetere la configurazione boilerplate.

La configurazione nella sezione profiles può sostituire o applicare patch a qualsiasi elemento della configurazione principale (ad esempio, le sezioni build, test o deploy).

Ad esempio, apri il file overlays > prod > deployment.yaml. Tieni presente che il numero di repliche per l'applicazione è configurato qui su tre, sostituendo la configurazione di base.

  1. Apri il seguente file app > main.go nel riquadro IDE. Si tratta di una semplice applicazione Golang che scrive una stringa in stdout ogni secondo.
  2. Tieni presente che l'applicazione restituisce anche il nome del pod Kubernetes in cui è in esecuzione.

Visualizzazione del Dockerfile

  1. Apri il file app > Dockerfile nel riquadro IDE. Questo file contiene una sequenza di direttive per creare l'immagine container dell'applicazione per il file main.go e viene fatto riferimento nel file skaffold.yaml di primo livello.

7. Sviluppare con Skaffold

Configurazione dell'ambiente Kubernetes

  1. Esegui il comando seguente per assicurarti che il cluster Kubernetes locale sia in esecuzione e configurato:
minikube start

L'operazione potrebbe richiedere diversi minuti. Se il cluster è stato avviato correttamente, dovresti vedere il seguente output:

Done! kubectl is now configured to use "minikube" cluster and "default" namespace by default
  1. Esegui il comando seguente per creare spazi dei nomi Kubernetes per dev, staging e prod:
kubectl apply -f namespaces.yaml

Dovresti vedere l'output seguente:

namespace/dev created
namespace/staging created
namespace/prod created

Utilizzo di Skaffold per lo sviluppo locale

  1. Esegui questo comando per creare l'applicazione ed eseguirne il deployment in un cluster Kubernetes locale in esecuzione in Cloud Shell:
skaffold dev

Dovresti vedere l'esecuzione del processo di build del container dell'applicazione, che potrebbe richiedere un minuto, e poi l'output dell'applicazione ripetersi ogni secondo:

[skaffold-kustomize] Hello world from pod skaffold-kustomize-dev-xxxxxxxxx-xxxxx

Tieni presente che il nome esatto del pod varierà rispetto all'output generico riportato sopra.

Apportare modifiche alla richiesta

Ora che l'applicazione è in esecuzione nel cluster Kubernetes locale, puoi apportare modifiche al codice e Skaffold ricompilerà ed eseguirà nuovamente il deployment dell'applicazione nel cluster.

  1. Apri il file app > main.go nel riquadro IDE e modifica la stringa di output:
"Hello world from pod %s!\n"

a:

"Hello Skaffold world from pod %s!\n"

Dopo aver apportato la modifica, dovresti vedere Skaffold ricompilare l'immagine e ridistribuirla al cluster, con la modifica dell'output visibile nella finestra del terminale.

  1. Ora, anche nel file "app > main.go" nel riquadro dell'IDE, modifica la riga:
time.Sleep(time.Second * 1)

a

time.Sleep(time.Second * 10)

Anche in questo caso dovresti vedere l'applicazione ricompilata e ridistribuita, con la riga di output che appare ogni 10 secondi.

Modifiche alla configurazione di Kubernetes

Successivamente, apporterai una modifica alla configurazione di Kubernetes e Skaffold eseguirà nuovamente il deployment automaticamente.

  1. Apri il file base > deployment.yaml nell'IDE e modifica la riga:
replicas: 1

a

replicas: 2

Una volta eseguito nuovamente il deployment dell'applicazione, dovresti visualizzare due pod in esecuzione, ognuno con un nome diverso.

  1. Ora, modifica la stessa riga nel file base > deployment.yaml riportandola a:
replicas: 1

Dovresti vedere uno dei pod rimosso dal servizio, in modo che ne rimanga solo uno.

  1. Infine, premi Ctrl-C nella finestra del terminale per arrestare lo sviluppo locale di Skaffold.

Tagliare una release

Dopodiché, creerai una release creando un'immagine della release ed eseguendo il deployment in un cluster.

  1. Esegui questo comando per creare la release:
skaffold build --file-output artifacts.json

Questo comando creerà l'immagine finale (se necessario) e restituirà i dettagli della release nel file artifacts.json.

Se vuoi utilizzare uno strumento come Cloud Deploy per il deployment nei tuoi cluster, questo file contiene le informazioni sulla release. Ciò significa che gli artefatti sono immutabili nel percorso verso la pubblicazione.

  1. Esegui questo comando per visualizzare i contenuti del file artifacts.json:
cat artifacts.json | jq

Tieni presente che il file contiene il riferimento all'immagine che verrà utilizzata nel deployment finale.

Deployment nella gestione temporanea in corso…

  1. Esegui questo comando per eseguire il deployment della release utilizzando il profilo staging:
skaffold deploy --profile staging --build-artifacts artifacts.json --tail

Al termine del deployment, dovresti vedere l'output di due pod simile al seguente:

[skaffold-kustomize] Hello world from pod skaffold-kustomize-staging-xxxxxxxxxx-xxxxx!
  1. Premi Ctrl+C nella finestra del terminale per interrompere l'output di Skaffold.
  2. Esegui questo comando per osservare la tua applicazione in esecuzione nel cluster:
kubectl get all --namespace staging

Dovresti vedere due nomi di pod distinti, perché il profilo staging per l'applicazione specifica che devono essere presenti due repliche nel deployment.

Esegui il deployment in produzione

  1. Ora esegui questo comando per eseguire il deployment della release utilizzando il profilo prod:
skaffold deploy --profile prod --build-artifacts artifacts.json --tail

Al termine del deployment, dovresti visualizzare l'output di tre pod simile al seguente:

[skaffold-kustomize] Hello world from pod skaffold-kustomize-prod-xxxxxxxxxx-xxxxx!
  1. Premi Ctrl+C nella finestra del terminale per interrompere l'output di Skaffold.

Dovresti vedere tre nomi di pod distinti, perché il profilo prod per l'applicazione specifica che devono essere presenti tre repliche nel deployment.

  1. Esegui questo comando per osservare la tua applicazione in esecuzione nel cluster:
kubectl get all --namespace prod

Dovresti vedere un output contenente righe simili alle seguenti che mostrano il deployment di produzione:

NAME                                      READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/skaffold-kustomize-prod   3/3     3            3           16m

Dovresti anche vedere tre pod dell'applicazione in esecuzione.

NAME                                           READY   STATUS    RESTARTS   AGE
pod/skaffold-kustomize-prod-xxxxxxxxxx-xxxxx   1/1     Running   0          10m
pod/skaffold-kustomize-prod-xxxxxxxxxx-xxxxx   1/1     Running   0          10m
pod/skaffold-kustomize-prod-xxxxxxxxxx-xxxxx   1/1     Running   0          10m

8. Complimenti!

Complimenti! Hai completato il lab Understanding Skaffold e hai imparato a configurare e utilizzare Skaffold per lo sviluppo locale e il deployment delle applicazioni.

Qual è il passaggio successivo?

Continua a scoprire di più su Skaffold:

Esegui la pulizia

  1. Esegui questo comando per arrestare il cluster locale:
minikube delete