feat: new deployment provider: apisix

2025-06-11 22:17:07 +08:00
parent b833d09466
commit e4bfa90a77
22 changed files with 545 additions and 0 deletions
--- a/ui/src/components/access/AccessForm.tsx
+++ b/ui/src/components/access/AccessForm.tsx
@@ -15,6 +15,7 @@ import AccessForm1PanelConfig from "./AccessForm1PanelConfig";
 import AccessFormACMECAConfig from "./AccessFormACMECAConfig";
 import AccessFormACMEHttpReqConfig from "./AccessFormACMEHttpReqConfig";
 import AccessFormAliyunConfig from "./AccessFormAliyunConfig";
+import AccessFormAPISIXConfig from "./AccessFormAPISIXConfig";
 import AccessFormAWSConfig from "./AccessFormAWSConfig";
 import AccessFormAzureConfig from "./AccessFormAzureConfig";
 import AccessFormBaiduCloudConfig from "./AccessFormBaiduCloudConfig";
@@ -194,6 +195,8 @@ const AccessForm = forwardRef<AccessFormInstance, AccessFormProps>(({ className,
        return <AccessFormACMEHttpReqConfig {...nestedFormProps} />;
      case ACCESS_PROVIDERS.ALIYUN:
        return <AccessFormAliyunConfig {...nestedFormProps} />;
+      case ACCESS_PROVIDERS.APISIX:
+        return <AccessFormAPISIXConfig {...nestedFormProps} />;
      case ACCESS_PROVIDERS.AWS:
        return <AccessFormAWSConfig {...nestedFormProps} />;
      case ACCESS_PROVIDERS.AZURE:
--- a/ui/src/components/access/AccessFormAPISIXConfig.tsx
+++ b/ui/src/components/access/AccessFormAPISIXConfig.tsx
@@ -0,0 +1,71 @@
+import { useTranslation } from "react-i18next";
+import { Form, type FormInstance, Input, Switch } from "antd";
+import { createSchemaFieldRule } from "antd-zod";
+import { z } from "zod";
+
+import { type AccessConfigForAPISIX } from "@/domain/access";
+
+type AccessFormAPISIXConfigFieldValues = Nullish<AccessConfigForAPISIX>;
+
+export type AccessFormAPISIXConfigProps = {
+  form: FormInstance;
+  formName: string;
+  disabled?: boolean;
+  initialValues?: AccessFormAPISIXConfigFieldValues;
+  onValuesChange?: (values: AccessFormAPISIXConfigFieldValues) => void;
+};
+
+const initFormModel = (): AccessFormAPISIXConfigFieldValues => {
+  return {
+    serverUrl: "http://<your-host-addr>:9180/",
+    apiKey: "",
+  };
+};
+
+const AccessFormAPISIXConfig = ({ form: formInst, formName, disabled, initialValues, onValuesChange }: AccessFormAPISIXConfigProps) => {
+  const { t } = useTranslation();
+
+  const formSchema = z.object({
+    serverUrl: z.string().url(t("common.errmsg.url_invalid")),
+    apiKey: z.string().trim().nonempty(t("access.form.apisix_api_key.placeholder")),
+    allowInsecureConnections: z.boolean().nullish(),
+  });
+  const formRule = createSchemaFieldRule(formSchema);
+
+  const handleFormChange = (_: unknown, values: z.infer<typeof formSchema>) => {
+    onValuesChange?.(values);
+  };
+
+  return (
+    <Form
+      form={formInst}
+      disabled={disabled}
+      initialValues={initialValues ?? initFormModel()}
+      layout="vertical"
+      name={formName}
+      onValuesChange={handleFormChange}
+    >
+      <Form.Item name="serverUrl" label={t("access.form.apisix_server_url.label")} rules={[formRule]}>
+        <Input placeholder={t("access.form.apisix_server_url.placeholder")} />
+      </Form.Item>
+
+      <Form.Item
+        name="apiKey"
+        label={t("access.form.apisix_api_key.label")}
+        rules={[formRule]}
+        tooltip={<span dangerouslySetInnerHTML={{ __html: t("access.form.apisix_api_key.tooltip") }}></span>}
+      >
+        <Input.Password autoComplete="new-password" placeholder={t("access.form.apisix_api_key.placeholder")} />
+      </Form.Item>
+
+      <Form.Item name="allowInsecureConnections" label={t("access.form.common_allow_insecure_conns.label")} rules={[formRule]}>
+        <Switch
+          checkedChildren={t("access.form.common_allow_insecure_conns.switch.on")}
+          unCheckedChildren={t("access.form.common_allow_insecure_conns.switch.off")}
+        />
+      </Form.Item>
+    </Form>
+  );
+};
+
+export default AccessFormAPISIXConfig;
--- a/ui/src/components/workflow/node/DeployNodeConfigForm.tsx
+++ b/ui/src/components/workflow/node/DeployNodeConfigForm.tsx
@@ -33,6 +33,7 @@ import DeployNodeConfigFormAliyunNLBConfig from "./DeployNodeConfigFormAliyunNLB
 import DeployNodeConfigFormAliyunOSSConfig from "./DeployNodeConfigFormAliyunOSSConfig";
 import DeployNodeConfigFormAliyunVODConfig from "./DeployNodeConfigFormAliyunVODConfig";
 import DeployNodeConfigFormAliyunWAFConfig from "./DeployNodeConfigFormAliyunWAFConfig";
+import DeployNodeConfigFormAPISIXConfig from "./DeployNodeConfigFormAPISIXConfig";
 import DeployNodeConfigFormAWSACMConfig from "./DeployNodeConfigFormAWSACMConfig";
 import DeployNodeConfigFormAWSCloudFrontConfig from "./DeployNodeConfigFormAWSCloudFrontConfig";
 import DeployNodeConfigFormAWSIAMConfig from "./DeployNodeConfigFormAWSIAMConfig";
@@ -234,6 +235,8 @@ const DeployNodeConfigForm = forwardRef<DeployNodeConfigFormInstance, DeployNode
          return <DeployNodeConfigFormAliyunVODConfig {...nestedFormProps} />;
        case DEPLOYMENT_PROVIDERS.ALIYUN_WAF:
          return <DeployNodeConfigFormAliyunWAFConfig {...nestedFormProps} />;
+        case DEPLOYMENT_PROVIDERS.APISIX:
+          return <DeployNodeConfigFormAPISIXConfig {...nestedFormProps} />;
        case DEPLOYMENT_PROVIDERS.AWS_ACM:
          return <DeployNodeConfigFormAWSACMConfig {...nestedFormProps} />;
        case DEPLOYMENT_PROVIDERS.AWS_CLOUDFRONT:
--- a/ui/src/components/workflow/node/DeployNodeConfigFormAPISIXConfig.tsx
+++ b/ui/src/components/workflow/node/DeployNodeConfigFormAPISIXConfig.tsx
@@ -0,0 +1,81 @@
+import { useTranslation } from "react-i18next";
+import { Form, type FormInstance, Input, Select } from "antd";
+import { createSchemaFieldRule } from "antd-zod";
+import { z } from "zod";
+
+import Show from "@/components/Show";
+
+type DeployNodeConfigFormAPISIXConfigFieldValues = Nullish<{
+  resourceType: string;
+  certificateId?: string;
+}>;
+
+export type DeployNodeConfigFormAPISIXConfigProps = {
+  form: FormInstance;
+  formName: string;
+  disabled?: boolean;
+  initialValues?: DeployNodeConfigFormAPISIXConfigFieldValues;
+  onValuesChange?: (values: DeployNodeConfigFormAPISIXConfigFieldValues) => void;
+};
+
+const RESOURCE_TYPE_CERTIFICATE = "certificate" as const;
+
+const initFormModel = (): DeployNodeConfigFormAPISIXConfigFieldValues => {
+  return {
+    resourceType: RESOURCE_TYPE_CERTIFICATE,
+    certificateId: "",
+  };
+};
+
+const DeployNodeConfigFormAPISIXConfig = ({ form: formInst, formName, disabled, initialValues, onValuesChange }: DeployNodeConfigFormAPISIXConfigProps) => {
+  const { t } = useTranslation();
+
+  const formSchema = z.object({
+    resourceType: z.literal(RESOURCE_TYPE_CERTIFICATE, {
+      message: t("workflow_node.deploy.form.apisix_resource_type.placeholder"),
+    }),
+    certificateId: z
+      .string()
+      .nullish()
+      .refine((v) => fieldResourceType !== RESOURCE_TYPE_CERTIFICATE || !!v?.trim(), t("workflow_node.deploy.form.apisix_certificate_id.placeholder")),
+  });
+  const formRule = createSchemaFieldRule(formSchema);
+
+  const fieldResourceType = Form.useWatch("resourceType", formInst);
+
+  const handleFormChange = (_: unknown, values: z.infer<typeof formSchema>) => {
+    onValuesChange?.(values);
+  };
+
+  return (
+    <Form
+      form={formInst}
+      disabled={disabled}
+      initialValues={initialValues ?? initFormModel()}
+      layout="vertical"
+      name={formName}
+      onValuesChange={handleFormChange}
+    >
+      <Form.Item name="resourceType" label={t("workflow_node.deploy.form.apisix_resource_type.label")} rules={[formRule]}>
+        <Select placeholder={t("workflow_node.deploy.form.apisix_resource_type.placeholder")}>
+          <Select.Option key={RESOURCE_TYPE_CERTIFICATE} value={RESOURCE_TYPE_CERTIFICATE}>
+            {t("workflow_node.deploy.form.apisix_resource_type.option.certificate.label")}
+          </Select.Option>
+        </Select>
+      </Form.Item>
+
+      <Show when={fieldResourceType === RESOURCE_TYPE_CERTIFICATE}>
+        <Form.Item
+          name="certificateId"
+          label={t("workflow_node.deploy.form.apisix_certificate_id.label")}
+          rules={[formRule]}
+          tooltip={<span dangerouslySetInnerHTML={{ __html: t("workflow_node.deploy.form.apisix_certificate_id.tooltip") }}></span>}
+        >
+          <Input placeholder={t("workflow_node.deploy.form.apisix_certificate_id.placeholder")} />
+        </Form.Item>
+      </Show>
+    </Form>
+  );
+};
+
+export default DeployNodeConfigFormAPISIXConfig;
--- a/ui/src/domain/access.ts
+++ b/ui/src/domain/access.ts
@@ -10,6 +10,7 @@ export interface AccessModel extends BaseModel {
      | AccessConfigForACMECA
      | AccessConfigForACMEHttpReq
      | AccessConfigForAliyun
+      | AccessConfigForAPISIX
      | AccessConfigForAWS
      | AccessConfigForAzure
      | AccessConfigForBaiduCloud
@@ -105,6 +106,12 @@ export type AccessConfigForAliyun = {
  resourceGroupId?: string;
 };

+export type AccessConfigForAPISIX = {
+  serverUrl: string;
+  apiKey: string;
+  allowInsecureConnections?: boolean;
+};
+
 export type AccessConfigForAWS = {
  accessKeyId: string;
  secretAccessKey: string;
--- a/ui/src/domain/provider.ts
+++ b/ui/src/domain/provider.ts
@@ -8,6 +8,7 @@ export const ACCESS_PROVIDERS = Object.freeze({
  ACMECA: "acmeca",
  ACMEHTTPREQ: "acmehttpreq",
  ALIYUN: "aliyun",
+  APISIX: "apisix",
  AWS: "aws",
  AZURE: "azure",
  BAIDUCLOUD: "baiducloud",
@@ -141,6 +142,7 @@ export const accessProvidersMap: Map<AccessProvider["type"] | string, AccessProv
    [ACCESS_PROVIDERS.LECDN, "provider.lecdn", "/imgs/providers/lecdn.svg", [ACCESS_USAGES.HOSTING]],
    [ACCESS_PROVIDERS.CACHEFLY, "provider.cachefly", "/imgs/providers/cachefly.png", [ACCESS_USAGES.HOSTING]],
    [ACCESS_PROVIDERS.EDGIO, "provider.edgio", "/imgs/providers/edgio.svg", [ACCESS_USAGES.HOSTING]],
+    [ACCESS_PROVIDERS.APISIX, "provider.apisix", "/imgs/providers/apisix.svg", [ACCESS_USAGES.HOSTING]],
    [ACCESS_PROVIDERS.PROXMOXVE, "provider.proxmoxve", "/imgs/providers/proxmoxve.svg", [ACCESS_USAGES.HOSTING]],

    [ACCESS_PROVIDERS.CLOUDFLARE, "provider.cloudflare", "/imgs/providers/cloudflare.svg", [ACCESS_USAGES.DNS]],
@@ -387,6 +389,7 @@ export const DEPLOYMENT_PROVIDERS = Object.freeze({
  ALIYUN_OSS: `${ACCESS_PROVIDERS.ALIYUN}-oss`,
  ALIYUN_VOD: `${ACCESS_PROVIDERS.ALIYUN}-vod`,
  ALIYUN_WAF: `${ACCESS_PROVIDERS.ALIYUN}-waf`,
+  APISIX: `${ACCESS_PROVIDERS.APISIX}`,
  AWS_ACM: `${ACCESS_PROVIDERS.AWS}-acm`,
  AWS_CLOUDFRONT: `${ACCESS_PROVIDERS.AWS}-cloudfront`,
  AWS_IAM: `${ACCESS_PROVIDERS.AWS}-iam`,
@@ -585,6 +588,7 @@ export const deploymentProvidersMap: Map<DeploymentProvider["type"] | string, De
    [DEPLOYMENT_PROVIDERS.BAOTAWAF_SITE, "provider.baotawaf.site", DEPLOYMENT_CATEGORIES.FIREWALL],
    [DEPLOYMENT_PROVIDERS.BAOTAWAF_CONSOLE, "provider.baotawaf.console", DEPLOYMENT_CATEGORIES.OTHER],
    [DEPLOYMENT_PROVIDERS.SAFELINE, "provider.safeline", DEPLOYMENT_CATEGORIES.FIREWALL],
+    [DEPLOYMENT_PROVIDERS.APISIX, "provider.apisix", DEPLOYMENT_CATEGORIES.APIGATEWAY],
    [DEPLOYMENT_PROVIDERS.PROXMOXVE, "provider.proxmoxve", DEPLOYMENT_CATEGORIES.NAS],
  ].map(([type, name, category, builtin]) => [
    type,
--- a/ui/src/i18n/locales/en/nls.access.json
+++ b/ui/src/i18n/locales/en/nls.access.json
@@ -72,6 +72,11 @@
  "access.form.aliyun_resource_group_id.label": "Aliyun resource group ID (Optional)",
  "access.form.aliyun_resource_group_id.placeholder": "Please enter Aliyun resource group ID",
  "access.form.aliyun_resource_group_id.tooltip": "For more information, see <a href=\"https://www.alibabacloud.com/help/en/resource-management/product-overview\" target=\"_blank\">https://www.alibabacloud.com/help/en/resource-management/product-overview</a>",
+  "access.form.apisix_server_url.label": "APISIX server URL",
+  "access.form.apisix_server_url.placeholder": "Please enter APISIX server URL",
+  "access.form.apisix_api_key.label": "APISIX Admin API key",
+  "access.form.apisix_api_key.placeholder": "Please enter APISIX Admin API key",
+  "access.form.apisix_api_key.tooltip": "For more information, see <a href=\"https://apisix.apache.org/docs/apisix/admin-api/\" target=\"_blank\">https://apisix.apache.org/docs/apisix/admin-api/</a>",
  "access.form.aws_access_key_id.label": "AWS AccessKeyId",
  "access.form.aws_access_key_id.placeholder": "Please enter AWS AccessKeyId",
  "access.form.aws_access_key_id.tooltip": "For more information, see <a href=\"https://docs.aws.amazon.com/en_us/IAM/latest/UserGuide/id_credentials_access-keys.html\" target=\"_blank\">https://docs.aws.amazon.com/en_us/IAM/latest/UserGuide/id_credentials_access-keys.html</a>",
--- a/ui/src/i18n/locales/en/nls.provider.json
+++ b/ui/src/i18n/locales/en/nls.provider.json
@@ -24,6 +24,7 @@
  "provider.aliyun.waf": "Alibaba Cloud - WAF (Web Application Firewall)",
  "provider.akamai": "Akamai",
  "provider.akamai.cdn": "Akamai - CDN (Content Delivery Network)",
+  "provider.apisix": "Apache APISIX",
  "provider.aws": "AWS",
  "provider.aws.acm": "AWS - ACM (Amazon Certificate Manager)",
  "provider.aws.cloudfront": "AWS - CloudFront",
--- a/ui/src/i18n/locales/en/nls.workflow.nodes.json
+++ b/ui/src/i18n/locales/en/nls.workflow.nodes.json
@@ -285,6 +285,12 @@
  "workflow_node.deploy.form.aliyun_waf_domain.label": "Alibaba Cloud WAF domain (Optional)",
  "workflow_node.deploy.form.aliyun_waf_domain.placeholder": "Please enter Alibaba Cloud WAF domain name",
  "workflow_node.deploy.form.aliyun_waf_domain.tooltip": "For more information, see <a href=\"https://waf.console.aliyun.com\" target=\"_blank\">https://waf.console.aliyun.com</a>",
+  "workflow_node.deploy.form.apisix_resource_type.label": "Resource type",
+  "workflow_node.deploy.form.apisix_resource_type.placeholder": "Please select resource type",
+  "workflow_node.deploy.form.apisix_resource_type.option.certificate.label": "SSL certificate",
+  "workflow_node.deploy.form.apisix_certificate_id.label": "APISIX certificate ID",
+  "workflow_node.deploy.form.apisix_certificate_id.placeholder": "Please enter APISIX certificate ID",
+  "workflow_node.deploy.form.apisix_certificate_id.tooltip": "You can find it on APISIX WebUI.",
  "workflow_node.deploy.form.aws_acm_region.label": "AWS ACM Region",
  "workflow_node.deploy.form.aws_acm_region.placeholder": "Please enter AWS ACM region (e.g. us-east-1)",
  "workflow_node.deploy.form.aws_acm_region.tooltip": "For more information, see <a href=\"https://docs.aws.amazon.com/en_us/general/latest/gr/rande.html#regional-endpoints\" target=\"_blank\">https://docs.aws.amazon.com/en_us/general/latest/gr/rande.html#regional-endpoints</a>",
--- a/ui/src/i18n/locales/zh/nls.access.json
+++ b/ui/src/i18n/locales/zh/nls.access.json
@@ -72,6 +72,11 @@
  "access.form.aliyun_resource_group_id.label": "阿里云资源组 ID（可选）",
  "access.form.aliyun_resource_group_id.placeholder": "请输入阿里云资源组 ID",
  "access.form.aliyun_resource_group_id.tooltip": "这是什么？请参阅 <a href=\"https://help.aliyun.com/zh/resource-management/resource-group/product-overview\" target=\"_blank\">https://help.aliyun.com/zh/resource-management/resource-group/product-overview</a>",
+  "access.form.apisix_server_url.label": "APISIX 服务地址",
+  "access.form.apisix_server_url.placeholder": "请输入 APISIX 服务地址",
+  "access.form.apisix_api_key.label": "APISIX Admin API Key",
+  "access.form.apisix_api_key.placeholder": "请输入 APISIX Admin API Key",
+  "access.form.apisix_api_key.tooltip": "这是什么？请参阅 <a href=\"https://apisix.apache.org/zh/docs/apisix/admin-api/\" target=\"_blank\">https://apisix.apache.org/zh/docs/apisix/admin-api/</a>",
  "access.form.aws_access_key_id.label": "AWS AccessKeyId",
  "access.form.aws_access_key_id.placeholder": "请输入 AWS AccessKeyId",
  "access.form.aws_access_key_id.tooltip": "这是什么？请参阅 <a href=\"https://docs.aws.amazon.com/zh_cn/IAM/latest/UserGuide/id_credentials_access-keys.html\" target=\"_blank\">https://docs.aws.amazon.com/zh_cn/IAM/latest/UserGuide/id_credentials_access-keys.html</a>",
--- a/ui/src/i18n/locales/zh/nls.provider.json
+++ b/ui/src/i18n/locales/zh/nls.provider.json
@@ -24,6 +24,7 @@
  "provider.aliyun.waf": "阿里云 - Web 应用防火墙 WAF",
  "provider.akamai": "Akamai",
  "provider.akamai.cdn": "Akamai - 内容分发网络 CDN",
+  "provider.apisix": "Apache APISIX",
  "provider.aws": "AWS",
  "provider.aws.acm": "AWS - ACM (Amazon Certificate Manager)",
  "provider.aws.cloudfront": "AWS - CloudFront",
--- a/ui/src/i18n/locales/zh/nls.workflow.nodes.json
+++ b/ui/src/i18n/locales/zh/nls.workflow.nodes.json
@@ -284,6 +284,12 @@
  "workflow_node.deploy.form.aliyun_waf_domain.label": "阿里云 WAF 接入域名（可选）",
  "workflow_node.deploy.form.aliyun_waf_domain.placeholder": "请输入阿里云 WAF 接入域名（支持泛域名）",
  "workflow_node.deploy.form.aliyun_waf_domain.tooltip": "这是什么？请参阅 <a href=\"https://waf.console.aliyun.com\" target=\"_blank\">waf.console.aliyun.com</a><br><br>不填写时，将替换实例的默认证书；否则，将替换扩展域名证书。",
+  "workflow_node.deploy.form.apisix_resource_type.label": "证书部署方式",
+  "workflow_node.deploy.form.apisix_resource_type.placeholder": "请选择证书部署方式",
+  "workflow_node.deploy.form.apisix_resource_type.option.certificate.label": "替换指定证书",
+  "workflow_node.deploy.form.apisix_certificate_id.label": "APISIX 证书 ID",
+  "workflow_node.deploy.form.apisix_certificate_id.placeholder": "请输入 APISIX 证书 ID",
+  "workflow_node.deploy.form.apisix_certificate_id.tooltip": "请登录 APISIX 控制台查看。",
  "workflow_node.deploy.form.aws_acm_region.label": "AWS ACM 服务区域",
  "workflow_node.deploy.form.aws_acm_region.placeholder": "请输入 AWS ACM 服务区域（例如：us-east-1）",
  "workflow_node.deploy.form.aws_acm_region.tooltip": "这是什么？请参阅 <a href=\"https://docs.aws.amazon.com/zh_cn/general/latest/gr/rande.html#regional-endpoints\" target=\"_blank\">https://docs.aws.amazon.com/zh_cn/general/latest/gr/rande.html#regional-endpoints</a>",