From 7fa411b44fe6e5b29235a1569610ee6ac8de918d Mon Sep 17 00:00:00 2001 From: Charlie Drage Date: Fri, 28 Oct 2016 11:15:16 -0400 Subject: [PATCH] Add documentation on recenty labels feature This adds some documentation to the user guide regarding the new labels feature that's been added to Kompose. --- docs/user-guide.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/user-guide.md b/docs/user-guide.md index 8bedfa91..c5a3d3cf 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -278,3 +278,31 @@ WARN[0000] Unsupported key build - ignoring WARN[0000] Unsupported key cap_add - ignoring WARN[0000] Unsupported key dockerfile - ignoring ``` + +## Labels + +`kompose` supports Kompose-specific labels within the `docker-compose.yml` file in order to explicitly imply a service type upon conversion. + +The currently supported options are: + +| Key | Value | +|----------------------|-------------------------------------| +| kompose.service.type | nodeport / clusterip / loadbalancer | + + +For example: + +```yaml +--- +version: "2" +services: + nginx: + image: nginx + dockerfile: foobar + build: ./foobar + cap_add: + - ALL + container_name: foobar + labels: + kompose.service.type: nodeport +```