3.5. 使用操作器部署 APIcast 网关自助管理解决方案

流程

1. 创建一个包含 3scale 系统管理门户端点信息的 OpenShift secret：

   $ oc create secret generic ${SOME_SECRET_NAME} --from-literal=AdminPortalURL=${MY_3SCALE_URL}

   • ${SOME_SECRET_NAME} 是 secret 的名称，只要它与现有 secret 不冲突，可以是您想要的任何名称。

   • ${MY_3SCALE_URL} 是包含 3scale 访问令牌和 3scale 系统门户端点的 URI。如需了解更多详细信息，请参阅 THREESCALE_PORTAL_ENDPOINT

     示例

     $ oc create secret generic 3scaleportal --from-literal=AdminPortalURL=https://access-token@account-admin.3scale.net

     有关机密内容的更多信息，请参阅 管理门户配置 secret 参考。

2. 为 APIcast 创建 OpenShift 对象

   apiVersion: apps.3scale.net/v1alpha1
   kind: APIcast
   metadata:
     name: example-apicast
   spec:
     adminPortalCredentialsRef:
       name: SOME_SECRET_NAME

   spec.adminPortalCredentialsRef.name 必须是包含 3scale 系统管理门户端点信息的现有 OpenShift secret 的名称。

3. 确认与 APIcast 对象关联的 OpenShift Deployment 的 readyReplicas 字段是否为 1，以验证 APIcast 容器集正在运行并已就绪。或者，等待字段设置为：

   $ echo $(oc get deployment apicast-example-apicast -o jsonpath='{.status.readyReplicas}')
   1

流程

1. 使用配置文件创建 secret：

   $ curl https://raw.githubusercontent.com/3scale/APIcast/master/examples/configuration/echo.json -o $PWD/config.json
   
   $ oc create secret generic apicast-echo-api-conf-secret --from-file=$PWD/config.json

   配置文件必须名为 config.json。这是一个 APIcast CRD 引用 要求。

   有关机密内容的更多信息，请参阅 管理门户配置 secret 参考。

2. 创建 APIcast 自定义资源 ：

   $ cat my-echo-apicast.yaml
   apiVersion: apps.3scale.net/v1alpha1
   kind: APIcast
   metadata:
     name: my-echo-apicast
   spec:
     exposedHost:
       host: YOUR DOMAIN
     embeddedConfigurationSecretRef:
       name: apicast-echo-api-conf-secret
   
   $ oc apply -f my-echo-apicast.yaml

   1. 以下是嵌入式配置 secret 的示例：

      apiVersion: v1
      kind: Secret
      metadata:
        name: SOME_SECRET_NAME
      type: Opaque
      stringData:
        config.json: |
          {
            "services": [
              {
                "proxy": {
                  "policy_chain": [
                    { "name": "apicast.policy.upstream",
                      "configuration": {
                        "rules": [{
                          "regex": "/",
                          "url": "http://echo-api.3scale.net"
                        }]
                      }
                    }
                  ]
                }
              }
            ]
          }

3. 在创建 APIcast 对象时设置以下内容：

   apiVersion: apps.3scale.net/v1alpha1
   kind: APIcast
   metadata:
     name: example-apicast
   spec:
     embeddedConfigurationSecretRef:
       name: SOME_SECRET_NAME

   spec.embeddedConfigurationSecretRef.name 必须是包含网关配置的现有 OpenShift secret 的名称。

4. 确认与 APIcast 对象关联的 OpenShift Deployment 的 readyReplicas 字段是否为 1，以验证 APIcast 容器集正在运行并已就绪。或者，等待字段设置为：

   $ echo $(oc get deployment apicast-example-apicast -o jsonpath='{.status.readyReplicas}')
   1

流程

1. 编写用于定义您要注入的自定义环境的 Lua 代码。例如，以下 env1.lua 文件显示 APIcast operator 为所有服务加载的自定义日志策略。

   local cjson = require('cjson')
   local PolicyChain = require('apicast.policy_chain')
   local policy_chain = context.policy_chain
   
   local logging_policy_config = cjson.decode([[
   {
     "enable_access_logs": false,
     "custom_logging": "\"{{request}}\" to service {{service.id}} and {{service.name}}"
   }
   ]])
   
   policy_chain:insert( PolicyChain.load_policy('logging', 'builtin', logging_policy_config), 1)
   
   return {
     policy_chain = policy_chain,
     port = { metrics = 9421 },
   }

2. 从定义自定义环境的 Lua 文件创建 secret。例如：

   $ oc create secret generic custom-env-1 --from-file=./env1.lua

   secret 可以包含多个自定义虚拟环境。为定义自定义环境的每个文件指定 -from-file 选项。Operator 会加载每个自定义环境。

3. 定义一个 APIcast 自定义资源，用于引用您刚才创建的 secret。以下示例显示了相对于引用定义自定义环境的 secret 的内容。

   apiVersion: apps.3scale.net/v1alpha1
   kind: APIcast
   metadata:
     name: apicast1
   spec:
     customEnvironments:
       - secretRef:
           name: custom-env-1

   APIcast 自定义资源可以引用定义自定义虚拟环境的多个 secret。Operator 会加载每个自定义环境。

4. 创建 APIcast 自定义资源来添加自定义虚拟环境。例如，如果您在 apicast.yaml 文件中保存 APIcast 自定义资源，请运行以下命令：

   $ oc apply -f apicast.yaml

流程

1. 从定义一个自定义策略的文件创建 secret。例如：

   $ oc create secret generic my-first-custom-policy-secret \
    --from-file=./apicast-policy.json \
    --from-file=./init.lua \
    --from-file=./my-first-custom-policy.lua

   如果您有多个自定义策略，请为每个自定义策略创建一个 secret。secret 只能包含一个自定义策略。

2. 定义一个 APIcast 自定义资源，用于引用您刚才创建的 secret。以下示例显示有关引用定义自定义策略的 secret 的内容。

   apiVersion: apps.3scale.net/v1alpha1
   kind: APIcast
   metadata:
     name: apicast1
   spec:
     customPolicies:
       - name: my-first-custom-policy
         version: "0.1"
         secretRef:
           name: my-first-custom-policy-secret

   APIcast 自定义资源可以引用定义自定义策略的多个 secret。Operator 加载每个自定义策略。

3. 创建 APIcast 自定义资源，以添加自定义策略。例如，如果您在 apicast.yaml 文件中保存 APIcast 自定义资源，请运行以下命令：

   $ oc apply -f apicast.yaml

流程

1. 在 stringData.config 中包含您的 OpenTracing 配置详情的 secret。这是包含您的 OpenTracing 配置详细信息的属性的唯一有效值。任何其他规格都阻止 APIcast 收到您的 OpenTracing 配置详细信息。以下示例显示了一个有效的 secret 定义：

   apiVersion: v1
   kind: Secret
   metadata:
     name: myjaeger
   stringData:
     config: |-
         {
         "service_name": "apicast",
         "disabled": false,
         "sampler": {
           "type": "const",
           "param": 1
         },
         "reporter": {
           "queueSize": 100,
           "bufferFlushInterval": 10,
           "logSpans": false,
           "localAgentHostPort": "jaeger-all-in-one-inmemory-agent:6831"
         },
         "headers": {
           "jaegerDebugHeader": "debug-id",
           "jaegerBaggageHeader": "baggage",
           "TraceContextHeaderName": "uber-trace-id",
           "traceBaggageHeaderPrefix": "testctx-"
         },
         "baggage_restrictions": {
             "denyBaggageOnInitializationFailure": false,
             "hostPort": "127.0.0.1:5778",
             "refreshInterval": 60
         }
         }
   type: Opaque

2. 创建 secret.例如，如果您将以前的 secret 定义保存到 myjaeger.yaml 文件中，您将运行以下命令：

   $ oc create -f myjaeger.yaml

3. 定义一个 APIcast 自定义资源，指定 OpenTracing 属性。在 CR 定义中，将 spec.tracingConfigSecretRef.name 属性设置为包含您的 OpenTracing 配置详情的 secret 的名称。下例仅显示了与配置 OpenTracing 相关的内容。

   apiVersion: apps.3scale.net/v1alpha1
   kind: APIcast
   metadata:
     name: apicast1
   spec:
     ...
     openTracing:
       enabled: true
       tracingConfigSecretRef:
         name: myjaeger
       tracingLibrary: jaeger
   ...

4. 创建配置 OpenTracing 的 APIManager 自定义资源。例如，如果您将 APIcast 自定义资源保存在 apicast1.yaml 文件中，您将运行以下命令：

   $ oc apply -f apicast1.yaml