Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
GuruCharan94 committed Aug 14, 2018
1 parent d1eed6b commit 72d7c30
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 37 deletions.
16 changes: 8 additions & 8 deletions 03-Security-In-CICD/Readme.md
Expand Up @@ -60,7 +60,7 @@ generated by the AzSK.

### Enable AzSK extension for your VSTS

This extesion has been published to the VSTS gallery under "Build and Release" category.
This extension has been published to the VSTS gallery under "Build and Release" category.
You can now install this extension from the Marketplace directly (https://marketplace.visualstudio.com/items?itemName=azsdktm.AzSDK-task).
> **Note:** You can also install this extension on your on-prem TFS instance. Please follow the instructions detailed at:
> https://docs.microsoft.com/en-us/vsts/marketplace/get-tfs-extensions
Expand All @@ -86,7 +86,7 @@ pipeline that builds and deploys a web app (or App Service) from VSTS to an Azur

Let us take a look at the steps needed to add the AzSK-SVT task to the release definition.

![03_Create_Release_Defination](../Images/03_Create_Release_Defination.PNG)
![03_Create_Release_Definition](../Images/03_Create_Release_Defination.PNG)

**Step-2:** Add the AzSK-SVT release task to the pipeline.
Click on "Add Tasks", and select "AzSK Security Verification Test".
Expand All @@ -107,7 +107,7 @@ a {tagname, tagvalue} pair based on how your application's resources are organiz
When the pipeline executes, SVTs will scan the specified set of resources.

Along with input parameter, you can check for below options
<br/>**Enable OMS Logging:** Switch to enable this task to publish SVT evalution results to an OMS workspace. Steps to configure OMS credential are explained in Step-4
<br/>**Enable OMS Logging:** Switch to enable this task to publish SVT evaluation results to an OMS workspace. Steps to configure OMS credential are explained in Step-4
<br/>**Aggregate Control Status:** Switch to aggregate the SVTs control output. When this is turned off it would show all the failed individual controls in the task summary output.
<br/>**Do not auto-update AzSK:** Switch to toggle auto update of AzSK and required AzureRM modules on the build server. Keep this un-checked for Hosted agent and Hosted VS2017 and while using SVT task fot the first time and if you want to update AZSK the version of AzSK.
![03_IP_Parameter_for_Task](../Images/03_IP_Parameter_for_Task.PNG)
Expand Down Expand Up @@ -263,7 +263,7 @@ that are supported by the VSTS task:
|Variable Name| Usage| Examples|
|-------------|------|---------|
|OMSWorkspaceID| Log analytics workspace to continuously monitor progressive release/deployment health| e.g. c18xxxxx-xxxx-abcd-efgh-12345613489c Refer to step-4 in the above section|
|OMSSharedKey| Log analytics workspace sharedkey for extension to push the scan results from CICD| Refer step-4 from the above section for detail steps|
|OMSSharedKey| Log analytics workspace shared key for extension to push the scan results from CICD| Refer step-4 from the above section for detail steps|
|AzSKServerURL| Org policy url for hosting the central policy configuration| Refer step-5 from the above section for detail steps |
|EnableServerAuth| Specifies whether Org policy URL (AzSKServerURL) is protected by AAD authentication.| e.g. true - protected by AAD authentication, false - not protected by AAD authentication|
|AzSKVersion| You could specify which version of toolkit you want to use in your CICD scan. And version specified should be >= N-2 where N is latest prod version. If variable is not provided, it uses the latest version available| e.g. 2.8.1|
Expand Down Expand Up @@ -339,7 +339,7 @@ This part assumes that you are familiar with Jenkins pipeline at a basic level.

![03_Input_Parameter](../Images/03_Input_Parameter.PNG)
- #### Step-5: (Optional) Setup connectivity from CICD to OMS.
You can also configure build to send runtime security evaluation results to OMS workspace. For that configure OMS credetial using below steps:
You can also configure build to send runtime security evaluation results to OMS workspace. For that configure OMS credential using below steps:
- For adding OMS workspace credentials
Go to Home Page --> Credentials --> System --> Global credentials --> Click on "Add Credentials" --> Select credential type "OMS Details"
Provide OMS details and click Ok
Expand Down Expand Up @@ -435,7 +435,7 @@ e.g. :

### Enable AzSK extension for your VSTS

This extesion has been published to the VSTS gallery under "Build and Release" category.
This extension has been published to the VSTS gallery under "Build and Release" category.
You can now install this extension from the Marketplace directly (https://marketplace.visualstudio.com/items?itemName=azsdktm.AzSDK-task).
> **Note:** You can also install this extension on your on-prem TFS instance. Please follow the instructions detailed at:
> https://docs.microsoft.com/en-us/vsts/marketplace/get-tfs-extensions
Expand All @@ -455,7 +455,7 @@ As shown below, currently the release definition is configured to simply deploy

Let us take a look at the steps needed to add the AzSK-ARM Template Checker task to the release definition.

![03_Create_Release_Defination](../Images/03_Create_Release_Defination_ARM.JPG)
![03_Create_Release_Definition](../Images/03_Create_Release_Defination_ARM.JPG)

**Step-2:** Add the AzSK-ARM Template Checker release task to the pipeline.
Click on "Add Tasks", and select "AzSK ARM Template Checker".
Expand All @@ -466,7 +466,7 @@ get added when you click "Add" once!
![03_Task_Catalog](../Images/03_Task_Catalog_ARM.JPG)

**Step-3:** Specify the input parameters for the ARM Checker task.
The "AzSK ARM Template Checker" task starts showing in the "Run on Agent" list and displays some configuration inputs that are required for the task to run. These are none other than the familiar options we have been specifying while running the AzSK ARM Template Checker manually - you can specify the target ARM Template file path or a folder path based on your requirment.
The "AzSK ARM Template Checker" task starts showing in the "Run on Agent" list and displays some configuration inputs that are required for the task to run. These are none other than the familiar options we have been specifying while running the AzSK ARM Template Checker manually - you can specify the target ARM Template file path or a folder path based on your requirement.

Along with input parameter, you can check for below options
<br/>**Recurse:** Switch this if you want to scan ARM Templates in the specified location and in all child folders of the location.
Expand Down

0 comments on commit 72d7c30

Please sign in to comment.