Connettiti a GitHub Enterprise Cloud

Questa pagina descrive come creare connessioni a GitHub Enterprise Cloud e creare link ai repository GitHub Enterprise Cloud. Puoi completare queste attività utilizzando la console Google Cloud o Google Cloud CLI.

Queste istruzioni sono destinate a sviluppatori di applicazioni, amministratori di piattaforme e responsabili della sicurezza che vogliono utilizzare i repository di codice sorgente GitHub Enterprise Cloud con Google. In particolare, puoi utilizzare i repository GitHub Enterprise Cloud con Gemini Code Assist.

Per scoprire di più su Developer Connect, consulta la panoramica di Developer Connect.

Prima di iniziare

  1. Accedi al tuo Account Google.

    Se non ne hai già uno, registrati per creare un nuovo account.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Developer Connect API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the Developer Connect API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

    8.

    L'abilitazione di Developer Connect abilita anche l'API Secret Manager.

  8. Assicurati di avere accesso a un account su GitHub Enterprise Cloud.

    Per contribuire a proteggere il lavoro del tuo team, ti consigliamo di completare le attività descritte in questa guida utilizzando un account bot o un account condiviso dal tuo team, non un account personale.

  9. Assicurati di essere proprietario di un repository GitHub Enterprise Cloud o di disporre delle autorizzazioni a livello di amministratore per un repository condiviso.
  10. (Facoltativo) Crea una chiave di crittografia gestita dal cliente (CMEK) per criptare i secret di autenticazione creati da Developer Connect.
  11. (Facoltativo) Per utilizzare le istruzioni della riga di comando in questa guida, completa i seguenti passaggi:
    1. Installa Google Cloud CLI. Se hai già installato gcloud CLI, assicurati di avere l'ultima versione disponibile eseguendo gcloud components update.
    2. Crea un service account Developer Connect eseguendo questo comando, dove PROJECT_ID è il tuo Google Cloud ID progetto: 
              gcloud beta services identity create \
            --service=developerconnect.googleapis.com \
            --project=PROJECT_ID

Ruoli obbligatori

Per ottenere le autorizzazioni necessarie per creare connessioni e link, chiedi all'amministratore di concederti i seguenti ruoli IAM:

  • Se non sei il proprietario del progetto: Amministratore di Developer Connect (roles/developerconnect.admin) sul tuo account utente.
  • Se prevedi di utilizzare una CMEK per criptare i secret creati da Developer Connect: Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter) sul service account Secret Manager.
  • Se prevedi di utilizzare gcloud CLI per completare i passaggi descritti in questa guida: Ruolo Amministratore Secret Manager (roles/secretmanager.admin) nell'account di servizio Developer Connect.
  • Se prevedi di utilizzare la Google Cloud console per completare i passaggi descritti in questa guida: Project IAM Admin (roles/resourcemanager.projectIamAdmin) sul tuo account utente.

Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

Potresti anche riuscire a ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

Crea una connessione

Questa sezione descrive come creare una connessione tra Developer Connect e GitHub Enterprise Cloud. Se utilizzi la console Google Cloud , puoi anche iniziare ad aggiungere link ai repository al termine della configurazione della connessione.

Per creare una nuova connessione GitHub Enterprise Cloud, seleziona una delle seguenti opzioni:

Console

Avvia una connessione completando i seguenti passaggi:

  1. Nella console Google Cloud , apri Developer Connect.

    Vai a Developer Connect

    Developer Connect visualizza la pagina Repository Git.

    • Se vedi un elenco di provider di gestione del codice sorgente: inizia a configurare la prima connessione selezionando un provider di gestione del codice sorgente. Fai clic su Connetti nella scheda GitHub Enterprise Cloud.

    • Se vedi una tabella che elenca le connessioni esistenti: imposta il provider di gestione del codice sorgente facendo clic su Crea connessione > GitHub Enterprise Cloud.

      Si apre la pagina Crea connessione.

  2. Per Regione, scegli una regione per le risorse di connessione.

    1. In Nome, inserisci un nome per la nuova connessione.

  3. Attiva la casella di controllo Abilita una connessione conforme alla residenza dei dati per rendere questa connessione conforme ai requisiti di residenza dei dati.

    Le connessioni GitHub create utilizzando la console Google Cloud sono conformi alla residenza dei dati se attivi questa casella di controllo quando crei la connessione. Quando lo fai, Developer Connect crea un'app GitHub

    Quando crei connessioni GitHub utilizzando Google Cloud CLI, queste non sono conformi alla residenza dei dati. Tutti gli altri tipi di connessione sono conformi alla residenza dei dati.

  4. Fai clic su Mostra altro per visualizzare le impostazioni di configurazione facoltative.

    1. (Facoltativo) Nella sezione Crittografia, seleziona una chiave CMEK per crittografare i secret di Secret Manager creati da Developer Connect.

    2. (Facoltativo) Per impostazione predefinita, Developer Connect può fungere da proxy per le chiamate Git a GitHub Enterprise Cloud. Per disattivare questa opzione, deseleziona la casella di controllo Abilita proxy Developer Connect.

  5. Fai clic su Continua.

  6. Fai clic su Comprendo e continuo per accettare di condividere il tuo token OAuth GitHub con Developer Connect e archiviarlo in Secret Manager.

  7. Accedi a GitHub, se ti viene richiesto.

  8. Fai clic su Autorizza Developer Connect per consentire all'app Google Developer Connect di accedere al tuo account GitHub.

    Se non vedi questo messaggio, l'autorizzazione è già stata concessa per questo account.

  9. Se hai selezionato Abilita una connessione conforme alla residenza dei dati, ti viene chiesto di creare un'app GitHub.

    1. Specifica un nome per questa app GitHub.

    2. Fai clic su Crea app GitHub.

    3. Seleziona la destinazione in cui vuoi installare l'app (il tuo account GitHub o un'organizzazione).

    4. Seleziona i repository per cui installare l'app GitHub o Tutti i repository e fai clic su Installa.

    5. Seleziona i repository da collegare per questa connessione e fai clic su Ok.

    6. Fai clic su Collega.

GitHub crea un token e Developer Connect lo archivia nel tuo progettoGoogle Cloud come secret di Secret Manager. Per saperne di più sulla gestione dei secret, consulta Visualizzare i dettagli dei secret.

Se hai attivato la residenza dei dati, ora hai un'app GitHub, che puoi gestire facendo clic su Gestisci installazione nella pagina Dettagli connessione.

Configura la connessione

I seguenti passaggi sono necessari se non hai attivato la casella di controllo Abilita una connessione conforme alla residenza dei dati.

Concedi le autorizzazioni sul tuo account GitHub e collega i repository seguendo le istruzioni riportate di seguito. I prompt visualizzati nel browser web dipendono dal fatto che l'app GitHub Developer Connect sia già installata nell'account GitHub.

Nella finestra di dialogo Developer Connect, completa i seguenti passaggi:

Se vedi un elenco di account GitHub, installa l'app e collega i repository completando questi passaggi:

  1. Scegli l'account GitHub che vuoi utilizzare.

  2. Seleziona uno o più repository a cui vuoi concedere l'accesso.

Se viene visualizzato un messaggio che ti chiede di riutilizzare un'installazione dell'app esistente, scegli dove configurare l'app completando questi passaggi:

  1. Fai clic su Account GitHub per visualizzare gli account in cui è installata l'app Google Developer Connect. Se vedi l'account che vuoi utilizzare, scegli Conferma.

  2. Se non vedi l'account che vuoi utilizzare, procedi nel seguente modo:

    1. Scegli Installa l'app GitHub su un altro account GitHub e fai clic su Conferma.

    2. Segui i passaggi di GitHub per consentire l'installazione dell'app.

    3. Seleziona uno o più repository a cui vuoi concedere l'accesso.

Quando la finestra di dialogo si chiude, l'installazione dell'app è completata.

Una volta creata la connessione, viene visualizzata la pagina Collega repository.

Completa i seguenti passaggi per collegare i repository alla tua connessione:

  1. Nell'elenco dei repository disponibili, seleziona quelli che vuoi utilizzare.

  2. Fai clic su OK.

  3. Fai clic su Collega.

La connessione viene aggiunta alla pagina Connessioni e i link al repository vengono aggiunti alla pagina Repository nella console Google Cloud . Puoi aggiungere altri link alle connessioni esistenti in qualsiasi momento.

gcloud

Le seguenti attività richiedono alcune azioni nel browser web.

Avvia una connessione completando i seguenti passaggi:

  1. Esegui il comando gcloud developer-connect connections create per creare una connessione a GitHub Enterprise Cloud.

    Se hai abilitato la residenza dei dati:

    gcloud developer-connect connections create CONNECTION_NAME \
    --location=REGION \
    --github-enterprise-config-app=DEVELOPER-CONNECT \
    --github-enterprise-config-host-uri=HOST_URI \
    --git-proxy-config-enabled

    Se la residenza dei dati non è abilitata:

    gcloud developer-connect connections create CONNECTION_NAME \
    --location=REGION \
    --github-config-app=DEVELOPER-CONNECT \
    --github-config-host-uri=HOST_URI \
    --git-proxy-config-enabled

    Sostituisci quanto segue:

    • CONNECTION_NAME: un nome per la connessione.
    • REGION: la regione per la connessione.
    • HOST_URI: l'URI dell'host a cui vuoi connetterti. Se hai attivato la residenza dei dati, verrà utilizzato un dominio che include il tuo sottodominio (YOUR_SUBDOMAIN.ghe.com). Se non hai attivato la residenza dei dati, verrà utilizzato github.com.
    • --git-proxy-config-enabled: un flag facoltativo che consente a Developer Connect di fungere da proxy per le chiamate Git a GitHub Enterprise Cloud. Questa funzionalità è in anteprima.

    Viene creato un nome per la connessione.

  2. Completa la creazione della connessione installando l'app GitHub Developer Connect. Esegui il comando seguente per ottenere l'URI per l'installazione dell'app:

    gcloud developer-connect connections describe CONNECTION_NAME \
    --location=REGION

    Sostituisci quanto segue:

    • CONNECTION_NAME: il nome della connessione.
    • REGION: la regione della connessione.

    Developer Connect restituisce un link per installare l'app Google Developer Connect in una finestra del browser. Copia questo link.

  3. Apri il link in un browser web.

  4. Fai clic su Comprendo e continuo per accettare di condividere il tuo token OAuth GitHub con Developer Connect e archiviarlo in Secret Manager.

  5. Accedi a GitHub, se ti viene richiesto.

  6. Fai clic su Autorizza Developer Connect per consentire all'app Google Developer Connect di accedere al tuo account GitHub. Se non visualizzi questo prompt, l'autorizzazione è già stata concessa per questo account.

GitHub crea un token e Developer Connect lo archivia nel tuo progettoGoogle Cloud come secret di Secret Manager. Per visualizzare i tuoi secret, elenca i secret in Secret Manager. Puoi revocare l'accesso a Developer Connect tramite GitHub in qualsiasi momento.

Configura la connessione

Concedi le autorizzazioni sul tuo account GitHub e collega i repository seguendo le istruzioni riportate di seguito. I prompt visualizzati nel browser web dipendono dal fatto che l'app GitHub Developer Connect sia già installata nell'account GitHub.

Nella finestra di dialogo Developer Connect, completa i seguenti passaggi:

Se vedi un elenco di account GitHub, installa l'app e collega i repository completando questi passaggi:

  1. Scegli l'account GitHub che vuoi utilizzare.

  2. Seleziona uno o più repository a cui vuoi concedere l'accesso.

Se viene visualizzato un messaggio che ti chiede di riutilizzare un'installazione dell'app esistente, scegli dove configurare l'app completando questi passaggi:

  1. Fai clic su Account GitHub per visualizzare gli account in cui è installata l'app Google Developer Connect. Se vedi l'account che vuoi utilizzare, scegli Conferma.

  2. Se non vedi l'account che vuoi utilizzare, procedi nel seguente modo:

    1. Scegli Installa l'app GitHub su un altro account GitHub e fai clic su Conferma.

    2. Segui i passaggi di GitHub per consentire l'installazione dell'app.

    3. Seleziona uno o più repository a cui vuoi concedere l'accesso.

Quando la finestra di dialogo si chiude, l'installazione dell'app è completata.

Verificare la connessione

Verifica la creazione della connessione GitHub Enterprise Cloud eseguendo questo comando:

gcloud developer-connect connections describe CONNECTION_NAME \
    --location=REGION

Sostituisci quanto segue:

  • CONNECTION_NAME: il nome della connessione.
  • REGION: la regione per la connessione.

Developer Connect restituisce uno stato nel campo installationState. Se il valore di questo campo è COMPLETE, l'installazione dell'app è completata. In caso contrario, Developer Connect restituisce un URI per tornare alla configurazione nel browser.

Una volta completata la connessione, scegli i repository da collegare seguendo le istruzioni riportate in Aggiungere link ai repository alle connessioni esistenti.

Una volta stabilita una connessione a GitHub Enterprise Cloud, puoi collegarti ai repository. Puoi ripetere questi passaggi in un secondo momento per collegare altri repository in base alle tue esigenze.

Per creare link ai repository in una connessione GitHub Enterprise Cloud esistente, seleziona una delle seguenti opzioni:

Console

  1. Apri la pagina Repository nella console Google Cloud .

    Apri la pagina Repository

  2. Fai clic su Collega repository.

    Si apre il riquadro Collega repository Git.

  3. Nell'elenco delle connessioni, scegli una connessione.

  4. Fai clic su Continua.

  5. Nell'elenco dei repository, seleziona quelli a cui vuoi collegarti.

  6. Fai clic su Crea.

Developer Connect crea i link ai repository e li visualizza nella console Google Cloud .

gcloud

Esegui questo comando:

gcloud developer-connect connections git-repository-links create REPO_NAME \
    --clone-uri=REPO_URI \
    --connection=CONNECTION_NAME \
    --location=REGION

Sostituisci quanto segue:

  • REPO_NAME: il nome del repository.
  • REPO_URI: il link al tuo repository GitHub Enterprise Cloud. Ad esempio, https://github.com/cloud-build/test-repo.git.
  • CONNECTION_NAME: il nome della connessione.
  • REGION: la regione per la connessione.

Developer Connect crea i link ai repository.

Per elencare i repository collegati, esegui il comando developer-connect connections git-repository-links list.

Se stai configurando Gemini Code Assist, continua la procedura seguendo i passaggi descritti in Configurare e utilizzare la personalizzazione del codice di Gemini Code Assist.

Configurare le liste consentite IP

Developer Connect è compatibile con le organizzazioni GitHub Enterprise Cloud che utilizzano elenchi consentiti di indirizzi IP per limitare l'accesso alle proprie risorse. Per configurare la lista consentita di GitHub Enterprise Cloud per l'utilizzo con Developer Connect, completa i seguenti passaggi.

Utilizza l'account proprietario dell'organizzazione GitHub Enterprise Cloud per completare queste attività.

  1. Accedi a GitHub Enterprise Cloud.

  2. Segui le istruzioni riportate nella documentazione di GitHub Enterprise Cloud per consentire l'accesso da parte delle app GitHub.

    GitHub Enterprise Cloud aggiunge gli indirizzi dell'app GitHub Developer Connect alla tua lista consentita.

    Puoi identificare gli indirizzi di Developer Connect dalle relative descrizioni, simili al seguente testo: managed by the Developer Connect GitHub app.

  3. Ora che l'app GitHub di Developer Connect può accedere alle tue risorse GitHub Enterprise Cloud, configura la tua lista consentita in modo che utilizzi gli stessi indirizzi IP per le interazioni basate su OAuth tra Developer Connect e GitHub Enterprise Cloud. In questo modo, Developer Connect può creare link ai tuoi repository Git.

    1. Copia tutti gli indirizzi IP dell'app GitHub Developer Connect.

    2. Segui le istruzioni riportate nella documentazione di GitHub Enterprise Cloud per aggiungere ogni indirizzo alla tua lista consentita come nuova voce.

Al termine, avrai due voci della lista consentita per ogni indirizzo IP che Developer Connect utilizza per comunicare con GitHub Enterprise Cloud.

Le voci OAuth vengono utilizzate solo per creare link ai repository. Puoi eliminare le voci OAuth dalla tua lista consentita dopo aver creato i link ai repository GitHub Enterprise Cloud.

Condivisione dei dati

I contenuti delle risorse Google Cloud collegate a questa connessione potrebbero essere trasferiti a GitHub. Questa affermazione si applica a tutte le risorse esistenti e future che utilizzano questa connessione. Per interrompere la condivisione di informazioni con GitHub, elimina le connessioni Developer Connect nella console Google Cloud o in gcloud CLI e revoca l'accesso in GitHub.

Passaggi successivi