3 分钟阅读 | 最后修改: 2021-12-31, 11:27:28 am

k8s 服务

添加 k8s 服务

URI

POST /admin-api/global/k8s

JSON body

  • name

    type: string

    required: yes

    description: k8s的名称

  • host

    type: string

    required: yes

    description: k8s的服务地址

  • domain

    type: string

    required: yes

    description: k8s 的域名，与 host 参数只能有一个

  • connect_timeout

    type: string

    required: yes

    description: 连接超时时间，单位秒

  • read_timeout

    type: string

    required: yes

    description: 读超时时间，单位秒

  • port

    type: integer

    required: yes

    description: k8s的服务端口

  • ssl_verify

    type: boolean

    required: yes

    description: 是否做 SSL 校验(默认否)

  • token

    type: string

    required: yes

    description: 访问 k8s 的token

请求示例

Shell

curl \
  -H "API-Token: 1df87165-3593-4eca-a910-9ac20005e6ec" \
  http://admin-site/admin-api/global/k8s \
  -d '
{
    "name":"test",
    "host":"10.68.0.1",
    "connect_timeout": 5,
    "read_timeout": 5,
    "port":443,
    "ssl_verify":false,
    "token":"eyJhbGciOiJSUzI1NiIsImtpZCI6InJOZkJvNWItMDhYOXBfUGw2czBleWxNWXZBWi1KOXFqQ05GdjVCWUdpc3cifQ.eyJpc3MiOiJrdWJlcm5ldGVzL3NlcnZpY2VhY2NvdW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9uYW1lc3BhY2UiOiJkZWZhdWx0Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZWNyZXQubmFtZSI6Im9wZW5yZXN0eS1lZGdlLXNlcnZpY2VhY2NvdW50LXRva2VuLTdkMjk5Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZXJ2aWNlLWFjY291bnQubmFtZSI6Im9wZW5yZXN0eS1lZGdlLXNlcnZpY2VhY2NvdW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZXJ2aWNlLWFjY291bnQudWlkIjoiYjkzZTI0MzAtNGFjMi00Y2ZjLWExYzktNzEyZjMxZmM4ZTUzIiwic3ViIjoic3lzdGVtOnNlcnZpY2VhY2NvdW50OmRlZmF1bHQ6b3BlbnJlc3R5LWVkZ2Utc2VydmljZWFjY291bnQifQ.I0x3A0Z1Oe_WQVKtCooYqas6JcQbvSxd0sFpFLecLT4vACDFyB3TsxAoVg1WPIzIue-VXoWUSij9Fa-RCHM_5k_mbY9nyuaJDjq8ziMZdlOHHRcgoACcCjUIK_2-o0D8PaNpHs5X3JZYmbQTXMMjs81Sd0sNsSJ2XIvhwN4Qkg9FCngFxPf_xBWYUh8EbMALde53GyB3LgKwgXu_538skCvoH2SGWXCr6oYc7W1wngHrrmy7Wzq_NlTlL-hQtEz9ST8Rik1zHbItrfQpgmW4d2UOrZ6IL91ZpKDGNS4gNt7pJ8opEvMascg92O28H9Y9kAIgJtOZFBHSQl10DADHBw"
}
'

响应示例

Status: 200 OK

{
    "data": {
        "id": 1
    },
    "status": 0
}

查询 k8s 服务列表

URI

GET /admin-api/global/k8s

JSON body

请求示例

Shell

curl \
  -H "API-Token: 1df87165-3593-4eca-a910-9ac20005e6ec" \
  http://admin-site/admin-api/global/k8s

响应示例

Status: 200 OK

{
    "data": [
        {
            "id" : 1,
            "name":"test",
            "host":"10.68.0.1",
            "port":443,
            "connect_timeout": 5,
            "read_timeout": 5,
            "ssl_verify":false,
            "status" : "NORMAL"
        }
    ],
    "status": 0
}

查询单个 k8s 服务信息

URI

GET /admin-api/global/k8s/{id}

JSON body

请求示例

Shell

curl \
  -H "API-Token: 1df87165-3593-4eca-a910-9ac20005e6ec" \
  http://admin-site/admin-api/global/k8s/1

响应示例

Status: 200 OK

{
    "data": {
            "id" : 1,
            "name":"test",
            "host":"10.68.0.1",
            "connect_timeout": 5,
            "read_timeout": 5,
            "port":443,
            "ssl_verify":false,
            "status" : "NORMAL",
    },
    "status": 0
}

更新单个 k8s 服务信息

URI

PUT /admin-api/global/k8s/{id}

JSON body

  • name

    type: string

    required: yes

    description: k8s的名称

  • host

    type: string

    required: yes

    description: k8s的服务地址

  • domain

    type: string

    required: yes

    description: k8s 的域名，与 host 参数只能有一个

  • connect_timeout

    type: string

    required: yes

    description: 连接超时时间，单位秒

  • read_timeout

    type: string

    required: yes

    description: 读超时时间，单位秒

  • port

    type: integer

    required: yes

    description: k8s的服务端口

  • ssl_verify

    type: boolean

    required: yes

    description: 是否做 SSL 校验(默认否)

  • token

    type: string

    required: yes

    description: 访问 k8s 的token

请求示例

Shell

curl \
  -H "API-Token: 1df87165-3593-4eca-a910-9ac20005e6ec" \
  -XPUT http://admin-site/admin-api/global/k8s/1 \
  -d '
{
    "name":"test",
    "host":"10.68.0.1",
    "port":443,
    "ssl_verify":false,
    "token":"eyJhbGciOiJSUzI1NiIsImtpZCI6InJOZkJvNWItMDhYOXBfUGw2czBleWxNWXZBWi1KOXFqQ05GdjVCWUdpc3cifQ.eyJpc3MiOiJrdWJlcm5ldGVzL3NlcnZpY2VhY2NvdW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9uYW1lc3BhY2UiOiJkZWZhdWx0Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZWNyZXQubmFtZSI6Im9wZW5yZXN0eS1lZGdlLXNlcnZpY2VhY2NvdW50LXRva2VuLTdkMjk5Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZXJ2aWNlLWFjY291bnQubmFtZSI6Im9wZW5yZXN0eS1lZGdlLXNlcnZpY2VhY2NvdW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZXJ2aWNlLWFjY291bnQudWlkIjoiYjkzZTI0MzAtNGFjMi00Y2ZjLWExYzktNzEyZjMxZmM4ZTUzIiwic3ViIjoic3lzdGVtOnNlcnZpY2VhY2NvdW50OmRlZmF1bHQ6b3BlbnJlc3R5LWVkZ2Utc2VydmljZWFjY291bnQifQ.I0x3A0Z1Oe_WQVKtCooYqas6JcQbvSxd0sFpFLecLT4vACDFyB3TsxAoVg1WPIzIue-VXoWUSij9Fa-RCHM_5k_mbY9nyuaJDjq8ziMZdlOHHRcgoACcCjUIK_2-o0D8PaNpHs5X3JZYmbQTXMMjs81Sd0sNsSJ2XIvhwN4Qkg9FCngFxPf_xBWYUh8EbMALde53GyB3LgKwgXu_538skCvoH2SGWXCr6oYc7W1wngHrrmy7Wzq_NlTlL-hQtEz9ST8Rik1zHbItrfQpgmW4d2UOrZ6IL91ZpKDGNS4gNt7pJ8opEvMascg92O28H9Y9kAIgJtOZFBHSQl10DADHBw"
}
'

响应示例

Status: 200 OK

{
    "status": 0
}

删除 k8s 服务

URI

DELETE /admin-api/global/k8s/{id}

请求示例

Shell

curl \
  -H "API-Token: 1df87165-3593-4eca-a910-9ac20005e6ec" \
  -XDELETE http://admin-site/admin-api/global/k8s/1

响应示例

Status: 200 OK

{
    "status": 0
}

查询某个 k8s 的命名空间列表

URI

GET /admin-api/k8s/{id}/namespaces

请求示例

Shell

curl \
  -H "API-Token: 1df87165-3593-4eca-a910-9ac20005e6ec" \
  -XGET http://admin-site/admin-api/k8s/1/namespaces

响应示例

Status: 200 OK

{
    "data" : [
        "default", "kube-public", "kube-system"
    ],

    "status": 0
}

查询某个 k8s 的某个命名空间下的服务列表

URI

GET /admin-api/k8s/{id}/namespaces/{namespace}/services

请求示例

Shell

curl \
  -H "API-Token: 1df87165-3593-4eca-a910-9ac20005e6ec" \
  -XGET http://admin-site/admin-api/k8s/1/namespaces/default/services

响应示例

Status: 200 OK

{
    "data" : [
        "test-hello", "test-nginx"
    ],

    "status": 0
}

查询某个 k8s 的某个命名空间下的某个服务的服务端口列表

URI

GET /admin-api/k8s/{id}/namespaces/{namespace}/services/{service}/ports

请求示例

Shell

curl \
  -H "API-Token: 1df87165-3593-4eca-a910-9ac20005e6ec" \
  -XGET http://admin-site/admin-api/k8s/1/namespaces/default/services

响应示例

Status: 200 OK

{
    "data" : [
        80, 8080
    ],

    "status": 0
}

添加一个上游并将这个上游设置为 k8s 中的某个服务

OpenResty Edge™ 会自动从 k8s 中获取上游的节点，并实时检测上游节点的变动。

URI

POST /admin-api/applications/http/{id}/k8s_upstreams

JSON body

  • name

    type: string

    required: yes

    description: upstream的名称

  • k8s_services

    type: array

    required: yes

    description: 绑定的 k8s 服务列表

  • k8s_services.k8s

    type: integer

    required: yes

    description: k8s id

  • k8s_services.k8s_namespace

    type: string

    required: yes

    description: k8s的命名空间

  • k8s_services.k8s_service

    type: string

    required: yes

    description: k8s的服务名称

  • k8s_services.k8s_service_port

    type: string

    required: yes

    description: k8s服务的服务端口

请求示例

Shell

curl \
  -H "API-Token: 1df87165-3593-4eca-a910-9ac20005e6ec" \
  -XPOST http://admin-site/admin-api/applications/http/1/clusters \
  -d '
{
    "name":"test",
    "enable_checker": false,
    "is_k8s_service" : true,
    "k8s_services" : [
        {
            "k8s" : 1,
            "k8s_namespace" : "default",
            "k8s_service" : "test-hello",
            "k8s_service_port" : 80
        }
    ]
}
'

响应示例

Status: 200 OK

{
    "data" : {
        "id" : 1
    },
    "status": 0
}

更新一个上游并将这个上游设置为 k8s 中的某个服务

OpenResty Edge™ 会自动从 k8s 中获取上游的节点，并实时检测上游节点的变动。

URI

PUT /admin-api/applications/http/{applicationid}/clusters/{clusterid}

JSON body

  • name

    type: string

    required: yes

    description: upstream的名称

  • k8s_services

    type: array

    required: yes

    description: 这个 upstream 绑定的 k8s 服务列表

  • k8s_services.k8s

    type: integer

    required: yes

    description: k8s id

  • k8s_services.k8s_namespace

    type: string

    required: yes

    description: k8s的命名空间

  • k8s_services.k8s_service

    type: string

    required: yes

    description: k8s的服务名称

  • k8s_services.k8s_service_port

    type: string

    required: yes

    description: k8s服务的服务端口

请求示例

Shell

curl \
  -H "API-Token: 1df87165-3593-4eca-a910-9ac20005e6ec" \
  -XPUT http://admin-site/admin-api/applications/http/1/k8s_upstreams/1 \
  -d '
{
    "name":"test",
    "enable_checker": false,
    "is_k8s_service" : true,
    "k8s_services" : [
        {
            "k8s" : 1,
            "k8s_namespace" : "default",
            "k8s_service" : "test-hello",
            "k8s_service_port" : 80
        }
    ]
}
'

响应示例

Status: 200 OK

{
    "status": 0
}