BernieWhite/DevOpsKitDsc

Automation resources for working with PowerShell Desired State Configuration (DSC).

DevOps Kit for Dsc

This DevOps Kit for Desired State Configuration (DOKD) aims to provide IT Pros with tools and documentation to easily adopt a DevOps model for deploying and managing Desired State Configuration (DSC).

DSC already provides the tools for IT Pros to automate the configuration of Windows or Linux to stand-up a fully running workload. Application Lifecycle Management (ALM) tools such as Visual Studio Team Services (VSTS) also provide features such as requirements tracking, version control and release management.

AppVeyor (Windows)	Codecov (Windows)

Disclaimer

This project is to be considered a proof-of-concept and not a supported Microsoft product.

Modules

The following modules are included in this repository.

Module	Description	Latest version
DevOpsKitDsc	Automate releases of Desired State Configuration configurations

Features

• DevOps
• Collections
  • Group configuration and nodes into collections that can be built together.
• Build
  • Restore module dependencies.
  • Build only changed nodes with incremental build.
  • Build documentation together with DSC configurations.
• Node configuration data
  • Use flat configuration data structure for a single node.
  • Use your choice of PSD1 or JSON files for storing node data.
• Release
  • Package configurations and resource modules ready for a local pull server or Azure Automation Service.

Getting started

Getting the module

• Install from PowerShell Gallery

# Install the module
Install-Module -Name 'DevOpsKitDsc';

• Save for offline use from PowerShell Gallery

# Save the DevOpsKitDsc module, in the .\modules directory
Save-Module -Name 'DevOpsKitDsc' -Path '.\modules';

Getting Visual Studio Code integration

• Install extension (preview) from Visual Studio Marketplace

# Install the extension
code --install-extension bewhite.dokd-vscode-preview

Building a cloned git repository

Get a sample configuration repository and build the configurations.

# Use git to clone the repository
git clone https://github.com/BernieWhite/DevOpsKitDsc-samples.git;

cd .\DevOpsKitDsc-samples

# Restore dependency modules to the workspace
Restore-DOKDscModule;

# Build all collections
Invoke-DOKDscBuild;

Detailed instructions

For detailed instructions please see getting started documentation here.

Commands

• Initialize-DOKDsc
• Register-DOKDscNode
• Import-DOKDscNodeConfiguration
• Invoke-DOKDscBuild
• New-DOKDscCollection
• Publish-DOKDscCollection
• Get-DOKDscCollection
• Set-DOKDscCollectionOption
• Import-DOKDscWorkspaceSetting
• Set-DOKDscWorkspaceOption
• Get-DOKDscWorkspaceOption
• Add-DOKDscModule
• Get-DOKDscModule
• Publish-DOKDscModule
• Restore-DOKDscModule

Related projects

Project name	Description
DevOpsKitDsc-vscode	A Visual Studio Code extension for DOKD
DevOpsKitDsc-samples	A sample DOKD repository
PSDocs	A PowerShell module to generate markdown from pipeline objects

Maintainers

• Bernie White

License

This project is licensed under the MIT License.