<ph type="x-smartling-placeholder"></ph>
您正在查看 Apigee Edge 文档。
转到
Apigee X 文档。 信息
添加自定义插件
您可以通过编写自定义 插件。自定义插件可让您以程序化方式与请求进行交互 和通过微网关的响应
本部分介绍如何封装插件并将其部署到 Edge Microgateway Kubernetes 集群中运行的一个实例。
本部分的其余内容假定 熟悉如何编写和配置 适用于标准 Edge Microgateway 设置的插件。如果不是,请参阅开发自定义插件。
打包插件
如需打包自定义插件,请按以下步骤操作:
根据编写简单插件中的说明编写和测试您的插件。
将插件代码放置在适当的目录结构中。插件目录必须遵循 set 结构。以下示例展示了 结构,其中
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 映像
- 在 ZIP 文件所在的同一目录中,新建一个名为
Dockerfile
的文件。 将以下代码添加到
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 的插件代码拉取新映像,并将其用于 创建的 Pod
如果您将 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
- 您在edgemicro configure
命令中指定的 Apigee 组织。your_environment
- 您在edgemicro configure
命令中指定的环境。configuration_key
-edgemicro configure
命令返回的键。configuration_secret
-edgemicro configure
命令返回的 Secret。config_file_path
-edgemicro configure
命令返回的 Edge Micro 配置文件的路径。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)
测试插件。调用该 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
- 您在edgemicro configure
命令中指定的 Apigee 组织。your_env
- 您在edgemicro configure
命令中指定的环境。your_key
-edgemicro configure
命令返回的键。your_secret
-edgemicro configure
命令返回的 Secret。config_file_path
-edgemicro configure
命令返回的 Edge Micro 配置文件的路径。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)
测试插件。调用服务 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
指定
EDGEMICRO_ORG
、EDGEMICRO_ENV
、EDGEMICRO_KEY
、EDGEMICRO_SECRET
的 base64 编码值: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 编码 配置文件内容:
cat $HOME/.edgemicro/org-env-config.yaml | base64 | tr -d '\n' | base64 | tr -d '\n'
将更改应用于运行服务的命名空间中的 Kubernetes。
kubectl apply -f secret.yaml -n
现有的 Microgateway Pod 不会自动获取这些新更改;不过, 新 Pod 将获取更改您可以删除现有 Pod Deployment 会创建一个新 Pod 来获取更改
服务示例
以下示例说明了如何使用
获取 Pod。
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
pod。kubectl delete pod edge-microgateway-57ccc7776b-g7nrg
输出示例:
pod "edge-microgateway-57ccc7776b-g7nrg" deleted
再次获取 Pod。一个新的 Pod 将启动并获取您的配置更改。
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
输出指示已部署一个副本。
将 Deployment 从 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
状态已更改为包含两个副本。
检查 Pod:
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
输出结果显示两个副本都处于运行状态。
将命名空间用于多项 Edge Microgateway 配置
您可以将多个 Edge Microgateway 服务实例部署到 Kubernetes 集群在此使用场景中,您可以配置每个微网关实例 具有自己的一组插件和参数。例如:
- Edge Microgateway Service A 只需要使用高峰控制插件。
- Edge Microgateway Service B 需要配额和 OAuth 插件,但不需要使用高峰控制。
如需应对此使用场景,请使用 Kubernetes 命名空间。例如,您可以将
Edge Microgateway Service A 到命名空间 foo
,Edge Microgateway Service B 到命名空间 foo
命名空间 bar
。
在以下示例中,组织“OrgA
”中配置的 Edge Microgateway 将作为服务部署到命名空间
使用 -n
选项执行 foo
操作:
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
同样,在以下示例中,组织 OrgB
中配置了 Edge Microgateway
使用 -n
选项作为服务部署到命名空间 bar
:
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