Menggunakan grup lingkungan

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Bagian ini menjelaskan cara membuat dan mengedit grup lingkungan, yang mencakup menambahkan lingkungan atau nama host ke grup, atau menghapusnya, dengan Apigee. Untuk mengetahui informasi selengkapnya tentang grup lingkungan dan cara kerjanya, lihat Ringkasan lingkungan dan grup lingkungan.

Membuat grup lingkungan

Anda dapat membuat grup lingkungan baru menggunakan UI Apigee atau Apigee API. Bagian ini menjelaskan cara melakukan keduanya.

Saat pertama kali Anda membuat grup lingkungan, grup tersebut tidak berisi lingkungan apa pun. Namun, hal ini menentukan nama host default: example.group-name. Untuk menambahkan lingkungan ke grup lingkungan, lihat Menambahkan lingkungan ke grup lingkungan.

Apigee di konsol Cloud

Untuk membuat grup lingkungan baru di Apigee di konsol Cloud:

  1. Buka UI Apigee di Cloud Console di browser.
  2. Pilih Pengelolaan > Lingkungan di panel navigasi sebelah kiri.
  3. Di panel Environments, pilih Environment Groups.
  4. Klik + Create Environment Group.
  5. Masukkan hal berikut:
    • Nama grup lingkungan: Nama untuk grup lingkungan. Nama harus diawali dan diakhiri dengan karakter alfanumerik. ID dapat berisi hingga 63 karakter yang terdiri dari karakter alfanumerik dan tanda hubung. Nama tersebut harus berbeda dengan nama grup lingkungan yang ada di organisasi Anda.
    • Hostames: Daftar nama host yang dapat digunakan untuk memanggil proxy. Setiap nama host harus ditulis pada baris terpisah.

      Anda juga memiliki opsi untuk mengklik Configure Google Load Balancer with these domains. Tindakan ini akan membuka halaman Load balancing di Cloud Console, tempat Anda dapat mengonfigurasi load balancing untuk nama host.

    • Lingkungan: Daftar lingkungan opsional yang akan disertakan dalam grup lingkungan.
  6. Klik Create.

Apigee Klasik

Untuk membuat grup lingkungan baru di UI Apigee klasik:

  1. Di UI Apigee, pilih Admin > Environments > Groups.
  2. Klik +Environment Group:

    Tombol tambahkan lingkungan

    Dialog Tambahkan Grup Lingkungan akan ditampilkan.

  3. Masukkan nama untuk grup lingkungan baru Anda:

    Menambahkan grup lingkungan

    Nama hanya boleh berisi huruf kecil, angka, dan tanda hubung. Selain itu, nama harus dimulai dengan huruf, memiliki panjang minimal dua karakter, dan tidak boleh diakhiri dengan tanda hubung. Nama yang valid mencakup my-env-group dan prod2.

  4. Klik Tambahkan.

    Apigee membuat grup lingkungan baru. Proses ini biasanya sangat cepat.

    Jika operasi berhasil, Apigee akan mengonfirmasi bahwa grup telah dibuat dengan banner yang terlihat seperti berikut:

    Banner konfirmasi grup

    Apigee juga menetapkan nama host default ke grup baru.

  5. (Opsional) Tetapkan nama host tambahan ke grup baru dengan mengklik untuk grup tersebut.

    Apigee menampilkan panel Detail grup lingkungan:

    Detail grup lingkungan

  6. Tambahkan nama host ke kolom Hostnames. Setiap nama host harus berada di baris terpisah.
  7. Klik Simpan setelah selesai.

    Anda dapat menambahkan dan menghapus nama host ke daftar ini kapan saja menggunakan prosedur yang sama.

Apigee API

Untuk membuat grup lingkungan baru menggunakan Apigee API, kirim permintaan POST ke Create environment groups API. Sebelum memanggil API, pastikan Anda memiliki token yang valid, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0.

Contoh perintah curl berikut menunjukkan sintaksis untuk membuat grup baru:

curl -i $TOKEN -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/envgroups?name=new-group-name

Saat menentukan nama grup baru, Anda hanya boleh menggunakan huruf kecil, angka, dan tanda hubung (a-z, A-Z, dan -). Anda tidak boleh menggunakan huruf besar atau karakter khusus selain tanda hubung. Anda juga harus memulai nama dengan huruf kecil.

Jika Anda tidak menentukan parameter tambahan, perintah ini akan membuat grup baru tanpa nama host yang ditetapkan.

Anda juga dapat menetapkan nama host saat membuat grup dengan menentukannya sebagai array dalam isi permintaan.

Contoh berikut membuat grup baru my-group dan menetapkan tiga nama host baru ke grup baru:

curl -i $TOKEN -X POST \
  https://apigee.googleapis.com/v1/organizations/org_name/envgroups?name=my-group \
  -d '{ \
    "hostnames": ["server1.mycompany.com", "server2.mycompany.com", "10.1.142.8"] \
  }'

Anda dapat mengubah nama host dalam daftar nanti dengan mengirimkan permintaan PATCH ke Patch environment groups API.

Menambahkan lingkungan ke grup lingkungan

Lingkungan yang tidak berada dalam grup tidak dapat diakses karena tidak ada nama host yang terkait dengannya. Nama host ditentukan di grup lingkungan, bukan lingkungan. Saat membuat lingkungan menggunakan UI Apigee di konsol Google Cloud, Anda memiliki opsi untuk menetapkan lingkungan ke grup lingkungan yang ada. Untuk mengetahui informasi selengkapnya, lihat Membuat lingkungan baru di UI.

Jika Anda tidak menetapkan lingkungan ke grup selama pembuatan lingkungan, bagian ini menjelaskan cara menambahkan lingkungan yang tidak ditetapkan ke grup lingkungan menggunakan UI Apigee atau Apigee API.

Apigee di konsol Cloud

Untuk menambahkan lingkungan ke grup lingkungan di konsol Apigee in Cloud:

  1. Buat lingkungan, seperti yang dijelaskan dalam Membuat lingkungan.
  2. Di UI Apigee di Cloud Console, pilih Management > Environments di panel navigasi sebelah kiri.
  3. Di panel Environments, pilih Environment Groups.
  4. Pada baris untuk grup lingkungan, klik menu tiga titik di bagian Tindakan, lalu pilih Edit.
  5. Di panel Edit Environment Group, pada bagian Environments (Optional), pilih lingkungan yang ingin ditambahkan ke grup lingkungan.
  6. Klik Perbarui.

Apigee Klasik

Untuk menambahkan lingkungan ke grup lingkungan di UI Apigee klasik:

  1. Buat lingkungan, seperti yang dijelaskan dalam Membuat lingkungan.
  2. Di UI Apigee, pilih Admin > Environments > Groups.
  3. Lihat di bagian Tidak ditetapkan untuk melihat daftar lingkungan yang bukan bagian dari grup lingkungan:

    Melihat lingkungan yang tidak ditetapkan

    Perhatikan lingkungan mana yang tidak ditetapkan karena Anda ingin menetapkannya.
  4. Klik di samping grup lingkungan tempat Anda ingin menambahkan lingkungan.

    Panel Detail Grup Lingkungan menampilkan:

    Panel detail grup

  5. Untuk menambahkan lingkungan baru ke grup ini, klik + di daftar Lingkungan.

    Panel Tambahkan lingkungan menampilkan:

    Menambahkan lingkungan ke dialog grup

  6. Pilih lingkungan yang ingin ditambahkan ke grup, lalu klik Tambahkan.

    Apigee menambahkan lingkungan ke grup.

Apigee API

Untuk menambahkan lingkungan baru ke grup lingkungan menggunakan Apigee API, kirim permintaan POST ke Environment group attachment API, seperti yang ditunjukkan pada contoh berikut:

curl -H "Authorization: Bearer $TOKEN" -X POST
  "https://apigee.googleapis.com/v1/organizations/my-org/envgroups/test-group/attachments"
  -d '{
    "name": "my-attachment",
    "environment": "test"
  }'

Dengan keterangan:

  • $TOKEN ditetapkan ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0.
  • Isi permintaan berisi nama lampiran serta nama lingkungan baru.

Isi permintaan berisi instance resource EnvironmentGroupAttachment, yang merupakan wrapper sederhana di sekitar satu lingkungan.

Jika berhasil, respons akan berisi detail tentang lampiran baru, termasuk stempel waktu saat lampiran dibuat; misalnya:

{
  "name": "my-attachment",
  "environment": "test"
  "createdAt": "42"
}

Menghapus lingkungan dari grup lingkungan

Anda dapat menghapus lingkungan dari grup lingkungan dengan UI Apigee atau Apigee API.

Apigee di konsol Cloud

Untuk menghapus lingkungan dari grup lingkungan di konsol Apigee in Cloud:

  1. Di UI Apigee di Cloud Console, pilih Management > Environments di panel navigasi sebelah kiri.
  2. Di panel Environments, pilih Environment Groups.
  3. Pada baris untuk grup lingkungan, klik menu tiga titik di bagian Tindakan, lalu pilih Edit.
  4. Di panel Edit Environment Group, pada bagian Environments (Optional), batalkan pilihan lingkungan yang ingin dihapus dari grup lingkungan.
  5. Klik Perbarui.

Apigee Klasik

Untuk menghapus lingkungan dari grup lingkungan di UI Apigee klasik:

  1. Di UI Apigee, pilih Admin > Environments > Overview.
  2. Pilih lingkungan yang ingin Anda hapus.
  3. Di panel Groups, gerakkan kursor ke akhir baris untuk grup tempat Anda ingin menghapus lingkungan, lalu klik Ikon sampah.

Apigee API

Untuk menghapus lingkungan dari grup lingkungan menggunakan Apigee API, gunakan metode delete di resource EnvironmentGroupAttachment untuk menghapus lampiran yang sesuai dengan lingkungan.

Menghapus grup lingkungan

Anda dapat menghapus grup lingkungan menggunakan UI Apigee atau API.

Apigee di konsol Cloud

Untuk menghapus grup lingkungan di konsol Apigee in Cloud:

  1. Di UI Apigee di Cloud Console, pilih Management > Environments di panel navigasi sebelah kiri.
  2. Di panel Environments, pilih Environment Groups.
  3. Di baris untuk grup lingkungan, klik menu tiga titik di bagian Tindakan, lalu pilih Hapus.

Apigee Klasik

Untuk menghapus grup lingkungan di UI Apigee klasik:

  1. Di UI Apigee, pilih Admin > Environments > Groups.
  2. Pindahkan kursor ke panel untuk grup yang ingin dihapus.
  3. Klik ikon Ikon sampah.

Apigee API

Untuk menghapus grup lingkungan menggunakan Apigee API, gunakan metode delete di resource EnvironmentGroup.

Menambahkan nama host ke grup

Saat Anda membuat grup, Apigee akan menambahkan nama host default example.GROUP_NAME. Anda dapat menambahkan nama host ke grup menggunakan petunjuk di bagian ini.

Nama host yang Anda tentukan di grup lingkungan:

  • Harus unik di semua grup lingkungan dalam organisasi; tidak dapat digunakan oleh lebih dari satu grup
  • Tidak mendukung karakter pengganti
  • Jalur dasar harus unik dalam host (tidak ada dua proxy yang dapat memiliki jalur dasar yang sama dalam host)

Apigee di konsol Cloud

Untuk menambahkan nama host ke grup lingkungan di konsol Apigee in Cloud:

  1. Di UI Apigee di Cloud Console, pilih Management > Environments di panel navigasi sebelah kiri.
  2. Di panel Environments, pilih Environment Groups.
  3. Pada baris untuk grup lingkungan, klik menu tiga titik di bagian Tindakan, lalu pilih Edit.
  4. Di panel Edit Environment Group, pada bagian Hostnames, masukkan nama host yang ingin ditambahkan ke grup lingkungan.
  5. Klik Perbarui.

Apigee Klasik

Untuk menambahkan nama host ke grup lingkungan di UI Apigee klasik:

  1. Di UI Apigee, pilih Admin > Environments > Groups.
  2. Arahkan kursor ke kartu grup, lalu pilih .

    Panel Detail grup lingkungan menampilkan:

    Panel detail grup

  3. Di kolom Hostnames, masukkan host baru Anda.
  4. Klik Save untuk menambahkan host baru ke grup.

Apigee API

Untuk menambahkan nama host ke grup lingkungan menggunakan Apigee API, kirim permintaan PATCH ke Patch environment groups API. Pastikan untuk menetapkan parameter updateMask ke hostnames dan menentukan seluruh daftar nama host yang Anda inginkan: nilai kolom tersebut dalam permintaan Anda mengganti daftar yang ada.

Contoh berikut menetapkan nama host untuk lingkungan pengujian:

curl -H "Authorization: Bearer $TOKEN" -X PATCH
  "https://apigee.googleapis.com/v1/organizations/my-org/envgroups/test-group?hostnames=updateMask"
  -d '{
    "name": "my-hostnames",
    "hostnames": [
      "test-1.example.com",
      "test-2.example.com",
      "test-3.example.com"
    ]
  }'

Dengan keterangan:

  • $TOKEN ditetapkan ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0.
  • Payload permintaan menentukan nama untuk array lampiran nama host, ditambah array nama itu sendiri.

Jika permintaan berhasil, respons akan berisi Resource operasi.

Menentukan apakah Cloud Load Balancer dikonfigurasi untuk nama host

Anda dapat memanggil proxy dengan perintah berikut:

curl -v https://YOUR_ENV_GROUP_HOSTNAME/myproxy

dengan YOUR_ENV_GROUP_HOSTNAME adalah nama host grup lingkungan yang berisi lingkungan tempat proxy di-deploy. Untuk melakukannya, Cloud Load Balancer harus dikonfigurasi untuk nama host grup lingkungan. Biasanya, Load Balancer dikonfigurasi saat Apigee pertama kali disediakan. Untuk menentukan apakah Load Balancer dikonfigurasi untuk nama host:

  1. Pada tampilan Admin > Environments > Groups, klik ikon edit di sebelah kanan grup lingkungan untuk nama host.
  2. Klik Configure Google Load Balancer with these domains. Tindakan ini akan mengarahkan Anda ke halaman Load balancing Google Cloud Platform.

    Halaman load balancing di Google Cloud Platform

  3. Klik nama load balancer di kolom Nama. Jika Apigee disediakan dengan Penyedia Penyiapan, nama load balancer akan menjadi apigee-proxy-url-map. Jika Anda tidak melihat nama tersebut, hubungi administrator sistem di organisasi Anda yang menyediakan Apigee.

    Saat Anda mengklik nama, halaman Load balancer details akan ditampilkan:

    Halaman detail load balancer di Google Cloud Platform

  4. Di tabel Frontend, klik sertifikat SSL di kolom Certificate dan cari sertifikat SSL yang cocok dengan nama host:
    • Jika Jenis sertifikat adalah DIKELOLA, periksa apakah kolom Nama Host DNS sertifikat cocok dengan nama host.
    • Jika sertifikat tidak dikelola, Anda mungkin perlu mendownload sertifikat dan memeriksa apakah Nama Umumnya cocok dengan nama host.

Jika Anda tidak menemukan nama host dalam sertifikat apa pun, hubungi administrator sistem Anda untuk mendapatkan bantuan lebih lanjut.