Skip to content

Latest commit

 

History

History
101 lines (75 loc) · 4.56 KB

README.md

File metadata and controls

101 lines (75 loc) · 4.56 KB
Raw

Guest Configuration Project

This module is a template to use with the Plaster tool for scaffolding new projects.

Demo

gif

Setup

To use this solution on your dev workstation, you will need to install the module from the PowerShell Gallery. This is easiest to do from PowerShell.

This tool has only been tested on PowerShell 7 preview

Install-Module GuestConfigurationProject -repository PSGallery -force

This command will also install the following required modules if they are not already available on the machine.

  • Plaster
  • Pester
  • GuestConfiguration

This module include task runners for the VS Code editor. However, you could scaffold the project and then open it in the editor of your choice.

How-to use the tool

Navigate to the folder where the GuestConfigurationProject module is installed. Run the command Invoke-Plaster with a . as the Template source location. For the Destination path location, use any folder where you would like to create a project.

Open VS Code, and open the project folder. A small window will prompt to import the workspace. This is optional and will not effect the functionality of the task runners.

Use the sample project to create a custom resource/configuration according to your requirements.

When you are ready to test, use the task runners by clicking Terminal and then Run Task.

Task runners

The tool includes task runners that automate the steps to test your project and create (and validate) a package to use in Azure Policy Guest Configuration.

The first step requires the Pester module. The second and third steps require the GuestConfiguration module.

The GuestConfiguration module includes a copy of the agents used in Azure, for both Windows and Linux, so packages can be validated from developer workstations.

  • 1. Run tests (Pester): Runs Pester tests for the new project to verify functionality.
  • 2. Build package: Runs the New-GuestConfigurationPackage command to create a .zip package containing the configuration and custom resources from your project.
  • 3. Test package: Runs the Test-GuestConfigurationPackage command to validate the package by running it using the same agent that is used in Azure, from your workstation.

Contents

File/folder Description
editor Task runners for VSCode.
Modules Custom DSC resource modules.
test Pester tests for custom resource modules.
.gitignore Define what to ignore at commit time.
azure-pipelines.yml A build script for this project to automate publishing to PSGallery.
CODE_OF_CONDUCT.md Code of conduct for participating in this community collaboration.
Configuration.md A sample MOF file.
GuestConfigurationProject.gif An animated demo.
GuestConfigurationProject.psd1 Module manifest.
LICENSE The license for the sample.
plasterManifest.xml Manifest file to define the Plaster template.
project.code-workspace VS Code workspace settings.
README.md This README file.
SECURITY.md How to report security issues.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.