New Support for Contained Availability Groups #9345

serenefiresiren · 2024-05-11T18:38:55Z

Type of Change

Purpose

SQL Server 2022 added support for contained availability groups.

Approach

The New-DbaAvailabilityGroup leverages the built-in ReuseSystemDatabses and IsContained parameters to facilitate both the initial build and a recreation with previously provisioned contained databases.

Commands to test

Work in progress

Learning

What is a contained availability group?
New-SQLAvailabilityGroup
SMOObject

added an extra check for major version to be consistent with source

… test.

andreasjordan

We are on a good way and I don't see a risk of breaking functionallity. But I would like to have some things changed before we merge.

andreasjordan · 2024-05-12T11:09:46Z

public/New-DbaAvailabilityGroup.ps1

@@ -1,4 +1,4 @@
-function New-DbaAvailabilityGroup {


I don't see a change here so there might be a problem with the encoding or the BOM. Please make sure that this line is not part of the diff.

andreasjordan · 2024-05-12T11:11:08Z

public/New-DbaAvailabilityGroup.ps1

+ .PARAMETER IsContained
+ Builds the Availability Group as contained. Only supported in SQL Server 2022 or higher.
+
+ https://learn.microsoft.com/en-us/sql/database-engine/availability-groups/windows/contained-availability-groups-overview?view=sql-server-ver16


I would exclude the "?view=sql-server-ver16" to always point to the latest version.

andreasjordan · 2024-05-12T11:13:13Z

public/New-DbaAvailabilityGroup.ps1

+ }
+
+ if ($ReuseSystemDatabases -and $IsContained -eq $false) {
+ Write-Message -Level Warning -Message "Reuse system databases is only applicable in contained availability groups test "


What does "test" mean? And there is a space at the end of the string.

andreasjordan · 2024-05-12T11:16:22Z

public/New-DbaAvailabilityGroup.ps1

+ https://learn.microsoft.com/en-us/sql/database-engine/availability-groups/windows/contained-availability-groups-overview?view=sql-server-ver16
+
+ .PARAMETER ReuseSystemDatabases
+ Used when rebuilding a cluster where system databases already exist for the contained availability group.


I would not use the term "cluster" here. Quote from the documentation: "This option is only valid for contained AGs, and specifies that the newly created AG should reuse existing contained system databases for a previous contained AG of the same name. For example, if you had a contained AG with the name MyContainedAG, and wanted to drop and recreate it, you could use this option to reuse the contents of the original contained system databases."

andreasjordan · 2024-05-12T11:17:52Z

public/New-DbaAvailabilityGroup.ps1

+ .EXAMPLE
+ PS C:\> New-DbaAvailabilityGroup -Primary sql2022n01 -Secondary sql2022n02 -Name AgContained -IsContained
+
+ Creates a contained availability group named AgContained on sql2022


Instead of "sql2022" (which is your cluster name?) we should name the nodes: "sql2022n01 and sql2022n02".

andreasjordan · 2024-05-12T11:21:13Z

public/New-DbaAvailabilityGroup.ps1

@@ -488,6 +511,7 @@ function New-DbaAvailabilityGroup {
 $ag.AutomatedBackupPreference = [Microsoft.SqlServer.Management.Smo.AvailabilityGroupAutomatedBackupPreference]::$AutomatedBackupPreference
 $ag.FailureConditionLevel = [Microsoft.SqlServer.Management.Smo.AvailabilityGroupFailureConditionLevel]::$FailureConditionLevel
 $ag.HealthCheckTimeout = $HealthCheckTimeout
+ $ag.ReuseSystemDatabases = $ReuseSystemDatabases


Maybe it is saver (and better to read) if we move this line after the new line 527 ($ag.IsContained = $IsContained). This way, the two new parameters are used only on 2022 and newer. This way, the code does not change for older versions of sql server.

andreasjordan · 2024-05-12T11:22:37Z

tests/New-DbaAvailabilityGroup.Tests.ps1

@@ -5,7 +5,7 @@ Write-Host -Object "Running $PSCommandpath" -ForegroundColor Cyan
 Describe "$commandname Unit Tests" -Tag 'UnitTests' {
 Context "Validate parameters" {
 [object[]]$params = (Get-Command $CommandName).Parameters.Keys | Where-Object { $_ -notin ('whatif', 'confirm') }
- [object[]]$knownParameters = 'Primary', 'PrimarySqlCredential', 'Secondary', 'SecondarySqlCredential', 'Name', 'DtcSupport', 'ClusterType', 'AutomatedBackupPreference', 'FailureConditionLevel', 'HealthCheckTimeout', 'Basic', 'DatabaseHealthTrigger', 'Passthru', 'Database', 'SharedPath', 'UseLastBackup', 'Force', 'AvailabilityMode', 'FailoverMode', 'BackupPriority', 'ConnectionModeInPrimaryRole', 'ConnectionModeInSecondaryRole', 'SeedingMode', 'Endpoint', 'EndpointUrl', 'Certificate', 'ConfigureXESession', 'IPAddress', 'SubnetMask', 'Port', 'Dhcp', 'EnableException'
+ [object[]]$knownParameters = 'Primary', 'PrimarySqlCredential', 'Secondary', 'SecondarySqlCredential', 'Name', 'DtcSupport', 'ClusterType', 'AutomatedBackupPreference', 'FailureConditionLevel', 'HealthCheckTimeout', 'Basic', 'DatabaseHealthTrigger', 'Passthru', 'Database', 'SharedPath', 'UseLastBackup', 'Force', 'AvailabilityMode', 'FailoverMode', 'BackupPriority', 'ConnectionModeInPrimaryRole', 'ConnectionModeInSecondaryRole', 'SeedingMode', 'Endpoint', 'EndpointUrl', 'Certificate', 'ConfigureXESession', 'IPAddress', 'SubnetMask', 'Port', 'Dhcp', 'EnableException', 'ReuseSystemDatabases', 'IsContained'


I would like to have the order of parameters in this list in the order of the param block. So after "name" in this case.

serenefiresiren · 2024-05-12T11:58:29Z

Thanks for the feedback! I'll get these fixed Monday.

potatoqualitee · 2024-05-14T08:07:59Z

Thank you both 🙏🏼 Will fix encoding issue once changes are complete, just prior to merge.

example

DorBreger · 2024-05-14T11:14:43Z

serenefiresiren#2

changes requested

andreasjordan

Sorry, I have not seen this in the first review. Please align the new parameter tests with the existing parameter tests.

andreasjordan · 2024-05-14T14:16:44Z

public/New-DbaAvailabilityGroup.ps1

@@ -366,6 +381,14 @@ function New-DbaAvailabilityGroup {
 return
 }

+ if ($IsContained -and $server.VersionMajor -lt 16) {
+ Stop-Function -Level Warning -Message "Contained availability groups are only supported in SQL Server 2022 and above"


Aa you can see some lines above, we need an additional "return" in case Stop-Function only issues a warning and not an exception (this depends on -EnableException). And please remove the -Level Warning. But you should add the -Target $Primary so that all the tests are written the same way.

andreasjordan · 2024-05-14T14:17:21Z

public/New-DbaAvailabilityGroup.ps1

+ }
+
+ if ($ReuseSystemDatabases -and $IsContained -eq $false) {
+ Write-Message -Level Warning -Message "Reuse system databases is only applicable in contained availability groups"


I would handle this the same way like the other test: Stop-Function and return.

reimplemented some paramter tests in a way that's consitent with code

andreasjordan · 2024-05-15T16:46:16Z

Sorry, still not correct. Please have a look at the other parameter tests.

andreasjordan · 2024-05-15T18:52:44Z

#9352 has all the needed changes, so we should close this one.

potatoqualitee · 2024-05-16T13:53:29Z

thank you all 🙏🏼 will merge for credit and fix all issues in next PR

Courtney Woolum and others added 5 commits May 11, 2024 14:28

New Support for Contained Availability Groups

3011556

added an extra check for major version to be consistent with source

353cef1

(feat) added contained AG docs

d97d972

Merge pull request #1 from DorBreger/NewContainedAGs

21d786c

added an extra check for major version to be consistent with source

Fix parameter type in core. Add new parameters to known parameters in…

611ac24

… test.

andreasjordan requested changes May 12, 2024

View reviewed changes

DorBreger added 6 commits May 14, 2024 13:33

change link to docs to always point to latest version

0fd3d62

Remote 'test' from string

e2678a4

name the nodes instead of the cluster name(?) in the contained AG

c981d1c

example

set reusesystemdatabases only when sqlserver version applies

adda53f

change order of parameters in test

fc183c9

slightly reword paramter documentation

4861320

Merge pull request #2 from DorBreger/NewContainedAGs

1941dbe

changes requested

andreasjordan requested changes May 14, 2024

View reviewed changes

DorBreger and others added 2 commits May 14, 2024 17:38

reimplemented some paramter tests in a way that's consitent with code

df8afc2

Merge pull request #3 from DorBreger/NewContainedAGs

847fa22

reimplemented some paramter tests in a way that's consitent with code

andreasjordan mentioned this pull request May 15, 2024

New-DbaAvailabilityGroup: Add support for contained availability groups #9352

Merged

10 tasks

potatoqualitee merged commit b51ae6d into dataplat:development May 16, 2024
2 of 3 checks passed

serenefiresiren deleted the NewContainedAGs branch May 16, 2024 14:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Support for Contained Availability Groups #9345

New Support for Contained Availability Groups #9345

serenefiresiren commented May 11, 2024 •

edited

andreasjordan left a comment

andreasjordan May 12, 2024

andreasjordan May 12, 2024

andreasjordan May 12, 2024

andreasjordan May 12, 2024

andreasjordan May 12, 2024

andreasjordan May 12, 2024

andreasjordan May 12, 2024

serenefiresiren commented May 12, 2024

potatoqualitee commented May 14, 2024

DorBreger commented May 14, 2024

andreasjordan left a comment

andreasjordan May 14, 2024

andreasjordan May 14, 2024

andreasjordan commented May 15, 2024

andreasjordan commented May 15, 2024 •

edited

potatoqualitee commented May 16, 2024

New Support for Contained Availability Groups #9345

New Support for Contained Availability Groups #9345

Conversation

serenefiresiren commented May 11, 2024 • edited

Type of Change

Purpose

Approach

Commands to test

Learning

andreasjordan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

serenefiresiren commented May 12, 2024

potatoqualitee commented May 14, 2024

DorBreger commented May 14, 2024

andreasjordan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andreasjordan commented May 15, 2024

andreasjordan commented May 15, 2024 • edited

potatoqualitee commented May 16, 2024

serenefiresiren commented May 11, 2024 •

edited

andreasjordan commented May 15, 2024 •

edited