งานการผสานรวม Kubernetes

คุณกําลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info

การเพิ่มปลั๊กอินที่กำหนดเอง

คุณสามารถเพิ่มฟีเจอร์และความสามารถใหม่ๆ ลงในไมโครเกตเวย์ได้โดยเขียนปลั๊กอินที่กำหนดเอง ปลั๊กอินที่กําหนดเองช่วยให้คุณโต้ตอบกับคําขอและคําตอบที่ส่งผ่านไมโครเกตเวย์แบบเป็นโปรแกรมได้

ส่วนนี้จะอธิบายวิธีแพ็กเกจและติดตั้งใช้งานปลั๊กอินในอินสแตนซ์ Edge Microgateway ที่ทำงานในคลัสเตอร์ Kubernetes

ส่วนที่เหลือของส่วนนี้จะถือว่าคุณคุ้นเคยกับการเขียนและกำหนดค่าปลั๊กอินสําหรับการตั้งค่า Edge Microgateway มาตรฐาน หากไม่ ให้ดูหัวข้อพัฒนาปลั๊กอินที่กำหนดเอง

แพ็กเกจปลั๊กอิน

หากต้องการแพ็กเกจปลั๊กอินที่กำหนดเอง ให้ทำตามขั้นตอนต่อไปนี้

  1. เขียนและทดสอบปลั๊กอินตามวิธีการในหัวข้อเขียนปลั๊กอินง่ายๆ

  2. วางโค้ดปลั๊กอินในโครงสร้างไดเรกทอรีที่เหมาะสม ไดเรกทอรีปลั๊กอินต้องเป็นไปตามโครงสร้างที่กำหนด ตัวอย่างต่อไปนี้แสดงโครงสร้างที่คุณต้องทำตาม โดยที่ response-uppercase และ request-headers คือชื่อโฟลเดอร์ที่มีโค้ดปลั๊กอินที่กำหนดเอง (ชื่อเหล่านี้เป็นเพียงตัวอย่างเท่านั้น ชื่อโฟลเดอร์ของคุณอาจแตกต่างออกไป)

    plugin
  |
  |-- plugins
    |
    |- response-uppercase
    |     |- index.js
    |     |- package.json
    |- request-headers
    |     | - index.js
          | - package.json

  3. cd ไปยังโฟลเดอร์ plugin

  4. ในโฟลเดอร์ plugin ให้ใส่ไฟล์ ZIP ของทั้งโฟลเดอร์ plugins โดยทำดังนี้

    zip -r plugins.zip plugins/

สร้างอิมเมจ Docker

  1. สร้างไฟล์ใหม่ชื่อ Dockerfile ในไดเรกทอรีเดียวกับที่มีไฟล์ ZIP อยู่

  2. เพิ่มโค้ดต่อไปนี้ลงใน 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"]

  3. สร้างอิมเมจ Docker ของ Edge Microgateway ใหม่ด้วยปลั๊กอิน แล้วพุชอิมเมจไปยังรีจิสทรี 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

อัปเดตการกำหนดค่า Microgateway ของ Edge

  1. เพิ่มปลั๊กอินลงในไฟล์การกําหนดค่า 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 จะดึงอิมเมจใหม่ที่มีโค้ดปลั๊กอินที่คุณพุชไปยังที่เก็บคอนเทนเนอร์ และใช้กับพ็อดที่สร้างขึ้นใหม่

หากคุณติดตั้งใช้งาน Edge Microgateway เป็นบริการ

ใช้คำสั่ง edgemicroctl เพื่อแทรกการกำหนดค่า Edge Microgateway ที่อัปเดตแล้ว

  1. อัปเดตการใช้งาน 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)

    where:

    • 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 ที่คุณพุชอิมเมจ Docker
    • image_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)

  2. ทดสอบปลั๊กอิน เรียกใช้ API เพื่อดูว่าคุณได้รับลักษณะการทำงานที่คาดไว้หรือไม่ ตัวอย่างเช่น สําหรับปลั๊กอิน "คำตอบตัวพิมพ์ใหญ่" ระบบจะแปลงข้อความตอบเป็นตัวพิมพ์ใหญ่ทั้งหมด ดังที่แสดงด้านล่าง

    curl $GATEWAY_IP -H 'x-api-key:3eqeedJRFLlCshwWBiXq4xKFoH1Se3xR'

    เอาต์พุต:

    HELLO WORLD
แทรกการกําหนดค่าใหม่ด้วยตนเอง

การส่งผ่านด้วยตนเองเป็นแนวทางที่ตรงไปตรงมา ซึ่งคุณแทรกการกําหนดค่าใหม่จากบรรทัดคําสั่ง

  1. เรียกใช้คำสั่งต่อไปนี้

    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)

    where:

    • 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 ที่คุณพุชอิมเมจ Docker
    • image_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)

  2. ทดสอบปลั๊กอิน เรียก API ของบริการเพื่อดูว่าคุณได้รับลักษณะการทำงานตามที่คาดไว้หรือไม่ เช่น สําหรับปลั๊กอิน "response uppercase" ระบบจะแปลงข้อความตอบกลับเป็นตัวพิมพ์ใหญ่ทั้งหมด ดังที่แสดงด้านล่าง

    curl $GATEWAY_IP -H 'x-api-key:3eqeedJRFLlCshwWBiXq4xKFoH1Se3xR'

    เอาต์พุต:

    HELLO WORLD

เปลี่ยนแปลงการกำหนดค่า Edge Microgateway

ในบางกรณี คุณอาจต้องแก้ไขการกำหนดค่า Microgateway ของ Edge เช่น คุณอาจต้องการเพิ่มปลั๊กอินใหม่ลงใน Edge Microgateway หรือเปลี่ยนพารามิเตอร์การกําหนดค่า ส่วนนี้จะอธิบายวิธีทําและนําการเปลี่ยนแปลงการกําหนดค่าไปใช้กับ Edge Microgateway ที่ทํางานใน Kubernetes

  1. สร้างไฟล์การกําหนดค่า 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

  2. ระบุค่าที่เข้ารหัส 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'

  3. ทำการเปลี่ยนแปลงในไฟล์การกําหนดค่า Edge Microgateway สําหรับองค์กรและสภาพแวดล้อมของคุณ

    $HOME/.edgemicro/your_org-your_env-config.yaml

  4. เข้ารหัส Base64 2 ครั้งสำหรับเนื้อหาของไฟล์กําหนดค่า

    cat $HOME/.edgemicro/org-env-config.yaml | base64 | tr -d '\n' | base64  | tr -d '\n'

  5. ใช้การเปลี่ยนแปลงกับ Kubernetes ในเนมสเปซที่บริการของคุณทํางานอยู่

    kubectl apply -f secret.yaml -n

พ็อด Microgateway ที่มีอยู่จะไม่รับการเปลี่ยนแปลงใหม่เหล่านี้โดยอัตโนมัติ แต่พ็อดใหม่จะได้รับการเปลี่ยนแปลง คุณสามารถลบพ็อดที่มีอยู่เพื่อให้การทําให้ใช้งานได้สร้างพ็อดใหม่ซึ่งรับการเปลี่ยนแปลง

ตัวอย่างบริการ

ตัวอย่างต่อไปนี้แสดงวิธีอัปเดตการทําให้ใช้งานได้ของบริการด้วย

  1. รับพ็อด

    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

  2. ลบพ็อด edge-microgateway

    kubectl delete pod edge-microgateway-57ccc7776b-g7nrg

    ตัวอย่างเอาต์พุต

    pod "edge-microgateway-57ccc7776b-g7nrg" deleted

  3. รับพ็อดอีกครั้ง พ็อดใหม่จะเริ่มต้นขึ้นและรับการเปลี่ยนแปลงการกําหนดค่า

    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 เพื่อปรับขนาดการนําไปใช้

การปรับขนาดการทําให้ใช้งานได้ของบริการ

  1. ตรวจสอบการติดตั้งใช้งาน

    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 รายการ

  2. ปรับขนาดการทําให้ใช้งานได้จาก 1 ไปจนถึงจํานวนที่ต้องการ ในตัวอย่างนี้ ระบบจะปรับขนาดบริการ edge-microgateway

    kubectl scale deployment edge-microgateway --replicas=2

  3. (ไม่บังคับ) หากต้องการใช้การปรับขนาดอัตโนมัติ ให้ใช้คําสั่งนี้

    kubectl autoscale deployment edge-microgateway --cpu-percent=50 --min=1 --max=10

  4. ตรวจสอบการติดตั้งใช้งานเพื่อยืนยันว่าเปิดใช้การปรับขนาดแล้ว โดยทำดังนี้

    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 รายการ

  5. ตรวจสอบพ็อด

    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 A ต้องใช้เฉพาะปลั๊กอินการป้องกันการเพิ่มขึ้นอย่างฉับพลัน
  • บริการ Microgateway ของ Edge B ต้องใช้โควต้าและปลั๊กอิน OAuth แต่ไม่ต้องใช้การหยุดการเพิ่มขึ้นอย่างฉับพลัน

หากต้องการจัดการกับกรณีการใช้งานนี้ ให้ใช้เนมสเปซ Kubernetes เช่น คุณสามารถทำให้บริการ Edge Microgateway A ใช้งานได้ในเนมสเปซ foo และทำให้บริการ Edge Microgateway 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

ในทำนองเดียวกัน ในตัวอย่างนี้ Microgateway ของ Edge ที่กําหนดค่าในองค์กร 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