Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andersonshatch/contrastazurearmtemplate
Example Azure ARM template and usage steps to automatically deploy an Azure App Service instance, the Contrast .NET / .NET Core Extension and its configuration
https://github.com/andersonshatch/contrastazurearmtemplate
azure azure-app-service azure-app-services azure-arm azure-arm-template azure-devops contrast
Last synced: about 1 month ago
JSON representation
Example Azure ARM template and usage steps to automatically deploy an Azure App Service instance, the Contrast .NET / .NET Core Extension and its configuration
- Host: GitHub
- URL: https://github.com/andersonshatch/contrastazurearmtemplate
- Owner: andersonshatch
- Created: 2020-06-12T10:31:32.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-03-19T17:02:54.000Z (almost 4 years ago)
- Last Synced: 2024-11-07T18:53:10.973Z (3 months ago)
- Topics: azure, azure-app-service, azure-app-services, azure-arm, azure-arm-template, azure-devops, contrast
- Language: PowerShell
- Size: 52.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Contrast Security + Azure App Service ARM template
ARM template to create a resource group, app service instance, and add the Contrast .NET or .NET Core extension to it.
Environment variables required by the extensions are also setup with this template.
## Alternative approaches
There are some additional branches which allow conditional inclusion of the extension, and even conditional inclusion of the extension and its configuration.
See:
- [`optional-extension`](https://github.com/andersonshatch/ContrastAzureARMTemplate/tree/optional-extension)
- [`optional-extension-optional-config`](https://github.com/andersonshatch/ContrastAzureARMTemplate/tree/optional-extension-optional-config)
## Components
1. The ARM template itself: [`WebSite.json`](WebSite.json)
1. The parameters to the template, using Azure Vault references: [`WebSite.parameters.json`](WebSite.parameters.json)
1. Minimal parameters to the template, if you do not want to use Azure Vault: [`WebSite.prompt-parameters.json`](WebSite.prompt-parameters.json)
1. A PowerShell script to deploy the template: [`Deploy-AzureResourceGroup.ps1`](Deploy-AzureResourceGroup.ps1)
### Contrast specifics in the template
As the provided ARM template generates many resources in addition to Contrast specifics, if you want to integrate the Contrast specific parts into an existing ARM template, the following links highlight key sections which you'll need to integrate:
- [Declaration of Parameters](/WebSite.json#L38:L81)
- [Parameter Reference to Vault Keys](/WebSite.parameters.json#L8:L39)
- [Declaration of Template Variables](/WebSite.json#L85:L90)
- [Setup of Contrast Environment Variables](/WebSite.json#L125:L153)
- [Addition of Contrast Extension](/WebSite.json#L158:L166)
## Setup
1. Define 4 secrets in Azure Key Vault: `contrastApiKey`, `contrastAgentServiceKey`, `contrastAgentUsername` and `contrastURL` -- values for these can be found by logging in to Contrast and navigating to Organization Settings -> API
(contrastURL should be scheme and host/port only, do not include `/Contrast`)
1. Set a value for `hostingPlanName` in `WebSite.parameters.json`
1. Update the 4 key vault references in `WebSite.parameters.json`
If you are not using Azure Key Vault, rename the minimal `WebSite.prompt-parameters.json` to `WebSite.parameters`, and then you will be prompted for the 4 values when running the deploy below.
## Deploy with PowerShell
1. Install the AzureRM module in PowerShell: `Install-Module AzureRM`
1. Login to your Azure instance in Powershell: `Connect-AzureRmAccount`
1. Determine which location to deploy the resources to. To see a list, run `Get-AzureRMLocation | Format-Table`
1. (Optional) Adjust the value for `ResourceGroupName` in `Deploy-AzureResourceGroup.ps1` or pass it as a parameter
1. Run the deployment script in PowerShell: `.\Deploy-AzureResourceGroup.ps1`
1. Specify a region
1. When prompted for `contrastDotnetOrDotnetCore`, enter `Dotnet` if your application is using the .NET Framework, and `DotnetCore` if your application is using .NET Core
This will create the required resources. To complete integration, you must publish your .NET or .NET Core application to this app services instance, and your application should then show up in Contrast.
## Deploy with Azure CLI
Run the following command, substituting `` with the name of the resource group to deploy this to:
`az deployment group create --resource-group --template-file WebSite.json --parameters WebSite.parameters.json`
When running interactively, you will be prompted for the value of `contrastDotnetOrDotnetCore`, this can also be passed with an additional switch: `--parameters contrastDotnetOrDotnetCore=`
It is optional, but **recommended** to pass a name for this deployment so deployment history will be maintained rather than overwritten, this can be achieved by adding e.g.:
`--name "website-with-contrast-$(date +%Y-%m-%d--%H-%M-%S)"`
## Deploy from Azure DevOps Pipeline
1. Add the following task to your Pipeline YAML file:
```yaml
- task: AzureResourceManagerTemplateDeployment@3
inputs:
deploymentScope: 'Resource Group'
azureResourceManagerConnection: ''
subscriptionId: ''
action: 'Create Or Update Resource Group'
resourceGroupName: ''
location: ''
templateLocation: 'Linked artifact'
csmFile: ''
csmParametersFile: ''
deploymentMode: 'Incremental'
overrideParameters: '-contrastDotnetOrDotnetCore '
```
1. Replace the following 7 parameters in the above snippet:
||Placeholder|Description
|---|---|---|
|1|``|Name of the Azure Service Connection your pipeline can use|
|2|``|The Azure Subscription ID to use for this deployment|
|3|``|The Resource Group to deploy this to|
|4|``|The Azure Region to deploy this to|
|5|``|The path to the ARM template in your repository|
|6|``|The path to the ARM parameters file in your repository|
|7|``|Which Contrast agent extension to use: .NET Framework (`Dotnet`) or .NET Core (`DotnetCore`)|
The following are optional, but **recommended** parameters which can be added to the `overrideParameters` section:
||Parameter Name|Value Description
|---|---|---|
|1|`-contrastServerEnvironment`|Environment value sent to Contrast when servers are created. Valid values are `DEVELOPMENT`, `QA` or `PRODUCTION`. Default: `QA`|
|2|`-contrastApplicationGroup`|A comma separated list of application groups the application should onboard to|
|3|`-contrastServerName`|Name for the server entry in Contrast (default: hostname)|