Skip to content

[Modules] Update dependency & documentation for module #2364

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.

Sign up for GitHub

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

Merged
AlexanderSehr merged 10 commits into from
Nov 25, 2022
Merged

[Modules] Update dependency & documentation for module #2364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e0d94bf
Updated to new secret location & updated docs
AlexanderSehr Nov 25, 2022
1664a67
Update to latest
AlexanderSehr Nov 25, 2022
5d88b69
Update to latest
AlexanderSehr Nov 25, 2022
fe89983
Update to latest
AlexanderSehr Nov 25, 2022
6234b84
Update docs/wiki/Getting started - Scenario 2 Onboard module library …
AlexanderSehr Nov 25, 2022
2340be4
Update modules/Microsoft.Web/sites/.test/FunctionAppCommon/deploy.tes…
AlexanderSehr Nov 25, 2022
b56ae7c
Update to latest
AlexanderSehr Nov 25, 2022
8641b20
Update to latest
AlexanderSehr Nov 25, 2022
ab7ada4
Update to latest
AlexanderSehr Nov 25, 2022
db56397
Cleanup
AlexanderSehr Nov 25, 2022
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
11 changes: 8 additions & 3 deletions .../wiki/Getting started - Scenario 2 Onboard module library and CI environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,6 +383,14 @@ In special cases, manual actions may be required to provision certain resources

To successfully deploy the sites module using the `fa.parameters.json` parameter file, you need to create an Azure Active Directory App with its API endpoint enabled (e.g., `api://<app id>`) and add a secret. The secret value needs then to be stored in a Key Vault secret.

Finally, the elements described above must further be configured in the following files:

| File | Parameter | Notes |
| - | - | - |
| `modules\Microsoft.Web\sites\.test\common\deploy.bicep` | `appSettingsKeyValuePairs.EASYAUTH_SECRET` | Key Vault secret URI without version (e.g., 'https://Test-KeyVault.vault.azure.net/secrets/aBcDeFghIjK69Ln') |
| `modules\Microsoft.Web\sites\.test\common\deploy.bicep` | `authSettingV2Configuration.identityProviders.azureActiveDirectory.registration.clientId` | App ID from the Azure Active Directory App (e.g., '11111111-1111-1111-1111-11111111111') |
| `modules\Microsoft.Web\sites\.test\common\deploy.bicep` | `authSettingV2Configuration.identityProviders.azureActiveDirectory.validation.allowedAudiences` | API endpoint from the Azure Active Directory app (e.g., 'api://11111111-1111-1111-1111-11111111111') |

# 5. Update module test files

Once the required dependencies are deployed, there is one more step left to get as many module pipelines running as possible.
Expand All @@ -400,9 +408,6 @@ For this reason, make sure to update the references in the following modules onc
| `modules\Microsoft.Compute\virtualMachineScaleSets\.test\windows.parameters.json` | `extensionDiskEncryptionConfig.value.settings.KeyEncryptionKeyURL` | |
| `modules\Microsoft.Sql\managedInstances\.test\parameters.json` | `keys.value.uri` | |
| `modules\Microsoft.Network\applicationGateways\.test\parameters.json` | `sslCertificates.value.properties.keyVaultSecretId` | |
| `modules\Microsoft.Web\sites\.test\fa.parameters.json` | `appSettingsKeyValuePairs.value.EASYAUTH_SECRET` | Key Vault secret URI without version |
| `modules\Microsoft.Web\sites\.test\fa.parameters.json` | `authSettingV2Configuration.value.identityProviders.azureActiveDirectory.registration.clientId` | App ID from the Azure Active Directory App |
| `modules\Microsoft.Web\sites\.test\fa.parameters.json` | `authSettingV2Configuration.value.identityProviders.azureActiveDirectory.validation.allowedAudiences` | API endpoint from the Azure Active Directory app |

</details>

Expand Down
0 ...test/FunctionAppCommon/dependencies.bicep → ...test/functionAppCommon/dependencies.bicep
View file
Open in desktop
File renamed without changes.
4 changes: 2 additions & 2 deletions ....test/FunctionAppCommon/deploy.test.bicep → ....test/functionAppCommon/deploy.test.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ module diagnosticDependencies '../../../../.shared/dependencyConstructs/diagnost
// ============== //
// Test Execution //
// ============== //

// For the below test case, please consider the guidelines described here: https://github.com/Azure/ResourceModules/wiki/Getting%20started%20-%20Scenario%202%20Onboard%20module%20library%20and%20CI%20environment#microsoftwebsites
module testDeployment '../../deploy.bicep' = {
scope: resourceGroup
name: '${uniqueString(deployment().name)}-test-${serviceShort}'
Expand All @@ -64,7 +64,7 @@ module testDeployment '../../deploy.bicep' = {
appInsightId: resourceGroupResources.outputs.applicationInsightsResourceId
appSettingsKeyValuePairs: {
AzureFunctionsJobHost__logging__logLevel__default: 'Trace'
EASYAUTH_SECRET: 'https://adp-<<namePrefix>>-az-kv-x-001.${environment().suffixes.keyvaultDns}/secrets/Modules-Test-SP-Password'
EASYAUTH_SECRET: 'https://<<namePrefix>>-KeyVault${environment().suffixes.keyvaultDns}/secrets/Modules-Test-SP-Password'
FUNCTIONS_EXTENSION_VERSION: '~4'
FUNCTIONS_WORKER_RUNTIME: 'dotnet'
}
Expand Down