Skip to content

Commit 4d927fe

Browse files
committed
doc: updated getting started doc
1 parent 2942355 commit 4d927fe

File tree

2 files changed

+26
-23
lines changed

2 files changed

+26
-23
lines changed

docs/getting_started.md

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ We noted the value of these variables in previous steps.
3737

3838
We make use of variable group inside Azure DevOps to store variables and their values that we want to make available across multiple pipelines. You can either store the values directly in [Azure DevOps](https://docs.microsoft.com/en-us/azure/devops/pipelines/library/variable-groups?view=azure-devops&tabs=designer#create-a-variable-group) or connect to an Azure Key Vault in your subscription. Please refer to the documentation [here](https://docs.microsoft.com/en-us/azure/devops/pipelines/library/variable-groups?view=azure-devops&tabs=designer#create-a-variable-group) to learn more about how to create a variable group and [link](https://docs.microsoft.com/en-us/azure/devops/pipelines/library/variable-groups?view=azure-devops&tabs=designer#use-a-variable-group) it to your pipeline.
3939

40-
Please name your variable group **AzureKeyVaultSecrets**, we are using this name within our build yaml file.
40+
Please name your variable group **``AzureKeyVaultSecrets``**, we are using this name within our build yaml file.
4141

4242
Up until now you shouls have
4343
- Forked (or cloned) the repo
@@ -74,7 +74,6 @@ We now have 3 pipelines that we would set up
7474

7575
Great, you now have the build pipeline setup, you can either manually trigger it or it gets automatically triggered everytime there is a change in the master branch.
7676

77-
9. <<TODO: Make sure that the build trigger is not enabled for PR>>
7877

7978
**Note:** The build pipeline will perform basic test on the code and provision infrastructure on azure. This can take around 10 mins to complete.
8079

@@ -96,7 +95,7 @@ On the next screen, click on **Save** and then click **Ok** to save the empty re
9695
1. Select the Release tab from the menu on the left, then click the New dropdown on top and click on **Import Release pipeline**
9796
![import release pipeline](./images/release-import.png)
9897

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.
98+
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.
10099
![release retraining triggger](./images/release-retrainingtrigger.png)
101100

102101
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.
@@ -119,7 +118,7 @@ On the next screen, click on **Save** and then click **Ok** to save the empty re
119118

120119
1. Artifact is now added for retraining trigger pipeline, hit the **save** button on top right and then click **ok**.
121120

122-
1. To trigger this pipeline every time build pipeline executes, click on the lighting sign to enable the **Continous Deployment Trigger**, click Save.
121+
1. To trigger this pipeline every time build pipeline executes, click on the lighting sign to enable the **Continous Deployment Trigger**, click **Save**.
123122
![release retraining artifact](./images/release-retrainingtrigger1.png)
124123

125124
2. If you want to run this pipeline on a schedule, you can set one by clicking on **Schedule set** in Artifacts section.
@@ -132,17 +131,19 @@ On the next screen, click on **Save** and then click **Ok** to save the empty re
132131
![release create ](./images/release-create.png)
133132
- On the next screen click on **Create** button, this creates a manual release for you.
134133

134+
**Note**: This release pipeline will call the published AML pipeline. The AML pipeline will train the model and package it into image. It will take around 10 mins to complete. The next steps need this pipeline to complete successfully.
135+
135136
### 7. Set up release (Deployment) pipeline
136137

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

139-
**Also Note:** Before creating this pipeline, make sure that the build pipeline and retraining trigger release pipeline have been executed, as they will be creating resources during their run like docker images that we will deploy as part of this pipeline. So it is important for them to have successful runs before the setup here.
140+
**Also Note:** Before creating this pipeline, make sure that the build pipeline, retraining trigger release pipeline and AML retraining pipeline have been executed, as they will be creating resources during their run like docker images that we will deploy as part of this pipeline. So it is important for them to have successful runs before the setup here.
140141

141142
Let's set up the release deployment pipeline now.
142143
1. As done in previous step, Select the Release tab from the menu on the left, then click the New dropdown on top and click on **Import Release pipeline**
143144
![import release pipeline](./images/release-import.png)
144145

145-
1. On the next screen, navigate to release-pipelines folder and select **releasedeployment.json** pipeline file, click import. You should now see the following screen. Under Stages click on the QA environment's **view stage task", where it shows the red error sign.
146+
1. On the next screen, navigate to **release-pipelines** folder and select **releasedeployment.json** pipeline file, click import. You should now see the following screen. Under Stages click on the QA environment's **view stage task", where it shows the red error sign.
146147
![release retraining triggger](./images/release-deployment.png)
147148

148149
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.
@@ -151,16 +152,30 @@ Let's set up the release deployment pipeline now.
151152
Follow the same steps for **Prod Environment** and select **Hosted Ubuntu 1604** for agent pool and save the pipeline.
152153
![release retraining agent](./images/release-deploymentprodagent.png)
153154

154-
1. <<TODO: Add steps to create a Service connection>>
155+
1. We now need to add artifact that will trigger this pipeline. We will add two artifacts:
156+
- Build pipeline output as artifact since that contains our configuration and code files that we require in this pipeline.
157+
- ACR artifact to trigger this pipeline everytime there is a new image that gets published to Azure container registry (ACR) as part of retraining pipeline.
158+
159+
Here are the steps to add build output as artifact
160+
161+
- Click on pipeline tab to go back to pipeline view and click **Add an artifact**. This will open a pop up window
162+
- for source type, select **Build**
163+
- for project, select your project in Azure DevOps that you created in previous steps.
164+
- For Source select the source build pipeline. If you have forked the git repo, the build pipeline may named ``yourgitusername.DevOpsForAI``
165+
- In the Source alias, replace the auto-populated value with
166+
**``DevOpsForAI``**
167+
- Field **Devault version** will get auto populated **Latest**, you can leave them as it is.
168+
- Click on **Add**, and then **Save** the pipeline
169+
![release retraining artifact](./images/release-retrainingartifact.png)
170+
171+
Here are the steps to add ACR as an artifact
155172

156-
1. We now need to add artifact that will trigger this pipeline, it gets triggered everytime there is a new image that gets published to Azure container registry (ACR) as part of retraining pipeline. We will also add our build output as artifact since that contains our configuration and code files that we require in this pipeline.
173+
![release retraining agent](./images/release-deployment-service-conn.png)
157174

158-
![release retraining agent](./images/release-deploymentacr.png)
159175

160-
Here are the steps to add ACR as an artifact
161176
- Click on pipeline tab to go back to pipeline view and click **Add an artifact**. This will open a pop up window
162177
- For Source type, click on **more artifact types** dropdown and select **Azure Container Registry**
163-
- For service connection, select an existing service connection to Azure, if you don't see anything in the dropdown, click on Manage and create one.
178+
- For **service connection**, select an existing service connection to Azure, if you don't see anything in the dropdown, click on **Manage** and [create new **Azure Resource Manager**](https://docs.microsoft.com/en-us/azure/devops/pipelines/library/service-endpoints?view=azure-devops#create-a-service-connection) service connection for your subscription.
164179
**Note:** You must have sufficient privileges to create a service connection, if not contact your subscription adminstrator.
165180
- For Resource Group, select **DevOps_AzureML_Demo**, this is the default resource group name that we are using and if the previous pipelines executed properly you will see this resource group in the drop down.
166181
- Under Azure container registry dropdown, select the container registry, there should be only one container registry entry.
@@ -171,18 +186,6 @@ Let's set up the release deployment pipeline now.
171186
- Click on lighting sign to enable the **Continous Deployment Trigger**, click Save.
172187
![release retraining artifact](./images/release-deploymentcitrigger.png)
173188

174-
Here are the steps to add build output as artifact
175-
176-
- Click on pipeline tab to go back to pipeline view and click **Add an artifact**. This will open a pop up window
177-
- for source type, select **Build**
178-
- for project, select your project in Azure DevOps that you created in previous steps.
179-
- For Source select the source build pipeline. If you have forked the git repo, the build pipeline may named ``yourgitusername.DevOpsForAI``
180-
- In the Source alias, replace the auto-populated value with
181-
**``DevOpsForAI``**
182-
- Field **Devault version** will get auto populated **Latest**, you can leave them as it is.
183-
- Click on **Add**, and then **Save** the pipeline
184-
![release retraining artifact](./images/release-retrainingartifact.png)
185-
186189

187190
1. We now have QA environment continously deployed each time there is a new image available in container registry. You can select pre-deployment conditions for prod environment, normally you don't want it to be auto deployed, so select manual only trigger here.
188191

135 KB
Loading

0 commit comments

Comments
 (0)