Gestire i repository di esempi personalizzati in Cloud Code per Cloud Shell

Un repository di esempio è un repository Git che contiene esempi personalizzati che il tuo team può utilizzare per sviluppare applicazioni.

Ciò significa che, all'interno di un'organizzazione o di un team, puoi configurare repository di esempio con Cloud Code, personalizzati per la tua organizzazione, per offrire un insieme standard di applicazioni di avvio, servizi e configurazione dell'infrastruttura che altri possono utilizzare. In questo modo, puoi allineare i nuovi progetti alle stack e standard tecnici preferiti e incoraggia le best practice a livello all'inizio del ciclo di sviluppo.

Un repository di esempio può essere un repository esistente di applicazioni di esempio che hai già creato o una nuova serie di campioni che vorresti fosse utilizzata da altri. Per importare un repository con Cloud Code, aggiungi un file descrittore di esempio al repository.

Quando sono pronti, i repository di esempio sono facili da condividere con il tuo team; loro occorre configurare Cloud Code e l'URL Git del repository di esempio per l'utilizzo. Per i repository Git privati, solo i membri che hanno accesso un repository può utilizzare gli esempi personalizzati sottostanti.

Per vedere un esempio di come potrebbe essere configurato un repository di esempio, fai riferimento a questo repository.

Creazione di un repository di esempio

Per utilizzare un repository esistente, vai alla creazione di un file descrittore di esempio. Per creare un nuovo da utilizzare come repository di esempio, segui questi passaggi:

  1. Creare un nuovo repository Git.

    Il tuo repository Git può essere ospitato da remoto o essere attivo sulla tua macchina locale. Questo esempio utilizza un nuovo repository GitHub, "custom-sample-repo".

    Interfaccia di creazione del repository GitHub con il campo del nome del repository compilato con "custom-sample-repo"

  2. Aggiungi directory di esempio al repository.

    Le directory di Sample possono contenere qualsiasi cosa e trovarsi in qualsiasi punto del repository. In questo esempio, sono state aggiunte due directory di esempio, "hello-world" e "kubernetes-custom-sample", a "custom-sample-repo".

    È vivamente consigliato un file readme con istruzioni su come utilizzare al meglio i sample personalizzati.

    'custom-sample-repo' con due directory di esempio sottostanti, 'hello-world' e 'kubernetes-custom-sample'

  3. Crea un file descrittore di esempio.

    Un file descrittore di esempio fornisce a Cloud Code informazioni sul tuo esempio per creare correttamente l'applicazione. Questo file deve essere denominato .cctemplate, deve trovarsi nella directory principale e deve avere il definito nel schema del file descrittore di esempio.

  4. Testa il tuo esempio personalizzato seguendo i passaggi per creare un'app da un esempio personalizzato.

Schema descrittore di esempio

Chiave Descrizione Tipo
metadati Metadati utilizzati da Cloud Code per la lettura. È conforme allo schema dei metadati. Metadati
templates Array di esempi contenuti in un repository. Gli oggetti in questo array devono essere conformi allo schema di esempio. Array<Sample>
name (facoltativo) Nome del repository di esempio. Stringa

Esempio

{
   "metadata":{
      "version":"1"
   },
   "name": "My Sample Repository",
   "templates":[
      {
         "path":"/path/to/sample1_location",
         "name":"My Sample 1",
         "description":"The first sample of its name."
      },
      {
         "path":"/path/to/sample2_location",
         "name":"My Sample 2",
         "description":"The sequel."
      }
   ]
}

Schema di esempio

Chiave Descrizione Tipo
percorso La posizione del Sample in un repository.
Il percorso è relativo alla radice del repository.
Stringa
nome Nome di un campione.
Il nome viene visualizzato in un IDE quando si seleziona un Sample su cui basare un'applicazione.
Stringa
descrizione (facoltativa) Descrizione di un campione.
La descrizione viene visualizzata in un IDE quando si seleziona un esempio su cui basare attiva l'applicazione.
Stringa

Esempio

{
   "path":"path/to/sample1",
   "name":"My Sample 1",
   "description":"The first sample of its name."
}

Schema dei metadati

Chiave Descrizione Tipo
versione La versione dello schema di esempio da utilizzare. L'unica versione valida è 1. Stringa

Esempio

{
   "version":"1"
}

Eliminazione di un repository di esempio personalizzato

Per eliminare un Sample personalizzato, rimuoverlo dal flusso di selezione delle applicazioni personalizzate e dalle macchine degli utenti:

  1. Nel file settings.json, cerca l'esempio personalizzato in localPath .

    "cloudcode.customApplications": [
      {
        "repoUrl": https://github.com/GoogleCloudPlatform/cloud-code-custom-samples-example.git,
        "branchName": "",
        "localPath": "/Users/username/Library/cloud-code/custom-templates/https-github-com-google-cloud-platform-cloud-code-custom-samples-example-git"
      }
    ],
    
  2. Elimina la cartella del modello nel percorso.

  3. Elimina la sezione di esempio personalizzata dal file settings.json.