Merge branch 'master' of github.com:microsoft/bedrock-cli into edaena…

…-int-ring

docs/commands/data.json

@@ -141,8 +141,8 @@
         "defaultValue": ""
       },
       {
-        "arg": "-e, --env <environment>",
-        "description": "Filter by environment name",
+        "arg": "-r, --ring <ring>",
+        "description": "Filter by ring name",
         "defaultValue": ""
       },
       {

guides/building-helm-charts-for-spk.md

@@ -218,7 +218,7 @@ cluster.
 [top-level configuration](#top-level-configuration)
 
 `serviceName`: This configuration is overriden by the values form the
-[ring-level-configuration](#ring-level-configuration) file
+[ring-level-configuration](#ring-level-configuration) file.
 
 `image.repository`: This configuration is a special configuration, that can
 _only_ configured by a pipeline variable, `ACR_NAME`. `ACR_NAME` must be
@@ -257,6 +257,34 @@ from [ring level configuration](#ring-level-configuration) originally generated
 from the `hld-lifecycle` pipeline. The `selector` in this `service` targets a
 Kubernetes `Deployment` that maintains the same label.
 
+##### A note on Service Types
+
+The Kubernetes Service scaffolded by the
+[provided helm chart](./sample-helm-chart) _explicitly_ does not specify a
+service type. By default, Kubernetes services are created as `ClusterIP`,
+meaning that the Kubernetes Service is bound to a cluster _internal_ IP address,
+preventing external users from accessing the service. While a user can choose to
+utilize an opposing Kubernetes Service type, `LoadBalancer` within their Helm
+Charts, it is inadvisible - as this binds an _external_ and _public_ IP address
+to the Kubernetes Service, allowing external users to access the Kubernetes
+Service. For more information on service types, and their routing implications,
+refer to the Kubernetes Documentation
+[here](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types).
+
+To allow external traffic (ie ingress traffic) to be routed to Services hosted
+on the cluster, `spk` utilizes the `traefik2` ingress controller and associated
+`IngressRoute` rules to allow external traffic to be routed into your cluster
+from a single endpoint. An Ingress Controller can be be configured to handle all
+kinds of scenarios that you may want to handle when running services in
+produciton, such as circuit breaking or traffic throttling - please refer to the
+`traefik2`
+[configuration introduction](https://docs.traefik.io/v2.0/getting-started/configuration-overview/)
+for more details. Further, assuming a correctly configured helm chart with all
+the [requsitite values](#mandatory-helm-chart-configuration), `spk` builds and
+scaffolds an `IngressRoute` for a service and its associated rings
+automatically. Refer to [static configuration](#static-configuration) for more
+details.
+
 #### Kubernetes Deployment
 
 ![Rendered Kubernetes Deployment](./images/spk-rendered-deployment.png)

src/commands/deployment/get.decorator.json

@@ -24,8 +24,8 @@
       "defaultValue": ""
     },
     {
-      "arg": "-e, --env <environment>",
-      "description": "Filter by environment name",
+      "arg": "-r, --ring <ring>",
+      "description": "Filter by ring name",
       "defaultValue": ""
     },
     {

src/commands/deployment/get.test.ts

@@ -33,7 +33,7 @@ const MOCKED_INPUT_VALUES: CommandOptions = {
   buildId: "",
   commitId: "",
   deploymentId: "",
-  env: "",
+  ring: "",
   imageTag: "",
   output: "",
   service: "",
@@ -45,7 +45,7 @@ const MOCKED_VALUES: ValidatedOptions = {
   buildId: "",
   commitId: "",
   deploymentId: "",
-  env: "",
+  ring: "",
   imageTag: "",
   nTop: 0,
   output: "",
@@ -292,7 +292,6 @@ describe("Introspect deployments", () => {
       const dep = deployment as IDeployment;
 
       // Make sure the basic fields are defined
-      expect(dep.deploymentId).not.toBe("");
       expect(dep.service).not.toBe("");
       expect(duration(dep)).not.toBe("");
       expect(status(dep)).not.toBe("");
@@ -321,7 +320,6 @@ describe("Print deployments", () => {
     const deployment = [
       "2019-08-30T21:05:19.047Z",
       "hello-bedrock",
-      "7468ca0a24e1",
       "c626394",
       6046,
       "hello-bedrock-master-6046",
@@ -338,13 +336,14 @@ describe("Print deployments", () => {
     expect(table).toBeDefined();
 
     if (table) {
-      const matchItems = table.filter((field) => field[2] === deployment[2]);
+      //Use date (index 0) as matching filter
+      const matchItems = table.filter((field) => field[0] === deployment[0]);
       expect(matchItems).toHaveLength(1); // one matching row
 
       (matchItems[0] as IDeployment[]).forEach((field, i) => {
         expect(field).toEqual(deployment[i]);
       });
-      expect(matchItems[0]).toHaveLength(14);
+      expect(matchItems[0]).toHaveLength(13);
 
       table = printDeployments(
         mockedDeps,
@@ -395,7 +394,7 @@ describe("Output formats", () => {
     expect(table).toBeDefined();
 
     if (table) {
-      table.forEach((field) => expect(field).toHaveLength(20));
+      table.forEach((field) => expect(field).toHaveLength(19));
     }
   });
 });

src/commands/deployment/get.ts

@@ -61,7 +61,7 @@ export interface InitObject {
 export interface CommandOptions {
   watch: boolean;
   output: string;
-  env: string;
+  ring: string;
   imageTag: string;
   buildId: string;
   commitId: string;
@@ -117,7 +117,7 @@ export const validateValues = (opts: CommandOptions): ValidatedOptions => {
     buildId: opts.buildId,
     commitId: opts.commitId,
     deploymentId: opts.deploymentId,
-    env: opts.env,
+    ring: opts.ring,
     imageTag: opts.imageTag,
     nTop: top,
     output: opts.output,
@@ -307,13 +307,12 @@ export const printDeployments = (
     let header = [
       "Start Time",
       "Service",
-      "Deployment",
       "Commit",
       "Src to ACR",
       "Image Tag",
       "Result",
       "ACR to HLD",
-      "Env",
+      "Ring",
       "Hld Commit",
       "Result",
     ];
@@ -373,7 +372,6 @@ export const printDeployments = (
           : "-"
       );
       row.push(deployment.service !== "" ? deployment.service : "-");
-      row.push(deployment.deploymentId);
       row.push(deployment.commitId !== "" ? deployment.commitId : "-");
       row.push(
         deployment.srcToDockerBuild ? deployment.srcToDockerBuild.id : "-"
@@ -515,7 +513,7 @@ export const getDeployments = async (
       initObj.srcPipeline,
       initObj.hldPipeline,
       initObj.clusterPipeline,
-      values.env,
+      values.ring,
       values.imageTag,
       values.buildId,
       values.commitId,