Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: small fixes in documentation #138

Merged
merged 5 commits into from
Feb 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions dashboard/installation/dashboard-buildpipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ Create a variable group named {prefix}.Invictus.Installation and add these varia
Once you have the variable group, we can now proceed to creating the build pipeline.

## YAML Pipeline
Add the files and folders from [this](./pipelines) location to your DevOps repo.
This contains an example YAML pipelines to build the Invictus for Azure Dashboard, change the [dashboard.build.yaml](./pipelines/dashboard.build.yaml) file according to your needs, for example change the trigger path:
Add the files and folders from [this](pipelines) location to your DevOps repo.
This contains an example YAML pipelines to build the Invictus for Azure Dashboard, change the [dashboard.build.yaml](pipelines/dashboard.build.yaml) file according to your needs, for example change the trigger path:
``` yaml
paths:
include:
- /src/customer.azure.invictus
```

Afterwards add the [dashboard.build.yaml](./pipelines/dashboard.build.yaml) in your DevOps environment as a pipeline, once you've saved the build pipeline you can create the [release pipeline](dashboard-releasepipeline.md).
Afterwards add the [dashboard.build.yaml](pipelines/dashboard.build.yaml) in your DevOps environment as a pipeline, once you've saved the build pipeline you can create the [release pipeline](dashboard-releasepipeline.md).

## Classic Pipeline
### Create the build pipeline
Expand Down
10 changes: 6 additions & 4 deletions dashboard/installation/dashboard-releasepipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Make sure the Project Collection Build Service has Administrator access to these
> ![Library Security](../../images/ifa-library-security.png)

## YAML Pipeline
Add the files and folders from [this](./pipelines) location to your DevOps repo.
This contains an example YAML pipeline to release the Invictus for Azure Dashboard, change the [framework.release.yaml](./pipelines/dashboard.release.yaml) file according to your needs, for example change the needed environments and change the name of the build pipeline trigger:
Add the files and folders from [this](pipelines) location to your DevOps repo.
This contains an example YAML pipeline to release the Invictus for Azure Dashboard, change the [dashboard.release.yaml](pipelines/dashboard.release.yaml) file according to your needs, for example change the needed environments and change the name of the build pipeline trigger:
``` yaml
resources:
pipelines:
Expand All @@ -27,11 +27,13 @@ resources:
trigger: true
```

Also make sure to change the ARM template parameters. In these example files we are deploying to DEV, TST and ADD using a `B1` service plan SKU and a `P1V2` service plan SKU to PRD. Make sure to change and parameterize this according to your needs.
**Make sure to replace the `azureSubscription` value with the name of your serviceconnection as this value cannot be parameterized**

Also make sure to change the ARM template parameters. In these example files we are deploying to DEV, TST and ACC using a `B1` service plan SKU and a `P1V2` service plan SKU to PRD. Make sure to change and parameterize this according to your needs.

If you need to overwrite more ARM Template parameters make sure to add this to the `deployScriptParameters`. A complete list of ARM Template parameters can be found [here](#ARM-Template-Parameters).

Afterwards add the [framework.release.yaml](./pipelines/dashboard.release.yaml) in your DevOps environment as a pipeline.
Afterwards add the [dashboard.release.yaml](pipelines/dashboard.release.yaml) in your DevOps environment as a pipeline.

## Classic Pipeline
### Release
Expand Down
8 changes: 4 additions & 4 deletions dashboard/installation/pipelines/dashboard.release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ stages:
displayName: Download Artifact
- template: ./Templates/dashboard-release-steps.yaml
parameters:
azureSubscription: $(Infra.Environment.ServiceConnection)
azureSubscription: 'NameOfYourServiceConnection'
scriptPath: '$(Pipeline.Workspace)/_build/dashboard/Deploy.ps1'
deployScriptParameters: '-resourcePrefix $(Infra.Environment.ResourcePrefix) -ArtifactsPath $(Pipeline.Workspace)/_build/dashboard -ResourceGroupName $(Infra.Environment.CustomerPrefix)-$(Infra.Environment.ShortName)-invictus -VariableGroupName invictus.$(Infra.Environment.ShortName) -devOpsObjectId "$(Infra.DevOps.Object.Id)" -servicePlanSkuName "B1" -eventHubSkuName "Standard" -eventHubSkuTier "Standard" -enableStatisticsFunction "true"'
- stage: deploy_tst
Expand All @@ -70,7 +70,7 @@ stages:
displayName: Download Artifact
- template: ./Templates/dashboard-release-steps.yaml
parameters:
azureSubscription: $(Infra.Environment.ServiceConnection)
azureSubscription: 'NameOfYourServiceConnection'
scriptPath: '$(Pipeline.Workspace)/_build/dashboard/Deploy.ps1'
deployScriptParameters: '-resourcePrefix $(Infra.Environment.ResourcePrefix) -ArtifactsPath $(Pipeline.Workspace)/_build/dashboard -ResourceGroupName $(Infra.Environment.CustomerPrefix)-$(Infra.Environment.ShortName)-invictus -VariableGroupName invictus.$(Infra.Environment.ShortName) -devOpsObjectId "$(Infra.DevOps.Object.Id)" -servicePlanSkuName "B1" -eventHubSkuName "Standard" -eventHubSkuTier "Standard" -enableStatisticsFunction "true"'

Expand All @@ -92,7 +92,7 @@ stages:
displayName: Download Artifact
- template: ./Templates/dashboard-release-steps.yaml
parameters:
azureSubscription: $(Infra.Environment.ServiceConnection)
azureSubscription: 'NameOfYourServiceConnection'
scriptPath: '$(Pipeline.Workspace)/_build/dashboard/Deploy.ps1'
deployScriptParameters: '-resourcePrefix $(Infra.Environment.ResourcePrefix) -ArtifactsPath $(Pipeline.Workspace)/_build/dashboard -ResourceGroupName $(Infra.Environment.CustomerPrefix)-$(Infra.Environment.ShortName)-invictus -VariableGroupName invictus.$(Infra.Environment.ShortName) -devOpsObjectId "$(Infra.DevOps.Object.Id)" -servicePlanSkuName "B1" -eventHubSkuName "Standard" -eventHubSkuTier "Standard" -enableStatisticsFunction "true"'
- stage: deploy_prd
Expand All @@ -113,6 +113,6 @@ stages:
displayName: Download Artifact
- template: ./Templates/dashboard-release-steps.yaml
parameters:
azureSubscription: $(Infra.Environment.ServiceConnection)
azureSubscription: 'NameOfYourServiceConnection'
scriptPath: '$(Pipeline.Workspace)/_build/dashboard/Deploy.ps1'
deployScriptParameters: '-resourcePrefix $(Infra.Environment.ResourcePrefix) -ArtifactsPath $(Pipeline.Workspace)/_build/dashboard -ResourceGroupName $(Infra.Environment.CustomerPrefix)-$(Infra.Environment.ShortName)-invictus -VariableGroupName invictus.$(Infra.Environment.ShortName) -devOpsObjectId "$(Infra.DevOps.Object.Id)" -servicePlanSkuName "P1V2" -eventHubSkuName "Standard" -eventHubSkuTier "Standard" -enableStatisticsFunction "true"'
4 changes: 3 additions & 1 deletion framework/installation/framework-releasepipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ resources:
trigger: true
```

Also make sure to change the ARM template parameters. In these example files we are deploying to DEV, TST and ADD using a `B1` service plan SKU and a `P1V2` service plan SKU to PRD. Make sure to change and parameterize this according to your needs.
**Make sure to replace the `azureSubscription` value with the name of your serviceconnection as this value cannot be parameterized**

Also make sure to change the ARM template parameters. In these example files we are deploying to DEV, TST and ACC using a `B1` service plan SKU and a `P1V2` service plan SKU to PRD. Make sure to change and parameterize this according to your needs.

If you need to overwrite more ARM Template parameters make sure to add this to the `deployScriptParameters`. A complete list of ARM Template parameters can be found [here](#ARM-Template-Parameters).

Expand Down
8 changes: 4 additions & 4 deletions framework/installation/pipelines/framework.release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ stages:
displayName: Download Artifact
- template: ./Templates/framework-release-steps.yaml
parameters:
azureSubscription: $(Infra.Environment.ServiceConnection)
azureSubscription: 'NameOfYourServiceConnection'
scriptPath: '$(Pipeline.Workspace)/_build/framework/Deploy.ps1'
deployScriptParameters: '-resourcePrefix $(Infra.Environment.ResourcePrefix) -ArtifactsPath $(Pipeline.Workspace)/_build/framework -ResourceGroupName $(Infra.Environment.CustomerPrefix)-$(Infra.Environment.ShortName)-invictus -VariableGroupName invictus.$(Infra.Environment.ShortName) -devOpsObjectId "$(Infra.DevOps.Object.Id)" -pubSubWebAppAlwaysOn "false" -matrixWebAppAlwaysOn "false" -transcoWebAppAlwaysOn "false" -servicePlanSkuName "B1" -eventHubSkuName "Standard" -eventHubSkuTier "Standard"'
- stage: deploy_tst
Expand All @@ -70,7 +70,7 @@ stages:
displayName: Download Artifact
- template: ./Templates/framework-release-steps.yaml
parameters:
azureSubscription: $(Infra.Environment.ServiceConnection)
azureSubscription: 'NameOfYourServiceConnection'
scriptPath: '$(Pipeline.Workspace)/_build/framework/Deploy.ps1'
deployScriptParameters: '-resourcePrefix $(Infra.Environment.ResourcePrefix) -ArtifactsPath $(Pipeline.Workspace)/_build/framework -ResourceGroupName $(Infra.Environment.CustomerPrefix)-$(Infra.Environment.ShortName)-invictus -VariableGroupName invictus.$(Infra.Environment.ShortName) -devOpsObjectId "$(Infra.DevOps.Object.Id)" -pubSubWebAppAlwaysOn "false" -matrixWebAppAlwaysOn "false" -transcoWebAppAlwaysOn "false" -servicePlanSkuName "B1" -eventHubSkuName "Standard" -eventHubSkuTier "Standard"'

Expand All @@ -92,7 +92,7 @@ stages:
displayName: Download Artifact
- template: ./Templates/framework-release-steps.yaml
parameters:
azureSubscription: $(Infra.Environment.ServiceConnection)
azureSubscription: 'NameOfYourServiceConnection'
scriptPath: '$(Pipeline.Workspace)/_build/framework/Deploy.ps1'
deployScriptParameters: '-resourcePrefix $(Infra.Environment.ResourcePrefix) -ArtifactsPath $(Pipeline.Workspace)/_build/framework -ResourceGroupName $(Infra.Environment.CustomerPrefix)-$(Infra.Environment.ShortName)-invictus -VariableGroupName invictus.$(Infra.Environment.ShortName) -devOpsObjectId "$(Infra.DevOps.Object.Id)" -pubSubWebAppAlwaysOn "false" -matrixWebAppAlwaysOn "false" -transcoWebAppAlwaysOn "false" -servicePlanSkuName "B1" -eventHubSkuName "Standard" -eventHubSkuTier "Standard"'
- stage: deploy_prd
Expand All @@ -113,6 +113,6 @@ stages:
displayName: Download Artifact
- template: ./Templates/framework-release-steps.yaml
parameters:
azureSubscription: $(Infra.Environment.ServiceConnection)
azureSubscription: 'NameOfYourServiceConnection'
scriptPath: '$(Pipeline.Workspace)/_build/framework/Deploy.ps1'
deployScriptParameters: '-resourcePrefix $(Infra.Environment.ResourcePrefix) -ArtifactsPath $(Pipeline.Workspace)/_build/framework -ResourceGroupName $(Infra.Environment.CustomerPrefix)-$(Infra.Environment.ShortName)-invictus -VariableGroupName invictus.$(Infra.Environment.ShortName) -devOpsObjectId "$(Infra.DevOps.Object.Id)" -pubSubWebAppAlwaysOn "true" -matrixWebAppAlwaysOn "true" -transcoWebAppAlwaysOn "true" -servicePlanSkuName "P1V2" -eventHubSkuName "Standard" -eventHubSkuTier "Standard"'