jcza / dsc

This repo is for the DSC v3 project

DSCv3

Note

This repo isn't accepting code contributions. It's public and open source to show progress and enable feedback. Once we're at a feature complete state, we can start taking code contributions.

What's DSCv3?

DSCv3 is the latest iteration of Microsoft's Desired State Configuration platform. DSCv3 is an open source command line application that abstracts the management of software components declaratively and idempotently. DSCv3 runs on Linux, macOS, and Windows without any external dependencies.

With DSCv3, you can:

• Author resources to manage your systems in any language
• Invoke individual resources
• Create configuration documents that define the desired state of a system

Differences from PowerShell DSC

This project is the next generation of DSC and leverages the PSDesiredStateConfiguration module to maintain compatibility with existing PowerShell based resources.

DSCv3 differs from PowerShell DSC in a few important ways:

• DSCv3 doesn't depend on PowerShell. You can use DSCv3 without PowerShell installed and manage resources written in bash, python, C#, Go, or any other language.
• DSCv3 doesn't include a local configuration manager. DSCv3 is invoked as a command. It doesn't run as a service.
• Non-PowerShell resources define their schemas with JSON files, not MOF files.
• Configuration documents are defined in JSON or YAML files, not PowerShell script files.

Importantly, while DSCv3 represents a major change to the DSC platform, DSCv3 is able to invoke PowerShell DSC Resources, including script-based and class-based DSC Resources, as they exist today. The configuration documents aren't compatible, but all published PowerShell DSC Resources are. You can use PowerShell DSC resources in DSCv3 with both Windows PowerShell and PowerShell.

Installing DSCv3

To install DSC v3:

1. Download the latest release from this repository.
2. Expand the release archive.
3. Add the folder containing the expanded archive contents to the PATH.

Explore DSCv3

If you're new to DSC or configuration management, we recommend reviewing the documentation.

Learning and authoring tutorials

If you're already familiar with DSC or just want to start experimenting with v3, we recommend reviewing the Samples repository and the accompanying tutorial site. The Samples repo is ready to accept Pull Requests, which is a great way to contribute while v3 is in early phases of development.

Integrating with DSCv3

DSCv3 is a platform tool that abstracts the concerns for defining and invoking resources. Higher order tools, like Azure Machine Configuration, Azure Automanaged VM, and WinGet are early partners for DSCv3 as orchestration agents.

DSCv3 uses JSON schemas to define the structure of resources, configuration documents, and the outputs that DSCv3 returns. These schemas make it easier to integrate DSCv3 with other tools, because they standardize and document how to interface with DSCv3.