From b2f0a31d7711a74a6dd90a0993580e42be613a78 Mon Sep 17 00:00:00 2001 From: Joao Fernandes Date: Wed, 21 Mar 2018 16:08:03 -0700 Subject: [PATCH] Update Interlock service labels reference --- _data/toc.yaml | 3 ++ .../interlock/configuration/service-labels.md | 34 ----------------- ee/ucp/interlock/usage/labels-reference.md | 37 +++++++++++++++++++ 3 files changed, 40 insertions(+), 34 deletions(-) delete mode 100644 ee/ucp/interlock/configuration/service-labels.md create mode 100644 ee/ucp/interlock/usage/labels-reference.md diff --git a/_data/toc.yaml b/_data/toc.yaml index b8635cca20..7d41cd9a60 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -1716,6 +1716,9 @@ manuals: - title: Set a default service path: /ee/ucp/interlock/usage/default-service/ + - title: Service labels reference + path: /ee/ucp/interlock/usage/labels-reference/ + - sectiontitle: Introduction section: diff --git a/ee/ucp/interlock/configuration/service-labels.md b/ee/ucp/interlock/configuration/service-labels.md deleted file mode 100644 index 1b8a5dab88..0000000000 --- a/ee/ucp/interlock/configuration/service-labels.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Interlock service labels -description: Learn about Interlock, an application routing and load balancing system - for Docker Swarm. -keywords: ucp, interlock, load balancing -ui_tabs: -- version: ucp-3.0 - orhigher: false ---- - -{% if include.version=="ucp-3.0" %} - -Applications that publish using Interlock use service labels to configure how they are published. -The following table describes the available options and what they do. - -| Label | Description | Example | -|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------| -| `com.docker.lb.hosts` | Comma separated list of the hosts that the service should serve | `example.com,test.com` | -| `com.docker.lb.port` | Port to use for internal upstream communication | `8080` | -| `com.docker.lb.network` | Name of network the proxy service should attach to for upstream connectivity | `app-network-a` | -| `com.docker.lb.context_root` | Context or path to use for the application | `/app` | -| `com.docker.lb.context_root_rewrite` | Boolean to enable rewrite for the context root | `true` | -| `com.docker.lb.ssl_only` | Boolean to force SSL for application | `true` | -| `com.docker.lb.ssl_cert` | Docker secret to use for the SSL certificate | `example.com.cert` | -| `com.docker.lb.ssl_key` | Docker secret to use for the SSL key | `example.com.key` | -| `com.docker.lb.websocket_endpoints` | Comma separated list of endpoints to configure to be upgraded for websockets | `/ws,/foo` | -| `com.docker.lb.service_cluster` | Name of the service cluster to use for the application | `us-east` | -| `com.docker.lb.ssl_backend` | Enable SSL communication to the upstreams | `true` | -| `com.docker.lb.ssl_backend_tls_verify` | Verification mode for the upstream TLS | `none` | -| `com.docker.lb.sticky_session_cookie` | Cookie to use for sticky sessions | `none` | -| `com.docker.lb.redirects` | Semi-colon separated list of redirects to add in the format of `,`. Example: (`http://old.example.com,http://new.example.com;`) | `none` | -| `com.docker.lb.ssl_passthrough` | Enable SSL passthrough | `false` | - -{% endif %} diff --git a/ee/ucp/interlock/usage/labels-reference.md b/ee/ucp/interlock/usage/labels-reference.md new file mode 100644 index 0000000000..9035b381ac --- /dev/null +++ b/ee/ucp/interlock/usage/labels-reference.md @@ -0,0 +1,37 @@ +--- +title: Layer 7 routing labels reference +description: Learn about Interlock, an application routing and load balancing system + for Docker Swarm. +keywords: ucp, interlock, load balancing +ui_tabs: +- version: ucp-3.0 + orhigher: false +--- + +{% if include.version=="ucp-3.0" %} + +Once the layer 7 routing solution is enabled, you can +[start using it in your swarm services](index.md). + +The following labels are available for you to use in swarm services: + + +| Label | Description | Example | +|:---------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------| +| `com.docker.lb.hosts` | Comma separated list of the hosts that the service should serve. | `example.com,test.com` | +| `com.docker.lb.port` | Port to use for internal upstream communication. | `8080` | +| `com.docker.lb.network` | Name of network the proxy service should attach to for upstream connectivity. | `app-network-a` | +| `com.docker.lb.context_root` | Context or path to use for the application. | `/app` | +| `com.docker.lb.context_root_rewrite` | Boolean to enable rewrite for the context root. | `true` | +| `com.docker.lb.ssl_only` | Boolean to force SSL for application. | `true` | +| `com.docker.lb.ssl_cert` | Docker secret to use for the SSL certificate. | `example.com.cert` | +| `com.docker.lb.ssl_key` | Docker secret to use for the SSL key. | `example.com.key` | +| `com.docker.lb.websocket_endpoints` | Comma separated list of endpoints to configure to be upgraded for websockets. | `/ws,/foo` | +| `com.docker.lb.service_cluster` | Name of the service cluster to use for the application. | `us-east` | +| `com.docker.lb.ssl_backend` | Enable SSL communication to the upstreams. | `true` | +| `com.docker.lb.ssl_backend_tls_verify` | Verification mode for the upstream TLS. | `none` | +| `com.docker.lb.sticky_session_cookie` | Cookie to use for sticky sessions. | `none` | +| `com.docker.lb.redirects` | Semi-colon separated list of redirects to add in the format of `,`. Example: `http://old.example.com,http://new.example.com;` | `none` | +| `com.docker.lb.ssl_passthrough` | Enable SSL passthrough. | `false` | + +{% endif %}