Adding configs for ingress routes for pathprefix, version, backend. (#222)

* Adding configs for ingress routes for versions and path prefix and backend

* Adding ingress configs to service create. Removing deprecated code for onboarding multiple services with project init

* Updating unit tests

* docs

* feedback. Renaming version to pathprefixversion. adding docs

* --path-prefix-major-version and --k8s-backend

* fixing merge conflicts and updating k8s-service-port to k8s-backend-port

* lint

* reconcile test

* fixing tests

Co-authored-by: Nate <[email protected]>
Co-authored-by: Bhargav Nookala <[email protected]>

Author: 3 people

docs/service-management.md

@@ -49,14 +49,38 @@ Options:
   -e, --maintainer-email <maintainer-email>                   The email of the primary maintainer for this service. (default: "maintainer email")
   --git-push                                                  SPK CLI will try to commit and push these changes to a new origin/branch named after the service. (default: false)
   --middlewares <comma-delimitated-list-of-middleware-names>  Traefik2 middlewares you wish to to be injected into your Traefik2 IngressRoutes (default: "")
-  --k8s-service-port <port>                                   Kubernetes service port which this service is exposed with; will be used to configure Traefik2 IngressRoutes (default: "80")
-  -h, --help                                                  output usage information
+  --k8s-backend-port <port>                                   Kubernetes backend service port which this service is exposed with; will be used to configure Traefik2 IngressRoutes (default: "80")
+  --k8s-backend <backend>                                     Kubernetes backend service name; will be used to configure Traefik2 IngressRoutes (default: "")
+  --path-prefix <path-prefix>                                 The path prefix for ingress route; will be used to configure Traefik2 IngressRoutes. If omitted, then the service name will used. (default: "")
+  --path-prefix-major-version <path-prefix-major-version>     Version to be used in the path prefix; will be used to configure Traefik2 IngressRoutes. ie. 'v1' will result in a path prefix of '/v1/servicename (default: "")
+  -h, --help                                                  output usage information                                            output usage information
 ```
 
-**NOTE:**
-
-`--helm-chart-*` and `--helm-config-*` settings are exclusive. **You may only
-use one.**
+**NOTES:**
+
+- `--helm-chart-*` and `--helm-config-*` settings are exclusive. **You may only
+  use one.**
+- `--middlewares`, `--k8s-backend-port`, `--path-prefix`,
+  `--path-prefix-major-version`, and `--k8s-backend` are all used to configure
+  the generated Traefik2 IngressRoutes. ie.
+  `spk service create my-example-documents-service --middlewares middlewareA --k8s-backend-port 3001 --k8s-backend docs-service --path-prefix documents --path-prefix-major-version v2`
+  will result in an IngressRoute that looks like:
+  ```
+  apiVersion: traefik.containo.us/v1alpha1
+  kind: IngressRoute
+  metadata:
+    name: my-example-documents-service-master
+  spec:
+    routes:
+      - kind: Rule
+        match: 'PathPrefix(`/v2/documents`) && Headers(`Ring`, `master`)'
+        middlewares:
+          - name: my-example-documents-service-master
+          - name: middlewareA
+        services:
+          - name: docs-service
+            port: 3001
+  ```
 
 ### install-build-pipeline
 

src/commands/hld/reconcile.test.ts

@@ -171,7 +171,7 @@ describe("addChartToRing", () => {
           path
         }
       },
-      k8sServicePort: 1337
+      k8sBackendPort: 1337
     };
 
     /* tslint:disable-next-line: no-string-literal */
@@ -201,7 +201,7 @@ describe("addChartToRing", () => {
           sha
         }
       },
-      k8sServicePort: 1337
+      k8sBackendPort: 1337
     };
 
     /* tslint:disable-next-line: no-string-literal */
@@ -229,7 +229,7 @@ describe("addChartToRing", () => {
           repository
         }
       },
-      k8sServicePort: 1337
+      k8sBackendPort: 1337
     };
 
     /* tslint:disable-next-line: no-string-literal */
@@ -282,7 +282,7 @@ describe("reconcile tests", () => {
               sha
             }
           },
-          k8sServicePort: 1337
+          k8sBackendPort: 1337
         }
       }
     };
@@ -329,7 +329,7 @@ describe("reconcile tests", () => {
               sha
             }
           },
-          k8sServicePort: 1337
+          k8sBackendPort: 1337
         }
       }
     };
@@ -369,7 +369,7 @@ describe("reconcile tests", () => {
             sha
           }
         },
-        k8sServicePort: 80
+        k8sBackendPort: 80
       }
     };
 
@@ -392,7 +392,7 @@ describe("reconcile tests", () => {
             sha
           }
         },
-        k8sServicePort: 80
+        k8sBackendPort: 80
       }
     };
 
@@ -419,7 +419,7 @@ describe("reconcile tests", () => {
             sha
           }
         },
-        k8sServicePort: 80
+        k8sBackendPort: 80
       }
     };
 

src/commands/hld/reconcile.ts

@@ -311,12 +311,15 @@ const createIngressRouteForRing = (
   const ingressRoute = TraefikIngressRoute(
     serviceName,
     ring,
-    serviceConfig.k8sServicePort,
+    serviceConfig.k8sBackendPort,
     {
+      k8sBackend: serviceConfig.k8sBackend,
       middlewares: [
         middlewares.metadata.name,
         ...(serviceConfig.middlewares ?? [])
-      ]
+      ],
+      pathPrefix: serviceConfig.pathPrefix,
+      pathPrefixMajorVersion: serviceConfig.pathPrefixMajorVersion
     }
   );
 

src/commands/project/init.test.ts

@@ -52,7 +52,7 @@ describe("initializing an existing file does not modify it", () => {
               sha: "bar"
             }
           },
-          k8sServicePort: 1337
+          k8sBackendPort: 1337
         }
       }
     };

src/commands/project/init.ts

@@ -67,9 +67,8 @@ export const initialize = async (
   logger.info(`Initializing project Bedrock project ${absProjectRoot}`);
 
   const defaultRing = opts ? [opts.defaultRing] : [];
-  // Initialize all paths
-  await generateBedrockFile(absProjectRoot, [], defaultRing);
-  await generateMaintainersFile(absProjectRoot, []); // TOFIX: packagePaths is hardcoded to []
+  await generateBedrockFile(absProjectRoot, defaultRing);
+  await generateMaintainersFile(absProjectRoot, []);
   await generateHldLifecyclePipelineYaml(absProjectRoot);
   generateGitIgnoreFile(absProjectRoot, "spk.log");
 
@@ -157,14 +156,12 @@ const generateMaintainersFile = async (
  */
 const generateBedrockFile = async (
   projectPath: string,
-  packagePaths: string[],
   defaultRings: string[] = []
 ) => {
   const absProjectPath = path.resolve(projectPath);
-  const absPackagePaths = packagePaths.map(p => path.resolve(p));
   logger.info(`Generating bedrock.yaml file in ${absProjectPath}`);
 
-  const base: IBedrockFile = {
+  const baseBedrockFile: IBedrockFile = {
     rings: defaultRings.reduce<{ [ring: string]: { isDefault: boolean } }>(
       (defaults, ring) => {
         defaults[ring] = { isDefault: true };
@@ -175,31 +172,6 @@ const generateBedrockFile = async (
     services: {}
   };
 
-  // Populate bedrock file
-  const bedrockFile = absPackagePaths.reduce<IBedrockFile>(
-    (file, absPackagePath) => {
-      const relPathToPackageFromRoot = path.relative(
-        absProjectPath,
-        absPackagePath
-      );
-
-      const helm: IHelmConfig = {
-        chart: {
-          branch: "",
-          git: "",
-          path: ""
-        }
-      };
-
-      file.services["./" + relPathToPackageFromRoot] = {
-        helm,
-        k8sServicePort: 80
-      };
-      return file;
-    },
-    base
-  );
-
   // Check if a bedrock.yaml already exists; skip write if present
   const bedrockFilePath = path.join(absProjectPath, "bedrock.yaml");
   if (fs.existsSync(bedrockFilePath)) {
@@ -208,6 +180,6 @@ const generateBedrockFile = async (
     );
   } else {
     // Write out
-    write(bedrockFile, absProjectPath);
+    write(baseBedrockFile, absProjectPath);
   }
 };

src/commands/service/create.test.ts

@@ -39,7 +39,10 @@ describe("validate pipeline config", () => {
     "my,middleware,string",
     true,
     "testDisplayName",
-    80
+    80,
+    "pathPrefix",
+    "version",
+    "backend"
   ];
 
   it("config is valid", () => {
@@ -81,13 +84,13 @@ describe("Adding a service to a repo directory", () => {
     );
 
     // addService call
-    const k8sServicePort = 1337;
+    const k8sBackendPort = 1337;
     await createService(
       randomTmpDir,
       serviceName,
       packageDir,
       false,
-      k8sServicePort
+      k8sBackendPort
     );
 
     // Check temp test directory exists
@@ -110,7 +113,7 @@ describe("Adding a service to a repo directory", () => {
     const bedrock = Bedrock(randomTmpDir);
     const newService = bedrock.services["./" + serviceName];
     expect(newService).toBeDefined();
-    expect(newService.k8sServicePort).toBe(k8sServicePort);
+    expect(newService.k8sBackendPort).toBe(k8sBackendPort);
   });
 
   test("New directory is created under '/packages' directory with required service files.", async () => {