-
Notifications
You must be signed in to change notification settings - Fork 225
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
SqlServerDsc: Documentation updates (#1576)
- SqlServerDsc - Remove the file `.github/CONTRIBUTION.md` as it no longer filled any purpose as GitHub will find the CONTRIBUTION.md in the root folder directly now (issue #1227). - The documentation in CONTRIBUTING.md has been somewhat updated. - Update documentation around design pattern for accounts that does not use passwords (issue #378) and (issue #1230). - Updating the Integration Test README.md to better explain what the integration tests for SqlSetup, SqlRSSetup, and SqlRS does (issue #1315). - SqlAGReplica - Update documentation with a requirement for SqlServer in certain circumstances (issue #1033). - SqlRSSetup - There was a typo in the error message that was thrown when not passing either the `Edition` or `ProductKey` that could be misleading (issue #1386). - Updated the parameter descriptions for the parameters `Edition` and `ProductKey` that they are mutually exclusive (issue #1386).
- Loading branch information
Showing
8 changed files
with
152 additions
and
55 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Credential Overview | ||
|
||
## Group Managed Service Account | ||
|
||
To support [Group Managed Service Accounts](https://docs.microsoft.com/en-us/windows-server/security/group-managed-service-accounts/group-managed-service-accounts-overview) | ||
(gMSAs) the DSC resource must support it. This also applies to Managed Service | ||
Accounts (MSAs). | ||
|
||
There are more information about using (g)MSAs with SQL Server | ||
in the article [Configure Windows Service Accounts and Permissions](https://docs.microsoft.com/en-us/sql/database-engine/configure-windows/configure-windows-service-accounts-and-permissions) in section [Managed Service Accounts, Group Managed Service Accounts, and Virtual Accounts](https://docs.microsoft.com/en-us/sql/database-engine/configure-windows/configure-windows-service-accounts-and-permissions#New_Accounts) | ||
|
||
To use a (g)MSA with a DSC resource you should pass the (g)MSA account name | ||
in the credential object and use any text string as password. | ||
|
||
>It is not possible to pass `$null` as password, it is a limitation by | ||
>how the MOF is generated when encrypting passwords. | ||
If there is a resource that you find that will not work with a (g)MSAs then | ||
please submit a [new issue](https://github.com/dsccommunity/SqlServerDsc/issues/new?template=Problem_with_resource.md). | ||
Then the community can work together to support (g)MSAs for that DSC resource | ||
too. | ||
|
||
For designing a resource for (g)MSAs see the section [Group Managed Service Account](https://github.com/dsccommunity/SqlServerDsc/blob/master/CONTRIBUTING.md#group-managed-service-account) | ||
in the contribution guidelines. | ||
|
||
<sup>_This was discussed in [issue #738](https://github.com/dsccommunity/SqlServerDsc/issues/738)_.</sup> | ||
|
||
## Built-In Account | ||
|
||
To use a built-in account with a DSC resource you should pass the built-in | ||
account name, e.g. 'NT AUTHORITY\NetworkService' in the credential object | ||
and use any text string as password. | ||
|
||
>It is not possible to pass `$null` as password, it is a limitation by | ||
>how the MOF is generated when encrypting passwords. | ||
If there is a resource that you find that will not work with a built-in account | ||
then please submit a [new issue](https://github.com/dsccommunity/SqlServerDsc/issues/new?template=Problem_with_resource.md). | ||
Then the community can work together to support built-in accounts for that | ||
DSC resource too. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters