gsadmin/pulse
1
0
Fork 0
mirror of https://github.com/rcourtman/Pulse.git synced 2026-09-11 14:00:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Align Windows agent onboarding with seamless install flow

Browse Source
This commit is contained in:
rcourtman
2026-05-26 09:29:03 +01:00
parent a0b75792a4
commit c1a4f4579e
11 changed files with 236 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/install.ps1
+79 -5
View File
@@ -20,7 +20,11 @@ param (
[bool]$Uninstall = $false,
[string]$CACertPath = $env:PULSE_CACERT,
[string]$AgentId = $env:PULSE_AGENT_ID,
[string]$Hostname = $env:PULSE_HOSTNAME
[string]$Hostname = $env:PULSE_HOSTNAME,
[string]$TokenFile = $env:PULSE_TOKEN_FILE,
[bool]$PreflightOnly = $false,
[string]$Output = $env:PULSE_OUTPUT,
[bool]$NonInteractive = $false
)
$ErrorActionPreference = "Stop"
@@ -85,6 +89,12 @@ if (-not $PSBoundParameters.ContainsKey('Insecure') -and -not [string]::IsNullOr
if (-not $PSBoundParameters.ContainsKey('Uninstall') -and -not [string]::IsNullOrWhiteSpace($env:PULSE_UNINSTALL)) {
$Uninstall = Parse-Bool $env:PULSE_UNINSTALL $Uninstall
}
if (-not $PSBoundParameters.ContainsKey('PreflightOnly') -and -not [string]::IsNullOrWhiteSpace($env:PULSE_PREFLIGHT_ONLY)) {
$PreflightOnly = Parse-Bool $env:PULSE_PREFLIGHT_ONLY $PreflightOnly
}
if (-not $PSBoundParameters.ContainsKey('NonInteractive') -and -not [string]::IsNullOrWhiteSpace($env:PULSE_NON_INTERACTIVE)) {
$NonInteractive = Parse-Bool $env:PULSE_NON_INTERACTIVE $NonInteractive
}
# Docker-only installs should not silently fall back to host metrics unless the
# caller explicitly opts back in.
@@ -94,7 +104,7 @@ if ($EnableDocker -and -not $PSBoundParameters.ContainsKey('EnableHost') -and [s
# --- Administrator Check ---
$isAdmin = ([Security.Principal.WindowsPrincipal] [Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator)
if (-not $isAdmin) {
if (-not $isAdmin -and -not $PreflightOnly) {
Write-Host "ERROR: This script must be run as Administrator" -ForegroundColor Red
Write-Host "Right-click PowerShell and select 'Run as Administrator'" -ForegroundColor Yellow
Exit 1
@@ -126,6 +136,22 @@ function Show-Error {
}
}
function Write-InstallerEvent {
param(
[string]$Phase,
[string]$Code,
[string]$Message,
[int]$ExitCode = 0
)
if ($Output -eq "json") {
@{ phase = $Phase; code = $Code; message = $Message; exitCode = $ExitCode } | ConvertTo-Json -Compress
return
}
Write-Host $Message
}
function Test-ValidUrl {
param([string]$TestUrl)
if ([string]::IsNullOrWhiteSpace($TestUrl)) { return $false }
@@ -515,6 +541,20 @@ if ($Uninstall) {
Exit 0
}
if ([string]::IsNullOrWhiteSpace($Token) -and -not [string]::IsNullOrWhiteSpace($TokenFile)) {
try {
$resolvedTokenFile = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($TokenFile)
if (-not (Test-Path $resolvedTokenFile)) {
Show-Error "Invalid token file. File does not exist.`nProvided: $TokenFile"
Exit 1
}
$Token = (Get-Content -Path $resolvedTokenFile -Raw -ErrorAction Stop).Trim()
} catch {
Show-Error "Failed to read token file.`nProvided: $TokenFile`nError: $_"
Exit 1
}
}
# --- Input Validation ---
Write-Host "Validating parameters..." -ForegroundColor Cyan
@@ -559,6 +599,10 @@ if (-not [string]::IsNullOrWhiteSpace($NormalizedProxmoxType) -and $NormalizedPr
# Normalize URL (remove trailing slash)
$Url = $Url.TrimEnd('/')
if ($Url.ToLowerInvariant().StartsWith("http://") -and -not $Insecure) {
Write-Host "Plain HTTP Pulse URL detected; enabling insecure mode for persisted agent update checks." -ForegroundColor Yellow
$Insecure = $true
}
# --- Download ---
# Determine architecture
@@ -573,6 +617,34 @@ if ($processorArch -eq "ARM64" -or $processorArch64 -eq "ARM64") {
}
$ArchParam = "windows-$Arch"
$DownloadUrl = "$Url/download/pulse-agent?arch=$ArchParam"
function Invoke-AgentDownloadPreflight {
param([string]$Uri)
try {
$preflightResponse = $null
Invoke-WithOptionalInsecureTls -AllowInsecure $Insecure -CustomCaCertificate $CustomCaCertificate -Action {
$preflightResponse = Invoke-WebRequest -Uri $Uri -Method Head -UseBasicParsing -TimeoutSec 10 -ErrorAction Stop
}
$checksum = $preflightResponse.Headers["X-Checksum-Sha256"]
if ([string]::IsNullOrWhiteSpace($checksum)) {
Write-InstallerEvent -Phase "preflight" -Code "agent_download_checksum_missing" -Message "Agent download exists but did not include a checksum header: $Uri" -ExitCode 12
Exit 12
}
Write-InstallerEvent -Phase "preflight" -Code "agent_download_available" -Message "Agent download is available for $ArchParam." -ExitCode 0
} catch {
Write-InstallerEvent -Phase "preflight" -Code "agent_download_unavailable" -Message "Agent download is not available for $ArchParam at $Uri. $_" -ExitCode 11
Exit 11
}
}
if ($PreflightOnly) {
Invoke-AgentDownloadPreflight $DownloadUrl
return
}
Write-Host "Downloading agent from $DownloadUrl..." -ForegroundColor Cyan
if (-not (Test-Path $InstallDir)) {
@@ -613,9 +685,11 @@ try {
} catch {
Cleanup
Show-Error "Failed to download agent: $_"
Write-Host ""
Write-Host "Press Enter to exit..." -ForegroundColor Yellow
Read-Host
if (-not $NonInteractive) {
Write-Host ""
Write-Host "Press Enter to exit..." -ForegroundColor Yellow
Read-Host
}
Exit 1
} finally {
if ($webClient) { $webClient.Dispose() }
scripts/installtests/install_ps1_test.go
+35
View File
@@ -54,7 +54,10 @@ func TestInstallPS1AllowsMissingTokenForOptionalAuth(t *testing.T) {
script := string(content)
required := []string{
`[string]$TokenFile = $env:PULSE_TOKEN_FILE,`,
`if (-not [string]::IsNullOrWhiteSpace($Token) -and -not (Test-ValidToken $Token)) {`,
`if ([string]::IsNullOrWhiteSpace($Token) -and -not [string]::IsNullOrWhiteSpace($TokenFile)) {`,
`$Token = (Get-Content -Path $resolvedTokenFile -Raw -ErrorAction Stop).Trim()`,
`function Write-RuntimeTokenFile {`,
`if (-not [string]::IsNullOrWhiteSpace($Token)) { $ServiceArgs += @("--token-file", "` + "`" + `"$TokenFilePath` + "`" + `"") }`,
}
@@ -142,6 +145,8 @@ func TestInstallPS1UsesInsecureTlsForRuntimeTransport(t *testing.T) {
`if ($AllowInsecure -or $null -ne $CustomCaCertificate) {`,
`if ($AllowInsecure) {`,
`return Test-CertificateTrustedByCustomCa -Certificate $certificate -CustomCaCertificate $CustomCaCertificate`,
`if ($Url.ToLowerInvariant().StartsWith("http://") -and -not $Insecure) {`,
`Plain HTTP Pulse URL detected; enabling insecure mode for persisted agent update checks.`,
`Invoke-WithOptionalInsecureTls -AllowInsecure $Insecure -CustomCaCertificate $CustomCaCertificate -Action {`,
`Invoke-RestMethod @invokeArgs | Out-Null`,
`$downloadTask = $webClient.DownloadFileTaskAsync($DownloadUrl, $TempPath)`,
@@ -153,6 +158,36 @@ func TestInstallPS1UsesInsecureTlsForRuntimeTransport(t *testing.T) {
}
}
func TestInstallPS1SupportsDownloadPreflightBeforeAdministratorInstall(t *testing.T) {
content, err := os.ReadFile(repoFile("scripts", "install.ps1"))
if err != nil {
t.Fatalf("read install.ps1: %v", err)
}
script := string(content)
required := []string{
`[bool]$PreflightOnly = $false,`,
`[string]$Output = $env:PULSE_OUTPUT,`,
`[bool]$NonInteractive = $false`,
`if (-not $isAdmin -and -not $PreflightOnly) {`,
`function Write-InstallerEvent {`,
`function Invoke-AgentDownloadPreflight {`,
`Invoke-WebRequest -Uri $Uri -Method Head -UseBasicParsing -TimeoutSec 10 -ErrorAction Stop`,
`$checksum = $preflightResponse.Headers["X-Checksum-Sha256"]`,
`agent_download_checksum_missing`,
`agent_download_available`,
`agent_download_unavailable`,
`if ($PreflightOnly) {`,
`Invoke-AgentDownloadPreflight $DownloadUrl`,
`if (-not $NonInteractive) {`,
}
for _, needle := range required {
if !strings.Contains(script, needle) {
t.Fatalf("install.ps1 missing download preflight handling: %s", needle)
}
}
}
func TestInstallPS1ReadsAgentIdentityFromEnvironment(t *testing.T) {
content, err := os.ReadFile(repoFile("scripts", "install.ps1"))
if err != nil {
scripts/release_control/subsystem_lookup_test.py
+1 -1
View File
@@ -3529,7 +3529,7 @@ class SubsystemLookupTest(unittest.TestCase):
{
"heading": "## Shared Boundaries",
"path": "internal/api/access_control_handlers.go",
"line": 268,
"line": 274,
"heading_line": 112,
}
],