Updating to version 0.5.5 (#367)

* Updating to version 0.5.5

* Updating changelog

CHANGELOG.md

@@ -1,5 +1,15 @@
 # RELEASE NOTES
 
+## [0.5.5] - 2020-03-04
+
+### Added
+
+- Initial version of `spk setup` command
+
+### Changed
+
+- Various bug fixes and refactoring
+
 ## [0.5.4] - 2020-02-25
 
 ### Changed

docs/commands/data.json

@@ -16,6 +16,18 @@
     ],
     "markdown": "This command creates a configuration file, `config.yaml` in a folder `.spk`\nunder your home directory. There are two options for creating this file\n\n1. an interactive mode where you have to answer a few questions; and\n2. you provide a `yaml` file and this `yaml` will be copied to the target\n   location.\n\n## Interactive mode\n\nThe command line tool attempts to read `config.yaml` in a folder `.spk` under\nyour home directory. Configuration values shall be read from it if it exists.\nAnd these values shall be default values for the questions. Otherwise, there\nshall be no default values. These are the questions\n\n1. Organization Name of Azure dev-op account\n2. Project Name of Azure dev-op account\n3. Personal Access Token (guides)\n\nThis tool shall verify these values by making an API call to Azure dev-op. They\nshall be written to `config.yaml` regardless the verification is successful or\nnot.\n\n> Note: In the event that you do not have internet connection, this verification\n> shall not be possible\n\n## Example\n\n```\nspk init --interactive\n```\n\nor\n\n```\nspk init --file myConfig.yaml\n```\n"
   },
+  "setup": {
+    "command": "setup",
+    "alias": "s",
+    "description": "An interactive command to setup resources in azure and azure dev-ops",
+    "options": [
+      {
+        "arg": "-f, --file <config-file-path>",
+        "description": "Path to the file that contains answers to the questions."
+      }
+    ],
+    "markdown": "## Description\n\nThis command assists in creating resources in Azure DevOps so that you can get\nstarted with using Bedrock. It creates\n\n1. An Azure DevOps project.\n\nBy Default, it runs in an interactive mode where you are prompted for answers\nfor a few questions\n\n1. Azure DevOps Organization Name\n2. Azure DevOps Project Name, the project to be created.\n3. Azure DevOps Personal Access Token. The token needs to have these permissions\n   1. Read and write projects.\n   2. Read and write codes.\n\nIt can also run in a non interactive mode by providing a file that contains\nanswers to the above questions.\n\n```\nspk setup --file <file-name>\n```\n\nContent of this file is as follow\n\n```\nazdo_org_name=<Azure DevOps Organization Name>\nazdo_project_name=<Azure DevOps Project Name>\nazdo_pat=<Azure DevOps Personal Access Token>\n```\n\n`azdo_project_name` is optional and default value is `BedrockRocks`.\n\nThe followings shall be created\n\n1. A working directory, `quick-start-env`\n2. Project shall not be created if it already exists.\n3. A Git Repo, `quick-start-hld`, it shall be deleted and recreated if it\n   already exists.\n   1. And initial commit shall be made to this repo\n4. A Git Repo, `quick-start-manifest`, it shall be deleted and recreated if it\n   already exists.\n   1. And initial commit shall be made to this repo\n\n## Setup log\n\nA `setup.log` file is created after running this command. This file contains\ninformation about what are created and the execution status (completed or\nincomplete). This file will not be created if input validation failed.\n"
+  },
   "deployment create": {
     "command": "create",
     "alias": "c",
@@ -440,12 +452,12 @@
       },
       {
         "arg": "-u, --repo-url <repo-url>",
-        "description": "Repository URL",
+        "description": "Repository URL in Azure DevOps for application/service source code",
         "required": true
       },
       {
         "arg": "-d, --devops-project <devops-project>",
-        "description": "Azure DevOps Project",
+        "description": "Azure DevOps Project name",
         "required": true
       },
       {
@@ -517,6 +529,11 @@
         "description": "bedrock helm chart repository. --helm-chart-* and --helm-config-* are exclusive; you may only use one.",
         "defaultValue": ""
       },
+      {
+        "arg": "-g, --helm-config-git <helm-git>",
+        "description": "bedrock helm chart configuration git repository. --helm-chart-* and --helm-config-* are exclusive; you may only use one.",
+        "defaultValue": ""
+      },
       {
         "arg": "-b, --helm-config-branch <helm-branch>",
         "description": "bedrock custom helm chart configuration branch. --helm-chart-* and --helm-config-* are exclusive; you may only use one.",
@@ -528,9 +545,9 @@
         "defaultValue": ""
       },
       {
-        "arg": "-g, --helm-config-git <helm-git>",
-        "description": "bedrock helm chart configuration git repository. --helm-chart-* and --helm-config-* are exclusive; you may only use one.",
-        "defaultValue": ""
+        "arg": "--helm-config-access-token-variable <env-variable>",
+        "description": "An environment variable which will contain the value of PAT to access the git repository specified in --helm-config-git",
+        "defaultValue": "ACCESS_TOKEN_SECRET"
       },
       {
         "arg": "-d, --packages-dir <dir>",
@@ -583,7 +600,7 @@
         "defaultValue": ""
       }
     ],
-    "markdown": "## Descripton\n\nAdd a new service into this initialized spk project repository.\n\n## Note\n\n- `--helm-chart-*` and `--helm-config-*` settings are exclusive. **You may only\n  use one.**\n- `--middlewares`, `--k8s-backend-port`, `--path-prefix`,\n  `--path-prefix-major-version`, and `--k8s-backend` are all used to configure\n  the generated Traefik2 IngressRoutes. ie.\n  `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`\n  will result in an IngressRoute that looks like:\n  ```\n  apiVersion: traefik.containo.us/v1alpha1\n  kind: IngressRoute\n  metadata:\n    name: my-example-documents-service-master\n  spec:\n    routes:\n      - kind: Rule\n        match: 'PathPrefix(`/v2/documents`) && Headers(`Ring`, `master`)'\n        middlewares:\n          - name: my-example-documents-service-master\n          - name: middlewareA\n        services:\n          - name: docs-service\n            port: 3001\n  ```\n"
+    "markdown": "## Description\n\nAdd a new service into this initialized spk project repository.\n\n## Example\n\n```bash\nspk service create . \\\n  --display-name $app_name \\\n  --helm-config-path $path_to_chart_in_repo \\\n  --helm-config-git $helm_repo_url \\ # Needs to start with https and not contain user name\n  --helm-config-branch master \\\n  --helm-chart-access-token-variable $ENV_VAR_NAME\n```\n\n## Note\n\n- `--helm-chart-*` and `--helm-config-*` settings are mutually-exclusive. **You\n  may only use one.**\n  - If the git repository referenced in `--helm-config-git` is a private\n    repository, you can specify an environment variable in your\n    HLD-to-Materialized pipeline containing your a PAT to authenticate with via\n    the `--helm-chart-access-token-variable` option.\n- `--middlewares`, `--k8s-backend-port`, `--path-prefix`,\n  `--path-prefix-major-version`, and `--k8s-backend` are all used to configure\n  the generated Traefik2 IngressRoutes. i.e.\n\n  ```sh\n  spk service create my-example-documents-service \\\n    --middlewares middleware \\\n    --k8s-backend-port 3001 \\\n    --k8s-backend docs-service \\\n    --path-prefix documents \\\n    --path-prefix-major-version v2\n  ```\n\n  will result in an IngressRoute that looks like:\n\n  ```yaml\n  apiVersion: traefik.containo.us/v1alpha1\n  kind: IngressRoute\n  metadata:\n    name: my-example-documents-service-master\n  spec:\n    routes:\n      - kind: Rule\n        match: \"PathPrefix(`/v2/documents`) && Headers(`Ring`, `master`)\"\n        middlewares:\n          - name: my-example-documents-service-master\n          - name: middlewareA\n        services:\n          - name: docs-service\n            port: 3001\n  ```\n"
   },
   "service install-build-pipeline": {
     "command": "install-build-pipeline <service-name>",