Skip to content

Commit 2792d94

Browse files
authored
Merge pull request MicrosoftDocs#82681 from mgreenegit/patch-5
DRAFT of community docs
2 parents 716b425 + 35b7c91 commit 2792d94

5 files changed

+311
-0
lines changed

articles/automation/TOC.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,22 @@
276276
- name: Troubleshoot State Configuration (DSC)
277277
href: troubleshoot/desired-state-configuration.md
278278
displayName: Desired State Configuration, troubleshoot
279+
- name: Reference
280+
items:
281+
- name: Community Solutions
282+
items:
283+
- name: Configuration data at scale
284+
href: automation-dsc-config-data-at-scale.md
285+
displayName: DSC, Configuration Data, ConfigData
286+
- name: Create configurations from servers
287+
href: automation-dsc-config-from-server.md
288+
displayName: DSC, ReverseDSC
289+
- name: Configuration based on STIG
290+
href: automation-dsc-configuration-based-on-stig.md
291+
displayName: DSC, Configuration
292+
- name: Convert configurations to composite resources
293+
href: automation-dsc-create-composite.md
294+
displayName: DSC, composite
279295
- name: Manage Shared Resources
280296
items:
281297
- name: Certificates
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
title: Configuration data at scale - Azure Automation
3+
description: Learn how to configure data at scale for state configuration in Azure Automation.
4+
keywords: dsc,powershell,configuration,setup
5+
services: automation
6+
ms.service: automation
7+
ms.subservice: dsc
8+
author: mgreenegit
9+
ms.author: migreene
10+
ms.date: 08/08/2019
11+
ms.topic: conceptual
12+
manager: carmonm
13+
---
14+
15+
# Configuration data at scale
16+
17+
> Applies To: Windows PowerShell 5.1
18+
19+
Managing hundreds or thousands of servers can be a challenge.
20+
Customers have provided feedback that the most difficult aspect is actually managing
21+
[configuration data](/powershell/dsc/configurations/configdata).
22+
Organizing information across logical constructs like location, type, and environment.
23+
24+
> [!NOTE]
25+
> This article refers to a solution that is maintained by the Open Source community.
26+
> Support is only available in the form of GitHub collaboration, not from Microsoft.
27+
28+
## Community project: Datum
29+
30+
A community maintained solution named
31+
[Datum](https://github.com/gaelcolas/Datum)
32+
has been created to resolve this challenge.
33+
Datum builds on great ideas from other configuration management platforms
34+
and implements the same type of solution for PowerShell DSC.
35+
Information is
36+
[organized in to text files](https://github.com/gaelcolas/Datum#3-intended-usage)
37+
based on logical ideas.
38+
Examples would be:
39+
40+
- Settings that should apply globally
41+
- Settings that should apply to all servers in a location
42+
- Settings that should apply to all database servers
43+
- Individual server settings
44+
45+
This information is organized in the file format you prefer (JSON, Yaml, or PSD1).
46+
Then cmdlets are provided to generate configuration data files by
47+
[consolidating the information](https://github.com/gaelcolas/Datum#datum-tree)
48+
from each file in to single view of a server or server role.
49+
50+
Once the data files have been generated,
51+
you can use them with
52+
[DSC Configuration scripts](/powershell/dsc/configurations/write-compile-apply-configuration)
53+
to generate MOF files
54+
and
55+
[upload the MOF files to Azure Automation](/azure/automation/tutorial-configure-servers-desired-state#create-and-upload-a-configuration-to-azure-automation).
56+
Then register your servers from either
57+
[on-premises](/azure/automation/automation-dsc-onboarding#physicalvirtual-windows-machines-on-premises-or-in-a-cloud-other-than-azureaws)
58+
or [in Azure](/azure/automation/automation-dsc-onboarding#azure-virtual-machines)
59+
to pull configurations.
60+
61+
To try out Datum, visit the
62+
[PowerShell Gallery](https://www.powershellgallery.com/packages/datum/)
63+
and download the solution or click "Project Site"
64+
to view the
65+
[documentation](https://github.com/gaelcolas/Datum#2-getting-started--concepts).
66+
67+
## Next steps
68+
69+
- [Windows PowerShell Desired State Configuration Overview](/powershell/dsc/overview/overview)
70+
- [DSC Resources](/powershell/dsc/resources/resources)
71+
- [Configuring The Local Configuration Manager](/powershell/dsc/managing-nodes/metaconfig)
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Create configurations from existing servers - Azure Automation
3+
description: Learn how to create configurations from existing servers for Azure Automation.
4+
keywords: dsc,powershell,configuration,setup
5+
services: automation
6+
ms.service: automation
7+
ms.subservice: dsc
8+
author: mgreenegit
9+
ms.author: migreene
10+
ms.date: 08/08/2019
11+
ms.topic: conceptual
12+
manager: carmonm
13+
---
14+
# Create configurations from existing servers
15+
16+
> Applies To: Windows PowerShell 5.1
17+
18+
Creating configurations from existing servers can be a challenging task.
19+
You might not want *all* settings,
20+
just those that you care about.
21+
Even then you need to know in what order the settings
22+
must be applied in order for the configuration to apply successfully.
23+
24+
> [!NOTE]
25+
> This article refers to a solution that is maintained by the Open Source community.
26+
> Support is only available in the form of GitHub collaboration, not from Microsoft.
27+
28+
## Community project: ReverseDSC
29+
30+
A community maintained solution named
31+
[ReverseDSC](https://github.com/microsoft/reversedsc)
32+
has been created to work in this area starting SharePoint.
33+
34+
The solution builds on the
35+
[SharePointDSC resource](https://github.com/powershell/sharepointdsc)
36+
and extends it to orchestrate
37+
[gathering information](https://github.com/Microsoft/sharepointDSC.reverse#how-to-use)
38+
from existing SharePoint servers.
39+
The latest version has multiple
40+
[extraction modes](https://github.com/Microsoft/SharePointDSC.Reverse/wiki/Extraction-Modes)
41+
to determine what level of information to include.
42+
43+
The result of using the solution is generating
44+
[Configuration Data](https://github.com/Microsoft/sharepointDSC.reverse#configuration-data)
45+
to be used with SharePointDSC configuration scripts.
46+
47+
Once the data files have been generated,
48+
you can use them with
49+
[DSC Configuration scripts](/powershell/dsc/overview/overview)
50+
to generate MOF files
51+
and
52+
[upload the MOF files to Azure Automation](/azure/automation/tutorial-configure-servers-desired-state#create-and-upload-a-configuration-to-azure-automation).
53+
Then register your servers from either
54+
[on-premises](/azure/automation/automation-dsc-onboarding#physicalvirtual-windows-machines-on-premises-or-in-a-cloud-other-than-azureaws)
55+
or [in Azure](/azure/automation/automation-dsc-onboarding#azure-virtual-machines)
56+
to pull configurations.
57+
58+
To try out ReverseDSC, visit the
59+
[PowerShell Gallery](https://www.powershellgallery.com/packages/ReverseDSC/)
60+
and download the solution or click "Project Site"
61+
to view the
62+
[documentation](https://github.com/Microsoft/sharepointDSC.reverse).
63+
64+
## Next steps
65+
66+
- [Windows PowerShell Desired State Configuration Overview](/powershell/dsc/overview/overview)
67+
- [DSC Resources](/powershell/dsc/resources/resources)
68+
- [Configuring The Local Configuration Manager](/powershell/dsc/managing-nodes/metaconfig)
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Configuration based on STIG to use in state configuration - Azure Automation
3+
description: Learn about configurations based on STIG for state configuration in Azure Automation.
4+
keywords: dsc,powershell,configuration,setup
5+
services: automation
6+
ms.service: automation
7+
ms.subservice: dsc
8+
author: mgreenegit
9+
ms.author: migreene
10+
ms.date: 08/08/2019
11+
ms.topic: conceptual
12+
manager: carmonm
13+
---
14+
# Configuration based on STIG
15+
16+
> Applies To: Windows PowerShell 5.1
17+
18+
Creating configuration content for the first time can be challenging.
19+
In many cases,
20+
the goal is to automate configuration of servers
21+
following a "baseline" that hopefully aligns to an industry recommendation.
22+
23+
> [!NOTE]
24+
> This article refers to a solution that is maintained by the Open Source community.
25+
> Support is only available in the form of GitHub collaboration, not from Microsoft.
26+
27+
## Community project: PowerSTIG
28+
29+
A community project named
30+
[PowerSTIG](https://github.com/microsoft/powerstig)
31+
aims to resolve this issue by generating DSC content based on
32+
[public information](https://public.cyber.mil/stigs/)
33+
provided about STIG (Security Technical Implementation Guide),
34+
35+
Dealing with baselines is more complicated than it sounds.
36+
Many organizations need to
37+
[document exceptions](https://github.com/microsoft/powerstig#powerstigdata)
38+
to rules and manage that data at scale.
39+
PowerSTIG addresses the problem by providing
40+
[Composite Resources](https://github.com/microsoft/powerstig#powerstigdsc)
41+
to address each area of the configuration
42+
rather than trying to address the entire range of settings
43+
in one large file.
44+
45+
Once the configurations have been generated,
46+
you can use the
47+
[DSC Configuration scripts](/powershell/dsc/configurations)
48+
to generate MOF files
49+
and
50+
[upload the MOF files to Azure Automation](/azure/automation/tutorial-configure-servers-desired-state#create-and-upload-a-configuration-to-azure-automation).
51+
Then register your servers from either
52+
[on-premises](/azure/automation/automation-dsc-onboarding#physicalvirtual-windows-machines-on-premises-or-in-a-cloud-other-than-azureaws)
53+
or [in Azure](/azure/automation/automation-dsc-onboarding#azure-virtual-machines)
54+
to pull configurations.
55+
56+
To try out PowerSTIG, visit the
57+
[PowerShell Gallery](http://www.powershellgallery.com)
58+
and download the solution or click "Project Site"
59+
to view the
60+
[documentation](https://github.com/microsoft/powerstig).
61+
62+
## Next steps
63+
64+
- [Windows PowerShell Desired State Configuration Overview](/powershell/dsc/overview/overview)
65+
- [DSC Resources](/powershell/dsc/resources/resources)
66+
- [Configuring The Local Configuration Manager](/powershell/dsc/managing-nodes/metaconfig)
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
---
2+
title: Convert configurations to composite resources for state configuration - Azure Automation
3+
description: Learn how to convert configurations to composite resources for state configuration in Azure Automation.
4+
keywords: dsc,powershell,configuration,setup
5+
services: automation
6+
ms.service: automation
7+
ms.subservice: dsc
8+
author: mgreenegit
9+
ms.author: migreene
10+
ms.date: 08/08/2019
11+
ms.topic: conceptual
12+
manager: carmonm
13+
---
14+
# Convert configurations to composite resources
15+
16+
> Applies To: Windows PowerShell 5.1
17+
18+
Once you get started authoring configurations,
19+
you can quickly create "scenarios" that manage
20+
groups of settings.
21+
Examples would be:
22+
23+
- create a web server
24+
- create a DNS server
25+
- create a SharePoint server
26+
- configure a SQL cluster
27+
- manage firewall settings
28+
- manage password settings
29+
30+
If you are interested in sharing this work with others,
31+
the best option is to package the configuration as a
32+
[Composite Resource](/powershell/dsc/resources/authoringresourcecomposite).
33+
Creating composite resources for the first time can be overwhelming.
34+
35+
> [!NOTE]
36+
> This article refers to a solution that is maintained by the Open Source community.
37+
> Support is only available in the form of GitHub collaboration, not from Microsoft.
38+
39+
## Community project: CompositeResource
40+
41+
A community maintained solution named
42+
[CompositeResource](https://github.com/microsoft/compositeresource)
43+
has been created to resolve this challenge.
44+
45+
CompositeResource automates the process of creating a new module from your configuration.
46+
You start by
47+
[dot sourcing](https://blogs.technet.microsoft.com/heyscriptingguy/2010/08/10/how-to-reuse-windows-powershell-functions-in-scripts/)
48+
the configuration script on your workstation (or build server)
49+
so it is loaded in memory.
50+
Next, rather than running the configuration to generate a MOF file,
51+
use the function provided by the CompositeResource module to automate a conversion.
52+
The cmdlet will load the contents of your configuration,
53+
get the list of parameters,
54+
and generate a new module with everything you need.
55+
56+
Once you have generated a module,
57+
you can increment the version and add release notes each time you make changes
58+
and publish it to your own
59+
[PowerShellGet repository](https://kevinmarquette.github.io/2018-03-03-Powershell-Using-a-NuGet-server-for-a-PSRepository/?utm_source=blog&utm_medium=blog&utm_content=psscriptrepo).
60+
61+
Once you have create a composite resource module containing your configuration
62+
(or multiple configurations),
63+
you can use them in the
64+
[Composable Authoring Experience](/azure/automation/compose-configurationwithcompositeresources)
65+
in Azure,
66+
or add them to
67+
[DSC Configuration scripts](/powershell/dsc/resources/configurations)
68+
to generate MOF files
69+
and
70+
[upload the MOF files to Azure Automation](/azure/automation/tutorial-configure-servers-desired-state#create-and-upload-a-configuration-to-azure-automation).
71+
Then register your servers from either
72+
[on-premises](/azure/automation/automation-dsc-onboarding#physicalvirtual-windows-machines-on-premises-or-in-a-cloud-other-than-azureaws)
73+
or [in Azure](/azure/automation/automation-dsc-onboarding#azure-virtual-machines)
74+
to pull configurations.
75+
The latest update to the project has also published
76+
[runbooks](https://www.powershellgallery.com/packages?q=DscGallerySamples)
77+
for Azure Automation to automate the process of importing configurations
78+
from the PowerShell Gallery.
79+
80+
To try out automating creation of composite resources for DSC, visit the
81+
[PowerShell Gallery](https://www.powershellgallery.com/packages/compositeresource/)
82+
and download the solution or click "Project Site"
83+
to view the
84+
[documentation](https://github.com/microsoft/compositeresource).
85+
86+
## Next steps
87+
88+
- [Windows PowerShell Desired State Configuration Overview](/powershell/dsc/overview/overview)
89+
- [DSC Resources](/powershell/dsc/resources/resources)
90+
- [Configuring The Local Configuration Manager](/powershell/dsc/managing-nodes/metaconfig)

0 commit comments

Comments
 (0)