Tugas Target yang Dihosting

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

Membatalkan deployment proxy Target yang Dihosting

Saat Anda membatalkan deployment proxy Edge yang menyertakan aplikasi Target yang Dihosting, aplikasi Target yang Dihosting yang terkait dibatalkan deploymentnya, tetapi image aplikasi yang mendasarinya tidak dihapus. Jika Anda men-deploy ulang proxy, aplikasi Target yang Dihosting akan di-deploy ulang.

Menghapus proxy Target yang Dihosting

Setelah Anda menghapus proxy Target yang Dihosting, instance runtime yang mendasarinya akan berhenti berjalan dalam beberapa waktu. Namun, kode aplikasi akan tetap ada.

Mengakses file log

File log berguna untuk proses debug dan pemecahan masalah. Anda dapat melihat dua jenis file log untuk deployment Target yang Dihosting:

  • Log build - Menampilkan output yang terkait dengan deployment dan build aplikasi Target yang Dihosting.
  • Log runtime - Menampilkan output yang terkait dengan aplikasi Target Hosted yang sedang berjalan. Log runtime dicakupkan ke lingkungan dan menampilkan informasi log untuk revisi proxy yang saat ini di-deploy.

Mengakses log dari UI Edge

  1. Buka: apigee.com/edge
  2. Masukkan kredensial login Anda, lalu klik Sign In.
  3. Pilih Develop > API Proxies di menu navigasi samping.
  4. Pilih proxy yang log-nya ingin Anda lihat.
  5. Klik tab Develop.
  6. Untuk melihat log build, klik Build Logs.
  7. Untuk melihat log runtime, klik Runtime Logs.

Mengakses log dengan API

Anda juga dapat menggunakan Edge API untuk mengambil log Target yang Dihosting. Untuk mengetahui detailnya, lihat Mendapatkan Log Node.js yang Di-cache.

Menggunakan repositori npm pribadi

Bagian ini menjelaskan cara men-deploy proxy Node.js ke Target yang Dihosting jika Anda menggunakan repositori NPM pribadi di lingkungan pengembangan Anda.

Yang perlu Anda ketahui tentang penggunaan repositori pribadi

Saat Anda men-deploy aplikasi Node.js ke Edge, semua dependensi project Anda akan diimpor secara otomatis sebagai bagian dari proses deployment. Pada dasarnya, Target yang Dihosting menjalankan npm install pada kode Anda saat di-deploy. Namun, jika Anda menggunakan repositori NPM pribadi di lingkungan pengembangan, dependensi pribadi tidak dapat diselesaikan di Cloud. Dalam hal ini, solusinya adalah menggunakan opsi --bundled-dependencies saat Anda menggunakan utilitas deployment apigeetool. Lihat juga Men-deploy Node.js dari sistem Anda ke Edge.

Saat Anda menggunakan tanda --bundled-dependencies pada apigeetool, aplikasi Node.js Anda akan diupload ke Target yang Dihosting dan semua file lokal/pribadi yang tercantum dalam array bundledDependencies di package.json akan dikompresi dan diupload bersama paket.

Meskipun bukan situasi yang umum, perlu diketahui bahwa jika Anda menduplikasi repositori NPM publik secara internal, deployment Anda akan gagal jika paket deployment Anda menyertakan file .npmrc atau package-lock.json yang mengarah ke duplikasi pribadi Anda. Dalam hal ini, pastikan untuk menghilangkan .npmrc atau package-lock.json dari paket proxy yang ingin Anda deploy.

Men-deploy dengan repositori NPM pribadi

Untuk menggunakan modul yang disediakan dari repositori NPM pribadi, ikuti langkah-langkah berikut:

  1. Login ke npm: 
    npm login
  2. Dapatkan token autentikasi npm:
    1. Cari .npmrc Anda (seharusnya di ~/.npmrc).
    2. Di .npmrc, perhatikan token di akhir baris yang terlihat seperti ini:

      //registry.npmjs.org/:_authToken=****
    3. Atau gunakan perintah npm token <list | create | revoke> untuk mencantumkan, membuat, atau mencabut token autentikasi. Lihat dokumentasi token npm untuk detail selengkapnya.
  3. Akses halaman konfigurasi Key Value Maps, seperti yang dijelaskan di bawah ini.

    Edge

    Untuk mengakses halaman konfigurasi Key Value Maps menggunakan Edge UI:

    1. Login ke apigee.com/edge.
    2. Pilih Admin > Environments > Key Value Maps di menu navigasi sebelah kiri.

    Edge Klasik (Private Cloud)

    Untuk mengakses halaman konfigurasi Key Value Maps menggunakan UI Edge Klasik:

    1. Login ke http://ms-ip:9000, dengan ms-ip yang merupakan alamat IP atau nama DNS node Server Pengelolaan.
    2. Pilih APIs > Environment Configuration > Key Value Maps di menu navigasi atas.
  4. Klik + Peta Nilai Kunci.
  5. Pada dialog New Key Value Map, masukkan nama dan pilih Encrypted.
  6. Klik Tambahkan.
  7. Tambahkan token autentikasi yang sebelumnya Anda temukan atau buat sebagai entri baru di setiap KVM yang baru saja Anda buat.
  8. Pada file app.yaml, tambahkan entri yang merujuk ke KVM dan kunci yang terkait dengan token autentikasi npm. TODO tersebut akan terlihat seperti berikut:
    9. env:
- name: NPM_TOKEN
 valueRef:
   name: npm_store
   key: private_token

    Dengan keterangan:

    • Atribut name tingkat atas sesuai dengan nama variabel lingkungan yang akan dibuat.
    • Nama di bagian valueRef sesuai dengan KVM yang Anda buat sebelumnya.
    • Atribut key sesuai dengan kunci yang dipetakan ke token npm yang Anda tambahkan ke KVM.
  9. Buat file .npmrc di direktori yang sama dengan package.json Anda. File ini akan terlihat seperti ini: 
    //registry.npmjs.org/:_authToken=${NPM_TOKEN}
    atau jika tidak menggunakan registry.npmjs.org, Anda dapat menyetel cakupan dalam file .npmrc dengan menambahkan baris seperti ini @myscope:registry=https://mycustomregistry.example.org Lihat juga dokumentasi npmrc.
  10. Upload atau perbarui proxy Node.js Anda dengan menyertakan file .npmrc dan file app.yaml.
  11. Pastikan proxy baru atau yang diperbarui men-deploy dan berfungsi dengan modul repositori pribadi yang diinginkan.
  12. Jika proxy tidak di-deploy, periksa log build untuk melihat apakah penginstalan modul npm pribadi gagal. Jika ya:
    1. Di tab pengembangan, pastikan .npmrc ada.
    2. Pastikan token Anda valid (coba instal modul secara lokal dengan token yang ada di kvm).
    3. Jika Anda menggunakan cakupan kustom, pastikan cakupan tersebut telah ditetapkan.

Menentukan versi NPM untuk dependensi yang dipaketkan

Secara default, NPM v4 digunakan untuk menginstal dependensi yang dipaketkan di lingkungan Target yang Dihosting. Namun, jika ingin menggunakan versi NPM yang berbeda, Anda dapat menentukannya dalam variabel lingkungan NPM_VERSION. Anda dapat menetapkan variabel ini dalam file manifes aplikasi. Lihat Elemen file manifes untuk mengetahui detailnya.

Jika Anda menggunakan dependensi paket, dan jika Anda tidak menentukan NPM_VERSION, Target yang Dihosting akan menggunakan NPM v4 secara default. Jika Anda tidak menggunakan dependensi paket, versi NPM yang disertakan dalam runtime Node.js yang Anda tentukan akan digunakan.

Contoh dependensi gabungan

Untuk contoh yang menunjukkan fitur dependensi yang dipaketkan dengan Target yang Dihosting, lihat Cara membuat aplikasi Node.js dengan Fungsi yang Dihosting menggunakan modul kustom.

Menambahkan endpoint health check

Anda memiliki opsi untuk menerapkan endpoint health check untuk aplikasi Node.js. Apigee menggunakan endpoint ini saat aplikasi Node.js Anda mulai memeriksa apakah aplikasi aktif dan berjalan di dalam container.

Secara default, endpoint yang diharapkan Apigee adalah /health. Anda dapat mengubah endpoint default, dengan menentukan endpoint dalam variabel lingkungan bernama HOSTED_TARGET_HEALTH_CHECK_PATH. Anda dapat menetapkan variabel ini dalam file manifes aplikasi. Lihat Elemen file manifes untuk mengetahui detailnya.

Menerapkan endpoint health check tidak diperlukan. Namun, jika Anda menerapkan endpoint health check, perhatikan hal-hal berikut:

  • Jika aplikasi Anda keluar saat Apigee mencapai endpoint, aplikasi tidak akan dimulai seperti yang diharapkan.
  • Tidak masalah jika endpoint Anda menampilkan status HTTP 404 Not Found. /health atau HOSTED_TARGET_HEALTH_CHECK_PATH hanya digunakan untuk memeriksa apakah aplikasi Anda berjalan. Respons yang sebenarnya akan diabaikan.

Mengubah lokasi cache NPM

Versi Node.js yang lebih baru menggunakan versi NPM yang menggunakan /root/.npm untuk cache NPM. Lokasi ini menimbulkan masalah untuk Target yang Dihosting karena lokasi direktori tersebut bersifat hanya baca karena runtime Target yang Dihosting menggunakan sistem file tmpfs yang hanya dapat menulis /tmp. Untuk mengatasi masalah ini, Anda dapat menetapkan variabel lingkungan npm_config_cache di file app.yaml (file manifes) aplikasi Anda ke direktori dalam /tmp. Contoh: 

  runtime: node
  application: my-express-app
  env:
    - name: npm_config_cache
      value: /tmp/.npm
    - name: NODE_ENV
      value: production
    - name: LOG_LEVEL
      value: 3

Menjalankan aplikasi Anda tanpa NPM

Secara default, Target yang Dihosting menggunakan npm start untuk menjalankan aplikasi Target yang Dihosting Anda. Namun, dalam tugas sebelumnya, kita telah membahas masalah terkait penggunaan NPM karena versi yang lebih baru akan mencoba menggunakan /root/.npm untuk cache NPM, yang tidak dapat ditulis dan mengakibatkan Target yang Dihosting gagal dimulai. Meskipun tugas sebelumnya akan mengatasi masalah ini, opsi lainnya adalah menjalankan aplikasi Anda tanpa NPM. Caranya, Anda dapat menggunakan nilai command dan args dalam file app.yaml (file manifes) aplikasi Anda untuk menjalankan Target yang Dihosting secara langsung menggunakan node index.js. Misalnya: 

  runtime: node
  application: my-express-app
  command: node
  args:
    - index.js
  env:
    - name: NODE_ENV
      value: production
    - name: LOG_LEVEL
      value: 3
Tentu saja, Anda dapat menggunakan perintah apa pun yang Anda anggap cocok dan node index.js hanyalah contoh.