您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。info
本主題說明如何在 Docker 容器中執行 Edge Microgateway。本主題涵蓋的步驟假設您已基本瞭解 Docker、Docker 指令,以及 Edge Microgateway 設定。詳情請參閱 Docker 和 Edge Microgateway 的說明文件。
必要條件
在 Docker 容器中執行 Edge Microgateway 之前,您必須完成下列工作:
為 Apigee 組織/環境設定 Edge Microgateway:
edgemicro configure -o your_org -e your_env -u your_username
如要進一步瞭解設定,請參閱「第 1 部分:設定 Edge Microgateway」。
完成設定步驟後,請找出設定檔。預設位置如下:
$HOME/.edgemicro/your_org-your_env-config.yaml
其中
your_org和your_env是您執行edgemicro config指令時使用的組織和環境。在 Docker 容器中啟動 Edge Microgateway 時,您會需要這個檔案。請務必備妥執行
edgemicro config指令時傳回的金鑰和密鑰憑證。例如:The following credentials are required to start edge micro key: d9c34e1aff68ed969273c016699eabf48780e4f652242e72fc88a43e21252cb0 secret: 3bc95a71c86a3c8ce04537fbcb788158731t51dfc6cdec13b7c05aa0bd969430在 Docker 容器中啟動 Edge Microgateway 之前,您必須建立 (或已建立) 經過驗證的 API Proxy 呼叫所需的 Apigee Edge 實體。這些實體包括 Edge Microgateway 感知 Proxy、API 產品、開發人員和開發人員應用程式。如需完整操作說明,請參閱「在 Apigee Edge 上建立實體」。
以 Docker 容器形式執行 Edge Micro
下載 Edge Microgateway 的 Docker 映像檔:
docker pull gcr.io/apigee-microgateway/edgemicro:latest
在繼續進行後續步驟之前,請務必完成「必要條件」一節中的所有步驟。
執行下列指令,將位於
$HOME/.edgemicro的 Edge Microgateway 設定檔進行 base64 編碼:export EDGEMICRO_CONFIG=`base64 $HOME/.edgemicro/your_org-your_env-config.yaml`
其中
your_org和your_env是您執行edgemicro config指令時使用的組織和環境。請記得在指令前後加上反引號 (`)。例如:
export EDGEMICRO_CONFIG=`base64 $HOME/.edgemicro/docs-test-config.yaml`
以容器形式執行 Edge Microgateway。這個指令會設定多個環境變數,容器執行階段會使用這些變數啟動 Edge Microgateway:
chown -R 100:101 ~/.edgemicro/ \ docker run -P -p 8000:8000 -d --name edgemicro \ -v /var/tmp:/opt/apigee/logs \ -e EDGEMICRO_PROCESSES=1 \ -e EDGEMICRO_ORG=your_org \ -e EDGEMICRO_ENV=your_env \ -e EDGEMICRO_KEY=your_key \ -e EDGEMICRO_SECRET=your_secret \ -e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG" \ -e "LOG_CONSOLE_OUTPUT_TO_FILE=false" \ -e SERVICE_NAME=edgemicro \ --security-opt=no-new-privileges \ --cap-drop=ALL \ gcr.io/apigee-microgateway/edgemicro:latest
參數
<tr> <td><code>SERVICE_NAME</code></td> <td>If you are on Kubernetes, this parameter is auto-populated. Otherwise, you can set it to anything you wish. If you specify nothing, the service name is set to <code>default</code>.</td> </tr> <tr> <tr> <td><code>DEBUG</code></td> <td>Set to <code>*</code> to enable debugging. </td> </tr> <tr> <td><code>HTTP_PROXY</code> <code>HTTPS_PROXY</code></td> <td>Use when Edge Microgateway is running behind a firewall and the gateway cannot communicate with Apigee Edge. For more information, see <a href="operation-and-configuration-reference-edge-microgateway#settingupedgemicrogatewaybehindacompanyfirewall">Setting up Edge Microgateway behind a company firewall</a>. <p>For example: <code>HTTP_PROXY=http://10.203.0.1:5187/</code></p></td> </tr> <tr> <td><code>NO_PROXY</code></td> <td>A comma delimited list of domains that Edge Microgateway should not proxy to. For more information, see <a href="operation-and-configuration-reference-edge-microgateway#settingupedgemicrogatewaybehindacompanyfirewall">Setting up Edge Microgateway behind a company firewall</a>. <p>For example: <code>localhost,127.0.0.1,localaddress,.localdomain.com</code></p></td> </tr> <tr> <tr> <tr> <td><code>NODE_EXTRA_CA_CERTS</code></td> <td>(Optional) Use this parameter if you are using a CA that's not trusted by default by Node.js. Set the value of this parameter to the path to a file containing one or more trusted certificates in PEM format. For details, see <a href="#tls_certificates">TLS certificates</a>.</td> </tr> <tr> <td><code>--security-opt</code></td> <td>(Optional) Sets desired Docker security options. See <a href="https://docs.docker.com/engine/reference/run/#security-configuration">Security configuration</a> in the Docker documentation.</td> </tr> <tr> <td><code>--cap-drop</code></td> <td>(Optional) Sets limits on Linux capabilities permitted in the container. See <a href="https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities">Runtime privilege and Linux capabilities</a> in the Docker documentation.</td> </tr> </tbody>參數 說明 -P將所有公開的通訊埠發布至主機。另請參閱 Docker run 參考資料。 -p明確對應單一通訊埠或通訊埠範圍。另請參閱 Docker run 參考資料。 -d以分離模式執行。另請參閱 Docker run 參考資料。 -v, -- volume指定磁碟區掛接。請注意,如果您將 Edge Microgateway 設為在 Docker 容器中使用 TLS,則必須在掛接記錄檔目錄時公開通訊埠 8443。另請參閱「VOLUME [共用檔案系統]」。另請參閱「在 Docker 容器中使用 TLS」。 -w, -- workdir(選用) 指定要建立 edgemicro.sock和edgemicro.pid檔案的目錄路徑。無法修改檔案名稱根目錄edgemicro。 預設為目前使用的目錄路徑。範例:
docker run -P -p 8000:8000 -d -w /tmp --name edgemicro
...EDGEMICRO_ORG您用來設定 Edge Microgateway 的 Apigee 組織名稱。 EDGEMICRO_ENV您用來設定 Edge Microgateway 的 Apigee 環境名稱。 EDGEMICRO_PROCESSES要啟動的程序數量。 EDGEMICRO_KEY設定 Edge Microgateway 時傳回的金鑰。 EDGEMICRO_SECRET設定 Edge Microgateway 時傳回的密鑰。 EDGEMICRO_CONFIG包含 Base64 編碼 Edge Microgateway 設定檔的變數。 LOG_CONSOLE_OUTPUT_TO_FILE(布林值) 可指定記錄輸出內容的傳送位置。請參閱「指定記錄檔選項」。 例如:
chown -R 100:101 ~/.edgemicro/
docker run -P -p 8000:8000 -d --name edgemicro
-v /var/tmp:/opt/apigee/logs
-e EDGEMICRO_PROCESS=1
-e EDGEMICRO_ORG=docs
-e EDGEMICRO_ENV=test
-e EDGEMICRO_KEY=d9c34e1aff68ed969273b016699eabf48780e4f652242e72fc88a23e21252cb0
-e EDGEMICRO_SECRET=3bc95a71c86a3c8ce04137fbcb788158731t51dfc6cdec13b7c05aa0bd969430
-e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG"
-e SERVICE_NAME=edgemicro
--security-opt=no-new-privileges
--cap-drop=ALL
gcr.io/apigee-microgateway/edgemicro如要確認容器是否正在執行,請按照下列步驟操作:
docker ps
輸出結果應該會類似下列內容:
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 8b92e082ea9c edgemicro "/tmp/entrypoint.sh" 12 minutes ago Up 12 minutes 0.0.0.0:8000->8000/tcp, 0.0.0.0:32775->8443/tcp edgemicro
指定記錄檔輸出選項
Edge Microgateway 設定參數 to_console 可讓您選擇將記錄資訊傳送至標準輸出內容,而非記錄檔。如果您按照步驟在 Docker 容器中執行 Edge Microgateway,容器預設會將 stdout 和錯誤輸出重新導向至容器中的檔案,位置為:
${APIGEE_ROOT}/logs/edgemicro.log。如要避免將記錄資訊傳送至
edgemicro.log,請在執行容器時使用LOG_CONSOLE_OUTPUT_TO_FILE變數。下表說明搭配使用
LOG_CONSOLE_OUTPUT_TO_FILE和to_console時的記錄輸出行為:to_console: trueLOG_CONSOLE_OUTPUT_TO_FILE=false- 系統不會將任何記錄傳送至 Edge Microgateway 記錄檔,如「管理記錄檔」一文所述。
- 記錄不會傳送至
edgemicro.log檔案。
to_console: trueLOG_CONSOLE_OUTPUT_TO_FILE=true- 系統不會將任何記錄傳送至 Edge Microgateway 記錄檔,如「管理記錄檔」一文所述。
- 記錄會傳送至
edgemicro.log檔案。
to_console: falseLOG_CONSOLE_OUTPUT_TO_FILE=true- 記錄會傳送至 Edge Microgateway 記錄檔,詳情請參閱「管理記錄檔」。
- 記錄會傳送至
edgemicro.log檔案。
測試 API 呼叫
在容器中啟動 Edge Microgateway 後,即可對其發出 API 呼叫。舉例來說,如果 API 的基本路徑是
/hello:http://localhost:8000/hello
輸出內容範例:
{"error":"missing_authorization","error_description":"Missing Authorization header"}如果看到這項回應,表示 Edge Microgateway 已成功處理 API 呼叫。不過,Edge Microgateway 預設會要求提供 API 金鑰進行驗證。在下一節中,您將使用有效的 API 金鑰測試 API。
使用有效的 API 金鑰測試 API
在 Edge UI 中,前往先前建立的開發人員應用程式。在「Developer App」(開發人員應用程式) 頁面中,顯示並複製用戶端金鑰。這個值就是 API 金鑰。您將使用這組金鑰發出經過驗證的 API 呼叫。
使用
x-api-key標頭呼叫 API,如下所示。從開發人員應用程式複製的用戶端金鑰值就是 API 金鑰。根據預設,Edge Microgateway 會要求您在名為x-api-key的標頭中傳遞金鑰,如下所示:curl -i http://localhost:8000/hello -H "x-api-key:apikey"
例如:
curl -i http://localhost:8000/hello -H "x-api-key:PydUKRDGIXRqF2xh4usn1FLHbhGKVIz"
如要進一步瞭解如何透過 Edge Microgateway 使用 API 金鑰和 OAuth 權杖發出經過驗證的 API 呼叫,請參閱「第 4 部分:保護 Edge Microgateway」。
停止 Edge Microgateway
使用下列 Docker 指令停止 Edge Microgateway:
docker stop edgemicro重新啟動 Edge Microgateway
停止 Edge Microgateway 後,您可以使用下列 Docker 指令重新啟動:
docker start edgemicro在 Docker 容器中使用 TLS
本節說明如何為在 Docker 容器中執行的 Edge Microgateway 設定 TLS。您可以將 Edge Microgateway 伺服器設為對傳入要求 (北向) 使用 TLS,也可以將 Edge Microgateway 設為 TLS 用戶端,對目標端點 (南向) 的傳出要求使用 TLS。
憑證檔案的存放位置
執行 Edge Microgateway 的 Docker 容器在
/opt/apigee/.edgemicro上有一個掛接點。將 Edge Microgateway 設為使用 TLS 憑證時,您可以在該掛接點提供憑證檔案,並在 Edge Microgateway 設定檔中參照這些檔案。這個設定檔通常位於$HOME/.edgemicro目錄中,名稱為your_org-your_env-config.yaml。例如:... edgemicro: ssl: key: /opt/apigee/.edgemicro/southbound/tls.key cert: /opt/apigee/.edgemicro/southbound/tls.crt ...使用 Node.js 不信任的 CA
如果您使用的憑證授權單位 (CA) 預設不受 Node.js 信任 (例如自行簽署的憑證),建議您在執行容器時使用
NODE_EXTRA_CA_CERTS參數。將這個參數設為檔案路徑,該檔案包含一或多個 PEM 格式的信任憑證。如要瞭解如何使用這個參數,請參閱「如何設定北向 TLS」和「如何設定南向 TLS」範例。
例如:
chown -R 100:101 ~/.edgemicro/ \ docker run -P -p 8443:8443 -d --name edgemicro \ -v $HOME/.edgemicro:/opt/apigee/.edgemicro \ -v $HOME/.edgemicro:/opt/apigee/logs \ -e NODE_EXTRA_CA_CERTS=/opt/apigee/.edgemicro/rootca.pem \ -e EDGEMICRO_PORT=8443 \ -e EDGEMICRO_ORG=docs \ -e EDGEMICRO_ENV=test \ -e EDGEMICRO_KEY=ac36574905fb54fdae65fc5433e831bec2680efb98220a355f2e917e52973c \ -e EDGEMICRO_SECRET=aac81dff6c326eaa222d53c15c8841fa78ea863bf4472568c9ce2d80a3bc56 \ -e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG" \ --link helloworld:helloworld gcr.io/apigee-microgateway/edgemicro另請參閱「以 Docker 容器形式執行 Edge Micro」。
關閉 TLS 驗證
雖然不建議這麼做,但在某些情況下,您可能需要為在容器中執行的 Edge Microgateway 停用 TLS 驗證。根據預設,Edge Microgateway Docker 容器並未內建停用 TLS 的功能。為完成這項工作,您必須為 Edge Microgateway 建立自訂 Docker 映像檔。以下是建構自訂映像檔和關閉 TLS 驗證的一般操作說明。
從
https://github.com/apigee-internal/microgateway複製或下載 Edge Microgateway 原始碼存放區。cd複製到原始碼目錄中的microgateway/kubernetes/docker/edgemicro目錄。例如:
cd $HOME/git/microgateway/kubernetes/docker/edgemicro開啟
entrypoint.sh檔案,並修改程式碼以接受NODE_TLS_REJECT_UNAUTHORIZED環境變數。稍後執行容器時,您會指定這個變數的值。建構 Docker 容器:
docker build -t edgemicro .執行容器時,請指定
-e NODE_TLS_REJECT_UNAUTHORIZED = 1選項。例如:
chown -R 100:101 ~/.edgemicro/ \ docker run -P -p 8443:8443 -d --name edgemicro \ -v $HOME/.edgemicro:/opt/apigee/.edgemicro \ -v $HOME/.edgemicro:/opt/apigee/logs \ -e NODE_TLS_REJECT_UNAUTHORIZED = 1 \ -e EDGEMICRO_PORT=8443 \ -e EDGEMICRO_ORG=docs \ -e EDGEMICRO_ENV=test \ -e EDGEMICRO_KEY=ac36574905fb54fdae65fc5433e831bec2680efb98220a355f2e917e52973c \ -e EDGEMICRO_SECRET=aac81dff6c326eaa222d53c15c8841fa78ea863bf4472568c9ce2d80a3bc56 \ -e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG" \ --link helloworld:helloworld gcr.io/apigee-microgateway/edgemicro範例:如何設定北向 TLS
本節說明如何在 Edge Microgateway 伺服器上設定北向 (傳入) TLS 連線。北向 TLS 可讓用戶端在向 Edge Microgateway 發出 API 呼叫時使用 HTTPS。以下範例使用自行簽署的憑證。
1. 初始設定步驟
- 在系統中找出
openssl.cnf檔案。例如:/etc/ssl/openssl.cnf。 - 開啟
opensssl.cnf檔案進行編輯。 請確認設定檔中包含
req_extensions。舉例來說,檔案中應有類似下列的資訊:[ req ] ... req_extensions = v3_req ... [ v3_req ] extendedKeyUsage = serverAuth, clientAuth, codeSigning, emailProtection basicConstraints = CA:FALSE keyUsage = nonRepudiation, digitalSignature, keyEncipherment將下列段落新增至
openssl.cnf,產生正確的 SNI 屬性:[ alt_names ] DNS.1 = www.example.com DNS.2 = example.com DNS.3 = localhost DNS.4 = localhost.localdomain DNS.5 = 127.0.0.1 DNS.6 = ::1 DNS.7 = fe80::1opensssl.cnf檔案範例:[ req ] distinguished_name = req_distinguished_name attributes = req_attributes req_extensions = v3_req [ v3_req ] extendedKeyUsage = serverAuth, clientAuth, codeSigning, emailProtection basicConstraints = CA:FALSE keyUsage = nonRepudiation, digitalSignature, keyEncipherment [ req_distinguished_name ] countryName = Country Name (2 letter code) countryName_min = 2 countryName_max = 2 stateOrProvinceName = State or Province Name (full name) localityName = Locality Name (eg, city) 0.organizationName = Organization Name (eg, company) organizationalUnitName = Organizational Unit Name (eg, section) commonName = Common Name (eg, fully qualified host name) commonName_max = 64 emailAddress = Email Address emailAddress_max = 64 [ req_attributes ] challengePassword = A challenge password challengePassword_min = 4 challengePassword_max = 20 [ alt_names ] DNS.1 = www.example.com DNS.2 = example.com DNS.3 = localhost DNS.4 = localhost.localdomain DNS.5 = 127.0.0.1 DNS.6 = ::1 DNS.7 = fe80::1如果您尚未完成「必要條件」一節中的步驟,請按照該節中的步驟初始化及設定 Edge Microgateway。完成後,您應該已建立 Edge Microgateway 感知 Proxy、API 產品、開發人員和開發人員應用程式。此外,您應該已執行
edgemicro configure指令,並收到金鑰和密鑰。
2. 產生自行簽署的憑證
接著,產生建立 TLS 所需的憑證和金鑰:
cd至$HOME/.edgemicro目錄。建立下列 Bash 指令碼。命名方式不限。例如
keygen.sh。#!/bin/bash # generate ca openssl genrsa -out rootca.key 2048 openssl req -x509 -new -nodes -key rootca.key -sha256 -days 1024 -out rootca.pem # generate key openssl genrsa -out tls.key 2048 openssl req -new -key tls.key -out tls.csr # sign cert openssl x509 -req -in tls.csr -CA rootca.pem -CAkey rootca.key -CAcreateserial -out tls.crt -days 1024 -sha256 -extensions 'v3_req' -extfile path/openssl.cnf
在 bash 檔案中,確認
openssl.cnf檔案的路徑正確無誤。執行 Bash 檔案。系統會提示您輸入憑證資訊。請務必使用
localhost做為通用名稱。確認下列檔案已建立:
rootca.keyrootca.pemtls.keytls.csrrootca.srltls.crt
3. 編輯 Edge Microgateway 設定檔
在編輯器中開啟 Edge Micro 設定檔。例如:
vi $HOME/.edgemicro/myorg-test-config.yaml按照下列方式編輯
edgemicro段落。請注意,您正在變更port和ssl屬性:edge_config: ... edgemicro: port: 8443 max_connections: 1000 config_change_poll_interval: 600 ssl: key: /opt/apigee/.edgemicro/tls.key cert: /opt/apigee/.edgemicro/tls.crt passphrase: admin123 rejectUnauthorized: true requestCert: false logging: ...執行下列指令,將位於
$HOME/.edgemicro的 Edge Microgateway 設定檔進行 base64 編碼:export EDGEMICRO_CONFIG=`base64 $HOME/.edgemicro/your_org-your_env-config.yaml`
其中
your_org和your_env是您執行edgemicro config指令時使用的組織和環境。請記得在指令前後加上反引號 (`)。例如:
export EDGEMICRO_CONFIG=`base64 $HOME/.edgemicro/docs-test-config.yaml`
另請參閱「以 Docker 容器形式執行 Edge Micro」。
4. 執行容器
執行下列指令,透過 Edge Microgateway 執行 Docker 容器:
chown -R 100:101 ~/.edgemicro/ \ docker run -P -p 8443:8443 -d --name edgemicro \ -v path_to_your_edgemicro_dir:/opt/apigee/.edgemicro \ -v path_to_your_logs_dir:/opt/apigee/logs \ -e NODE_EXTRA_CA_CERTS=/opt/apigee/.edgemicro/rootca.pem \ -e EDGEMICRO_PORT=8443 \ -e EDGEMICRO_ORG=$EDGEMICRO_ORG \ -e EDGEMICRO_ENV=$EDGEMICRO_ENV \ -e EDGEMICRO_KEY=$EDGEMICRO_KEY \ -e EDGEMICRO_SECRET=$EDGEMICRO_SECRET \ -e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG" \ gcr.io/apigee-microgateway/edgemicro:latest
請注意指令中使用的下列參數,這些參數與「以 Docker 容器形式執行 Edge Micro」一節所述的基本指令不同。
port設為8443。- 磁碟區掛接用於掛接金鑰和憑證檔案。
NODE_EXTRA_CA_CERTS變數用於新增自訂 CA (如自行簽署憑證時所需)。
5. 測試 TLS 設定
執行下列 cURL 指令來測試設定。將基本路徑和 API 金鑰替換至指令中。以下範例假設您位於
rootca.pem所在的目錄,且您建立的 Proxy 具有基本路徑/hello:curl -v https://localhost:8443/hello --cacert rootca.pem \ -H "x-api-key: Az82fdnfONVCOOE4NKhajxAboDgA3FAo"詳細的 cURL 輸出內容會顯示 TLS 握手的每個步驟。如果看到 HTTP 200 回應,表示設定成功:
* Trying ::1...ey:Az82fdnfONVCOOE4NKhajxAboDgA3FAo" * TCP_NODELAY set * Connected to localhost (::1) port 8443 (#0) * ALPN, offering h2 * ALPN, offering http/1.1 * Cipher selection: ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH * successfully set certificate verify locations: * CAfile: rootca.pem CApath: none * TLSv1.2 (OUT), TLS handshake, Client hello (1): * TLSv1.2 (IN), TLS handshake, Server hello (2): * TLSv1.2 (IN), TLS handshake, Certificate (11): * TLSv1.2 (IN), TLS handshake, Server key exchange (12): * TLSv1.2 (IN), TLS handshake, Server finished (14): * TLSv1.2 (OUT), TLS handshake, Client key exchange (16): * TLSv1.2 (OUT), TLS change cipher, Client hello (1): * TLSv1.2 (OUT), TLS handshake, Finished (20): * TLSv1.2 (IN), TLS change cipher, Client hello (1): * TLSv1.2 (IN), TLS handshake, Finished (20): * SSL connection using TLSv1.2 / ECDHE-RSA-AES128-GCM-SHA256 * ALPN, server accepted to use http/1.1 * Server certificate: * subject: C=US; ST=CO; L=Boulder; O=Docs; OU=Docs; CN=localhost; emailAddress=docs@apigee.com * start date: Dec 14 22:35:28 2018 GMT * expire date: Oct 3 22:35:28 2021 GMT * common name: localhost (matched) * issuer: C=US; ST=CO; L=Boulder; O=Docs; OU=Docs; CN=localhost; emailAddress=docs@apigee.com * SSL certificate verify ok. > GET /hello HTTP/1.1 > Host: localhost:8443 > User-Agent: curl/7.54.0 > Accept: */* > x-api-key:Az82fdnfaONVCOE4NKhajxAboDA3FAo > < HTTP/1.1 200 OK < x-powered-by: Apigee < access-control-allow-origin: * < x-frame-options: ALLOW-FROM RESOURCE-URL < x-xss-protection: 1 < x-content-type-options: nosniff < content-type: text/plain; charset=utf-8 < etag: W/"d-GHB1ZrJKk/wdVTdB/jgBsw" < date: Fri, 14 Dec 2018 22:43:13 GMT < via: 1.1 google < alt-svc: clear < x-response-time: 1325 < Connection: keep-alive < Transfer-Encoding: chunked < * Connection #0 to host localhost left intact Hello, Guest!
範例:如何設定南向 TLS
本節說明如何在 Edge Microgateway 伺服器和後端目標應用程式之間,設定南向 (傳出) TLS 連線。以下範例使用自行簽署的憑證。
1. 初始設定步驟
- 在系統中找出
openssl.cnf檔案。例如:/etc/ssl/openssl.cnf。 - 開啟
opensssl.cnf檔案進行編輯。 請確認設定檔中包含
req_extensions。舉例來說,檔案中應有類似下列的資訊:[ req ] ... req_extensions = v3_req ... [ v3_req ] extendedKeyUsage = serverAuth, clientAuth, codeSigning, emailProtection basicConstraints = CA:FALSE keyUsage = nonRepudiation, digitalSignature, keyEncipherment將下列段落新增至
openssl.cnf,產生正確的 SNI 屬性:[ alt_names ] DNS.1 = helloworld DNS.2 = localhost DNS.3 = localhost.localdomain DNS.4 = 127.0.0.1 DNS.5 = ::1 DNS.6 = fe80::1opensssl.cnf檔案範例:[ req ] distinguished_name = req_distinguished_name attributes = req_attributes req_extensions = v3_req [ v3_req ] extendedKeyUsage = serverAuth, clientAuth, codeSigning, emailProtection basicConstraints = CA:FALSE keyUsage = nonRepudiation, digitalSignature, keyEncipherment [ req_distinguished_name ] countryName = Country Name (2 letter code) countryName_min = 2 countryName_max = 2 stateOrProvinceName = State or Province Name (full name) localityName = Locality Name (eg, city) 0.organizationName = Organization Name (eg, company) organizationalUnitName = Organizational Unit Name (eg, section) commonName = Common Name (eg, fully qualified host name) commonName_max = 64 emailAddress = Email Address emailAddress_max = 64 [ req_attributes ] challengePassword = A challenge password challengePassword_min = 4 challengePassword_max = 20 [ alt_names ] DNS.1 = helloworld DNS.2 = localhost DNS.3 = localhost.localdomain DNS.4 = 127.0.0.1 DNS.5 = ::1 DNS.6 = fe80::1執行
edgemicro configure指令:edgemicro configure -o your_org -e your_env -u your_username
如要進一步瞭解設定,請參閱「第 1 部分:設定 Edge Microgateway」。
複製
edgemicro configure傳回的金鑰和密鑰憑證。執行容器時會用到這些值。例如:The following credentials are required to start edge micro key: d9c34e1aff68ed969273c016699eabf48780e4f652242e72fc88a43e21252cb0 secret: 3bc95a71c86a3c8ce04537fbcb788158731t51dfc6cdec13b7c05aa0bd969430
2. 建立 Node.js 目標應用程式
cd至.edgemicro目錄。建立下列 Bash 指令碼。命名方式不限。例如
keygen.sh。#!/bin/bash # generate ca openssl genrsa -out rootca.key 2048 openssl req -x509 -new -nodes -key rootca.key -sha256 -days 1024 -out rootca.pem # generate key openssl genrsa -out tls.key 2048 openssl req -new -key tls.key -out tls.csr # sign cert openssl x509 -req -in tls.csr -CA rootca.pem -CAkey rootca.key -CAcreateserial -out tls.crt -days 1024 -sha256 -extensions 'v3_req' -extfile path/openssl.cnf
在 bash 檔案中,確認
openssl.cnf檔案的路徑正確無誤。執行 Bash 檔案。系統會提示您輸入憑證資訊。請務必使用
hellworld做為通用名稱。確認下列檔案已建立:
rootca.keyrootca.pemtls.keytls.csrrootca.srltls.crt
建立名為
server.js的新檔案。'use strict'; const express = require('express'); const https = require('https'); const fs = require('fs'); const options = { key: fs.readFileSync("tls.key"), cert: fs.readFileSync("tls.crt") }; // Constants const PORT = 9443; const HOST = '0.0.0.0'; // App const app = express(); app.get('/', (req, res) => { res.send('Hello world\n'); }); https.createServer(options, app).listen(PORT);在
server.js所在的目錄中建立package.json檔案。例如:{ "name": "helloworld", "version": "1.0.0", "description": "", "main": "server.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "start": "node server.js" }, "author": "", "license": "ISC", "dependencies": { "express": "^4.16.4", "fs": "0.0.1-security", "https": "^1.0.0" } }執行
npm install即可取得依附元件。在
server.js所在的目錄中建立新的 Dockerfile,其中WORKDIR是 Node.js 應用程式根目錄的路徑:FROM node:8-alpine WORKDIR path-to-your-node-app COPY package*.json ./ RUN npm install COPY . . EXPOSE 9443 CMD [ "npm", "start" ]
建構 Docker 映像檔:
docker build -t helloworld .啟動範例應用程式:
docker run -P -p 9443:9443 --name helloworld helloworld
3. 在 Apigee Edge 建立實體
使用這些設定建立 Edge Microgateway 感知 Proxy。詳情請參閱「在 Edge 上建立 Edge Microgateway 感知 API Proxy」。
- Proxy 名稱:
edgemicro_local - 修訂版本:
1 - 基本路徑:
/local - 目標:
https://helloworld:9443
- Proxy 名稱:
建立 API 產品。詳情請參閱「建立產品」。
建立開發人員。詳情請參閱「建立開發人員」。
建立開發人員應用程式。詳情請參閱「建立開發人員應用程式」
4. 執行容器
在編輯器中開啟 Edge Micro 設定檔。例如:
vi $HOME/.edgemicro/myorg-test-config.yaml按照下列方式編輯
edgemicro段落。請注意,您正在變更port和ssl屬性:edge_config: ... edgemicro: port: 8443 max_connections: 1000 config_change_poll_interval: 600 ssl: key: /opt/apigee/.edgemicro/tls.key cert: /opt/apigee/.edgemicro/tls.crt passphrase: admin123 rejectUnauthorized: true requestCert: false logging: ...執行下列指令,將位於
$HOME/.edgemicro的 Edge Microgateway 設定檔進行 base64 編碼:export EDGEMICRO_CONFIG=`base64 $HOME/.edgemicro/your_org-your_env-config.yaml`
其中
your_org和your_env是您執行edgemicro config指令時使用的組織和環境。請記得在指令前後加上反引號 (`)。例如:
export EDGEMICRO_CONFIG=`base64 $HOME/.edgemicro/docs-test-config.yaml`
執行下列指令,在 Docker 容器中啟動 Edge Microgateway。
chown -R 100:101 ~/.edgemicro/ \ docker run -P -p 8443:8443 -d --name edgemicro \ -v path_to_your_edgemicro_dir:/opt/apigee/.edgemicro \ -v path_to_your_logs_dir:/opt/apigee/logs \ -e EDGEMICRO_PORT=8443 \ -e EDGEMICRO_ORG=$EDGEMICRO_ORG \ -e EDGEMICRO_ENV=$EDGEMICRO_ENV \ -e EDGEMICRO_KEY=$EDGEMICRO_KEY \ -e EDGEMICRO_SECRET=$EDGEMICRO_SECRET \ -e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG" \ --link helloworld:helloworld gcr.io/apigee-microgateway/edgemicro
5. 測試 TLS 設定
執行下列 cURL 指令來測試設定。請替換您在 microgateway-aware Proxy 中使用的基本路徑,以及從 Apigee Edge 上建立的開發人員應用程式取得的 API 金鑰。例如:
curl https://localhost:8443/local -k -H "x-api-key: xxxx" -v您應該會看到下列錯誤訊息:
... * subject: C=CA; ST=Ontario; L=Toronto; O=Google Canada; OU=Google Cloud Platform; CN=edgemicro; emailAddress=srinandans@google.com * start date: Dec 10 02:12:22 2018 GMT * expire date: Sep 29 02:12:22 2021 GMT * issuer: C=CA; ST=Ontario; L=Toronto; O=Google Canada; OU=Google Cloud Platform; CN=edgemicro; emailAddress=srinandans@google.com * SSL certificate verify result: unable to get local issuer certificate (20), continuing anyway. > GET /local HTTP/1.1 > Host: localhost:8443 > User-Agent: curl/7.54.0 > Accept: */* > x-api-key: 9fVC65pFj8LrmlPmVyxFjx4KgAHTxqSd > < HTTP/1.1 502 Bad Gateway < Date: Wed, 12 Dec 2018 05:25:01 GMT < Connection: keep-alive < Content-Length: 93 < * Connection #0 to host localhost left intact {"message":"unable to verify the first certificate","code":"UNABLE_TO_VERIFY_LEAF_SIGNATURE"}重新執行 Edge Microgateway,但這次要加入
NODE_EXTRA_CA_CERTS變數。chown -R 100:101 ~/.edgemicro/ \ docker run -P -p 8443:8443 -d --name edgemicro \ -v path_to_your_edgemicro_dir:/opt/apigee/.edgemicro \ -v path_to_your_logs_dir:/opt/apigee/logs \ -e NODE_EXTRA_CA_CERTS=/opt/apigee/.edgemicro/rootca.pem \ -e EDGEMICRO_PORT=8443 \ -e EDGEMICRO_ORG=$EDGEMICRO_ORG \ -e EDGEMICRO_ENV=$EDGEMICRO_ENV \ -e EDGEMICRO_KEY=$EDGEMICRO_KEY \ -e EDGEMICRO_SECRET=$EDGEMICRO_SECRET \ -e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG" \ --link helloworld:helloworld gcr.io/apigee-microgateway/edgemicro
執行下列 cURL 指令。請按照先前做法,替換基本路徑和 API 金鑰。例如:
curl https://localhost:8443/local -k -H "x-api-key: xxxx" -v查看輸出內容。如果成功,您會收到 HTTP 200 狀態回應:
... > GET /local HTTP/1.1 > Host: localhost:8443 > User-Agent: curl/7.54.0 > Accept: */* > x-api-key: 9fVC65pFj8LrmlPmVyxFjx4KgAHTxqSd > < HTTP/1.1 200 OK < x-powered-by: Express < content-type: text/html; charset=utf-8 < etag: W/"c-M6tWOb/Y57lesdjQuHeB1P/qTV0" < date: Wed, 12 Dec 2018 05:49:28 GMT < x-response-time: 421 < Connection: keep-alive < Transfer-Encoding: chunked < Hello world
新增自訂外掛程式
您可以編寫自訂外掛程式,為 Microgateway 新增功能。自訂外掛程式可讓您以程式輔助方式,與流經微閘道的要求和回應互動。
如要將外掛程式部署至在 Docker 容器中執行的 Edge Microgateway 執行個體,有兩種做法:
本節其餘部分假設您熟悉如何為標準 Edge Microgateway 設定編寫及設定外掛程式。如果沒有,請參閱「開發自訂外掛程式」。
方法 A:將外掛程式目錄掛接至磁碟區
(2.5.27 版新增) 透過磁碟區掛接新增外掛程式的步驟,與將任何自訂外掛程式新增至 Edge Microgateway 的步驟類似。執行 Docker 容器時,您可以將本機系統 (磁碟區) 上的外掛程式目錄掛接至容器掛接點
/opt/apigee/plugins。接著,在 Edge Microgateway 設定檔中指定本機磁碟區目錄。下列步驟說明如何使用 Docker 掛接點加入自訂外掛程式。
停止 Edge Microgateway:
edgemicro stop為自訂外掛程式建立目錄。舉例來說,您可以建立
$HOME/edgemicro/custom/plugins將自訂外掛程式目錄新增至 Edge Microgateway 設定檔。例如:
plugins: dir: $HOME/edgemicro/custom/plugins sequence: - oauth - response-uppercase ````按照「編寫簡單的外掛程式」中的指示,編寫及測試外掛程式。請務必將外掛程式程式碼放在正確的目錄結構中。例如:
custom | |-- plugins | |- response-uppercase | |- index.js | |- package.json |- request-headers | | - index.js | - package.json使用類似下列的指令執行 Docker 容器,其中
-v選項用於將外掛程式目錄掛接至 Docker 磁碟區。在下列範例指令中,外掛程式目錄$HOME/edgemicro/custom/plugins(自訂外掛程式所在位置) 會對應至容器的掛接點/opt/apigee/plugins:chown -R 100:101 ~/.edgemicro/ \ docker run -P -p 8000:8000 -d --name edgemicro \ -v /var/tmp:/opt/apigee/logs \ -v $HOME/edgemicro/custom/plugins:/opt/apigee/plugins \ -e EDGEMICRO_PROCESSES=1 \ -e EDGEMICRO_ORG=jdoe \ -e EDGEMICRO_ENV=test \ -e EDGEMICRO_KEY=39c4b561100cd7f258768d1072f3e1d7c17b5f36a18fe89972bb5c9ce7e58fb \ -e EDGEMICRO_SECRET=f5f9e239a38b4e6cc99c2aa067716a84aebdcff9580a7925fc500e402b1a5fa \ -e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG" \ -e SERVICE_NAME=edgemicro \ --security-opt=no-new-privileges \ --cap-drop=ALL gcr.io/apigee-microgateway/edgemicro:latest呼叫 API 來測試外掛程式。
詳情請參閱「VOLUME [共用檔案系統]」。
方法 B:將外掛程式建構至容器
在這個選項中,您會將外掛程式建構到容器中。
1. 封裝外掛程式
按照「編寫簡單的外掛程式」中的指示,編寫及測試外掛程式。
將外掛程式程式碼放在適當的目錄結構中。外掛程式目錄必須遵循一組結構。以下範例顯示您必須遵循的結構,其中
response-uppercase和request-headers是包含自訂外掛程式程式碼的資料夾名稱 (這些名稱僅為範例,您的資料夾名稱可能不同):plugin | |-- plugins | |- response-uppercase | |- index.js | |- package.json |- request-headers | | - index.js | - package.jsoncd至plugin資料夾。在
plugin資料夾中,壓縮整個plugins資料夾:zip -r plugins.zip plugins/
2. 建立 Docker 映像檔
接著,建立 Dockerfile,將外掛程式程式碼新增至 Edge Microgateway 映像檔。
- 在 ZIP 檔案所在的目錄中,建立名為
Dockerfile的新檔案。 將下列程式碼新增至
Dockerfile並儲存檔案:FROM gcr.io/apigee-microgateway/edgemicro:latest USER root RUN apt-get update && \ apt-get install -y unzip && \ rm -rf /var/lib/apt/lists/* && \ mkdir /opt/apigee/customplugins && \ chown apigee:apigee /opt/apigee/customplugins COPY plugins.zip /opt/apigee/customplugins RUN su - apigee -c "unzip /opt/apigee/customplugins/plugins.zip -d /opt/apigee/customplugins" EXPOSE 8000 EXPOSE 8443 USER apigee ENTRYPOINT ["/opt/apigee/entrypoint.sh"]使用外掛程式建立新的 Edge Microgateway Docker 映像檔:
docker build -t image-name .例如:
docker build -t edgemicroplugins .
3. 更新 Edge Microgateway 設定
外掛程式已封裝完成,現在需要將其新增至 Edge Microgateway 設定檔。
在編輯器中開啟 Edge Microgateway 設定檔:
$HOME/.edgemicro/org-env-config.yaml
例如:
vi $HOME/.edgemicro/myorg-test-config.yaml
將外掛程式目錄新增至設定檔。在下列範例中,
dir屬性指定外掛程式程式碼的位置 (您在 Dockerfile 中指定的位置)。您也必須指定外掛程式目錄的名稱,在以下範例中為response-uppercase。edgemicro: ... plugins: dir: /opt/apigee/plugins sequence: - oauth - response-uppercase
4. 啟動 Microgateway
最後,您必須在容器中啟動 Microgateway。
執行下列指令,將位於
$HOME/.edgemicro的 Edge Microgateway 設定檔進行 base64 編碼:export EDGEMICRO_CONFIG=`base64 $HOME/.edgemicro/your_org-your_env-config.yaml`
其中
your_org和your_env是您執行edgemicro config指令時使用的組織和環境。請記得在指令前後加上反引號 (`)。例如:
export EDGEMICRO_CONFIG=`base64 $HOME/.edgemicro/docs-test-config.yaml`
以容器形式執行 Edge Microgateway。這個指令會設定多個環境變數,容器執行階段會使用這些變數啟動 Edge Microgateway:
docker run -P -p 8000:8000 -d --name edgemicroplugins \ -e EDGEMICRO_PLUGIN_DIR=/opt/apigee/customplugins/plugins \ -e EDGEMICRO_ORG=your_org \ -e EDGEMICRO_ENV=your_env \ -e EDGEMICRO_KEY=your_key \ -e EDGEMICRO_SECRET=your_secret \ -e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG" \ -e SERVICE_NAME=edgemicroplugins image_name
例如:
docker run -P -p 8000:8000 -d --name edgemicroplugins \ -e EDGEMICRO_PLUGIN_DIR=/opt/apigee/customplugins/plugins \ -e EDGEMICRO_ORG=docs \ -e EDGEMICRO_ENV=test \ -e EDGEMICRO_KEY=d9c34e1aff68ed969273b016699eabf48780e4f652242e72fc88a23e21252cb0 \ -e EDGEMICRO_SECRET=3bc95a71c86a3c8ce04137fbcb788158731t51dfc6cdec13b7c05aa0bd969430 \ -e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG" \ -e SERVICE_NAME=edgemicroplugins edgemicroplugins
呼叫 API 來測試外掛程式:
呼叫 API 並確認輸出內容符合預期,藉此測試外掛程式程式碼是否執行:
curl -i http://localhost:8000/hello -H "x-api-key:apikey"
舉例來說,
response-uppercase外掛程式可能會傳回類似以下的回覆:curl -i http://localhost:8000/hello -H "x-api-key:PydUKRDGIXRqF2xh4usn1FLHbhGKVIz" HELLO, WORLD!