Halaman ini berlaku untuk Apigee dan Apigee Hybrid.
Baca dokumentasi Apigee Edge.
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.
Bagian ini memungkinkan Anda:
Lihat berbagai versi emulator yang terinstal, 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
Lihat 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.
Memilih versi emulator
Tampilan emulator secara default menunjukkan versi yang stabil. Namun, mudah untuk memilih versi yang berbeda berdasarkan kebutuhan Anda.
Lihat daftar versi Emulator Apigee menggunakan salah satu metode berikut dan catat 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
Untuk menambahkan versi Emulator Apigee ke ekstensi Cloud Code, klik
Manage > Settings, lalu telusuriapigee emulators
.Klik Tambahkan item.
Masukkan nilai Tag yang diperoleh di langkah 1. Contoh:
1.10.0
ataugoogle/apigee-emulator:1.10.0
Klik OK.
Emulator yang baru ditambahkan akan muncul di tampilan emulator.
Menginstal Emulator Apigee
Untuk menginstal Emulator Apigee:
Luaskan item emulators di bagian Local development untuk melihat emulator yang tercantum di sana.
Posisikan kursor di atas versi Emulator Apigee yang ingin Anda instal.
Klik .
Anda akan diminta untuk mengonfigurasi container Emulator Apigee.
Masukkan nama unik untuk penampung Emulator Apigee, lalu tekan Enter. Masukkan karakter alfanumerik, tanda pisah (-), atau garis bawah (_).
Masukkan nilai numerik unik yang akan digunakan sebagai port kontrol untuk container Emulator Apigee, lalu tekan Enter. Port kontrol ditetapkan secara default ke
8080
.Masukkan nilai numerik unik yang akan digunakan sebagai port traffic untuk penampung Emulator Apigee, lalu tekan Enter. Port traffic ditetapkan secara default ke
8998
.
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
Untuk menambahkan container bagi Emulator Apigee menggunakan UI:
Luaskan bagian emulators di bagian Local development.
Posisikan kursor di atas Emulator Apigee yang ingin Anda tambahkan penampung.
Klik +. Anda akan diminta untuk mengonfigurasi penampung.
Masukkan nilai numerik yang akan digunakan sebagai port kontrol untuk container Emulator Apigee, lalu tekan Enter. Port kontrol harus unik di seluruh container. Nilai defaultnya adalah
8080
.Masukkan nilai numerik yang akan digunakan sebagai port traffic untuk penampung Emulator Apigee, lalu tekan Enter. Port traffic harus unik di seluruh container. Nilai defaultnya adalah
8998
.Masukkan nama unik untuk penampung Emulator Apigee, lalu tekan Enter. Masukkan karakter alfanumerik, tanda pisah (-), 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 container di bagian Emulator Apigee. Informasi yang Anda lihat cocok dengan versi Emulator Apigee yang digunakan.
Menggunakan Docker CLI
Guna melihat informasi status penampung untuk Emulator Apigee dan port yang
dikonfigurasi, jalankan docker ps
di tab Terminal. 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 di atas penampung Emulator Apigee yang ingin dimulai, lalu klik .
Menggunakan Docker CLI
Untuk memulai Emulator Apigee, jalankan docker start apigee-emulator
di tab Terminal.
Status yang 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 Apigee Emulators lalu klik .
Emulator Apigee direset dan statusnya disetel ke Ready
:
Informasi berikut 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 ini 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 Apigee Emulators 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 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 Apigee Emulators lalu klik .
Menggunakan Docker CLI
Untuk menghentikan Emulator Apigee, jalankan docker stop apigee-emulator
di tab Terminal.
Emulator Apigee dihentikan dan statusnya diubah 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 Apigee Emulators lalu klik .
Menggunakan Docker CLI
Untuk menghapus container bagi 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 dengan menggunakan opsi berikut.
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 container. Nilai defaultnya adalah true . |
dns |
Mengontrol tanda -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. Nilainya, jika disediakan, akan ditambahkan ke perintah docker run menggunakan -e . Daftar default mencakup "XTERM": "xterm-256color" .
|
labels |
Tambahkan satu atau beberapa label untuk dilampirkan dengan penampung. Label ditambahkan ke perintah docker run menggunakan -l . Setelan defaultnya adalah none . |
privileged |
Mengontrol apakah opsi --privileged digunakan saat menjalankan penampung. Nilai defaultnya adalah true . |
volumes |
Tambahkan satu atau beberapa volume yang akan dipasang di container. Volume ditambahkan ke perintah docker run menggunakan -v . Setelan defaultnya adalah none . |
Untuk menyesuaikan container Docker runtime Apigee:
Fitur ini tersedia sebagai bagian dari build Insider (v1.21.0 dan yang lebih baru). Instal build Insider, seperti yang dijelaskan dalam Menginstal build Insider.
Klik
Kelola > Setelan, lalu telusuriapigee docker
.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":"" }
Edit opsi tersebut, sesuai kebutuhan, dan simpan file.
Menyesuaikan Emulator Apigee agar 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 Emulator Apigee agar 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 bagi Emulator Apigee untuk mendukung akun layanan. Buat kunci untuk akun layanan seperti yang dijelaskan di Membuat kunci akun layanan..
Download kunci ke sistem file lokal agar dapat diberikan ke emulator Apigee.
Mengonfigurasi Emulator Apigee
Untuk mengonfigurasi setelan Emulator Apigee:
Buka opsi Docker, seperti yang dijelaskan dalam Menyesuaikan container Docker runtime Apigee di atas.
Di bagian
volumes
pada opsi Docker, tambahkan volume baru sehingga jalur kunci akun layanan yang didownload dapat tersedia di container. Dengan asumsi kunci didownload di jalur/opt/apigee/keys/apigee-sa-key.json
, setelan berikut memasang konten/opt/apigee/keys
di jalur/emulator/keys
dalam container:"volumes": { "/opt/apigee/keys":"/emulator/keys" }
Di bagian
environmentVariables
opsi Docker, tambahkan variabelGOOGLE_APPLICATION_CREDENTIALS
yang mengarah ke file di jalur yang terpasang:"environmentVariables": { "GOOGLE_APPLICATION_CREDENTIALS":"/emulator/keys/apigee-sa-key.json" }
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
Sering kali, target backend yang terkait dengan proxy hanya dapat dijangkau menggunakan
proxy penerusan HTTP. Emulator Apigee dapat dikonfigurasi untuk menggunakan proxy penerusan sekaligus terhubung ke target menggunakan variabel lingkungan bernama FORWARD_PROXY
.
Untuk mengonfigurasi setelan Emulator Apigee:
Buka opsi Docker, seperti yang dijelaskan dalam Menyesuaikan container Docker runtime Apigee.
Di bagian
environmentVariables
opsi Docker, tambahkan variabelFORWARD_PROXY
yang mengarah ke alamat proxy penerusan sebagai URL HTTP"environmentVariables": { "FORWARD_PROXY":"http://proxy_host:proxy_port" }
Simpan setelan dan buat instance container baru untuk pengujian.