Menghubungkan ke repositori GitHub Enterprise yang dihosting di jaringan pribadi

Halaman ini menjelaskan cara terhubung ke repositori GitHub Enterprise yang dihosting di jaringan pribadi menggunakan Developer Connect dan Service Directory. Anda dapat menyelesaikan tugas ini menggunakan Konsol Google Cloud atau Google Cloud CLI.

Petunjuk ini ditujukan bagi developer aplikasi, administrator platform, dan pengelola keamanan yang ingin menggunakan repositori kode sumber GitHub Enterprise dengan Google. Secara khusus, Anda dapat menggunakan repositori GitHub Enterprise dengan Gemini Code Assist.

Untuk mempelajari Developer Connect lebih lanjut, lihat Ringkasan Developer Connect.

Sebelum memulai

  1. Login ke Akun Google Anda.

    Jika Anda belum memilikinya, Daftar untuk membuat akun baru.

  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 and Service Directory APIs.

    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 APIs

  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 and Service Directory APIs.

    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 APIs

    8.

    Mengaktifkan Developer Connect juga akan mengaktifkan Secret Manager API.

  8. Pastikan Anda memiliki akses ke akun di GitHub Enterprise.

    Untuk membantu menjaga keamanan pekerjaan tim Anda, sebaiknya selesaikan tugas dalam panduan ini menggunakan akun bot atau akun yang dibagikan oleh tim Anda, bukan akun pribadi.

  9. Pastikan Anda memiliki repositori GitHub Enterprise, atau memiliki izin tingkat admin di repositori bersama.

  10. Saat menggunakan repositori di organisasi GitHub Enterprise, pastikan Anda memiliki izin Pengelola Aplikasi GitHub.

  11. Pastikan Anda memiliki resource layanan Service Directory untuk terhubung ke jaringan pribadi, atau buat resource layanan Service Directory. Anda dapat membuat resource layanan Service Directory di project yang sama dengan yang Anda gunakan dengan Developer Connect, atau Anda dapat menggunakan project yang berbeda.

    Untuk koneksi ke jaringan di luar Google Cloud, Anda mungkin perlu mengonfigurasi Service Directory secara berbeda. Lihat bagian Menggunakan Service Directory untuk menjangkau host di luar Google Cloud.

  12. Opsional: Buat kunci enkripsi yang dikelola pelanggan (CMEK) untuk mengenkripsi secret autentikasi yang dibuat Developer Connect.
  13. Opsional: Untuk menggunakan petunjuk command line dalam panduan ini, selesaikan langkah-langkah berikut:
    1. Instal Google Cloud CLI. Jika Anda telah menginstal gcloud CLI sebelumnya, pastikan Anda memiliki versi terbaru yang tersedia dengan menjalankan gcloud components update.
    2. Buat akun layanan Developer Connect dengan menjalankan perintah berikut, dengan PROJECT_ID adalah Google Cloud project ID Anda: 
              gcloud beta services identity create \
            --service=developerconnect.googleapis.com \
            --project=PROJECT_ID

Memberikan izin IAM yang diperlukan

Untuk mendapatkan izin yang Anda perlukan untuk membuat koneksi dan link, minta administrator untuk memberi Anda peran IAM berikut:

  • Jika Anda bukan pemilik project: Admin Koneksi Developer (roles/developerconnect.admin) di akun pengguna Anda.
  • Jika Anda berencana menggunakan CMEK untuk mengenkripsi secret yang dibuat Developer Connect: Pengenkripsi/Pendekripsi CryptoKey Cloud KMS (roles/cloudkms.cryptoKeyEncrypterDecrypter) di Akun Layanan Secret Manager.
  • Jika Anda berencana menggunakan gcloud CLI untuk menyelesaikan langkah-langkah dalam panduan ini: Peran Secret Manager Admin (roles/secretmanager.admin) di Akun Layanan Developer Connect.
  • Jika Anda berencana menggunakan konsol Google Cloud untuk menyelesaikan langkah-langkah dalam panduan ini: Admin IAM Project (roles/resourcemanager.projectIamAdmin) di akun pengguna Anda.

Untuk mengetahui informasi selengkapnya tentang pemberian peran, lihat Mengelola akses ke project, folder, dan organisasi.

Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.

Memberikan izin untuk menggunakan Service Directory

Selesaikan langkah-langkah berikut untuk mengizinkan Developer Connect menggunakan Direktori Layanan, dan mengizinkan Direktori Layanan mengakses resource jaringan VPC Anda.

  1. Berikan izin untuk akun layanan Developer Connect agar dapat menggunakan Service Directory dengan menjalankan perintah berikut:

    PROJECT_NUMBER=$(gcloud projects describe PROJECT_ID --format="value(projectNumber)")

SERVICE_ACCOUNT="service-${PROJECT_NUMBER}@gcp-sa-devconnect.iam.gserviceaccount.com"

gcloud projects add-iam-policy-binding SERVICE_DIRECTORY_RESOURCE_PROJECT_ID \
    --member="serviceAccount:${SERVICE_ACCOUNT}" \
    --role="roles/servicedirectory.viewer"

    Ganti kode berikut:

    • PROJECT_ID: Google Cloud Project ID Anda.
    • SERVICE_DIRECTORY_RESOURCE_PROJECT_ID: ID project untuk project yang berisi resource layanan Service Directory Anda. Google Cloud

  2. Berikan izin agar Service Directory dapat mengakses resource jaringan VPC Anda. Resource jaringan dapat berada di project yang berbeda.

    gcloud projects add-iam-policy-binding NETWORK_RESOURCE_PROJECT_ID \
    --member="serviceAccount:${SERVICE_ACCOUNT}" \
    --role="roles/servicedirectory.pscAuthorizedService"

    Ganti NETWORK_RESOURCE_PROJECT_ID dengan project ID untuk project yang berisi resource jaringan VPC Anda.

Menggunakan Direktori Layanan untuk menjangkau host di luar Google Cloud

Service Directory menggunakan rentang alamat IP 35.199.192.0/19 untuk menghubungkan host Anda di luar Google Cloud. Anda harus menambahkan rentang ini ke daftar yang diizinkan di firewall Anda. Selain itu, jaringan pribadi Anda harus dikonfigurasi untuk merutekan rentang ini melalui koneksi Cloud VPN atau Cloud Interconnect.

Jika koneksi Anda menggunakan Cloud Router, Anda dapat mengonfigurasi koneksi untuk mengomunikasikan rentang ke jaringan pribadi Anda.

Untuk mempelajari lebih lanjut, lihat Mengonfigurasi akses jaringan pribadi.

Menggunakan Cloud Load Balancing untuk menjangkau host di luar Google Cloud

Jika konfigurasi jaringan Anda tidak memungkinkan Anda merutekan rentang alamat IP Service Directory 35.199.192.0/19 ke Cloud VPN atau Cloud Interconnect, Anda dapat membuat load balancer menggunakan Cloud Load Balancing yang mengarahkan traffic ke host Anda.

Saat membuat endpoint Service Directory, pastikan untuk menggunakan alamat IP aturan penerusan load balancer, bukan alamat IP host Anda. Anda dapat menggunakan load balancer HTTPS internal atau load balancer internal transmission control protocol (TCP) saat membuat endpoint.

Saat membuat load balancer TCP, pertimbangkan hal-hal berikut:

  • Hanya grup endpoint jaringan (NEG) konektivitas hybrid yang diperlukan untuk menjangkau host Anda.
  • Load balancer TCP tidak memerlukan kunci pribadi yang tidak dienkripsi untuk sertifikat SSL Anda.
  • Penyiapan Cloud VPN Anda harus menggunakan Cloud Router dengan perutean dinamis global. Jika Cloud VPN Anda menggunakan perutean statis, Anda dapat menggunakan proxy yang menggunakan Cloud Service Mesh. Untuk mempelajari lebih lanjut, lihat Menyiapkan layanan edge jaringan untuk deployment hibrida.

Untuk mempelajari lebih lanjut cara membuat load balancer HTTPS, lihat Menyiapkan Load Balancer Aplikasi internal dengan konektivitas hibrida. Untuk mempelajari lebih lanjut cara membuat load balancer TCP, lihat Menyiapkan Load Balancer Jaringan proxy internal regional dengan konektivitas hibrida.

Membuat koneksi

Bagian ini menjelaskan cara membuat koneksi antara Developer Connect dan GitHub Enterprise. Jika menggunakan konsol Google Cloud , Anda juga dapat mulai menambahkan link ke repositori setelah selesai menyiapkan koneksi.

Untuk membuat koneksi GitHub Enterprise baru, pilih salah satu opsi berikut:

Konsol

Mulai koneksi dengan menyelesaikan langkah-langkah berikut:

  1. Di konsol Google Cloud , buka Developer Connect.

    Buka Developer Connect

    Developer Connect akan menampilkan halaman Repositori Git.

    • Jika Anda melihat daftar penyedia pengelolaan kode sumber: Mulai konfigurasi koneksi pertama Anda dengan memilih penyedia pengelolaan kode sumber. Klik Hubungkan di kartu GitHub Enterprise.

    • Jika Anda melihat tabel yang mencantumkan koneksi yang ada: Tetapkan penyedia pengelolaan kode sumber dengan mengklik Buat koneksi > GitHub Enterprise.

      Halaman Buat Koneksi akan terbuka.

  2. Untuk Region, pilih region untuk resource koneksi Anda.

    1. Untuk Name, masukkan nama untuk koneksi baru Anda.

  3. Centang kotak Aktifkan koneksi yang mematuhi residensi data agar koneksi ini mematuhi persyaratan residensi data.

    Koneksi GitHub yang dibuat menggunakan konsol Google Cloud mematuhi persyaratan residensi data jika Anda mencentang kotak ini saat membuat koneksi. Saat Anda melakukannya, Developer Connect akan membuat aplikasi GitHub

    Saat Anda membuat koneksi GitHub menggunakan Google Cloud CLI, koneksi tersebut tidak mematuhi persyaratan residensi data. Semua jenis koneksi lainnya mematuhi persyaratan residensi data.

  4. Untuk URL Host, masukkan URL host yang ingin Anda hubungkan.

  5. Klik Tampilkan lebih banyak untuk melihat setelan konfigurasi opsional.

    1. Kotak centang Enable Developer Connect proxy dipilih secara default sehingga Developer Connect dapat bertindak sebagai proxy untuk panggilan Git ke GitHub Enterprise.

    2. Di bagian Networking, untuk Network type, pilih Private network.

    3. Untuk CA Certificate, klik Browse untuk mengupload sertifikat yang ditandatangani sendiri.

      Ukuran sertifikat Anda tidak boleh lebih dari 10 KB dan harus dalam format PEM (.pem, .cer, atau .crt). Jika bagian ini dibiarkan kosong, sekumpulan sertifikat default akan digunakan.

    4. Di bagian Layanan Service Directory, pilih lokasi layanan Anda:

      • Dalam project your-project
      • Dalam project lain
      • Masukkan secara manual

      Jika Anda memilih Dalam project lain atau Masukkan secara manual, tentukan project ID Google Cloud Anda. Pilih project di menu drop-down, atau masukkan project ID secara manual.

    5. Region: Pilih region layanan Service Directory Anda. Region yang ditentukan untuk layanan Anda harus cocok dengan region yang terkait dengan koneksi Anda.

    6. Namespace: Pilih namespace layanan Direktori Layanan Anda.

    7. Layanan: Pilih nama layanan Service Directory di namespace Anda.

    8. Opsional: Di bagian Encryption, pilih kunci CMEK untuk mengenkripsi secret Secret Manager yang dibuat Developer Connect.

  6. Klik Lanjutkan.

    Dialog GitHub akan muncul, yang meminta Anda untuk membuat aplikasi GitHub.

  7. Dengan mengikuti perintah di GitHub, selesaikan tugas berikut:

    1. Masukkan nama untuk aplikasi Anda.

    2. Pilih organisasi tempat Anda ingin menginstal aplikasi.

    3. Pilih repositori yang ingin Anda beri akses.

    Dialog akan ditutup.

    Developer Connect mengambil kunci pribadi Anda dari GitHub dan menyimpannya di project Google Cloud Anda sebagai rahasia Secret Manager. Untuk melihat secret Anda, buat daftar secret di Secret Manager.

Setelah koneksi dibuat, halaman Tautkan repositori akan muncul.

Selesaikan langkah-langkah berikut untuk menautkan repositori ke koneksi Anda:

  1. Dalam daftar repositori yang tersedia, pilih repositori yang ingin Anda gunakan.

  2. Klik Oke.

  3. Klik Tautkan.

Koneksi Anda ditambahkan ke halaman Connections dan link repositori Anda ditambahkan ke halaman Repositories di konsol Google Cloud . Anda dapat menambahkan lebih banyak link ke koneksi yang ada kapan saja.

Jika Anda menyiapkan Gemini Code Assist, lanjutkan prosesnya dengan mengikuti langkah-langkah di Mengonfigurasi dan menggunakan penyesuaian kode Gemini Code Assist.

gcloud

Tugas berikut memerlukan beberapa tindakan di browser web Anda.

  1. Jalankan perintah gcloud developer-connect connections create untuk membuat koneksi ke GitHub Enterprise:

    gcloud developer-connect connections create CONNECTION_NAME \
    --location=REGION \
    --project=PROJECT_ID \
    --github-enterprise-config-host-uri=HOST_URI
    --github-enterprise-config-service-directory=SERVICE_DIRECTORY_RESOURCE
    --git-proxy-config-enabled

    Ganti kode berikut:

    • CONNECTION_NAME: nama untuk koneksi Anda.
    • REGION: region untuk koneksi Anda.
    • HOST_URI: URI untuk host yang ingin Anda hubungkan.
    • SERVICE_DIRECTORY_RESOURCE: jalur resource Service Directory Anda, dalam format projects/PROJECT_ID/locations/REGION/namespaces/NAMESPACE/services/SERVICE.
    • --git-proxy-config-enabled adalah tanda opsional yang memungkinkan Developer Connect bertindak sebagai proxy untuk panggilan Git ke GitHub Enterprise. Anda harus mengaktifkan fitur ini saat menjalankan penyesuaian kode Gemini Code Assist di repositori kode sumber GitHub Enterprise yang dihosting di jaringan pribadi.
    • --github-enterprise-config-ssl-ca-certificate adalah tanda opsional untuk menambahkan sertifikat SSL, dalam format $HOME/my-ssl-ca.txt.

  2. Anda harus membuat aplikasi GitHub untuk mengelola koneksi dengan GitHub. Jalankan perintah berikut untuk mendapatkan URI penyiapan aplikasi:

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

    Ganti kode berikut:

    • CONNECTION_NAME: nama untuk koneksi Anda.
    • REGION: region untuk koneksi Anda.

    Developer Connect menampilkan link untuk menyelesaikan langkah berikutnya di jendela browser. Salin link ini.

  3. Buka link di browser web.

  4. Login ke akun GitHub Anda jika diminta untuk melakukannya.

  5. Dengan mengikuti perintah di GitHub, selesaikan tugas berikut:

    1. Masukkan nama untuk aplikasi Anda.

    2. Pilih organisasi tempat Anda ingin menginstal aplikasi.

    3. Pilih repositori yang ingin Anda beri akses.

    Dialog akan ditutup.

    Developer Connect mengambil kunci pribadi Anda dari GitHub dan menyimpannya di project Google Cloud Anda sebagai rahasia Secret Manager. Untuk melihat secret Anda, buat daftar secret di Secret Manager.

Memverifikasi koneksi

Verifikasi pembuatan koneksi GitHub Anda dengan menjalankan perintah berikut:

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

Dengan:

  • CONNECTION_NAME: nama koneksi Anda.
  • REGION: region untuk koneksi Anda.

Developer Connect menampilkan status di kolom installationState. Jika nilai kolom ini adalah COMPLETE, penginstalan aplikasi Anda selesai. Jika tidak, Developer Connect akan menampilkan URI untuk mengembalikan Anda ke konfigurasi di browser.

Setelah koneksi Anda selesai, pilih repositori yang akan ditautkan dengan mengikuti petunjuk di Menautkan ke repositori.

Setelah membuat koneksi ke GitHub Enterprise, Anda dapat menautkan ke repositori. Anda dapat mengulangi langkah-langkah ini nanti untuk menautkan repositori tambahan sesuai kebutuhan.

Untuk membuat link repositori di koneksi GitHub Enterprise yang ada, pilih salah satu opsi berikut:

Konsol

  1. Buka halaman Repositori di Google Cloud konsol.

    Buka halaman Repositories

  2. Klik Link repository.

    Panel Tautkan repositori Git akan terbuka.

  3. Di daftar koneksi, pilih koneksi.

  4. Klik Lanjutkan.

  5. Di daftar repositori, pilih repositori yang ingin Anda tautkan.

  6. Klik Create.

Developer Connect membuat link repositori dan menampilkannya di konsol Google Cloud .

gcloud

Jalankan perintah berikut:

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

Ganti kode berikut:

  • REPO_NAME: nama untuk link repositori Anda.
  • REPO_URI: link ke repositori Anda. Contoh, https://github.com/cloud-build/test-repo.git.
  • CONNECTION_NAME: nama koneksi Anda.
  • REGION: region untuk koneksi Anda.

Developer Connect membuat link repositori.

Untuk mencantumkan repositori tertaut, jalankan perintah developer-connect connections git-repository-links list.

Jika Anda menyiapkan Gemini Code Assist, lanjutkan prosesnya dengan mengikuti langkah-langkah di Mengonfigurasi dan menggunakan penyesuaian kode Gemini Code Assist.

Berbagi data

Konten dari Google Cloud resource yang ditautkan ke koneksi ini mungkin ditransfer ke GitHub. Pernyataan ini berlaku untuk semua resource yang ada dan mendatang yang menggunakan koneksi ini. Untuk berhenti membagikan informasi dengan GitHub, hapus koneksi Developer Connect di konsol Google Cloud atau gcloud CLI, dan batalkan akses di GitHub.

Langkah berikutnya