(#240) Parameterize setup #284
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
steviecoaster
force-pushed
the
gh240
branch
3 times, most recently
from
c2d1bb6 to
78f53cf
Compare
steviecoaster
requested review from
JPRuskin and
ryanrichter94
and removed request for
JPRuskin
steviecoaster
force-pushed
the
gh240
branch
2 times, most recently
from
c1f8e77 to
86402af
Compare
This script adds parameterization to the ClientSetup.ps1 script that is hosted within the Nexus repository. It also adds parameterization to the registration script that is executed on a client so you can customize the installation.
3 tasks
JPRuskin
reviewed
Dec 12, 2024
There was a problem hiding this comment.
There's a lot of single-character variables that I think could be expanded to have helpful names, to ease legibility and maintainability in the future, but I haven't made suggestions as they generally spanned a fair number of lines and got muddled with other comments.
| $ProxyCredential, | ||
|
|
||
| #Install the Chocolatey Licensed Extension with right-click context menus available |
There was a problem hiding this comment.
Suggested change
| #Install the Chocolatey Licensed Extension with right-click context menus available | |
| # Install the Chocolatey Licensed Extension with right-click context menus available. |
Matching the format of the other param comments.
|
|
||
|
|
||
| Write-Host "Applying user supplied configuration" -ForegroundColor Cyan | ||
| #How we call choco from here changes as we need to be more dynamic with thingsii . |
There was a problem hiding this comment.
Suggested change
| #How we call choco from here changes as we need to be more dynamic with thingsii . | |
| # How we call choco from here changes as we need to be more dynamic with things. |
| @@ -158,3 +187,128 @@ if ($ServiceSalt) { | |||
| } | |||
| choco feature enable --name="'useChocolateyCentralManagement'" | |||
| choco feature enable --name="'useChocolateyCentralManagementDeployments'" | |||
|
|
|||
|
|
|||
| Write-Host "Applying user supplied configuration" -ForegroundColor Cyan | |||
There was a problem hiding this comment.
Suggested change
| Write-Host "Applying user supplied configuration" -ForegroundColor Cyan | |
| if ($AdditionalConfiguration -or $AdditionalFeatures -or $AdditionalSources -or AdditionalPackages) { | |
| Write-Host "Applying user supplied configuration" -ForegroundColor Cyan | |
| } |
| $package.ContainsKey('Pin') { $c.Add('--pin') } | ||
| } | ||
|
|
||
| #Ensure packages install and they don't flood the console output |
There was a problem hiding this comment.
Suggested change
| #Ensure packages install and they don't flood the console output | |
| # Ensure packages install and they don't flood the console output |
scripts/Register-C4bEndpoint.ps1
Outdated
|
|
||
| $PSBoundParameters.ContainsKey('IncludePackageTools') { | ||
| $params.Add('IncludePackageTools',$IncludePackageTools) |
There was a problem hiding this comment.
Suggested change
| $params.Add('IncludePackageTools',$IncludePackageTools) | |
| $params.Add('IncludePackageTools', $IncludePackageTools) |
| #> | ||
| Foreach ($a in $AdditionalSources) { | ||
| $c = [System.Collections.Generic.List[string]]::new() | ||
| #Required items |
There was a problem hiding this comment.
Suggested change
| #Required items | |
| # Required items |
| CertificatePassword = 's0mepa$$' | ||
| } | ||
| #> | ||
| Foreach ($a in $AdditionalSources) { |
There was a problem hiding this comment.
Suggested change
| Foreach ($a in $AdditionalSources) { | |
| foreach ($a in $AdditionalSources) { |
| choco source add --name="'ChocolateyInternal'" --source="'$RepositoryUrl'" --allow-self-service --priority=1 | ||
| } | ||
|
|
||
| #Environment base Source configuration |
There was a problem hiding this comment.
Suggested change
| #Environment base Source configuration | |
| # Environment base source configuration |
Comment on lines
+98
to
+124
| Credential = $RepositoryCredential | ||
| ClientSalt = $ClientCommunicationSalt | ||
| ServiceSalt = $ServiceCommunicationSalt | ||
| RepositoryUrl = $RepositoryUrl | ||
| } | ||
|
|
||
| switch ($true) { | ||
| $PSBoundParameters.ContainsKey('AdditionalConfiguration') { | ||
| $params.Add('AdditionalConfiguration', $AdditionalConfiguration) | ||
| } | ||
| $PSBoundParameters.ContainsKey('AdditionalFeatures') { | ||
| $params.add('AdditionalFeatures', $AdditionalFeatures) | ||
| } | ||
|
|
||
| $PSBoundParameters.ContainsKey('AdditionalPackages') { | ||
| $params.Add('AdditionalPackages', $AdditionalPackages) | ||
| } | ||
|
|
||
| $PSBoundParameters.ContainsKey('AdditionalSources') { | ||
| $params.Add('AdditionalSources', $AdditionalSources) | ||
| } | ||
|
|
||
| $PSBoundParameters.ContainsKey('IncludePackageTools') { | ||
| $params.Add('IncludePackageTools', $IncludePackageTools) | ||
| } | ||
| } |
There was a problem hiding this comment.
Instead of all this, given we control the params, is it worth literally just parsing and passing PSBoundParams? I think the only thing that would need changing is FQDN/RepositoryUrl.
Suggested change
| $params = @{ | |
| Credential = $RepositoryCredential | |
| ClientSalt = $ClientCommunicationSalt | |
| ServiceSalt = $ServiceCommunicationSalt | |
| RepositoryUrl = $RepositoryUrl | |
| } | |
| switch ($true) { | |
| $PSBoundParameters.ContainsKey('AdditionalConfiguration') { | |
| $params.Add('AdditionalConfiguration', $AdditionalConfiguration) | |
| } | |
| $PSBoundParameters.ContainsKey('AdditionalFeatures') { | |
| $params.add('AdditionalFeatures', $AdditionalFeatures) | |
| } | |
| $PSBoundParameters.ContainsKey('AdditionalPackages') { | |
| $params.Add('AdditionalPackages', $AdditionalPackages) | |
| } | |
| $PSBoundParameters.ContainsKey('AdditionalSources') { | |
| $params.Add('AdditionalSources', $AdditionalSources) | |
| } | |
| $PSBoundParameters.ContainsKey('IncludePackageTools') { | |
| $params.Add('IncludePackageTools', $IncludePackageTools) | |
| } | |
| } | |
| $params = $PSBoundParameters | |
| foreach ($Parameter in @("FQDN", "TrustCertificate")) { | |
| $null = $params.Remove($Parameter) | |
| } | |
| $params += @{ | |
| RepositoryUrl = $RepositoryUrl | |
| } |
Please note, I've not tested this (and there's probably more properties to nuke), but it seems like there's less code to maintain with this approach.
| $c.Add("--name='$($a.Name)'") | ||
| $c.Add("--source='$($a.Source)'") | ||
|
|
||
| #Add credentials if source has them |
There was a problem hiding this comment.
Suggested change
| #Add credentials if source has them | |
| # Add credentials if source has them |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description Of Changes
Adds parameterization to both
ClientSetup.ps1andRegister-C4bEndpoint.ps1to allow an end user to customize the installation of Chocolatey For Business on an endpoint.Motivation and Context
An opinionated approach is nice, but allowing some level of customization that is easy for the end user is a nice added touch to really improve the overall experience with our tooling.
Testing
Operating Systems Testing
Change Types Made
Change Checklist
Related Issue
Fixes #240