Merge pull request #446 from garden-io/service-port

Adds Service port config option to container module

docs/reference/config.md

@@ -643,16 +643,28 @@ module:
           # Required.
           name:
 
-          # The protocol of the service container port.
+          # The protocol of the port.
           #
           # Optional.
           protocol: TCP
 
-          # The port number on the service container.
+          # The port exposed on the container by the running procces. This will also be the
+          # default value for `servicePort`.
+          # `servicePort:80 -> containerPort:8080 -> process:8080`
+          #
+          # Example: "8080"
           #
           # Required.
           containerPort:
 
+          # The port exposed on the service. Defaults to `containerPort` if not specified.
+          # `servicePort:80 -> containerPort:8080 -> process:8080`
+          #
+          # Example: "80"
+          #
+          # Optional.
+          servicePort: <containerPort>
+
           hostPort:
 
           # Set this to expose the service on the specified port on the host node (may not be

examples/simple-project/services/go-service/garden.yml

@@ -6,7 +6,9 @@ module:
     - name: go-service
       ports:
         - name: http
-          containerPort: 80
+          containerPort: 8080
+          # Maps service:80 -> container:8080
+          servicePort: 80
       ingresses:
         - path: /hello-go
-          port: http
+          port: http

examples/simple-project/services/go-service/webserver/main.go

@@ -13,5 +13,5 @@ func main() {
 	http.HandleFunc("/hello-go", handler)
 	fmt.Println("Server running...")
 
-	http.ListenAndServe(":80", nil)
+	http.ListenAndServe(":8080", nil)
 }

garden-service/src/docs/config.ts

@@ -81,13 +81,18 @@ function renderCommentDescription(description: Joi.Description, width: number, {
   return wrap(output.join("\n")).split("\n").map(line => "# " + line)
 }
 
-function getDefaultValue(description: Joi.Description) {
+export function getDefaultValue(description: Joi.Description) {
   const defaultSpec = get(description, "flags.default")
 
   if (defaultSpec === undefined) {
     return
   } else if (defaultSpec && defaultSpec.function) {
-    return defaultSpec.function()
+    const value = defaultSpec.function({})
+    if (value === undefined) {
+      return defaultSpec.description
+    } else {
+      return value
+    }
   } else {
     return defaultSpec
   }

garden-service/src/plugins/container.ts

@@ -60,6 +60,8 @@ export interface ServicePortSpec {
   name: string
   protocol: ServicePortProtocol
   containerPort: number
+  // Defaults to containerPort
+  servicePort: number
   hostPort?: number
   nodePort?: number | null
 }
@@ -164,18 +166,29 @@ const healthCheckSchema = Joi.object()
       .description("Set this to check the service's health by checking if this TCP port is accepting connections."),
   }).xor("httpGet", "command", "tcpPort")
 
-const portSchema = Joi.object()
+export const portSchema = Joi.object()
   .keys({
     name: joiIdentifier()
       .required()
       .description("The name of the port (used when referencing the port elsewhere in the service configuration)."),
     protocol: Joi.string()
       .allow("TCP", "UDP")
       .default(DEFAULT_PORT_PROTOCOL)
-      .description("The protocol of the service container port."),
+      .description("The protocol of the port."),
     containerPort: Joi.number()
       .required()
-      .description("The port number on the service container."),
+      .example("8080")
+      .description(deline`
+        The port exposed on the container by the running procces. This will also be the default value
+        for \`servicePort\`.
+
+        \`servicePort:80 -> containerPort:8080 -> process:8080\``),
+    servicePort: Joi.number().default((context) => context.containerPort, "<containerPort>")
+      .example("80")
+      .description(deline`The port exposed on the service.
+        Defaults to \`containerPort\` if not specified.
+
+        \`servicePort:80 -> containerPort:8080 -> process:8080\``),
     hostPort: Joi.number()
       .meta({ deprecated: true }),
     nodePort: Joi.number()

garden-service/src/plugins/kubernetes/deployment.ts

@@ -204,6 +204,7 @@ export async function createDeployment(
 
   for (const port of ports) {
     container.ports.push({
+      name: port.name,
       protocol: port.protocol,
       containerPort: port.containerPort,
     })

garden-service/src/plugins/kubernetes/ingress.ts

@@ -45,7 +45,7 @@ export async function createIngresses(api: KubeApi, namespace: string, service:
           path: ingress.path,
           backend: {
             serviceName: service.name,
-            servicePort: findByName(service.spec.ports, ingress.spec.port)!.containerPort,
+            servicePort: findByName(service.spec.ports, ingress.spec.port)!.servicePort,
           },
         })),
       },

garden-service/src/plugins/kubernetes/service.ts

@@ -42,7 +42,7 @@ export async function createServices(service: ContainerService, namespace: strin
       name: portSpec.name,
       protocol: portSpec.protocol,
       targetPort: portSpec.containerPort,
-      port: portSpec.containerPort,
+      port: portSpec.servicePort,
     })
   }
 

garden-service/src/plugins/local/local-docker-swarm.ts

@@ -60,7 +60,7 @@ export const gardenPlugin = (): GardenPlugin => ({
           }
 
           if (p.hostPort) {
-            port.PublishedPort = p.hostPort
+            port.PublishedPort = p.servicePort
           }
         })
 

garden-service/src/plugins/local/local-google-cloud-functions.ts

@@ -61,6 +61,7 @@ export const gardenPlugin = (): GardenPlugin => ({
                 name: "http",
                 protocol: <ServicePortProtocol>"TCP",
                 containerPort: emulatorPort,
+                servicePort: emulatorPort,
               },
             ],
             volumes: [],

garden-service/test/src/docs/config.ts

@@ -0,0 +1,51 @@
+import { renderSchemaDescription, getDefaultValue } from "../../../src/docs/config"
+import { expect } from "chai"
+import * as Joi from "joi"
+import dedent = require("dedent")
+
+describe("config", () => {
+  const serivcePortSchema = Joi.number().default((context) => context.containerPort, "default value")
+    .example("8080")
+    .description("description")
+
+  const testDefaultSchema = Joi.number().default(() => "result", "default value")
+    .description("description")
+
+  const portSchema = Joi.object()
+    .keys({
+      containerPort: Joi.number()
+        .required()
+        .description("description"),
+      servicePort: serivcePortSchema,
+    })
+    .required()
+
+  describe("renderSchemaDescription", () => {
+    it("should render correct markdown", () => {
+      const yaml = renderSchemaDescription(portSchema.describe(), { required: true })
+      expect(yaml).to.equal(dedent`\n# description
+        #
+        # Required.
+        containerPort:
+
+        # description
+        #
+        # Example: "8080"
+        #
+        # Optional.
+        servicePort: default value`)
+    })
+  })
+
+  describe("renderSchemaDescription", () => {
+    it("should get the default return of the function over the param", () => {
+      const value = getDefaultValue(testDefaultSchema.describe())
+      expect(value).to.eq("result")
+    })
+
+    it("should get the default value if a function with context", () => {
+      const value = getDefaultValue(serivcePortSchema.describe())
+      expect(value).to.eq("default value")
+    })
+  })
+})

garden-service/test/src/plugins/container.ts

@@ -224,6 +224,7 @@ describe("plugins.container", () => {
                 name: "http",
                 protocol: "TCP",
                 containerPort: 8080,
+                servicePort: 8080,
               }],
               outputs: {},
               volumes: [],
@@ -275,7 +276,7 @@ describe("plugins.container", () => {
                 },
                 healthCheck:
                   { httpGet: { path: "/health", port: "http", scheme: "HTTP" } },
-                ports: [{ name: "http", protocol: "TCP", containerPort: 8080 }],
+                ports: [{ name: "http", protocol: "TCP", containerPort: 8080, servicePort: 8080 }],
                 outputs: {},
                 volumes: [],
               }],
@@ -315,7 +316,7 @@ describe("plugins.container", () => {
                 },
                 healthCheck:
                   { httpGet: { path: "/health", port: "http", scheme: "HTTP" } },
-                ports: [{ name: "http", protocol: "TCP", containerPort: 8080 }],
+                ports: [{ name: "http", protocol: "TCP", containerPort: 8080, servicePort: 8080 }],
                 outputs: {},
                 volumes: [],
               },

garden-service/test/src/plugins/kubernetes/ingress.ts

@@ -21,6 +21,7 @@ const ports = [{
   name: "http",
   protocol: <ServicePortProtocol>"http",
   containerPort: 123,
+  servicePort: 123,
 }]
 
 const basicConfig: KubernetesConfig = {

garden-service/test/src/types/container.ts

@@ -0,0 +1,22 @@
+import { expect } from "chai"
+import { validate } from "../../../src/config/common"
+import { portSchema } from "../../../src/plugins/container"
+
+describe("portSchema", () => {
+  it("should default servicePort to containerPorts value", async () => {
+    const containerPort = 8080
+    const obj = { name: "a", containerPort }
+
+    const value = validate(obj, portSchema)
+    expect(value["servicePort"]).to.equal(containerPort)
+  })
+
+  it("should not default servicePort to containerPorts when configured", async () => {
+    const containerPort = 8080
+    const servicePort = 9090
+    const obj = { name: "a", containerPort, servicePort }
+
+    const value = validate(obj, portSchema)
+    expect(value["servicePort"]).to.equal(servicePort)
+  })
+})