Aggiunta di un modello come tipo composito

Questa pagina descrive come creare un tipo composito con Deployment Manager. Dopo aver creato un tipo composito, puoi chiamarlo nella configurazione e creare deployment.

Un tipo composito è uno o più modelli configurati per funzionare insieme che sono stati aggiunti in modo permanente a Deployment Manager. Una volta aggiunto, puoi utilizzare un tipo composito come faresti con un tipo di proprietà di Google. Per scoprire di più sui tipi, leggi la panoramica dei tipi.

Ad esempio, potresti creare un insieme di modelli che eseguono il deployment di un gruppo di istanze gestite con bilanciamento del carico di rete. Aggiungi questi modelli come tipo composito a Deployment Manager e puoi quindi utilizzarli nelle configurazioni future come faresti con altri tipi.

Potrebbe interessarti anche Condivisione dei tipi tra progetti.

Prima di iniziare

Componenti di un tipo composito

Per creare un tipo composto, devi avere un modello Jinja o Python di primo livello e, facoltativamente, un insieme di file di supporto che alla fine si risolvono in tipi di base. I tipi compositi possono essere costituiti da risorse che a loro volta sono altri tipi compositi. Deployment Manager espande questi tipi in modo ricorsivo durante il deployment.

Un tipo composto è costituito da:

  • Un modello di primo livello: il modello Jinja o Python di primo livello eseguito durante l'espansione quando viene chiamato il tipo.
  • Uno schema: il file JSON Schema che descrive le informazioni sul modello di primo livello e su eventuali importazioni secondarie definite.
  • File importati: tutti i file aggiuntivi necessari per l'esecuzione, ad esempio file di supporto, modelli secondari e schemi pertinenti per i modelli secondari, se applicabile. Tuttavia, questa opzione è facoltativa. Il tipo composito può contenere anche un solo modello di primo livello.

Creazione di un tipo composito

Puoi creare un tipo composito registrando il modello di primo livello di una configurazione e i relativi import e schema. Crea un tipo composito utilizzando gcloud o l'API.

Potrebbe interessarti anche l'esempio che descrive come creare e chiamare un tipo composito.

gcloud

Per eseguire questo comando, devi trovarti nella directory in cui hai archiviato il modello di primo livello e i modelli secondari che fanno parte di questo tipo composto.

Utilizzando gcloud CLI, effettua una richiesta types create e specifica il template di primo livello e il nome del tipo desiderato per chiamare questo tipo composito. Esegui questo comando nella directory locale in cui si trovano i file modello.

$ gcloud beta deployment-manager types create [TYPE_NAME] --template=[TOP_LEVEL_TEMPLATE]

dove:

  • [TYPE_NAME] è il nome che vuoi dare a questo tipo
  • [TOP_LEVEL_TEMPLATE] è il percorso relativo al modello di primo livello che descrive questo tipo.

API

Nell'API, invia una richiesta POST che contenga i campi composite e name. Nel campo composite, definisci:

  • Lo schema di primo livello
  • I contenuti dei modelli importati
  • I contenuti del modello di primo livello

Il corpo della richiesta API ha la seguente struttura:

POST https://www.googleapis.com/deploymentmanager/v2beta/projects/[PROJECT_ID]/global/compositeTypes

{
 "composite": {
  "files": {
   "schema": "[CONTENTS_OF_SCHEMA]",
   "imports": [
    {
     "name": "[TEMPLATE_FILE]",
     "content": "[CONTENTS_OF_TEMPLATE_FILE]"
    },
    {
     "name": "[ANOTHER_TEMPLATE_IF_NECESSARY]",
     "content": "[CONTENTS_OF_TEMPLATES]"
    }
   ],
   "template": "[TOP-LEVEL_TEMPLATE_CONTENTS]",
   "templateFileType": "[FILE_TYPE]"
  }
 },
 "name": "[TYPE_NAME]"
}

Per un esempio di come creare queste richieste, consulta Creazione di un tipo composito di gruppo di istanze gestite con scalabilità automatica. Per saperne di più, consulta la documentazione relativa al metodo insert.

Deployment di un tipo composito

I tipi sono una risorsa per progetto e sono accessibili in base alle autorizzazioni descritte nella documentazione Controllo accesso. Ossia:

  • Gli editor e i visualizzatori del progetto e gli editor dei tipi possono creare e utilizzare i tipi disponibili per il progetto.
  • Gli spettatori dei tipi possono ottenere un elenco dei tipi e dei tipi di utilizzo disponibili per il progetto.

Puoi anche aggiungere un altro progetto come visualizzatore di tipi in modo che possa accedere ai tuoi tipi. Leggi Condivisione dei tipi tra progetti.

Una volta registrato un tipo composito, puoi eseguirne il deployment nello stesso modo in cui chiameresti i tipi gestiti da Google:

types: [PROJECT_ID]/composite:[TYPE_NAME]

Ad esempio:

resources:
- name: my example-resource
  type: example-project/composite:autoscaled-igm
  properties:
  ...

Deployment di un tipo composito direttamente con lo strumento a riga di comando

Deployment Manager offre la possibilità di eseguire il deployment di un tipo composto direttamente con Google Cloud CLI. Anziché creare un file di configurazione di primo livello, gcloud CLI genererà automaticamente una configurazione di primo livello per te.

Ad esempio, il seguente comando esegue il deployment di un tipo composto denominato autoscaled-igm:

gcloud deployment-manager deployments create my-igm \
    --composite-type example-project/composite:autoscaled-igm

Puoi anche impostare le proprietà del tipo composito utilizzando il flag --properties:

gcloud deployment-manager deployments create my-igm \
    --composite-type example-project/composite:autoscaled-igm \
    --properties zone:us-central1-a

Tieni presente che:

  • Tutti i valori vengono analizzati come valori YAML. Ad esempio, version: 3 viene passato come numero intero. Se vuoi specificarlo come stringa, inserisci virgolette singole di escape intorno al valore, version: \'3\'.

  • I valori booleani non fanno distinzione tra maiuscole e minuscole, quindi TRUE, true e True vengono trattati allo stesso modo.

  • Devi trasmettere tutte le proprietà obbligatorie definite dal tipo composito. Non puoi fornire solo un sottoinsieme delle proprietà. Se determinate proprietà hanno valori predefiniti, puoi ometterle dalla riga di comando.

Per specificare più proprietà, fornisci coppie chiave:valore separate da virgole. Non importa in quale ordine specifichi le coppie. Ad esempio:

gcloud deployment-manager deployments create my-igm \
    --composite-type example-project/composite:autoscaled-igm \
    --properties zone:us-central1-a,machineType:n1-standard-1,image:debian-8

Dopo aver eseguito questo comando, Deployment Manager crea un deployment utilizzando il tipo composito che hai fornito. Puoi verificare che il deployment sia stato creato utilizzando la console Google Cloud o gcloud CLI. Per informazioni sulla visualizzazione di un deployment, leggi Visualizzare un manifest.

Esempio: creare un tipo composto

Deployment Manager offre molte configurazioni di esempio dal repository GitHub di Deployment Manager che puoi utilizzare come tipi compositi. Per questo esempio, aggiungerai un tipo composito che esegue il deployment di un servizio di alta disponibilità bilanciato del carico in più zone di una singola regione. Per saperne di più, vedi l'esempio completo.

In questo esempio, il file di configurazione di primo livello è ha-service.py. Tutti i modelli secondari vengono importati nei file di schema.

  1. Scarica i file Python e dello schema dalla directory GitHub. Ometti tutti i file in una sottodirectory e tutti i file di diagrammi.

  2. Nella directory locale in cui hai scaricato tutti i file, esegui questo comando per creare un nuovo tipo composito denominato ha-service-example:

    gcloud beta deployment-manager types create ha-service-example --template=ha-service.py

  3. Recupera un elenco di tipi per verificare che il tipo sia stato creato correttamente:

    gcloud beta deployment-manager types list --provider composite

  4. Descrivi il nuovo tipo:

    gcloud beta deployment-manager types describe ha-service-example --provider composite

  5. Crea una nuova configurazione che esegua il deployment del tipo. Sostituisci [PROJECT_ID] con l'ID progetto:

    resources:
- name: ha-service-example
  type: [PROJECT_ID]/composite:ha-service-example
  properties:
    dockerImage: gcr.io/deployment-manager-examples/nodejsservicestatic
    zones:
    - us-central1-b
    - us-central1-a

    Salva la configurazione come example-config.yaml. Tieni presente che non hai dovuto importare alcun modello nella configurazione.

  6. Esegui il deployment del nuovo tipo composito:

    gcloud deployment-manager deployments create ha-service-deployment --config example-config.yaml

    L'API restituisce un elenco di risorse create dal tipo:

    Waiting for create [operation-1488254932422-5498f5a950d71-2bd3b8c8-b13ddab5]...done.
Create operation operation-1488254932422-5498f5a950d71-2bd3b8c8-b13ddab5 completed successfully.
NAME                                            TYPE                             STATE      ERRORS  INTENT
ha-service-deployment-lb-fr                      compute.v1.forwardingRule        COMPLETED  []
ha-service-deployment-lb-hc                      compute.v1.httpHealthCheck       COMPLETED  []
ha-service-deployment-lb-tp                      compute.v1.targetPool            COMPLETED  []
ha-service-deployment-service-us-central1-a-as   compute.v1.autoscaler            COMPLETED  []
ha-service-deployment-service-us-central1-a-igm  compute.v1.instanceGroupManager  COMPLETED  []
ha-service-deployment-service-us-central1-a-it   compute.v1.instanceTemplate      COMPLETED  []
ha-service-deployment-service-us-central1-b-as   compute.v1.autoscaler            COMPLETED  []
ha-service-deployment-service-us-central1-b-igm  compute.v1.instanceGroupManager  COMPLETED  []
ha-service-deployment-service-us-central1-b-it   compute.v1.instanceTemplate      COMPLETED  []

Congratulazioni, hai creato il tuo primo tipo composito.

Passaggi successivi