คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
การเพิ่มปลั๊กอินที่กำหนดเอง
คุณเพิ่มฟีเจอร์และความสามารถใหม่ๆ ให้กับไมโครเกตได้โดยเขียนปลั๊กอินที่กำหนดเอง ปลั๊กอินที่กำหนดเองช่วยให้คุณโต้ตอบแบบเป็นโปรแกรมกับคำขอและการตอบสนองที่ไหลผ่าน Microgateway ได้
ส่วนนี้จะอธิบายวิธีสร้างแพ็กเกจและติดตั้งใช้งานปลั๊กอินกับอินสแตนซ์ Edge Microgateway ที่ทำงานในคลัสเตอร์ Kubernetes
เนื้อหาที่เหลือของส่วนนี้จะสมมติว่าคุณคุ้นเคยกับการเขียนและกำหนดค่าปลั๊กอินสำหรับการตั้งค่า Edge Microgateway แบบมาตรฐาน หากยังไม่ได้สร้าง โปรดดูที่พัฒนาปลั๊กอินที่กำหนดเอง
สร้างแพ็กเกจปลั๊กอินของคุณ
หากต้องการจัดแพ็กเกจปลั๊กอินที่กำหนดเอง ให้ทำตามขั้นตอนต่อไปนี้
เขียนและทดสอบปลั๊กอินตามคำแนะนำในเขียนปลั๊กอินอย่างง่าย
วางโค้ดปลั๊กอินของคุณในโครงสร้างไดเรกทอรีที่เหมาะสม ไดเรกทอรีปลั๊กอินต้องเป็นไปตามโครงสร้างชุด ตัวอย่างต่อไปนี้แสดงโครงสร้างที่คุณต้องปฏิบัติตาม โดย
response-uppercase
และrequest-headers
คือชื่อโฟลเดอร์ที่มีโค้ดปลั๊กอินที่กำหนดเอง (ชื่อเหล่านี้เป็นตัวอย่างเท่านั้น ชื่อโฟลเดอร์อาจแตกต่างกัน)plugin | |-- plugins | |- response-uppercase | |- index.js | |- package.json |- request-headers | | - index.js | - package.json
cd
ไปยังโฟลเดอร์plugin
ในโฟลเดอร์
plugin
ให้บีบอัดโฟลเดอร์plugins
ทั้งโฟลเดอร์:zip -r plugins.zip plugins/
สร้างอิมเมจ Docker
- สร้างไฟล์ใหม่ชื่อ
Dockerfile
ในไดเรกทอรีเดียวกันกับที่มีไฟล์ ZIP เพิ่มโค้ดต่อไปนี้ลงใน
Dockerfile
และบันทึกไฟล์:FROM gcr.io/apigee-microgateway/edgemicro:latest RUN apt-get install unzip COPY plugins.zip /opt/apigee/ RUN chown apigee:apigee /opt/apigee/plugins.zip RUN su - apigee -c "unzip /opt/apigee/plugins.zip -d /opt/apigee" EXPOSE 8000 EXPOSE 8443 ENTRYPOINT ["entrypoint"]
สร้างอิมเมจ Edge Microgateway Docker ใหม่ด้วยปลั๊กอินของคุณแล้วพุชอิมเมจไปยังรีจิสทรีของ Docker คุณจะใช้รีจิสทรีใดก็ได้ที่ต้องการ เช่น
docker.io
หรือgcr.io
docker build -t edgemicroplugins .
docker tag edgemicroplugins container-registry/your-project/edgemicroplugins
docker push container-registry/your-project/edgemicroplugins
เช่น
docker build -t edgemicroplugins .
docker tag edgemicroplugins gcr.io/my-project/edgemicroplugins
docker push gcr.io/my-project/edgemicroplugins
อัปเดตการกำหนดค่า Edge Microgateway
เพิ่มปลั๊กอินลงในไฟล์การกำหนดค่า Edge Microgateway คุณจะพบไฟล์การกำหนดค่าได้ที่นี่
$HOME/.edgemicro/org-env-config.yaml
เช่น
$HOME/.edgemicro/myorg-test-config.yaml
ในการกำหนดค่าตัวอย่างต่อไปนี้ มีการเพิ่มปลั๊กอินที่กำหนดเอง response-uppercase
ปลั๊กอิน oauth
มีให้ใช้งานอยู่แล้วโดยค่าเริ่มต้น
edgemicro:
...
plugins:
sequence:
- oauth
- response-uppercase
อัปเดตคลัสเตอร์ Kubernetes
ขั้นตอนสุดท้ายคือการใช้การเปลี่ยนแปลงการกำหนดค่ากับคลัสเตอร์ Kubernetes Kubernetes จะดึงอิมเมจใหม่ที่มีโค้ดปลั๊กอินที่คุณพุชไปยัง Container Registry และใช้กับพ็อดที่สร้างใหม่
หากคุณทำให้ Edge Microgateway เป็นบริการ
ใช้คำสั่ง edgemicroctl
เพื่อแทรกการกำหนดค่า Edge Microgateway ที่อัปเดตแล้วดังนี้
อัปเดตการติดตั้งใช้งาน Edge Microgateway ด้วยรูปภาพใหม่ เช่น
kubectl apply -f <(edgemicroctl -org=your_organization -env=your_environment -key=configuration_key -sec=configuration_secret -conf=config_file_path -img=container-registry/your_project_name/image_name:latest)
ที่ไหน
your_organization
- องค์กร Apigee ที่คุณระบุไว้ในคำสั่งedgemicro configure
your_environment
- สภาพแวดล้อมที่คุณระบุในคำสั่งedgemicro configure
configuration_key
- คีย์ที่แสดงผลจากคำสั่งedgemicro configure
configuration_secret
- ข้อมูลลับที่แสดงผลจากคำสั่งedgemicro configure
config_file_path
- เส้นทางไปยังไฟล์การกำหนดค่า Edge Micro ที่ส่งคืนจากคำสั่งedgemicro configure
container-registry
- รีจิสทรีของ Docker ที่คุณพุชอิมเมจ เช่นgcr.io
หรือdocker.io
your_project_name
- ชื่อโปรเจ็กต์สำหรับที่เก็บ Docker ที่คุณพุชอิมเมจ Dockerimage_name
- ชื่อของอิมเมจ Docker ที่คุณส่ง
ตัวอย่าง
kubectl apply -f <(edgemicroctl -org=jdoe -env=test -key=f2d2eaa52b758493d00cec656e574ac947bee1d701c5c5f3295e5eaa39a3b -sec=0c38cda3fac6c59152f15657052ba1728f8003c1a763cf08da2a -conf=/Users/jdoe/.edgemicro/apigeesearch-test-config.yaml -img=gcr.io/jdoe-project/edgemicroplugins:latest)
ทดสอบปลั๊กอิน เรียก API เพื่อดูว่าคุณได้รับลักษณะการทำงานตามที่คาดไว้หรือไม่ ตัวอย่างเช่น สำหรับปลั๊กอิน "ตัวพิมพ์ใหญ่ของการตอบกลับ" ข้อความตอบกลับจะถูกแปลงเป็นตัวพิมพ์ใหญ่ทั้งหมดตามที่แสดงด้านล่าง
curl $GATEWAY_IP -H 'x-api-key:3eqeedJRFLlCshwWBiXq4xKFoH1Se3xR'
เอาต์พุต:
HELLO WORLD
การแทรกการกำหนดค่าใหม่ด้วยตนเอง
การแทรกด้วยตนเองเป็นวิธีที่ตรงไปตรงมา โดยให้คุณแทรกการกำหนดค่าใหม่จากบรรทัดคำสั่ง
เรียกใช้คำสั่งต่อไปนี้
kubectl apply -f <(edgemicroctl -org=your_org -env=your_env -key=your_key -sec=your_secret -conf=config_file_path -img=container-registry/your_project_name/image_name:latest -svc=service_deployment_file)
ที่ไหน
your_org
- องค์กร Apigee ที่คุณระบุไว้ในคำสั่งedgemicro configure
your_env
- สภาพแวดล้อมที่คุณระบุในคำสั่งedgemicro configure
your_key
- คีย์ที่แสดงผลจากคำสั่งedgemicro configure
your_secret
- ข้อมูลลับที่แสดงผลจากคำสั่งedgemicro configure
config_file_path
- เส้นทางไปยังไฟล์การกำหนดค่า Edge Micro ที่ส่งคืนจากคำสั่งedgemicro configure
container-registry
- รีจิสทรีของ Docker ที่คุณพุชอิมเมจ เช่นgcr.io
หรือdocker.io
your_project_name
- ชื่อโปรเจ็กต์สำหรับที่เก็บ Docker ที่คุณพุชอิมเมจ Dockerimage_name
- ชื่อของอิมเมจ Docker ที่คุณส่งservice_deployment_file
- เส้นทางไปยังไฟล์การทำให้ใช้งานได้ของบริการที่จะใช้ปลั๊กอิน เช่นsamples/helloworld/helloworld.yaml
เช่น
kubectl apply -f <(edgemicroctl -org=myorg -env=test-key=0e3ecea28a64099410594406b30e54439af5265f8 -sec=e3919250bee37c69cb2e5b41170b488e1c1d -conf=/Users/jdoe/.edgemicro/myorg-test-config.yaml -img=gcr.io/myproject/edgemicroplugins:latest -svc=samples/helloworld/helloworld.yaml)
ทดสอบปลั๊กอิน เรียกใช้ API บริการเพื่อดูว่า คุณได้รับลักษณะการทำงานตามที่คาดไว้หรือไม่ ตัวอย่างเช่น สำหรับปลั๊กอิน "ตัวพิมพ์ใหญ่ของการตอบกลับ" ข้อความตอบกลับจะถูกแปลงเป็นตัวพิมพ์ใหญ่ทั้งหมด ตามที่แสดงด้านล่าง
curl $GATEWAY_IP -H 'x-api-key:3eqeedJRFLlCshwWBiXq4xKFoH1Se3xR'
เอาต์พุต:
HELLO WORLD
การเปลี่ยนแปลงการกำหนดค่า Edge Microgateway
ในบางกรณี คุณอาจต้องแก้ไขการกำหนดค่า Edge Microgateway ตัวอย่างเช่น คุณอาจต้องการเพิ่มปลั๊กอินใหม่ไปยัง Edge Microgateway หรือเปลี่ยนพารามิเตอร์การกำหนดค่า ส่วนนี้อธิบายวิธีสร้างและใช้การเปลี่ยนแปลงการกำหนดค่ากับ Edge Microgateway ที่ทำงานใน Kubernetes
สร้างไฟล์การกำหนดค่า
secret.yaml
ดังที่แสดงด้านล่างapiVersion: v1 kind: Secret metadata: name: mgwsecret type: Opaque data: mgorg: EDGEMICRO_ORG mgenv: EDGEMICRO_ENV mgkey: EDGEMICRO_KEY mgsecret: EDGEMICRO_SECRET mgconfig: EDGEMICRO_CONFIG
ระบุค่าที่เข้ารหัส base64 ของ
EDGEMICRO_ORG
,EDGEMICRO_ENV
,EDGEMICRO_KEY
,EDGEMICRO_SECRET
:echo -n "your-org" | base64 | tr -d '\n'
echo -n "your-org-env" | base64 | tr -d '\n'
echo -n "your-mg-key" | base64 | tr -d '\n'
echo -n "your-mg-secret" | base64 | tr -d '\n'
ทำการเปลี่ยนแปลงไฟล์การกำหนดค่า Edge Microgateway สำหรับองค์กรและสภาพแวดล้อม โดยทำดังนี้
$HOME/.edgemicro/your_org-your_env-config.yaml
เข้ารหัส Base64 เป็น 2 เท่าของเนื้อหาของไฟล์การกำหนดค่า
cat $HOME/.edgemicro/org-env-config.yaml | base64 | tr -d '\n' | base64 | tr -d '\n'
ใช้การเปลี่ยนแปลงกับ Kubernetes บนเนมสเปซที่บริการทำงานอยู่
kubectl apply -f secret.yaml -n
พ็อด Microgateway ที่มีอยู่จะไม่จับการเปลี่ยนแปลงใหม่เหล่านี้โดยอัตโนมัติ แต่พ็อดใหม่จะได้รับการเปลี่ยนแปลง คุณสามารถลบพ็อดที่มีอยู่ เพื่อให้การติดตั้งใช้งานสร้างพ็อดใหม่ที่รับการเปลี่ยนแปลง
ตัวอย่างบริการ
ตัวอย่างต่อไปนี้จะแสดงวิธีอัปเดตการทำให้บริการใช้งานได้ด้วย
รับพ็อด
kubectl get pods
ตัวอย่างเอาต์พุต
NAME READY STATUS RESTARTS AGE edge-microgateway-57ccc7776b-g7nrg 1/1 Running 0 19h helloworld-6987878fc4-cltc2 1/1 Running 0 1d
ลบพ็อด
edge-microgateway
kubectl delete pod edge-microgateway-57ccc7776b-g7nrg
ตัวอย่างเอาต์พุต
pod "edge-microgateway-57ccc7776b-g7nrg" deleted
รับพ็อดอีกครั้ง พ็อดใหม่จะปรากฏขึ้นและเปลี่ยนการกำหนดค่า
kubectl get pods
ตัวอย่างเอาต์พุต
NAME READY STATUS RESTARTS AGE edge-microgateway-57ccc7776b-7f6tc 1/1 Running 0 5s helloworld-6987878fc4-cltc2 1/1 Running 0 1d
ปรับขนาดการทำให้ใช้งานได้
ส่วนนี้จะอธิบายวิธีใช้หลักการการปรับขนาดของ Kubernetes เพื่อปรับขนาดการทำให้ใช้งานได้
การปรับขนาดการทำให้บริการใช้งานได้
ตรวจสอบการติดตั้งใช้งานดังนี้
kubectl get deployments
ตัวอย่างเอาต์พุต
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE edge-microgateway 1 1 1 1 18h helloworld 1 1 1 1 1d
เอาต์พุตจะระบุว่ามีการใช้ตัวจำลอง 1 รายการ
ปรับขนาดการติดตั้งใช้งานจากตัวจำลอง 1 ตัวเป็นตัวจำลองได้มากเท่าที่ต้องการ ในตัวอย่างนี้ บริการ
edge-microgateway
มีการปรับขนาดkubectl scale deployment edge-microgateway --replicas=2
(ไม่บังคับ) หากต้องการใช้การปรับขนาดอัตโนมัติ ให้ใช้คำสั่งนี้
kubectl autoscale deployment edge-microgateway --cpu-percent=50 --min=1 --max=10
ตรวจสอบการทำให้ใช้งานได้เพื่อยืนยันว่ามีการเปิดใช้การปรับขนาดแล้ว
kubectl get deployments
ตัวอย่างเอาต์พุต
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE edge-microgateway 2 2 2 2 18h helloworld 1 1 1 1 1d
รัฐได้มีการเปลี่ยนแปลงให้รวมเมืองจำลอง 2 แห่ง
ตรวจสอบพ็อดโดยทำดังนี้
kubectl get pods
ตัวอย่างเอาต์พุต
NAME READY STATUS RESTARTS AGE edge-microgateway-57ccc7776b-g7nrg 1/1 Running 0 18h edge-microgateway-57ccc7776b-rvfz4 1/1 Running 0 41s helloworld-6987878fc4-cltc2 1/1 Running 0 1d
เอาต์พุตจะแสดงให้เห็นว่าตัวจำลองทั้ง 2 รายการอยู่ในสถานะทำงานอยู่
ใช้เนมสเปซสำหรับการกำหนดค่า Edge Microgateway หลายรายการ
คุณอาจทำให้ใช้งานได้และกำหนดค่าบริการ Edge Microgateway หลายรายการกับคลัสเตอร์ Kubernetes กรณีการใช้งานนี้ให้คุณกำหนดค่าอินสแตนซ์ Microgateway แต่ละรายการด้วยชุดปลั๊กอินและพารามิเตอร์ของตนเอง เช่น
- Edge Microgateway Service A ต้องใช้เฉพาะปลั๊กอินการตรึงการเพิ่มขึ้นเท่านั้น
- Edge Microgateway Service B กำหนดให้ใช้โควต้าและปลั๊กอิน OAuth แต่ไม่จำเป็นต้องระงับการขัดขวาง
หากต้องการแก้ไขกรณีการใช้งานนี้ ให้ใช้ Namespace ของ Kubernetes ตัวอย่างเช่น คุณอาจทำให้
Edge Microgateway Service A ใช้งานได้กับเนมสเปซ foo
และ Edge Microgateway Service B เป็น
เนมสเปซ bar
ในตัวอย่างต่อไปนี้ Edge Microgateway ที่กำหนดค่าในองค์กร OrgA
จะถูกทำให้เป็นบริการในเนมสเปซ foo
โดยใช้ตัวเลือก -n
kubectl apply -f <(edgemicroctl -org=myorgA -env=test-key=0e3ecea28a64099410594406b30e54439af5265f8 -sec=e3919250bee37c69cb2e5b41170b488e1c1d -conf=/Users/joed/.edgemicro/orgA-test-config.yaml -svc=samples/helloworld/helloworld.yaml) -n foo
ในทำนองเดียวกัน ในตัวอย่างต่อไปนี้ Edge Microgateway ที่กำหนดค่าในองค์กร OrgB
จะถูกทำให้เป็นบริการในเนมสเปซ bar
โดยใช้ตัวเลือก -n
kubectl apply -f <(edgemicroctl -org=myorgB -env=test-key=0e3ecea28a64099410594406b30e54439af5265f8 -sec=e3919250bee37c69cb2e5b41170b488e1c1d -conf=/Users/joed/.edgemicro/orgB-test-config.yaml -svc=samples/helloworld/helloworld.yaml) -n bar