search

dsccommunity / ComputerManagementDsc

DSC resources for for configuration of a Windows computer. These DSC resources allow you to perform computer management tasks, such as renaming the computer, joining a domain and scheduling tasks as well as configuring items such as virtual memory, event logs, time zones and power settings.
https://dsccommunity.org
MIT License
309 stars 82 forks source link

PowershellModule, PowershellRepository: New resource proposal #393

Open nickgw opened 2 years ago

nickgw commented 2 years ago

Resource proposal

Currently, psmodule and psrepository are bundled in the PowershellGet v2 module. In PowerShellGet v3 the resources have been moved into a new, dsc specific module, PowerShellGetDsc. Unfortunately, these repositories are either no longer maintained, or have not had any activity in years.

I'm proposing taking the resources and moving them into ComputerManagementDsc with new names to avoid multiple DSC resources with the same name. This way, the community can add features and bug fixes more rapidly. If there comes a time that PowershellGetDsc is actively maintained, we can take the contributions from ComputerManagementDsc and port them over.

https://github.com/PowerShell/PowerShellGetDsc - no contributions in 11 months, no target production release https://github.com/PowerShell/PowerShellGet - does not include Dsc resources anymore https://github.com/PowerShell/PowerShellGetv2 - Contains PSModule and PSRepository, no longer in development and not accepting any pull requests

Proposed properties

[ClassVersion("1.0.0.0"),FriendlyName("PSModule")] class MSFT_PSModule : OMI_BaseResource { [Key] String Name; [Write,ValueMap{"Present", "Absent"},Values{"Present", "Absent"}] String Ensure; [Write] String Repository; [Write,ValueMap{"Trusted", "Untrusted"},Values{"Trusted", "Untrusted"}] String InstallationPolicy; [Write] Boolean Trusted; [Write] String Version; [Write] Boolean NoClobber; [Write] Boolean SkipPublisherCheck; [Read] string Description; [Read] String InstalledVersion; [Read] String Guid; [Read] String ModuleBase; [Read] String ModuleType; [Read] String Author; };

[ClassVersion("1.0.0.0"),FriendlyName("PSRepository")] class MSFT_PSRepository : OMI_BaseResource { [Key] String Name; [Write, ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure; [Write] String URL; [Write] String Priority; [Write, ValueMap{"Trusted","Untrusted"}, Values{"Trusted","Untrusted"}] String InstallationPolicy; [Read] Boolean Trusted; [Read] Boolean Registered; };

Special considerations or limitations

There may come a time when psmodule and psrepository are actively developed and we should work to contribute any fixes or features from ComputerManagementDsc to the official repository.

johlju commented 2 years ago

We could name the resources PSResource and PSResourceRepository to align with PowerShellGet v3, and they would not conflict with any existing DSC resources. Though, in case the goal of the PowerShell team is to create those resources we could name them differently. But since there has not been any activity for the existing resources for PSGet v3 maybe we could use the names.

Also suggest the resources are made as class-based resources so that they also work (can be made work) cross-platform. Of course the goal should also be to support both v2 and v3 of PowerShellGet (once the later is released).

nickgw commented 2 years ago

@johlju Do we have any examples of class-based resource structure in a module that is all mof based? I can take a stab at this but JeaDsc's resource structure doesn't seem quite applicable.

johlju commented 2 years ago

Please look at SqlServerDsc, it has both class-based resources and MOF-based resources, and uses the pattern we try to follow.

johlju commented 2 years ago

Use the resource SqlAudit in SqlServerDsc as an example. There are also class-based resources in DnsServerDsc

PlagueHO commented 2 years ago

This does sound like a great idea. I'd be all for this. And agree that we should aim to make them class-based if possible.