Skip to content

Commit 5621cda

Browse files
committed
Intial commit, fixing some of the bugs found in the getting started guide
1 parent ba2f843 commit 5621cda

File tree

2 files changed

+41
-22
lines changed

2 files changed

+41
-22
lines changed

docs/getting_started.md

Lines changed: 38 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -82,44 +82,63 @@ Great, you now have the build pipeline setup, you can either manually trigger it
8282

8383
**Note:** For setting up release pipelines, first download the [release-pipelines](../release-pipelines) to your local filesystem so you can import it.
8484

85-
1. Select the Release tab from the menu on the left, then click on **New Pipeline**![import release pipeline](./images/release-new-pipeline.png)
85+
**Also Note:** If this is the first time you are creating a release pipeline, you would see the following option, click on **New Pipeline**
86+
![import release pipeline](./images/release-new-pipeline.png)
8687

87-
2. <<TODO: Create a empty release pipeline definition, such that we can get option to import the pipeline Json>>
88+
To enable the option to **Import release pipeline**, we must have atleast one release pipeline so let's create one with an empty job.
89+
![import release pipeline](./images/release-empty-job.png)
8890

89-
2. Select the Release tab from the menu on the left, then click the New dropdown on top and click on **Import Release pipeline**
91+
On the next screen, click on **Save** and then click **Ok** to save the empty release pipeline.
92+
![import release pipeline](./images/release-save-empty.png)
93+
94+
**Steps**
95+
96+
1. Select the Release tab from the menu on the left, then click the New dropdown on top and click on **Import Release pipeline**
9097
![import release pipeline](./images/release-import.png)
9198

92-
3. On the next screen, navigate to release-pipelines folder and select retrainingtrigger.json pipeline file, click import. You should now see the following screen. Under Stages click on the Retrain stage, where it shows the red error sign.
99+
1. On the next screen, navigate to release-pipelines folder and select retrainingtrigger.json pipeline file, click import. You should now see the following screen. Under Stages click on the Retrain stage, where it shows the red error sign.
93100
![release retraining triggger](./images/release-retrainingtrigger.png)
94101

95-
Click on agent job and then from the drop down for Agent Pool on the right side select **Hosted Ubuntu 1604** agent to execute your run and click **Save** button on top right.
102+
Click on agent job and then from the drop down for Agent Pool on the right side select **Hosted Ubuntu 1604** agent to execute your run and click **Save** button on top right.
96103
![release retraining agent](./images/release-retrainingagent.png)
97104

98-
4. We want the retraining pipeline to be triggered every time build pipeline is complete. To create this dependency, we will link the artifact from build pipeline as a trigger for retraining trigger release pipeline. To do so, click on the pipeline tab and then hit **Add an artifact** option under Artifacts.
105+
1. We would now link the variable group we created earlier to this release pipeline. To do so click on the **Variables** tab, then click on **Variable** groups and then select **Link variable group** and select the variable group that we created in previous step and click **Link** followed by **Save** button.
106+
![release retraining artifact](./images/release-link-vg.png)
107+
1. We want the retraining pipeline to be triggered every time build pipeline is complete. To create this dependency, we will link the artifact from build pipeline as a trigger for retraining trigger release pipeline. To do so, click on the **pipeline** tab and then select **Add an artifact** option under Artifacts.
99108
![release pipeline view](./images/release-retrainingpipeline.png)
100109

101-
5. This will open up a pop up window, on this screen:
110+
1. This will open up a pop up window, on this screen:
102111
- for source type, select **Build**
103112
- for project, select your project in Azure DevOps that you created in previous steps.
104113
- For Source select the source build pipeline.
105114
- Other fields will get auto populated, you can leave them as it is.
106115
![release retraining artifact](./images/release-retrainingartifact.png)
107116

108-
6. Artifact is now added for retraining trigger pipeline, hit the **save** button on top right and then click **ok**. You now have the retraining trigger pipeline all set up and it will get executed everytime your build pipeline finishes its run. If you want to run this pipeline on a schedule, you can set one by clicking on **Schedule set** in Artifacts section.
117+
1. Artifact is now added for retraining trigger pipeline, hit the **save** button on top right and then click **ok**. You now have the retraining trigger pipeline all set up. To trigger this pipeline every time build pipeline executes, click on the lighting sign to enable the **Continous Deployment Trigger**, click Save.
118+
![release retraining artifact](./images/release-deploymentcitrigger.png)
119+
120+
1. We now need to update one of the tasks in the pipeline to correct the script path as it is dependent on the artifact name. The artifact name is based of your GitHub username since you cloned the repo. To make the change
121+
- From the release pipeline view, click on the highlighted section.
122+
![release retraining task](./images/release-retraintask.png)
123+
- On the next screen, select the **install requirements** task and click on three dots in the highlighted section.
124+
![release env task](./images/release-envtask.png).
125+
- This will open a pop up for the linked artifact and you can select the file.
126+
![release env task](./images/release-envtask-scriptpath.png)
127+
Also update the path for **Working Directory** (under Advanced) and select **environment_setup** as working directoy from the linked artifact.
128+
- Similarly for **Run AML Pipeline** task, change the working directory to **devops-for-ai** under your artifact.
129+
![release env task](./images/release-workingdir.png)
130+
131+
2. If you want to run this pipeline on a schedule, you can set one by clicking on **Schedule set** in Artifacts section.
109132
![release retraining artifact](./images/release-retrainingartifactsuccess.png)
110133

111-
1. <<TODO: Link Variable group to the release pipeline>>
112-
113-
7. You can also run this pipeline on a schedule. Click on **Schedule set** to set the pipeline run schedule
114-
115-
116-
To view the newly created pipeline, click on the release tab on the left hand side and it will show the retraining trigger pipeline.
117-
118-
1. <<TODO: Enable the continuous deployment trigger on the build artifact>>
119-
120-
1. <<TODO: Manual Trigger the retraining pipeline trigger>>
134+
1. For the first time, we will manually trigger this pipeline.
135+
- Click Releases option on the left hand side and navigate to the release pipeline you just created.
136+
![release retraining artifact](./images/release-createarelease.png)
137+
- Click **Create Release**
138+
![release create ](./images/release-create.png)
139+
- On the next screen click on **Create** button, this creates a manual release for you.
121140

122-
1. <<TODO: The artifact name is defined by the name of build pipeline. If people fork it, the build pipeline name will change, this will change the artifact name and the workingDirectory path will change causing release pipelines to fail >>
141+
2. <<TODO: The artifact name is defined by the name of build pipeline. If people fork it, the build pipeline name will change, this will change the artifact name and the workingDirectory path will change causing release pipelines to fail >>
123142

124143
### 7. Set up release (Deployment) pipeline
125144

release-pipelines/retrainingtrigger.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,10 +151,10 @@
151151
"condition": "succeeded()",
152152
"inputs": {
153153
"targetType": "filePath",
154-
"filePath": "$(System.DefaultWorkingDirectory)/_Microsoft.DevOpsForAI/devops-for-ai/environment_setup/install_requirements.sh",
154+
"filePath": "$(System.DefaultWorkingDirectory)",
155155
"arguments": "",
156156
"script": "# Write your commands here\n\n# Use the environment variables input below to pass secret variables to this script",
157-
"workingDirectory": "$(System.DefaultWorkingDirectory)/_Microsoft.DevOpsForAI/devops-for-ai/environment_setup",
157+
"workingDirectory": "$(System.DefaultWorkingDirectory)",
158158
"failOnStderr": "false",
159159
"noProfile": "true",
160160
"noRc": "true"
@@ -194,7 +194,7 @@
194194
"condition": "succeeded()",
195195
"inputs": {
196196
"script": "python aml_service/05-TriggerAmlPipeline.py",
197-
"workingDirectory": "$(System.DefaultWorkingDirectory)/_Microsoft.DevOpsForAI/devops-for-ai",
197+
"workingDirectory": "$(System.DefaultWorkingDirectory)",
198198
"failOnStderr": "false"
199199
}
200200
}

0 commit comments

Comments
 (0)