Apa itu Emulator Apigee

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Dokumentasi Apigee Edge.

Catatan: Gunakan pengembangan lokal dengan Apigee dan Apigee Hybrid 1.5 dan yang lebih tinggi.

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

Emulator Apigee 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 berkala di gcr.

Jika sudah 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 hanya untuk tujuan referensi dan mungkin tidak menampilkan versi Emulator Apigee terbaru. Selalu gunakan Apigee stabil terbaru Versi emulator yang memenuhi kebutuhan Anda. Lihat Memilih versi emulator untuk informasi tambahan.

Bagian ini memungkinkan Anda:

• Melihat berbagai versi emulator yang diinstal, dan container yang dibuat untuk setiap versi emulator, termasuk informasi Docker dan runtime-nya, serta port kontrol dan traffic

• Menambahkan, menghapus, memulai, menghentikan, mereset, mengupdate, dan memuat ulang tampilan container Emulator Apigee, seperti yang dijelaskan dalam Mengelola Emulator Apigee

• Melihat aplikasi yang saat ini di-deploy (lihat Men-deploy lingkungan

• Melihat resource pengujian yang aktif (lihat Mengekspor resource pengujian ke Emulator Apigee

Mengelola Emulator Apigee

Kelola Emulator Apigee seperti yang dijelaskan di bagian berikut. Lihat juga Menjelajahi Emulator Apigee.

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

Memilih versi emulator

Tampilan emulator secara default menunjukkan versi yang stabil. Namun, Anda dapat memilih versi yang berbeda berdasarkan kebutuhan Anda.

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

   • Gunakan Google Container Registry di: https://gcr.io/apigee-release/hybrid/apigee-emulator

     

   • Gunakan Docker Hub di: https://registry.hub.docker.com/r/google/apigee-emulator/tags

     

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

3. Klik Tambahkan item.

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

5. Klik Oke.

6. Emulator yang baru ditambahkan akan muncul di tampilan emulator.

Menginstal Emulator Apigee

Untuk menginstal Emulator Apigee:

1. Luaskan item emulators di bagian Local development untuk melihat emulator yang tercantum di sana.

2. Posisikan kursor ke versi Emulator Apigee yang ingin diinstal.

3. Klik .

   

   Anda akan diminta untuk mengonfigurasi penampung Emulator Apigee.

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

5. Masukkan nilai numerik unik yang akan digunakan sebagai port kontrol untuk penampung Apigee Emulator, lalu tekan Enter. Port kontrol ditetapkan secara default ke 8080.

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

6. Masukkan nilai numerik unik yang akan digunakan sebagai port traffic untuk penampung Apigee Emulator, lalu tekan Enter. Port traffic ditetapkan secara default ke 8998.

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

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

Menambahkan container untuk Emulator Apigee

Guna menambahkan container untuk Emulator Apigee menggunakan UI:

1. Perluas bagian emulators di bagian Local development.

   

2. Posisikan kursor di atas Emulator Apigee yang ingin ditambahkan penampung.

3. Klik +. Anda akan diminta untuk mengonfigurasi penampung.

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

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

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

Penampung ditambahkan.

Melihat informasi status untuk Emulator Apigee

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

Menggunakan UI

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

Menggunakan Docker CLI

Guna melihat informasi status penampung untuk Emulator Apigee dan emulator yang dikonfigurasi port, jalankan docker ps di tab Terminal. Hal berikut memberikan contoh respons. Respons sebenarnya yang Anda lihat bergantung pada versi Emulator Apigee 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 container Docker runtime Apigee.

Memulai Emulator Apigee

Mulai Emulator Apigee seperti yang dijelaskan di bagian berikut.

Menggunakan UI

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

Menggunakan Docker CLI

Untuk memulai Emulator Apigee, jalankan docker start apigee-emulator di tab Terminal.

Status ditetapkan ke Ready:

Lihat juga Menyesuaikan container Docker runtime Apigee.

Mereset Emulator Apigee

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

Menggunakan UI

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

Emulator Apigee direset dan statusnya disetel ke Ready:

Informasi berikut akan ditampilkan di tab Output:

Resetting the Apigee Emulator
Reset completed

Lihat juga Menyesuaikan container Docker runtime Apigee.

Memulai ulang Emulator Apigee

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

Berikut adalah contoh respons: MyContainer

Mengupdate Emulator Apigee

Jika Emulator Apigee 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 Emulator Apigee, posisikan kursor ke Emulator Apigee di bagian Emulator Apigee, lalu klik .

Menggunakan Docker CLI

Untuk mengupdate Emulator Apigee, 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 imagename untuk mengupdate image penginstalan Emulator Apigee. Contoh: docker pull gcr.io/apigee-release/hybrid/apigee-emulator:Emulator version

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

Lihat juga Menyesuaikan container Docker runtime Apigee.

Menghentikan Emulator Apigee

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

Menggunakan UI

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

Menggunakan Docker CLI

Untuk menghentikan Emulator Apigee, jalankan docker stop apigee-emulator di tab Terminal.

Emulator Apigee dihentikan dan statusnya berubah menjadi Not running:

Lihat juga Menyesuaikan container Docker runtime Apigee.

Menghapus container untuk Emulator Apigee

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

Menggunakan UI

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

Menggunakan Docker CLI

Guna menghapus container untuk Emulator Apigee, jalankan perintah Docker berikut di tab Terminal:

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

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

Penampung dihapus.

Lihat juga Menyesuaikan container Docker runtime Apigee.

Menyesuaikan container Docker runtime Apigee

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

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

Opsi	Deskripsi
additionalArguments	Tambahkan satu atau beberapa argumen. Argumen ditambahkan ke perintah docker run persis seperti yang disediakan. Default-nya adalah "" (tidak ada).
detached	Mengontrol apakah opsi --detached digunakan saat menjalankan container. 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 dalam Opsi. Nilai, jika tersedia, ditambahkan ke perintah docker run menggunakan -e name=value. Daftar default mencakup "XTERM": "xterm-256color".
labels	Tambahkan satu atau beberapa label untuk disertakan dengan penampung. Label ditambahkan ke perintah docker run menggunakan -l label:value. Setelan defaultnya adalah none.
privileged	Mengontrol apakah opsi --privileged digunakan saat menjalankan container. Default-nya adalah true.
volumes	Tambahkan satu atau beberapa volume yang akan dipasang di container. Volume ditambahkan ke perintah docker run menggunakan -v label:value. Setelan defaultnya adalah none.

Untuk menyesuaikan container Docker runtime Apigee:

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

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

3. Di bagian Cloudcode > Apigee: Opsi Docker, klik Edit di settings.json. Opsi yang dapat disesuaikan ditampilkan di 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, sesuai kebutuhan, dan simpan file.

Menyesuaikan Emulator Apigee untuk mendukung autentikasi berbasis akun layanan

Saat menguji proxy yang bergantung pada autentikasi berbasis akun layanan Google Cloud, Emulator Apigee memerlukan akses ke kunci akun layanan Google. Ikuti langkah-langkah untuk mengonfigurasi Emulator Apigee 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 untuk Emulator Apigee untuk mendukung akun layanan. Membuat kunci untuk layanan seperti yang dijelaskan dalam Buat kunci akun layanan.

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

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

Mengonfigurasi Emulator Apigee

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

Untuk mengonfigurasi setelan Emulator Apigee:

1. Buka opsi Docker, seperti yang dijelaskan di bagian Menyesuaikan container Docker runtime Apigee di atas.

2. Di bagian volumes opsi Docker, tambahkan volume baru sehingga jalur kunci akun layanan yang didownload dapat 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 container:

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

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

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

4. Simpan setelan dan buat instance container 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 Emulator Apigee 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 {i>forward proxy<i} HTTP. Emulator Apigee dapat dikonfigurasi untuk menggunakan penerusan proxy saat terhubung ke target menggunakan variabel lingkungan bernama FORWARD_PROXY.

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

Untuk mengonfigurasi setelan Emulator Apigee:

1. Buka opsi Docker, seperti yang dijelaskan di 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 container baru untuk pengujian.