Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(DOCS) Update reference/changelog for preview.8 #476

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 79 additions & 28 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
title: "Desired State Configuration changelog"
description: >-
A log of the changes for releases of DSCv3.
ms.date: 03/06/2024
ms.topic: whats-new
ms.date: 06/24/2024
---

# Changelog
Expand Down Expand Up @@ -45,7 +46,7 @@ This section includes a summary of user-facing changes since the last release. F
changes since the last release, see the [diff on GitHub][unreleased].

<!-- Unreleased comparison link - always update version to match last release tag-->
[unreleased]: https://github.com/PowerShell/DSC/compare/v3.0.0-preview.7...main
[unreleased]: https://github.com/PowerShell/DSC/compare/v3.0.0-preview.8...main

<!--
Unreleased change entry instructions:
Expand All @@ -70,25 +71,55 @@ changes since the last release, see the [diff on GitHub][unreleased].
for the `v3.0.0.0-alpha.5` release. Leave the release links under the release section.
-->

<!-- Unreleased change links -->

## [v3.0.0-preview.8][release-v3.0.0-preview.8] - 2024-06-19

This section includes a summary of changes for the `preview.8` release. For the full list of changes
in this release, see the [diff on GitHub][compare-v3.0.0-preview.8].

<!-- Release links -->
[release-v3.0.0-preview.8]: https://github.com/PowerShell/DSC/releases/tag/v3.0.0-preview.8 "Link to the DSC v3.0.0-preview.8 release on GitHub"
[compare-v3.0.0-preview.8]: https://github.com/PowerShell/DSC/compare/v3.0.0-preview.7...v3.0.0-preview.8

### Changed

- Changed the `Microsoft.DSC/PowerShell` adapter to only handle PowerShell DSC Resources
implemented as classes and remove the dependency on the **PSDesiredStateConfiguration** module.
The `Microsoft.Windows/WindowsPowerShell` adapter continues to work with classic PSDSC resources.
Neither adapter supports composite PSDSC resources. This change simplified the code and coincided
with ensuring that the `Microsoft.DSC/PowerShell` adapter works correctly on Linux and macOS as
well as Windows. This change also brought performance improvements to the adapter, speeding up
resource invocation and discovery.

<details><summary>Related work items</summary>

- Issues: _None_.
- PRs:
- [#435][#435]
- [#439][#439]

</details>

### Added

- Added the [`--what-if` (`-w`)][ur-aa] option to the [dsc config set][cmd-cset] command. When you
- Added the [`--what-if` (`-w`)][p8-01] option to the [dsc config set][cmd-cset] command. When you
call `dsc config set` with the `--what-if` option, DSC doesn't actually invoke the resources to
enforce the desired state. Instead, it returns the expected output for the command, showing the
before and after state for each resource instance.

The output for the `dsc config set` operation with the `--what-if` operation is the same as an
[actual configuration set operation][ur-ab], except that the metadata field
[executionType][ur-ac] is set to `WhatIf` instead of `Actual`.
[actual configuration set operation][p8-02], except that the metadata field
[executionType][p8-03] is set to `WhatIf` instead of `Actual`.

By default, the generated output is synthetic, based on the results of the resources' `test`
operation. Resources can define the [whatIf][ur-ad] property in their resource manifest to
operation. Resources can define the [whatIf][p8-04] property in their resource manifest to
participate in what-if operations, reporting more specifically how they will change the system.
For example, participating resources could indicate whether an actual set operation will require
a reboot or whether the current user has the correct permissions to manage that resource
instance.

Participating resources have the [WhatIf capability][ur-ae].
Participating resources have the [WhatIf capability][p8-05].

<details><summary>Related work items</summary>

Expand All @@ -99,21 +130,23 @@ changes since the last release, see the [diff on GitHub][unreleased].

</details>

- Added support for [importer resources][ur-af]. These resources resolve external sources to a
- Added support for [importer resources][p8-06]. These resources resolve external sources to a
nested DSC Configuration document. The resolved instances are processed as nested resource
instances.

This required some updates to the schemas, all backwards-compatible:

- Added a new [resourceKind][ur-ag] named `Import`.
- Added the [resolve][ur-ah] command to resource manifests.
- Added the new [`Resolve`][ur-ai] capability, returned in the output for the
- Added a new [resourceKind][p8-07] named `Import`.
- Added the [resolve][p8-08] command to resource manifests.
- Added the new [`Resolve`][p8-09] capability, returned in the output for the
[dsc resource list][cmd-rlist] command when DSC discovers an importer resource.

<details><summary>Related work items</summary>

- Issues: [#429][#429]
- PRs: [#412][#412]
- PRs:
- [#412][#412]
- [#464][#464]

</details>

Expand Down Expand Up @@ -207,9 +240,20 @@ changes since the last release, see the [diff on GitHub][unreleased].

</details>

- Added the `Microsoft.DSC.Experimental/SystemctlService` class-based PSDSC resource. It has the
`Get` and `Export` [capabilities][p8-10]. You can use it on Linux systems that manage services
with SystemD and `systemctl`. In this release, it doesn't support setting services.

<details><summary>Related work items</summary>

- Issues: _None_.
- PRs: [#454][#454]

</details>

### Fixed

- Fixed the JSON Schema for [exit codes][ur-fa] in the resource manifest to support negative
- Fixed the JSON Schema for [exit codes][p8-11] in the resource manifest to support negative
integers. Prior to this release, the DSC engine supported negative exit codes but the JSON Schema
forbid them.

Expand Down Expand Up @@ -243,17 +287,18 @@ changes since the last release, see the [diff on GitHub][unreleased].

</details>

<!-- Unreleased change links -->
[ur-aa]: ./docs/reference/cli/config/set.md#-w---what-if
[ur-ab]: ./docs/reference/schemas/outputs/config/set.md
[ur-ac]: ./docs/reference/schemas/metadata/Microsoft.DSC/properties.md#executiontype
[ur-ad]: ./docs/reference/schemas/resource/manifest/whatif.md
[ur-ae]: ./docs/reference/schemas/outputs/resource/list.md#capability-whatif
[ur-af]: ./docs/reference/schemas/definitions/resourceKind.md#importer-resources
[ur-ag]: ./docs/reference/schemas/definitions/resourceKind.md
[ur-ah]: ./docs/reference/schemas/resource/manifest/resolve.md
[ur-ai]: ./docs/reference/schemas/outputs/resource/list.md#capability-resolve
[ur-fa]: ./docs/reference/schemas/resource/manifest/root.md#exitcodes
<!-- Preview.8 links -->
[p8-01]: ./docs/reference/cli/config/set.md#-w---what-if
[p8-02]: ./docs/reference/schemas/outputs/config/set.md
[p8-03]: ./docs/reference/schemas/metadata/Microsoft.DSC/properties.md#executiontype
[p8-04]: ./docs/reference/schemas/resource/manifest/whatif.md
[p8-05]: ./docs/reference/schemas/outputs/resource/list.md#capability-whatif
[p8-06]: ./docs/reference/schemas/definitions/resourceKind.md#importer-resources
[p8-07]: ./docs/reference/schemas/definitions/resourceKind.md
[p8-08]: ./docs/reference/schemas/resource/manifest/resolve.md
[p8-09]: ./docs/reference/schemas/outputs/resource/list.md#capability-resolve
[p8-10]: ./docs/reference/schemas/outputs/resource/list.md#capabilities
[p8-11]: ./docs/reference/schemas/resource/manifest/root.md#exitcodes

## [v3.0.0-preview.7][release-v3.0.0-preview.7] - 2024-04-22

Expand Down Expand Up @@ -309,10 +354,12 @@ in this release, see the [diff on GitHub][compare-v3.0.0-preview.7].

</details>

- <a id="rename-provider-to-adapter" /> In this release, the term `DSC Resource Provider` is
replaced with the more semantically accurate `DSC Resource Adapter`. These resources enable users
to leverage resources that don't define a DSC Resource Manifest with DSC, like PSDSC resources -
they're _adapters_ between DSCv3 and resources defined in a different way.
- <a id="rename-provider-to-adapter"></a>

In this release, the term `DSC Resource Provider` is replaced with the more semantically accurate
`DSC Resource Adapter`. These resources enable users to leverage resources that don't define a
DSC Resource Manifest with DSC, like PSDSC resources - they're _adapters_ between DSCv3 and
resources defined in a different way.

Beyond using different terminology in the documentation, this change also renamed the resource
manifest property `provider` to [adapter][p7-01], and the `requires` property in the output for
Expand Down Expand Up @@ -1522,9 +1569,13 @@ For the full list of changes in this release, see the [diff on GitHub][compare-v
[#431]: https://github.com/PowerShell/DSC/issues/431
[#432]: https://github.com/PowerShell/DSC/issues/432
[#434]: https://github.com/PowerShell/DSC/issues/434
[#435]: https://github.com/PowerShell/DSC/issues/435
[#438]: https://github.com/PowerShell/DSC/issues/438
[#439]: https://github.com/PowerShell/DSC/issues/439
[#441]: https://github.com/PowerShell/DSC/issues/441
[#444]: https://github.com/PowerShell/DSC/issues/444
[#454]: https://github.com/PowerShell/DSC/issues/454
[#464]: https://github.com/PowerShell/DSC/issues/464
[#45]: https://github.com/PowerShell/DSC/issues/45
[#49]: https://github.com/PowerShell/DSC/issues/49
[#57]: https://github.com/PowerShell/DSC/issues/57
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/cli/config/get.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Command line reference for the 'dsc config get' command
ms.date: 01/17/2024
ms.date: 06/24/2024
ms.topic: reference
title: dsc config get
---
Expand Down Expand Up @@ -52,7 +52,7 @@ document saved as `example.dsc.config.yaml`.
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
- name: Windows only
type: DSC/AssertionGroup
type: Microsoft.DSC/Assertion
properties:
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
Expand All @@ -64,9 +64,9 @@ resources:
type: Microsoft.Windows/Registry
properties:
keyPath: HKCU\example
_ensure: Present
_exist: true
dependsOn:
- '[DSC/Assertion]Windows only'
- "[resourceId('Microsoft.DSC/Assertion', 'Windows only')"
```

```sh
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/cli/config/set.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Command line reference for the 'dsc config set' command
ms.date: 01/17/2024
ms.date: 06/24/2024
ms.topic: reference
title: dsc config set
---
Expand Down Expand Up @@ -53,7 +53,7 @@ The command inspects the resource instances defined in the configuration documen
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
- name: Windows only
type: DSC/AssertionGroup
type: Microsoft.DSC/Assertion
properties:
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
Expand All @@ -65,9 +65,9 @@ resources:
type: Microsoft.Windows/Registry
properties:
keyPath: HKCU\example
_ensure: Present
_exist: true
dependsOn:
- '[DSC/Assertion]Windows only'
- "[resourceId('Microsoft.DSC/Assertion', 'Windows only')"
```

```sh
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/cli/config/test.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Command line reference for the 'dsc config test' command
ms.date: 01/17/2024
ms.date: 06/24/2024
ms.topic: reference
title: dsc config test
---
Expand Down Expand Up @@ -52,7 +52,7 @@ resource instances defined in the configuration document saved as `example.dsc.c
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
- name: Windows only
type: DSC/AssertionGroup
type: Microsoft.DSC/Assertion
properties:
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
Expand All @@ -64,9 +64,9 @@ resources:
type: Microsoft.Windows/Registry
properties:
keyPath: HKCU\example
_ensure: Present
_exist: true
dependsOn:
- '[DSC/Assertion]Windows only'
- "[resourceId('Microsoft.DSC/Assertion', 'Windows only')"
```

```sh
Expand Down
Loading