WSO2 APK - 适用于 Kubernetes 的 API 平台

APK 是适用于 Kubernetes 的 API 平台，是一款尖端的 API 管理解决方案，旨在利用 Kubernetes 的强大功能实现无缝和可扩展的部署。APK 利用 Kubernetes 的原生特性，根据负载和可配置参数实现自动扩展，利用丰富的 Kubernetes 指标。

APK 强大的网关解决方案的核心是精心选择的 Envoy 技术，以其卓越的性能、轻量级特性和与 APK 生态系统的完美兼容性而闻名。APK 超越了传统网关的范畴，通过专门构建的扩展解决特定的 API 管理用例。其中一些扩展已贡献回 Envoy 社区，体现了我们对协作创新的承诺。

WSO2 APK 遵循 Kubernetes 网关 API 规范，这是由 SIG-NETWORK 社区管理的开源项目。该规范引入了重要资源，如 GatewayClass、Gateway、HTTPRoute、TCPRoute 和 Service，增强了 Kubernetes 中的服务网络功能。通过遵循这一规范，WSO2 APK 与 Kubernetes 服务网络无缝集成，利用富有表现力和可扩展的接口来增强 Kubernetes 部署中的 API 管理功能。

APK 的一些特点

APK 的微服务架构提供了易于扩展和无缝升级等优势，充分利用该架构的敏捷性和灵活性。
APK 中控制平面和数据平面的分离允许用户集成任何他们选择的控制平面，提供最大的灵活性和定制化。
APK 是一个不断发展的开源解决方案，提供先进的 API 管理功能，专为云原生架构设计，与 Kubernetes 无缝集成。
通过无缝的 CI/CD 集成，APK 支持简化的 GitOps 方法，实现高效的 API 部署和管理。
APK 旨在提供 API 市场功能，实现 API 的共享、发现和可重用性，同时关注高效的治理和管理。
凭借其 Kubernetes 原生方法、卓越的特性、微服务架构以及对协作和创新的承诺，APK 为 API 管理设立了新标准。

有关 APK 发布计划和项目管理信息，请访问 APK 项目仪表板

有关 WSO2 API 管理平台的详细信息，请访问 WSO2 API 管理

要向我们的社区提问并获得帮助，请访问 WSO2 Discord

要了解如何参与我们的整体社区，请访问我们的社区页面

在本 README 中：

简介
入门
问题管理

您可以在我们的文档中找到许多其他有用的文档。

简介

APK 是一个开源平台，用于在 Kubernetes 集群管理平台上提供完整的 API 管理功能。

APK 由以下组件组成：

APK 架构包括控制平面和数据平面组件。在数据平面中，我们有配置服务，这是一个开放的 API，用于根据输入（如 OpenAPI 模式文件）生成 APK 配置和 Kubernetes API 工件。部署服务允许在网关运行时创建 API 工件，需要有效的访问令牌进行安全部署。

这些组件有效地生成配置并在数据平面中部署 API 工件。网关分区包括路由器、执行器和管理客户端。路由器拦截 API 流量，应用 QoS 策略以获得最佳性能。执行器处理身份验证和授权，确保授权访问。管理客户端配置和同步路由器和执行器，确保网关分区的顺畅运行。

该架构还包括速率限制服务，用于管理 API 调用的速率限制。路由器与速率限制器通信以强制执行配额合规。为了在网关之间实现分布式计数器，Redis 作为速率限制的共享信息存储。

测试产品 API

WSO2 APK 提供了 Postman 集合来测试产品 API，开发人员可以使用 API 请求集合并配置它们以测试不同的场景。例如，他们可以重用可用的请求来验证 API 是否为不同的请求返回正确的响应。这些测试将允许用户在使用之前识别潜在的问题或错误。请参阅存储库的 Postman 测试部分，了解有关测试和测试工件的更多信息。

入门

要尝试 APK，请参阅此文档。

在开始之前...

安装 Helm（3.11.x）和 Kubernetes 客户端。
设置 Kubernetes 集群。如果您想在本地运行，可以使用 Minikube 或 Kind 或类似软件。

设置部署命名空间。

kubectl create namespace <命名空间>

部署 APK DS 服务器和 CloudNativePG 的步骤

HELM-HOME = apk/helm-charts

执行 helm repo add bitnami https://charts.bitnami.com/bitnami 和 helm repo add jetstack https://charts.jetstack.io。
克隆存储库并进入 HELM-HOME 文件夹。
执行 helm dependency build 命令下载依赖图表。
现在执行 helm install apk-test . 安装 APK 组件。

可选

要仅部署控制平面组件，使用 --set wso2.apk.dp.enabled=false

要仅部署数据平面组件，使用 --set wso2.apk.cp.enabled=false
通过执行 kubectl get pods 验证部署

通过本地机器访问部署

您可以识别网关服务的外部 IP 地址，通过 APK 网关调用 API
```
kubectl get svc | grep gateway-service
```

或者，将端口转发到路由器服务以使用 localhost。

kubectl port-forward svc/apk-test-wso2-apk-gateway-service 9095:9095

使用 Kubernetes 客户端快速启动 APK

按照以下说明使用 kubectl 部署 API。

创建 API CR 并创建生产和/或沙箱 HTTPRoute CR，以及 API 后端的服务。您可以在此存储库的 developer/tryout/samples/ 文件夹中找到示例 CR 集。
使用 kubectl 将 CR 应用到 Kubernetes API 服务器。
```
kubectl apply -f developer/tryout/samples/
```
注意

服务应在与 APK 或 Kubernetes 系统命名空间不同的命名空间中创建。

API 应在 APK 部署命名空间中创建。

在以下命令中，将 {router_service} 替换为路由器服务的外部 IP。

获取令牌以调用系统 API。

ACCESS_TOKEN=$(curl --location --request POST "https://{router_service}:9095/oauth2/token" \
--header "Host: idp.am.wso2.com" \
--header "Authorization: Basic NDVmMWM1YzgtYTkyZS0xMWVkLWFmYTEtMDI0MmFjMTIwMDAyOjRmYmQ2MmVjLWE5MmUtMTFlZC1hZmExLTAyNDJhYzEyMDAwMg==" \
--header "Content-Type: application/x-www-form-urlencoded" \
--data-urlencode "grant_type=client_credentials" | jq -r ".access_token")

列出创建的 API 并检索 API 的 id。

curl --location --request GET "https://{router_service}:9095/api/runtime/apis" \
--header "Host: api.am.wso2.com" \
--header "Authorization: Bearer $ACCESS_TOKEN"

获取令牌以调用创建的 API。在以下命令中，将 {api_id} 替换为 API 的 id。

INTERNAL_KEY=$(curl --location --request POST "https://{router_service}:9095/api/runtime/apis/{api_id}/generate-key" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Host: api.am.wso2.com" \
--header "Authorization: Bearer $ACCESS_TOKEN" | jq -r ".apikey")

调用 API。

curl --location --request GET "https://{router_service}:9095/http-bin-api/1.0.8/get" \
--header "HOST: gw.wso2.com" \
--header "Internal-Key: $INTERNAL_KEY"

在 APK 中使用 Postman 运行域服务 API

测试 Postman 集合

构建 APK 组件

前提条件

安装 Java JDK 11。
安装 Gradle（7.5.1）。
安装 Ballerina 版本：2201.8.5（Swan Lake Update 8）。
安装 Go。
安装 Lua。
Docker 运行时正在运行。

构建所有组件

运行 apk/build-apk.sh 文件。

sh build-apk.sh

构建单个组件

例如：构建运行时域服务

cd runtime/runtime-domain-service
gradle build

问题管理

我们使用 GitHub 来跟踪所有错误和功能请求。我们跟踪的每个问题都有各种元数据：

Epic。一个 epic 代表 APK 整体的一个功能区域。Epic 的范围相当广泛，基本上是产品级别的东西。每个问题最终都是一个 epic 的一部分。
里程碑。每个问题都被分配一个里程碑。这是 0.1、0.2、...，或"遥远的未来"。里程碑表示我们认为应该在何时解决该问题。
优先级。每个问题都有一个优先级，由优先级排序项目中的列表示。优先级可以是 P1、P2 或 >P2。优先级表示在里程碑内解决问题的重要性。P1 表示如果问题未解决，则不能认为里程碑已实现。