PSResourceRepository: New resource proposal

[nickgw]

Resource proposal

This is a duplicate of Issue #393 , but scoped solely to the proposed PSResourceRepository resource.

Currently, psrepository is bundled in the PowershellGet v2 module. In PowerShellGet v3 the resource has 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 resource 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("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 psrepository is actively developed and we should work to contribute any fixes or features from ComputerManagementDsc to the official repository.

[nickgw]

@johlju I've got some questions about the design of this resource.

For the properties MaximumVersion, and MinimumVersion does specifying a state of one of them mean all resources out of compliance are uninstalled, or do we just say the resource is in the correct state if a single resource meets the critera.

For example: Given this resource declaration:

$Params = @{
  Name = 'PSResource'
  ModuleName = 'ComputerManagementDsc'
  Property = @{
    Name   = 'jeadsc'
    Ensure = 'Present'
    MaximumVersion = '0.6.0'
  }
  Method = 'Get'
}

and this result of Get-Module -Name JeaDsc -ListAvailable

PS C:\Users\vagrant> Get-Module -Name JeaDsc -ListAvailable


    Directory: C:\Program Files\WindowsPowerShell\Modules


ModuleType Version    Name                                ExportedCommands                                                                                                           
---------- -------    ----                                ----------------                                                                                                           
Script     0.7.2      JeaDsc                              ConvertTo-Expression                                                                                                       
Script     0.6.0      JeaDsc                              {Compare-JeaConfiguration, Convert-ObjectToHashtable, Convert-StringToObject}

Is the resource in compliance because JeaDsc version 6.0.0 meets the resource, or out of spec because 0.7.2 exceeds it and we need to uninstall 0.7.2?

Similar question for RequiredVersion, but I think it's more cut and dry that as long as the resource of the requiredversion exists, we're in the correct state.

thanks!

[johlju]

I think this was meant for issue #398?

Is the resource in compliance because JeaDsc version 6.0.0 meets the resource, or out of spec because 0.7.2 exceeds it and we need to uninstall 0.7.2?

Yes, I think in the case we should uninstall all other newer versions than 0.6.0. But probably only if the user adds an optional parameter RemoveNonCompliantVersions or Force (or something similar) so that the user opt-in for the removal. 🤔