fix(config): remove name field from service endpoint spec

BREAKING CHANGE: Endpoint names will have to be removed from module configs.
garden-io · Sep 10, 2018 · 9f6f9f0 · 9f6f9f0
1 parent 7f010f9
commit 9f6f9f0
Show file tree

Hide file tree

Showing 9 changed files with 2 additions and 39 deletions.
diff --git a/docs/reference/config.md b/docs/reference/config.md
@@ -501,12 +501,7 @@ module:
       #
       # Optional.
       endpoints: 
-        - # A name to assign to the endpoint.
-          #
-          # Optional.
-          name: default
-
-          # The hostname that should route to this service. Defaults to the default hostname
+        - # The hostname that should route to this service. Defaults to the default hostname
           # configured
           # in the provider configuration.
           #

diff --git a/examples/local-tls/services/node-service/garden.yml b/examples/local-tls/services/node-service/garden.yml
@@ -11,8 +11,7 @@ module:
       endpoints:
         - path: /hello
           port: http
-        - name: call-go
-          path: /call-go-service
+        - path: /call-go-service
           port: http
       dependencies:
         - go-service

diff --git a/garden-cli/src/plugins/container.ts b/garden-cli/src/plugins/container.ts
@@ -40,7 +40,6 @@ import { ModuleSpec, ModuleConfig } from "../config/module"
 import { BaseServiceSpec, ServiceConfig, baseServiceSchema } from "../config/service"
 
 export interface ContainerEndpointSpec {
-  name: string
   hostname?: string
   path: string
   port: string
@@ -86,9 +85,6 @@ export type ContainerServiceConfig = ServiceConfig<ContainerServiceSpec>
 
 const endpointSchema = Joi.object()
   .keys({
-    name: joiIdentifier()
-      .default("default")
-      .description("A name to assign to the endpoint."),
     hostname: endpointHostnameSchema,
     path: Joi.string().uri(<any>{ relativeOnly: true })
       .default("/")
@@ -160,7 +156,6 @@ const serviceSchema = baseServiceSchema
       .default(false)
       .description("Whether to run the service as a daemon (to ensure only one runs per node)."),
     endpoints: joiArray(endpointSchema)
-      .unique("name")
       .description("List of endpoints that the service exposes.")
       .example([{
         path: "/api",

diff --git a/garden-cli/src/plugins/openfaas.ts b/garden-cli/src/plugins/openfaas.ts
@@ -279,7 +279,6 @@ async function getServiceStatus({ ctx, provider, service }: GetServiceStatusPara
   const k8sProvider = getK8sProvider(ctx)
 
   const endpoints: ServiceEndpoint[] = [{
-    name: "default",
     hostname: getExternalGatewayHostname(provider, k8sProvider),
     path: getServicePath(service),
     port: k8sProvider.config.ingressHttpPort,

diff --git a/garden-cli/src/types/service.ts b/garden-cli/src/types/service.ts
@@ -39,7 +39,6 @@ export type ServiceState = "ready" | "deploying" | "stopped" | "unhealthy" | "un
 export type ServiceProtocol = "http" | "https"  // | "tcp" | "udp"
 
 export interface ServiceEndpointSpec {
-  name: string
   hostname?: string
   path: string
   port: number
@@ -67,9 +66,6 @@ const portSchema = Joi.number()
 
 export const serviceEndpointSpecSchema = Joi.object()
   .keys({
-    name: Joi.string()
-      .default("default")
-      .description("A unique name for this endpoint."),
     hostname: endpointHostnameSchema,
     port: portSchema,
     path: Joi.string()
@@ -122,7 +118,6 @@ export const serviceStatusSchema = Joi.object()
       .description("How many replicas of the service are currently running."),
     endpoints: Joi.array()
       .items(serviceEndpointSchema)
-      .unique("name")
       .description("List of currently deployed endpoints for the service."),
     lastMessage: Joi.string()
       .allow("")

diff --git a/garden-cli/test/src/commands/call.ts b/garden-cli/test/src/commands/call.ts
@@ -13,7 +13,6 @@ const testProvider: PluginFactory = () => {
     "service-a": {
       state: "ready",
       endpoints: [{
-        name: "default",
         hostname: "service-a.test-project-b.local.app.garden",
         path: "/path-a",
         protocol: "http",
@@ -23,7 +22,6 @@ const testProvider: PluginFactory = () => {
     "service-b": {
       state: "ready",
       endpoints: [{
-        name: "default",
         hostname: "service-b.test-project-b.local.app.garden",
         path: "/",
         port: 32000,

diff --git a/garden-cli/test/src/commands/deploy.ts b/garden-cli/test/src/commands/deploy.ts
@@ -19,7 +19,6 @@ const testProvider: PluginFactory = () => {
     "service-a": {
       state: "ready",
       endpoints: [{
-        name: "default",
         hostname: "service-a.test-project-b.local.app.garden",
         path: "/path-a",
         port: 80,

diff --git a/garden-cli/test/src/plugins/container.ts b/garden-cli/test/src/plugins/container.ts
@@ -215,7 +215,6 @@ describe("plugins.container", () => {
               daemon: false,
               endpoints: [
                 {
-                  name: "default",
                   path: "/",
                   port: "http",
                 },
@@ -269,7 +268,6 @@ describe("plugins.container", () => {
                 dependencies: [],
                 daemon: false,
                 endpoints: [{
-                  name: "default",
                   path: "/",
                   port: "http",
                 }],
@@ -303,7 +301,6 @@ describe("plugins.container", () => {
                 dependencies: [],
                 daemon: false,
                 endpoints: [{
-                  name: "default",
                   path: "/",
                   port: "http",
                 }],
@@ -355,7 +352,6 @@ describe("plugins.container", () => {
               daemon: false,
               endpoints: [
                 {
-                  name: "bla",
                   path: "/",
                   port: "bla",
                 },

diff --git a/garden-cli/test/src/plugins/kubernetes/ingress.ts b/garden-cli/test/src/plugins/kubernetes/ingress.ts
@@ -379,7 +379,6 @@ describe("createIngresses", () => {
 
   it("should create an ingress for a basic container service", async () => {
     const service = await getTestService({
-      name: "default",
       path: "/",
       port: "http",
     })
@@ -422,12 +421,10 @@ describe("createIngresses", () => {
   it("should group endpoints by hostname", async () => {
     const service = await getTestService(
       {
-        name: "a",
         path: "/here",
         port: "http",
       },
       {
-        name: "b",
         path: "/there",
         port: "http",
       },
@@ -478,13 +475,11 @@ describe("createIngresses", () => {
   it("should create a rule for each hostname", async () => {
     const service = await getTestService(
       {
-        name: "a",
         hostname: "foo",
         path: "/",
         port: "http",
       },
       {
-        name: "b",
         hostname: "bar",
         path: "/",
         port: "http",
@@ -543,7 +538,6 @@ describe("createIngresses", () => {
   it("should map a configured TLS certificate to an endpoint", async () => {
     const service = await getTestService(
       {
-        name: "default",
         path: "/",
         port: "http",
       },
@@ -592,12 +586,10 @@ describe("createIngresses", () => {
   it("should group multiple endpoints by TLS certificate", async () => {
     const service = await getTestService(
       {
-        name: "default",
         path: "/",
         port: "http",
       },
       {
-        name: "other",
         hostname: "other.domain.com",
         path: "/",
         port: "http",
@@ -680,7 +672,6 @@ describe("createIngresses", () => {
   it("should throw if a configured certificate doesn't exist", async () => {
     const service = await getTestService(
       {
-        name: "default",
         path: "/",
         port: "http",
       },
@@ -704,7 +695,6 @@ describe("createIngresses", () => {
   it("should throw if a secret for a configured certificate doesn't contain a certificate", async () => {
     const service = await getTestService(
       {
-        name: "default",
         path: "/",
         port: "http",
       },
@@ -732,7 +722,6 @@ describe("createIngresses", () => {
   it("should throw if a secret for a configured certificate contains an invalid certificate", async () => {
     const service = await getTestService(
       {
-        name: "default",
         path: "/",
         port: "http",
       },
@@ -762,7 +751,6 @@ describe("createIngresses", () => {
   it("should correctly match an endpoint to a wildcard certificate", async () => {
     const service = await getTestService(
       {
-        name: "default",
         hostname: "something.wildcarddomain.com",
         path: "/",
         port: "http",
@@ -812,7 +800,6 @@ describe("createIngresses", () => {
   it("should use configured hostnames for a certificate when specified", async () => {
     const service = await getTestService(
       {
-        name: "default",
         hostname: "madeup.domain.com",
         path: "/",
         port: "http",