คุณกำลังดูเอกสารประกอบสำหรับ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info
ขีดจำกัดตัวแปรสภาพแวดล้อม
เป้าหมายที่โฮสต์จะจำกัดขนาดและจำนวนตัวแปรสภาพแวดล้อมที่ตั้งค่าได้ในสภาพแวดล้อมรันไทม์ของเป้าหมายที่โฮสต์
- 1000: ความยาวสูงสุดของตัวแปรสภาพแวดล้อมเดียว
- 100: จำนวนตัวแปรสภาพแวดล้อมสูงสุดที่ตั้งค่าได้
ดูข้อมูลเกี่ยวกับการตั้งค่าตัวแปรสภาพแวดล้อมได้ที่ไฟล์ Manifest
ตัวแปรสภาพแวดล้อมที่ตั้งค่าไว้ในรันไทม์ของแอปพลิเคชัน
เมื่อคุณทำให้แอปพลิเคชันเป้าหมายที่โฮสต์ใช้งานได้ ระบบจะตั้งค่าตัวแปรสภาพแวดล้อมต่อไปนี้และพร้อมใช้สำหรับแอปพลิเคชันขณะรันไทม์
APIGEE_ENVIRONMENT
- สภาพแวดล้อมที่ติดตั้งใช้งานพร็อกซีเป้าหมายที่โฮสต์APIGEE_ORGANIZATION
- องค์กรที่ใช้งานพร็อกซีเป้าหมายที่โฮสต์PORT
- พอร์ตที่แอปพลิเคชันเป้าหมายที่โฮสต์ต้องรับคำสั่ง
การจัดสรรทรัพยากรของระบบ
อินสแตนซ์เป้าหมายที่โฮสต์แต่ละรายการจะได้รับทรัพยากรต่อไปนี้
- หน่วยความจำ 256 MB
- CPU 1.2 GHz
การปรับสเกล
ส่วนนี้อธิบายวิธีปรับขนาดแอปพลิเคชันเป้าหมายที่โฮสต์ไว้ ทั้งนี้ขึ้นอยู่กับประเภทของบัญชี Edge ที่คุณมี- Apigee Edge เวอร์ชันทดลองใช้มีขีดจํากัดอยู่ที่อินสแตนซ์เป้าหมายที่โฮสต์ 1 รายการต่อพร็อกซี 1 รายการ
- บัญชี Apigee Edge แบบชําระเงินจะได้รับการปรับขนาดอัตโนมัติตามอัตราการส่งคําขอ เวลาในการตอบสนอง และเมตริกอื่นๆ ของแอปพลิเคชันต่อพร็อกซี
- แอปเป้าหมายที่โฮสต์ซึ่งปรับใช้กับทั้งเวอร์ชันแบบชำระเงินและเวอร์ชันทดลองใช้ของ Apigee Edge จนถึง 0 ในช่วงที่ไม่มีการใช้งาน ในกรณีนี้ คุณอาจสังเกตเห็นว่าเวลาในการตอบกลับช้าลงไประยะหนึ่ง ดูปัญหาที่ทราบ
ไฟล์ Manifest
Edge จะมองหาไฟล์ Manifest ชื่อ app.yaml ในไดเรกทอรี resources/hosted เพื่อรวบรวมข้อมูลรันไทม์สำหรับการสร้างและทำให้แอปพลิเคชันที่โฮสต์ใช้งานได้ ไฟล์นี้มีข้อมูลที่จําเป็นสําหรับการสร้างและติดตั้งใช้งานแอปพลิเคชันเป้าหมายที่โฮสต์
ไวยากรณ์ของไฟล์ 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
องค์ประกอบไฟล์ Manifest
ไฟล์ Manifest app.yaml มีองค์ประกอบต่อไปนี้
- runtime - (ต้องระบุ) ระบุประเภทของแอปพลิเคชันที่คุณทำให้ใช้งานได้
คุณต้องระบุ
node
- runtimeVersion - (ไม่บังคับ) เวอร์ชันรันไทม์ที่แอปพลิเคชันใช้ ค่าเริ่มต้น: Node.js LTS (v10.x) โปรดดูตัวเลือกอื่นๆ ที่ที่เก็บอย่างเป็นทางการของ Docker สำหรับโหนด
- command - (ไม่บังคับ) ช่วยให้คุณระบุคำสั่งที่จะเรียกใช้นอกเหนือจากคำสั่งเริ่มต้นที่ใช้เพื่อเริ่มแอปพลิเคชัน ค่าเริ่มต้น:
Node.js=npm
- args - (ไม่บังคับ) อาร์เรย์ของอาร์กิวเมนต์บรรทัดคำสั่งที่จะส่งไปยังแอปพลิเคชัน (ระบุไว้ในไวยากรณ์อาร์เรย์ YAML มาตรฐาน) โดยปกติแล้ว ระบบจะเพิ่มตัวเลือกเหล่านี้ลงในคําสั่งเริ่มต้น
ค่าเริ่มต้นคือ start เช่น โดยค่าเริ่มต้น แอป Node.js จะส่งผ่านคำสั่ง
npm start
- env - (ไม่บังคับ) อาร์เรย์ของตัวแปรสภาพแวดล้อม (คู่ชื่อ/ค่า) ที่จะตั้งค่าในสภาพแวดล้อมรันไทม์ของเป้าหมายที่โฮสต์ ตัวแปรเหล่านี้พร้อมใช้งานในแอปเป้าหมายที่โฮสต์ซึ่งทำให้ใช้งานได้แล้ว
- name - ชื่อตัวแปร
- value | valueRef - คุณมี 2 ตัวเลือก คุณสามารถกําหนดค่าตัวอักษรหรืออ้างอิงค่าที่เก็บไว้ในแผนที่คีย์-ค่า ต้องมีแมปค่าคีย์อยู่ในสภาพแวดล้อม Edge อยู่แล้ว ดูการใช้งานการแมปค่าคีย์
- หากใช้ value คุณต้องระบุตัวแปร
name
และค่าคงที่value
เช่นruntime: node env: - name: NODE_ENV value: production
- หากใช้ valueRef คุณต้องระบุชื่อของการแมปค่าคีย์ (KVM) ที่สร้างไว้ก่อนหน้านี้ใน Edge และคีย์
ตัวอย่างเช่น
runtime: node env: - name: DB_ENV value: production - name: DB_PASSWORD valueRef: name: hosted-kvm key: db-password
- หากใช้ value คุณต้องระบุตัวแปร
ตัวอย่างไฟล์ Manifest
ส่วนนี้ประกอบด้วยตัวอย่างไฟล์ Manifest สำหรับแอปพลิเคชัน Node.js ไฟล์ Manifest ต้องใช้ในการทำให้แอปเป้าหมายที่โฮสต์ใช้งานได้ และต้องอยู่ในไดเรกทอรี apiproxy/resources/hosted
และชื่อไฟล์ต้องเป็น app.yaml
ต่อไปนี้คือตัวอย่างไฟล์ app.yaml
(ไฟล์ Manifest) สําหรับแอป Node.js
ตัวอย่างที่ระบุตัวแปรสภาพแวดล้อมลิเทอรัล
runtime: node env: - name: NODE_ENV value: production
ตัวอย่างที่มีคำสั่งเริ่มต้น อาร์กิวเมนต์บรรทัดคำสั่ง และตัวแปรสภาพแวดล้อม
runtime: node command: ./node_modules/pm2/bin/pm2 env: - name: NODE_ENV value: production args: - app.js
ตัวอย่างที่ระบุการอ้างอิงการแมปคีย์ (KVM)
ดูข้อมูลเพิ่มเติมเกี่ยวกับการเข้าถึง KVM ได้ที่ไฟล์ Manifest
runtime: node env: - name: DB_ENV value: production - name: DB_PASSWORD valueRef: name: hosted-kvm key: db-password
ตัวอย่างแอปพลิเคชันเป้าหมายที่โฮสต์บน GitHub
Apigee มีตัวอย่างพร็อกซีใน GitHub ที่มีแอปพลิเคชันเป้าหมายที่โฮสต์ซึ่งเขียนด้วย Node.js คุณสามารถโคลนที่เก็บนี้และทำตามวิธีการของ README เพื่อทำให้พร็อกซีใช้งานได้
ข้อกำหนดเบื้องต้น
ในการทำให้ตัวอย่างใช้งานได้ คุณต้องติดตั้งเครื่องมือ 2 รายการในระบบของคุณดังนี้
- apigeetool - เครื่องมือบรรทัดคำสั่งสําหรับการทําให้พร็อกซี Edge ใช้งานได้
- get_token - เครื่องมือบรรทัดคำสั่งสำหรับการรับโทเค็นการให้สิทธิ์ที่ apigeetool กำหนดให้
หากต้องการทดสอบตัวอย่างในเครื่อง คุณจะต้องติดตั้ง Node.js ด้วย
การรับที่เก็บตัวอย่าง
- ไปที่ https://github.com/apigee/api-platform-samples ในเบราว์เซอร์
- คลิกโคลนหรือดาวน์โหลด แล้วดึงข้อมูลรีโปไปยังระบบในเครื่องโดยใช้วิธีการที่ต้องการ
- cd เป็น <your install dir>/api-platform-samples/doc-samples/hosted-targets
- เมื่อดาวน์โหลดที่เก็บเรียบร้อยแล้ว ให้ใช้คำสั่ง cd ไปยังไดเรกทอรีตัวอย่างใดก็ได้ แล้วทำตามวิธีการใน README เพื่อติดตั้งใช้งานพร็อกซีตัวอย่างใน Edge คำสั่งทำให้ใช้งานได้แสดงอยู่ด้านล่าง เพียงแทนที่พารามิเตอร์ที่ระบุด้วยพารามิเตอร์สำหรับบัญชี Apigee ดังนี้
get_token && apigeetool deployproxy \ -o YOUR_ORGANIZATION \ -e YOUR_ENVIRONMENT \ --json \ --token "$(< ~/.sso-cli/valid_token.dat)"\ --api NAME_OF_THE_PROXY \ --directory .
ตัวอย่าง: การใช้งานแอปตัวอย่าง
โคลนที่เก็บตัวอย่าง
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
ทดสอบแอปพลิเคชันในเครื่อง
คุณต้องติดตั้ง Node.js เพื่อทำการทดสอบในเครื่อง
PORT=8081 node apiproxy/resources/hosted/index.js
curl http://localhost:8081
ตัวอย่างเอาต์พุต
{"date":"2018-03-12T21:45:22.161Z","msg":"Hello, World!"}
ทำให้พร็อกซีใช้งานได้
get_token && apigeetool deployproxy \ -o myorg \ -e test \ --json \ --token "$(< ~/.sso-cli/valid_token.dat)"\ --api node-hosted-hello \ --directory .
ทดสอบการติดตั้งใช้งาน
การทำให้ใช้งานได้อาจใช้เวลาสักครู่จึงจะเสร็จสมบูรณ์ หากได้รับข้อผิดพลาดเกี่ยวกับการทำให้ใช้งานได้ ให้เรียกใช้คำสั่งทำให้ใช้งานได้อีกครั้ง
curl http://myorg-test.apigee.net/node-hosted-hello
ตัวอย่างเอาต์พุต
{"date":"2018-03-23T18:59:18.668Z","msg":"Hello, World!"
ปัญหาที่ทราบ
- เวลาในการตอบสนองของเครือข่าย - เมื่อแอปพลิเคชัน Node.js ไม่ทำงานใน JVM ของ MP อีกต่อไป เครือข่ายจะข้ามไปมาระหว่าง MP กับการใช้งาน แน่นอนว่าต้องมีค่าใช้จ่าย แต่การเปรียบเทียบเริ่มต้นแสดงให้เห็นว่าอยู่ในจำนวนที่เหมาะสม
- การตอบสนองของ API ที่ช้า - โครงสร้างพื้นฐานที่เรียกใช้แอปพลิเคชันของคุณจะปรับขนาดโดยอัตโนมัติตามความต้องการ ซึ่งหมายความว่าแอปพลิเคชันของคุณสามารถลดขนาดลงเหลือ 0 อินสแตนซ์ได้ และในกรณีดังกล่าว คำขอ API ครั้งถัดไปจะใช้เวลานานกว่าคำขอ API ทั่วไปเล็กน้อย เนื่องจากโครงสร้างพื้นฐานกำลังสร้างอินสแตนซ์เพื่อประมวลผลคำขอ
- ข้อผิดพลาดในการติดตั้งใช้งาน - หากได้รับข้อผิดพลาดในการติดตั้งใช้งานเมื่อติดตั้งใช้งานพร็อกซีเป้าหมายที่โฮสต์ ให้ลองติดตั้งใช้งานพร็อกซีอีกครั้ง ในบางกรณี การทำให้ใช้งานได้อาจหมดเวลาและหากคุณทำให้ใช้งานได้อีกครั้ง ปัญหาจะหายไปเอง