Referensi Target yang Dihosting

Anda sedang melihat dokumentasi Apigee Edge.
Buka Dokumentasi Apigee X. info

Batas variabel lingkungan

Target yang Dihosting membatasi ukuran dan jumlah variabel lingkungan yang dapat Anda tetapkan di lingkungan runtime Target yang Dihosting.

  • 1.000: Panjang maksimum variabel lingkungan tunggal.
  • 100: Jumlah maksimum variabel lingkungan yang dapat Anda tetapkan.

Untuk informasi tentang cara menyetel variabel lingkungan, lihat File manifes.

Variabel lingkungan yang ditetapkan dalam runtime aplikasi

Saat Anda men-deploy aplikasi Target yang Dihosting, variabel lingkungan berikut ditetapkan dan tersedia untuk aplikasi Anda pada runtime:

  • APIGEE_ENVIRONMENT - Lingkungan tempat proxy Target yang Dihosting di-deploy.
  • APIGEE_ORGANIZATION - Organisasi tempat proxy Target yang Dihosting di-deploy.
  • PORT - Port tempat aplikasi Target yang Dihosting harus memproses.

Alokasi resource sistem

Setiap instance Target yang Dihosting menerima resource berikut:

  • Memori 256 MB
  • CPU 1,2 GHz

Penskalaan

Bagian ini menjelaskan cara penskalaan aplikasi Target yang Dihosting, bergantung pada jenis akun Edge Anda miliki.
  • Versi Uji Coba Apigee Edge terbatas untuk satu instance Target yang Dihosting per proxy.
  • Akun Apigee Edge berbayar menerima penskalaan otomatis berdasarkan rasio permintaan, latensi respons, dan metrik aplikasi lainnya per proxy.
  • Aplikasi Target yang dihosting yang di-deploy ke versi berbayar dan uji coba Apigee Edge akan diskalakan ke nol saat tidak aktif. Dalam hal ini, Anda mungkin melihat waktu respons yang lebih lambat untuk periode singkat. Lihat juga Masalah umum

File manifes

Untuk mengumpulkan informasi runtime guna membangun dan men-deploy aplikasi yang dihosting, Edge mencari file manifes bernama app.yaml di direktori resources/hosts. File ini berisi informasi yang diperlukan untuk membangun dan men-deploy aplikasi Hosted Targets.

Sintaksis file Manfiest

runtime: node
runtimeVersion: version_number
command: command_name
args: argument_array
env:
  - name: variable_name
    value: literal_value
  - name: variable_name
    valueRef:
      name: kvm_name
      key: kvm_value

Elemen file manifes

File manifes app.yaml mencakup elemen-elemen berikut ini:

  • runtime - (Diperlukan) Menentukan jenis aplikasi yang akan di-deploy. Anda harus menentukan node.
  • runtimeVersion - (Opsional) Versi runtime yang digunakan aplikasi Anda. Default: LTS Node.js (v10.x). Lihat repositori resmi Docker untuk Node untuk opsi lainnya.
  • command - (Opsional) Memungkinkan Anda menentukan perintah yang akan dijalankan selain perintah {i>default<i} yang digunakan untuk memulai aplikasi Anda. Default: Node.js=npm
  • args - (Opsional) Array argumen command line yang akan diteruskan ke (ditentukan dalam sintaksis array YAML standar). Biasanya, ini ditambahkan ke perintah {i>default<i}. Defaultnya adalah start. Misalnya, secara default aplikasi Node.js akan menerima perintah npm start.
  • env - (Opsional) Array variabel lingkungan (pasangan nama/nilai) untuk ditetapkan di lingkungan runtime Target yang Dihosting. Variabel ini tersedia untuk men-deploy Hosted Targets.
    • name - Nama variabel.
    • nilai | valueRef - Anda memiliki dua opsi. Anda dapat menetapkan nilai literal atau mereferensikan nilai yang disimpan dalam Key Value Map. Peta Nilai Kunci harus sudah ada di lingkungan Edge Anda. Lihat Bekerja dengan Peta Nilai Kunci
      • Jika menggunakan value, Anda harus menentukan variabel name dan value literal. Contoh: 
        runtime: node
env:
 - name: NODE_ENV
   value: production
      • Jika Anda menggunakan valueRef, Anda harus memberikan nama Key Value Map (KVM) yang sebelumnya dibuat di Edge dan sebuah kunci. Contoh: 
        runtime: node
env:
  - name: DB_ENV
    value: production
  - name: DB_PASSWORD
    valueRef:
      name: hosted-kvm
      key: db-password

    Contoh file manifes

    Bagian ini berisi contoh file manifes untuk Node.js menggunakan berbagai aplikasi obrolan. File manifes diperlukan untuk men-deploy aplikasi Hosted Targets, dan harus ditemukan dalam direktori apiproxy/resources/hosted, dan nama filenya harus app.yaml.

    Berikut adalah contoh file app.yaml (manifes) untuk aplikasi Node.js.

    Contoh yang menentukan variabel lingkungan literal: 

     runtime: node
 env:
   - name: NODE_ENV
     value: production

    Contoh dengan perintah start, argumen command line, dan variabel lingkungan.

     runtime: node
 command: ./node_modules/pm2/bin/pm2
 env:
   - name: NODE_ENV
     value: production
 args:
   - app.js


    Contoh yang menentukan referensi Key Value Map (KVM):

    Untuk mengetahui informasi selengkapnya tentang akses KVM, lihat File Manifest.

    runtime: node
env:
  - name: DB_ENV
    value: production
  - name: DB_PASSWORD
    valueRef:
      name: hosted-kvm
      key: db-password

    Contoh aplikasi Target yang Dihosting di GitHub

    Apigee menyediakan proxy contoh di GitHub dengan penulisan aplikasi Target yang Dihosting di Node.js. Anda dapat meng-clone repo ini dan mengikuti petunjuk README untuk men-deploy salah satu {i>proxy<i}.

    Prasyarat

    Untuk men-deploy sampel, Anda harus menginstal dua alat di sistem:

    • apigeetool -- Command line untuk men-deploy proxy Edge.
    • get_token - Alat command line untuk mendapatkan token otorisasi yang diperlukan oleh apigeetool.

    Jika ingin menguji sampel secara lokal, Anda juga harus menginstal Node.js.

    Mendapatkan repositori sampel

    1. Di browser, buka https://github.com/apigee/api-platform-samples.
    2. Klik Clone or download, lalu tarik repo ke sistem lokal Anda, menggunakan metode pilihan Anda.
    3. cd ke <your install dir>/api-platform-samples/doc-samples/hosting-targets
    4. Setelah repo didownload, Anda bisa melakukan cd ke salah satu direktori contoh dan mengikuti README petunjuk men-deploy proxy contoh ke Edge. Perintah deploy ditampilkan di bawah ini. Simply ganti parameter yang ditunjukkan dengan parameter untuk akun Apigee Anda:
      5. get_token && apigeetool deployproxy \
  -o YOUR_ORGANIZATION \
  -e YOUR_ENVIRONMENT \
  --json \
  --token "$(< ~/.sso-cli/valid_token.dat)"\
  --api NAME_OF_THE_PROXY \
  --directory .

    Contoh: Mengeksekusi aplikasi contoh

    Meng-clone repositori contoh

    cd ~/myhome
git clone https://github.com/apigee/api-platform-samples.git
cd ~/myhome/api-platform-samples/doc-samples/hosted-targets
cd node-hosted-hello

    Menguji aplikasi secara lokal

    Anda harus menginstal Node.js untuk melakukan pengujian lokal ini.

     PORT=8081 node apiproxy/resources/hosted/index.js
 curl http://localhost:8081

    Contoh output:

    {"date":"2018-03-12T21:45:22.161Z","msg":"Hello, World!"}

    Men-deploy proxy

     get_token && apigeetool deployproxy \
   -o myorg \
   -e test \
   --json \
   --token "$(< ~/.sso-cli/valid_token.dat)"\
   --api node-hosted-hello \
   --directory .

    Melakukan pengujian deployment

    Proses deployment mungkin memerlukan waktu beberapa menit sampai selesai. Jika terjadi error deployment, jalankan perintah deploy lagi.

    curl http://myorg-test.apigee.net/node-hosted-hello

    Contoh output:

    {"date":"2018-03-23T18:59:18.668Z","msg":"Hello, World!"

    Masalah Umum

    • Latensi Jaringan - Karena aplikasi Node.js tidak lagi berjalan di JVM milik MP, sekarang ada {i>network hop<i} antara MP dan deployment. Tentu saja hal ini memerlukan biaya, tetapi tolok ukur awal menunjukkan bahwa solusi ini baik dalam jumlah yang wajar
    • Respons API Lambat - Infrastruktur yang menjalankan aplikasi Anda diskalakan secara otomatis berdasarkan kebutuhan. Ini berarti aplikasi Anda benar-benar dapat diperkecil hingga nol, dan jika demikian, permintaan API berikutnya akan memakan waktu sedikit lebih permintaan API umumnya karena infrastruktur menjalankan instance untuk memproses permintaan.
    • Error deployment - Jika Anda menerima error deployment saat men-deploy Proxy Target yang Dihosting, coba deploy ulang proxy. Pada beberapa kasus, waktu tunggu deployment dapat habis dan jika Anda melakukan deployment ulang, masalah ini akan teratasi dengan sendirinya.