Apa itu Apigee Emulator

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Penting: Buka ruang kerja sebelum menyiapkan emulator. Lihat Mengelola ruang kerja Apigee.

Apigee Emulator adalah image Docker yang disesuaikan dan disediakan secara publik kepada developer untuk men-deploy dan menguji proxy API di lingkungan pengembangan lokal. Image Docker dipublikasikan secara rutin di gcr.

Saat siap men-deploy dan menguji proxy API pertama, Anda harus menggunakan bagian emulator untuk melihat dan mengelola versi emulator serta siklus proses emulator yang disiapkan.

Catatan: Gambar dan contoh dalam panduan ini ditujukan untuk tujuan referensi dan mungkin tidak menampilkan versi Apigee Emulator terbaru. Selalu gunakan versi Apigee Emulator stabil terbaru yang memenuhi kebutuhan Anda. Lihat Memilih versi emulator untuk mengetahui informasinya.

Bagian ini memungkinkan Anda:

• Lihat berbagai versi emulator yang diinstal, dan penampung yang dibuat untuk setiap versi emulator, termasuk informasi Docker dan runtime, serta port kontrol dan traffic.

• Tambahkan, hapus, mulai, hentikan, reset, perbarui, dan muat ulang tampilan penampung Apigee Emulator, seperti yang dijelaskan dalam Mengelola Apigee Emulator.

• Melihat aplikasi yang di-deploy (lihat Men-deploy lingkungan).

• Lihat resource pengujian aktif (lihat Mengekspor resource pengujian ke Emulator Apigee).

Mengelola Emulator Apigee

Kelola Apigee Emulator seperti yang dijelaskan di bagian berikut.

Catatan: Docker harus diinstal dan berjalan di sistem Anda agar Apigee Emulator dapat diinstal dan dijalankan.

Memilih versi emulator

Secara default, folder emulator menampilkan versi yang stabil. Namun, Anda dapat memilih versi yang berbeda berdasarkan persyaratan Anda.

1. Lihat daftar versi Apigee Emulator menggunakan salah satu metode berikut dan catat nilai Tag:

   • Gunakan Artifact Registry Google. (Lihat Dokumentasi dan Antarmuka pengguna).

     

   • Gunakan Docker Hub.

     

2. Untuk menambahkan versi Apigee Emulator ke ekstensi Cloud Code, klik Kelola > Setelan, lalu telusuri apigee emulators.

3. Klik Tambahkan item.

4. Masukkan nilai Tag yang diperoleh di langkah 1. Misalnya: 1.10.0 atau google/apigee-emulator:1.10.0

5. Klik Oke.

6. Emulator yang baru ditambahkan akan ditampilkan di folder emulator.

Menginstal Emulator Apigee

Untuk menginstal Apigee Emulator:

1. Luaskan folder emulator di ruang kerja Anda.

2. Posisikan kursor pada versi Apigee Emulator yang akan diinstal.

3. Klik .

   

4. Tambahkan penampung dengan mengikuti petunjuk di Menambahkan penampung untuk Apigee

   Emulator.

Image terbaru dari versi Apigee Emulator yang dipilih telah diinstal. Setelah penginstalan selesai, pesan Emulator installed successfully akan ditampilkan, dan status penampung Apigee Emulator akan berubah menjadi Siap.

Menambahkan penampung untuk Apigee Emulator

Untuk menambahkan penampung bagi Apigee Emulator menggunakan UI:

1. Luaskan folder emulators.

   

2. Posisikan kursor ke Apigee Emulator yang ingin Anda tambahkan penampung.

3. Klik +.

4. Masukkan nama unik untuk penampung Apigee Emulator, lalu tekan Enter. Masukkan karakter alfanumerik, tanda hubung (-), atau garis bawah (_).

5. Masukkan nilai numerik yang akan digunakan sebagai port kontrol untuk penampung Apigee Emulator, lalu tekan Enter. Port kontrol harus unik di seluruh penampung. Nilai defaultnya adalah 8080.

   Penting! Port kontrol harus unik dan tidak digunakan oleh komponen lain.

6. Masukkan nilai numerik yang akan digunakan sebagai port traffic untuk penampung Apigee Emulator, lalu tekan Enter. Port traffic harus unik di seluruh penampung. Nilai defaultnya adalah 8998.

   Penting! Port traffic harus unik dan tidak digunakan oleh komponen lain.

Penampung ditambahkan.

Melihat informasi status untuk Emulator Apigee

Lihat informasi status untuk Apigee Emulator seperti yang dijelaskan di bagian berikut.

Menggunakan UI

Untuk melihat informasi status Apigee Emulator, termasuk informasi Docker dan Runtime-nya, luaskan penampung di bagian emulator. Informasi yang Anda lihat cocok dengan versi Apigee Emulator yang digunakan.

Menggunakan Docker CLI

Untuk melihat informasi status penampung untuk Apigee Emulator dan port yang dikonfigurasinya, jalankan docker ps di tab Terminal. Berikut ini contoh respons. Respons sebenarnya yang Anda lihat bergantung pada versi Apigee Emulator yang digunakan:

CONTAINER ID   IMAGE                                COMMAND       CREATED        STATUS        PORTS                                      NAMES
33756b8c5c5b   ...apigee-emulator:1.11.0   "/usr/bin…"   10 hours ago   Up 10 hours   7000-7001/tcp, 0.0.0.0:8080->8080/tcp...   apigee-emulator

Lihat juga Menyesuaikan penampung Docker runtime Apigee.

Memulai Emulator Apigee

Mulai Apigee Emulator seperti yang dijelaskan di bagian berikut.

Menggunakan UI

Untuk memulai Apigee Emulator, posisikan kursor di atas penampung yang ingin Anda mulai, lalu klik .

Menggunakan Docker CLI

Untuk memulai Apigee Emulator, jalankan docker start CONTAINER_NAME

di tab Terminal.

Status ditetapkan ke Ready:

Lihat juga Menyesuaikan penampung Docker runtime Apigee.

Mereset Emulator Apigee

Reset Apigee Emulator untuk menghapus semua deployment dan resource pengujian yang diekspor seperti yang dijelaskan di bagian berikut.

Menggunakan UI

Untuk mereset Apigee Emulator, posisikan kursor di atas penampung Apigee Emulator di bagian emulator, lalu klik .

Emulator Apigee direset dan statusnya ditetapkan ke Ready:

Informasi berikut ditampilkan di tab Output:

Resetting the Apigee Emulator
Reset completed

Lihat juga Menyesuaikan penampung Docker runtime Apigee.

Memulai ulang Apigee Emulator

Untuk memulai ulang Apigee Emulator, jalankan docker restart CONTAINER_NAME di tab Terminal. Contoh: docker restart MyContainer

Mengupdate Emulator Apigee

Jika Apigee Emulator tidak sinkron dengan versi terbaru, Anda dapat mengupdate versi yang diinstal menggunakan UI atau Docker CLI, seperti yang dijelaskan di bagian berikut.

Menggunakan UI

Untuk mengupdate Apigee Emulator, posisikan kursor ke Apigee Emulator di bagian emulator, lalu klik .

Menggunakan Docker CLI

Untuk mengupdate Apigee Emulator, jalankan perintah Docker berikut di tab Terminal, menggunakan versi terbaru yang sesuai:

• Jalankan docker ps untuk mendapatkan nama image. Contoh: gcr.io/apigee-release/hybrid/apigee-emulator:EMULATOR_VERSION

• Jalankan docker pull IMAGE_NAME untuk mengupdate image penginstalan Apigee Emulator. Contoh: docker pull gcr.io/apigee-release/hybrid/apigee-emulator:EMULATOR_VERSION

Apigee Emulator diupdate dan pesan berikut ditampilkan: Emulator version is up to date

Lihat juga Menyesuaikan penampung Docker runtime Apigee.

Menghentikan Emulator Apigee

Hentikan Apigee Emulator menggunakan UI atau Docker CLI seperti yang dijelaskan di bagian berikut.

Menggunakan UI

Untuk menghentikan Apigee Emulator, posisikan kursor di atas penampung Apigee Emulator di bagian emulator, lalu klik .

Menggunakan Docker CLI

Untuk menghentikan Apigee Emulator, jalankan docker stop CONTAINER_NAME di tab Terminal.

Apigee Emulator dihentikan dan statusnya diubah menjadi Not running:

Lihat juga Menyesuaikan penampung Docker runtime Apigee.

Menghapus penampung untuk Apigee Emulator

Hapus penampung untuk Apigee Emulator menggunakan UI atau Docker CL seperti yang dijelaskan di bagian berikut.

Menggunakan UI

Untuk menghapus Apigee Emulator, posisikan kursor ke penampung Apigee Emulator di bagian emulator, lalu klik .

Menggunakan Docker CLI

Untuk menghapus penampung Apigee Emulator, jalankan perintah Docker berikut di tab Terminal:

• Jalankan docker stop CONTAINER_NAME untuk menghentikan image penginstalan Apigee Emulator (jika belum dihentikan). Contoh: docker stop MyContainer

• Jalankan docker rm CONTAINER_NAME untuk menghentikan image penginstalan Apigee Emulator. Contoh: docker rm MyContainer

Penampung dihapus.

Lihat juga Menyesuaikan penampung Docker runtime Apigee.

Menyesuaikan container Docker runtime Apigee

Anda dapat menyesuaikan command line Docker yang digunakan untuk mengontrol instance Apigee Emulator menggunakan opsi berikut.

Catatan: Penyesuaian penampung Docker runtime Apigee tidak diperlukan; jika tidak ditentukan, nilai opsi default akan digunakan. Setiap perubahan pada opsi hanya berlaku untuk penampung yang dibuat setelah opsi diubah. Jika ingin opsi diterapkan ke penampung yang ada, Anda harus membuatnya ulang.

Opsi	Deskripsi
additionalArguments	Tambahkan satu atau beberapa argumen. Argumen ditambahkan ke perintah docker run persis seperti yang diberikan. Default-nya adalah "" (tidak ada).
detached	Mengontrol apakah opsi --detached digunakan saat menjalankan penampung. Default-nya adalah true.
dns	Mengontrol flag -dns layanan DNS, seperti yang dijelaskan dalam layanan DNS. Setelan defaultnya adalah 8.8.8.8.
environmentVariables	Tambahkan variabel lingkungan ke perintah docker run, seperti yang dijelaskan di Opsi. Nilai, jika diberikan, akan ditambahkan ke perintah docker run menggunakan -e name=value. Daftar default mencakup "XTERM": "xterm-256color".
labels	Tambahkan satu atau beberapa label yang akan dilampirkan dengan penampung. Label ditambahkan ke perintah docker run menggunakan -l label:value. Setelan defaultnya adalah none.
privileged	Mengontrol apakah opsi --privileged digunakan saat menjalankan penampung. Default-nya adalah true.
volumes	Tambahkan satu atau beberapa volume yang akan dipasang di penampung. Volume ditambahkan ke perintah docker run menggunakan -v label:value. Setelan defaultnya adalah none.

Untuk menyesuaikan penampung Docker runtime Apigee:

1. Fitur ini tersedia sebagai bagian dari build Insiders (v1.21.0 dan yang lebih tinggi). Instal build Insider, seperti yang dijelaskan dalam Menginstal build Insider.

2. Klik Kelola > Setelan, lalu telusuri apigee docker.

3. Di bagian Cloudcode > Apigee: Docker Options, klik Edit in settings.json. Opsi yang dapat disesuaikan ditampilkan dalam file settings.json, seperti yang ditunjukkan:

   "cloudcode.apigee.dockerOptions": {
     "environmentVariables": {
         "XTERM": "xterm-256-color"
     },
     "dns": "8.8.8.8",
     "detached": true
     "privileged": true,
     "labels": {},
     "volumes": {},
     "additionalArguments":""
   }

4. Edit opsi dan simpan file.

Menyesuaikan Apigee Emulator untuk mendukung autentikasi berbasis akun layanan

Saat menguji proxy yang bergantung pada autentikasi berbasis akun layanan Google Cloud, Apigee Emulator memerlukan akses ke kunci akun layanan Google. Ikuti langkah-langkah untuk mengonfigurasi Apigee Emulator guna mendukung autentikasi berbasis akun layanan.

Membuat dan mendownload kunci akun layanan

Buat akun layanan Google Cloud dengan peran Service Account Token Creator, yang merupakan persyaratan agar Emulator Apigee mendukung akun layanan. Buat kunci untuk akun layanan, seperti yang dijelaskan dalam Membuat kunci akun layanan.

Download kunci ke sistem file lokal, sehingga dapat diberikan ke emulator Apigee.

Catatan: Kunci akun layanan akan berisiko keamanan jika tidak dikelola dengan benar. Anda bertanggung jawab atas keamanan kunci pribadi dan atas operasi lainnya yang dijelaskan oleh Praktik terbaik untuk mengelola kunci akun layanan. Jika Anda tidak dapat membuat kunci akun layanan, pembuatan kunci akun layanan mungkin dinonaktifkan untuk organisasi Anda. Untuk mengetahui informasi selengkapnya, lihat Mengelola resource organisasi yang aman secara default.

Mengonfigurasi Apigee Emulator

Setelan yang ditentukan di bagian ini hanya berlaku untuk instance penampung Docker yang dibuat setelah setelan disimpan.

Untuk mengonfigurasi setelan Apigee Emulator:

1. Buka opsi Docker, seperti yang dijelaskan dalam Menyesuaikan Docker runtime Apigee

   container.

2. Di bagian volumes pada opsi Docker, tambahkan volume baru sehingga jalur kunci akun layanan yang didownload tersedia di penampung. Dengan asumsi kunci didownload di jalur /opt/apigee/keys/apigee-sa-key.json, setelan berikut akan memasang konten /opt/apigee/keys di jalur /emulator/keys dalam penampung:

   "volumes": {
     "/opt/apigee/keys":"/emulator/keys"
   }

3. Di bagian environmentVariables opsi Docker, tambahkan variabel GOOGLE_APPLICATION_CREDENTIALS yang mengarah ke file di jalur yang dipasang:

   "environmentVariables": {
     "GOOGLE_APPLICATION_CREDENTIALS":"/emulator/keys/apigee-sa-key.json"
   }

4. Simpan setelan dan buat instance penampung baru yang dapat digunakan untuk pengujian.

Contoh berikut menunjukkan cara mengaitkan kunci akun layanan Google dengan Emulator Apigee.

"cloudcode.apigee.dockerOptions": {
      "environmentVariables": {
          "XTERM": "xterm-256-color",
          "GOOGLE_APPLICATION_CREDENTIALS":"/emulator/keys/apigee-sa-key.json"
      },
      "dns": "8.8.8.8",
      "detached": true
      "privileged": true,
      "labels": {},
      "volumes": {
         "/opt/apigee/keys":"/emulator/keys"
      },
      "additionalArguments":""
    }

Mengonfigurasi Apigee Emulator untuk mendukung proxy penerusan HTTP

Setelan yang ditentukan di bagian ini hanya berlaku untuk emulator versi 1.11.0 dan yang lebih baru.

Sering kali target backend yang terkait dengan proxy hanya dapat dijangkau menggunakan proxy forward HTTP. Emulator Apigee dapat dikonfigurasi untuk menggunakan proxy forward saat terhubung ke target menggunakan variabel lingkungan bernama FORWARD_PROXY.

Setelan yang ditentukan di bagian ini hanya berlaku untuk instance penampung Docker yang dibuat setelah setelan disimpan.

Untuk mengonfigurasi setelan Apigee Emulator:

1. Buka opsi Docker, seperti yang dijelaskan dalam Menyesuaikan penampung Docker runtime Apigee.

2. Di bagian environmentVariables opsi Docker, tambahkan variabel FORWARD_PROXY yang mengarah ke alamat proxy penerusan sebagai URL HTTP

   "environmentVariables": {
     "FORWARD_PROXY":"http://proxy_host:proxy_port"
   }

3. Simpan setelan dan buat instance penampung baru untuk pengujian.