Add basic descriptions to YAML pipelines (#200)

* Add basic descriptions to YAML pipelines

* Updated comments to address review feedback

* Add missing feedback fix

Author: tcare

.pipelines/azdo-abtest-pipeline.yml

@@ -1,3 +1,4 @@
+# Pipeline for the canary deployment workflow.
 pr: none
 trigger:
   branches:
@@ -23,7 +24,6 @@ variables:
 - name: 'SCORE_SCRIPT'
   value: 'scoreA.py'
 
-
 stages:
 - stage: 'Building'
   jobs:
@@ -50,7 +50,6 @@ stages:
     - publish: $(System.DefaultWorkingDirectory)/charts
       artifact: allcharts
 
-
 - stage: 'Blue_Staging'
   jobs:
   - deployment: "Deploy_to_Staging"

.pipelines/azdo-base-pipeline.yml

@@ -1,3 +1,4 @@
+# Pipeline template to run linting, unit tests with code coverage, and publish the results.
 steps:
 - script: |   
    flake8 --output-file=lint-testresults.xml --format junit-xml

.pipelines/azdo-helm-install.yml

@@ -1,9 +1,10 @@
+# Pipeline template for installing helm on the agent.
 steps:
 - task: Bash@3
   displayName: 'Install Helm $(helmVersion)'
   inputs:
     targetType: inline
-    script:  wget -q $(helmDownloadURL) -O /tmp/$FILENAME && tar -zxvf /tmp/$FILENAME -C /tmp && sudo mv /tmp/linux-amd64/helm /usr/local/bin/helm
+    script: wget -q $(helmDownloadURL) -O /tmp/$FILENAME && tar -zxvf /tmp/$FILENAME -C /tmp && sudo mv /tmp/linux-amd64/helm /usr/local/bin/helm
   env:
     HELM_VERSION: $(helmVersion)
     FILENAME: helm-$(helmVersion)-linux-amd64.tar.gz

.pipelines/azdo-helm-upgrade.yml

@@ -1,8 +1,9 @@
+# Pipeline template for deploying / upgrading using Helm.
 parameters:
   chartPath: ''
   releaseName: '' 
   overrideValues: ''
-    
+
 steps:
 - template: azdo-helm-install.yml
 - task: HelmDeploy@0

.pipelines/azdo-pr-build-train.yml

@@ -1,3 +1,4 @@
+# Pipeline to run basic code quality tests as part of pull requests to the master branch.
 trigger: none
 pr:
   branches:

.pipelines/diabetes_regression-ci-build-train.yml

@@ -1,3 +1,4 @@
+# Continuous Integration (CI) pipeline that orchestrates the training, evaluation, registration, deployment, and testing of the diabetes_regression model.
 pr: none
 trigger:
   branches:
@@ -84,6 +85,7 @@ stages:
     timeoutInMinutes: 0
     steps:
     - template: diabetes_regression-template-get-model-version.yml
+
 - stage: 'Deploy_ACI'
   displayName: 'Deploy to ACI'
   dependsOn: Trigger_AML_Pipeline

.pipelines/diabetes_regression-ci-image.yml

@@ -1,3 +1,4 @@
+# Builds the container image that is used by other pipelines for scoring.
 pr: none
 trigger:
   branches:
@@ -10,7 +11,7 @@ trigger:
     - diabetes_regression/scoring/
     exclude:
     - diabetes_regression/scoring/deployment_config_aci.yml
-    - diabetes_regression/scoring/deployment_config_aks.yml    
+    - diabetes_regression/scoring/deployment_config_aks.yml
 
 pool: 
   vmImage: 'ubuntu-latest'
@@ -23,7 +24,6 @@ variables:
   value: 'scoreB.py'
 
 steps:
-
 - task: AzureCLI@1
   inputs:
     azureSubscription: '$(WORKSPACE_SVC_CONNECTION)'
@@ -32,6 +32,6 @@ steps:
     inlineScript: |
       set -e
       export SUBSCRIPTION_ID=$(az account show --query id -o tsv)
-      python3 -m ml_service.util.create_scoring_image   
+      python3 -m ml_service.util.create_scoring_image
   displayName: 'Create Scoring Image'
 

.pipelines/diabetes_regression-template-get-model-version.yml

@@ -1,3 +1,4 @@
+# Pipeline template that attempts to get the latest model version and adds it to the environment for subsequent tasks to use.
 steps:
 - task: AzureCLI@1
   inputs:

.pipelines/diabetes_regression-variables.yml

@@ -1,8 +1,10 @@
+# Pipeline template that defines common runtime environment variables.
 variables:
   # Azure ML Workspace Variables
   - name: EXPERIMENT_NAME
     value: mlopspython
-    # AML Compute Cluster Config
+
+  # AML Compute Cluster Config
   - name: AML_COMPUTE_CLUSTER_CPU_SKU
     value: STANDARD_DS2_V2
   - name: AML_COMPUTE_CLUSTER_NAME
@@ -13,6 +15,7 @@ variables:
     value: 4
   - name: AML_CLUSTER_PRIORITY
     value: lowpriority
+
     # Training Config
   - name: BUILD_TRAIN_SCRIPT
     value: diabetes_regression_build_train_pipeline.py
@@ -22,6 +25,7 @@ variables:
     value: sklearn_regression_model.pkl
   - name: MODEL_VERSION
     value: "1"
+
     # AML Pipeline Config
   - name: TRAINING_PIPELINE_NAME
     value: "diabetes-Training-Pipeline"

environment_setup/docker-image-pipeline.yml

@@ -1,3 +1,4 @@
+# Pipeline that builds and pushes the microsoft/mlopspython image.
 resources:
 - repo: self
 

environment_setup/iac-create-environment.yml

@@ -1,3 +1,4 @@
+# CI/PR Pipeline that deploys an ARM template to create or update the resources needed by the other pipelines.
 trigger:
   branches:
     include:

environment_setup/iac-remove-environment.yml

@@ -1,3 +1,4 @@
+# Pipeline that removes the resources created by the IaC Create Environment pipeline.
 pr: none
 trigger: none