Skip to content

Commit d5f77a5

Browse files
authored
Merge pull request #215393 from SnehaSudhirG/21Oct-Freshness-Set1
Revised the presentation for usability- Freshness effort
2 parents 7adb9e4 + 8a40f77 commit d5f77a5

File tree

1 file changed

+28
-58
lines changed

1 file changed

+28
-58
lines changed

articles/automation/automation-dsc-create-composite.md

Lines changed: 28 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -5,80 +5,50 @@ keywords: dsc,powershell,configuration,setup
55
services: automation
66
ms.subservice: dsc
77
ms.date: 08/08/2019
8+
ms.custom: engagement-fy23
89
ms.topic: conceptual
910
---
1011

1112
# Convert configurations to composite resources
1213

13-
> Applies To: Windows PowerShell 5.1
14+
> **Applies to:** :heavy_check_mark: Windows PowerShell 5.1
1415
15-
Once you get started authoring configurations,
16-
you can quickly create "scenarios" that manage
17-
groups of settings.
18-
Examples would be:
16+
> [!IMPORTANT]
17+
> This article refers to a solution that is maintained by the Open Source community and support is only available in the form of GitHub collaboration, not from Microsoft.
1918
20-
- create a web server
21-
- create a DNS server
22-
- create a server that runs SharePoint
23-
- configure a SQL cluster
24-
- manage firewall settings
25-
- manage password settings
19+
This article, explains on creating **scenarios** that manage groups of settings, after you get started with authoring configurations. Listed below are few examples:
2620

27-
If you are interested in sharing this work with others,
28-
the best option is to package the configuration as a
29-
[Composite Resource](/powershell/dsc/resources/authoringresourcecomposite).
30-
Creating composite resources for the first time can be overwhelming.
21+
- Create a web server
22+
- Create a DNS server
23+
- Create a server that runs SharePoint
24+
- Configure a SQL cluster
25+
- Manage firewall settings
26+
- Manage password settings
3127

32-
> [!NOTE]
33-
> This article refers to a solution that is maintained by the Open Source community.
34-
> Support is only available in the form of GitHub collaboration, not from Microsoft.
28+
We recommend that you package the configuration as a [Composite Resource](/powershell/dsc/resources/authoringresourcecomposite) before you share it with others as creating composite resources for the first time can be a tedious effort.
29+
30+
## Community project - CompositeResource
31+
32+
A [CompositeResource](https://github.com/microsoft/compositeresource) is a community maintained solution that
33+
has been created to resolve this challenge. Composite Resource automates the process of creating a new module from your configuration.
3534

36-
## Community project: CompositeResource
3735

38-
A community maintained solution named
39-
[CompositeResource](https://github.com/microsoft/compositeresource)
40-
has been created to resolve this challenge.
36+
## Create a composite resource module
4137

42-
CompositeResource automates the process of creating a new module from your configuration.
43-
You start by
44-
[dot sourcing](https://devblogs.microsoft.com/scripting/how-to-reuse-windows-powershell-functions-in-scripts/)
45-
the configuration script on your workstation (or build server)
46-
so it is loaded in memory.
47-
Next, rather than running the configuration to generate a MOF file,
48-
use the function provided by the CompositeResource module to automate a conversion.
49-
The cmdlet will load the contents of your configuration,
50-
get the list of parameters,
51-
and generate a new module with everything you need.
38+
Follow the steps to create a composite resource module:
5239

53-
Once you have generated a module,
54-
you can increment the version and add release notes each time you make changes
55-
and publish it to your own
40+
1. Begin by [dot sourcing](https://devblogs.microsoft.com/scripting/how-to-reuse-windows-powershell-functions-in-scripts/) the configuration script on your workstation (or build server) to ensure that it is loaded in memory.
41+
1. Use the function provided by the *CompositeResource* module to automate a conversion instead of running the configuration to generate a *MOF* file.
42+
Here, the cmdlet will load the contents of your configuration, gets the list of parameters, and generates a new module.
43+
1. After you generate a module, you can increment the version and add release notes each time you make changes and publish it to your own
5644
[PowerShellGet repository](https://powershellexplained.com/2018-03-03-Powershell-Using-a-NuGet-server-for-a-PSRepository/?utm_source=blog&utm_medium=blog&utm_content=psscriptrepo).
45+
1. Use the module in the [Composable Authoring Experience](./compose-configurationwithcompositeresources.md) in Azure, or add them to [DSC Configuration scripts](/powershell/dsc/configurations/configurations) to generate MOF files and [upload the MOF files to Azure Automation](./tutorial-configure-servers-desired-state.md#create-and-upload-a-configuration-to-azure-automation).
46+
1. Register your servers from either [on-premises](./automation-dsc-onboarding.md#enable-physicalvirtual-linux-machines) or [in Azure](./automation-dsc-onboarding.md#enable-azure-vms)to pull configurations.
5747

58-
Once you have created a composite resource module containing your configuration
59-
(or multiple configurations),
60-
you can use them in the
61-
[Composable Authoring Experience](./compose-configurationwithcompositeresources.md)
62-
in Azure,
63-
or add them to
64-
[DSC Configuration scripts](/powershell/dsc/configurations/configurations)
65-
to generate MOF files
66-
and
67-
[upload the MOF files to Azure Automation](./tutorial-configure-servers-desired-state.md#create-and-upload-a-configuration-to-azure-automation).
68-
Then register your servers from either
69-
[on-premises](./automation-dsc-onboarding.md#enable-physicalvirtual-linux-machines)
70-
or [in Azure](./automation-dsc-onboarding.md#enable-azure-vms)
71-
to pull configurations.
72-
The latest update to the project has also published
73-
[runbooks](https://www.powershellgallery.com/packages?q=DscGallerySamples)
74-
for Azure Automation to automate the process of importing configurations
75-
from the PowerShell Gallery.
48+
> [!NOTE]
49+
> The latest update to the project has also published [runbooks](https://www.powershellgallery.com/packages?q=DscGallerySamples) for Azure Automation to automate the process of importing configurations from the PowerShell Gallery.
7650
77-
To try out automating creation of composite resources for DSC, visit the
78-
[PowerShell Gallery](https://www.powershellgallery.com/packages/compositeresource/)
79-
and download the solution or click "Project Site"
80-
to view the
81-
[documentation](https://github.com/microsoft/compositeresource).
51+
For more information on how to automate the creation of composite resources for DSC, see [PowerShell Gallery](https://www.powershellgallery.com/packages/compositeresource/) and download the solution or select **Project Site** to view the [documentation](https://github.com/microsoft/compositeresource).
8252

8353
## Next steps
8454

0 commit comments

Comments
 (0)