DSCResources/ARCADE_GraylogSidecar/ARCADE_GraylogSidecar.psm1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
<#
    .SYNOPSIS
        Get the current Graylog Sidecar installation status.
 
    .PARAMETER IsSingleInstance
        Specifies the resource is a single instance, the value must be 'Yes'.
 
    .PARAMETER SetupPath
        Path to the setup file.
 
    .PARAMETER ServerUrl
        Target Graylog server url.
 
    .PARAMETER ServerApiToken
        Target Graylog API token.
#>

function Get-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Collections.Hashtable])]
    param
    (
        [Parameter(Mandatory = $true)]
        [ValidateSet('Yes')]
        [System.String]
        $IsSingleInstance,

        [Parameter(Mandatory = $true)]
        [System.String]
        $SetupPath,

        [Parameter(Mandatory = $true)]
        [System.String]
        $ServerUrl,

        [Parameter(Mandatory = $true)]
        [System.String]
        $ServerApiToken
    )

    Write-Verbose 'Get Graylog Sidecar resource'

    $setupProperties = Get-ItemProperty -Path $SetupPath -ErrorAction Stop

    # Get the versions of the setup file and the installed components. This is
    # required to detect, if the Sidecar must be updated.
    $setupVersion = $setupProperties.VersionInfo.ProductVersion
    $version      = Get-GraylogSidecarVersion

    # Get the sidecar configuration
    $config = Get-GraylogSidecarConfigFile

    # Set ensure to present if the Sidecar is installed, even if the version
    # does not match.
    $ensure = 'Present'
    if ([System.String]::IsNullOrEmpty($version))
    {
        $ensure = 'Absent'
    }

    $returnValue = @{
        IsSingleInstance       = $IsSingleInstance
        Ensure                 = $ensure
        SetupPath              = $SetupPath
        SetupVersion           = $setupVersion
        Version                = $version
        ServerUrl              = $config.ServerUrl
        ServerApiToken         = $config.ServerApiToken
        NodeName               = $config.NodeName
    }

    return $returnValue
}

<#
    .SYNOPSIS
        Install or uninstall Graylog Sidecar.
 
    .PARAMETER IsSingleInstance
        Specifies the resource is a single instance, the value must be 'Yes'.
 
    .PARAMETER Ensure
        Specified if the client should be added or removed.
 
    .PARAMETER SetupPath
        Path to the setup file.
 
    .PARAMETER ServerUrl
        Target Graylog server url.
 
    .PARAMETER ServerApiToken
        Target Graylog API token.
 
    .PARAMETER NodeName
        The sidecar node name to identify the installation. Matches the hostname
        by default.
#>

function Set-TargetResource
{
    [CmdletBinding(SupportsShouldProcess = $true)]
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSShouldProcess', '')]
    param
    (
        [Parameter(Mandatory = $true)]
        [ValidateSet('Yes')]
        [System.String]
        $IsSingleInstance,

        [Parameter(Mandatory = $false)]
        [ValidateSet('Present', 'Absent')]
        [System.String]
        $Ensure = 'Present',

        [Parameter(Mandatory = $true)]
        [System.String]
        $SetupPath,

        [Parameter(Mandatory = $true)]
        [System.String]
        $ServerUrl,

        [Parameter(Mandatory = $true)]
        [System.String]
        $ServerApiToken,

        [Parameter(Mandatory = $false)]
        [System.String]
        $NodeName = $Env:ComputerName.ToLower()
    )

    Write-Verbose 'Set Graylog Sidecar resource'

    $getTargetResourceSplat = @{
        IsSingleInstance = $IsSingleInstance
        SetupPath        = $SetupPath
        ServerUrl        = $ServerUrl
        ServerApiToken   = $ServerApiToken
    }

    $currentState = Get-TargetResource @getTargetResourceSplat

    # Uninstall the application if it's not needed anymore
    if ($Ensure -eq 'Absent' -and $currentState.Ensure -eq 'Present')
    {
        Uninstall-GraylogSidecar

        # Update the state after the removal
        $currentState = Get-TargetResource @getTargetResourceSplat
    }

    # Install the application, if it's not presend or needs an update
    if ($Ensure -eq 'Present' -and ($currentState.Ensure -eq 'Absent' -or $currentState.SetupVersion -ne $currentState.Version))
    {
        Install-GraylogSidecar -SetupPath $SetupPath -ServerUrl $ServerUrl -ServerApiToken $ServerApiToken

        # Update the state after the installation
        $currentState = Get-TargetResource @getTargetResourceSplat
    }

    # Update the configuration, if it does not match
    if ($Ensure -eq 'Present' -and $currentState.NodeName -ne $NodeName)
    {
        Set-GraylogSidecarConfigFile -NodeName $NodeName
    }

    # Update the configuration, if it does not match
    if ($Ensure -eq 'Present' -and $currentState.ServerUrl -ne $ServerUrl)
    {
        Set-GraylogSidecarConfigFile -ServerUrl $ServerUrl
    }

    # Update the configuration, if it does not match
    if ($Ensure -eq 'Present' -and $currentState.ServerApiToken -ne $ServerApiToken)
    {
        Set-GraylogSidecarConfigFile -ServerApiToken $ServerApiToken
    }

    # Wait 10 seconds to give the Graylog Sidecar the chance to register itself
    # on the graylog server, so that at the end of the configuration, the
    # sidecar is already available on the Graylog server and ready to be
    # configured e.g. by the GraylogSidecarConfiguration resource.
    Start-Sleep -Seconds 10
}

<#
    .SYNOPSIS
        Install or uninstall Graylog Sidecar.
 
    .PARAMETER IsSingleInstance
        Specifies the resource is a single instance, the value must be 'Yes'.
 
    .PARAMETER Ensure
        Specified if the client should be added or removed.
 
    .PARAMETER SetupPath
        Path to the setup file.
 
    .PARAMETER ServerUrl
        Target Graylog server url.
 
    .PARAMETER ServerApiToken
        Target Graylog API token.
 
    .PARAMETER NodeName
        The sidecar node name to identify the installation. Matches the hostname
        by default.
#>

function Test-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [Parameter(Mandatory = $true)]
        [ValidateSet('Yes')]
        [System.String]
        $IsSingleInstance,

        [Parameter(Mandatory = $false)]
        [ValidateSet('Present', 'Absent')]
        [System.String]
        $Ensure = 'Present',

        [Parameter(Mandatory = $true)]
        [System.String]
        $SetupPath,

        [Parameter(Mandatory = $true)]
        [System.String]
        $ServerUrl,

        [Parameter(Mandatory = $true)]
        [System.String]
        $ServerApiToken,

        [Parameter(Mandatory = $false)]
        [System.String]
        $NodeName = $Env:ComputerName.ToLower()
    )

    Write-Verbose 'Test Graylog Sidecar resource'

    $currentState = Get-TargetResource -IsSingleInstance $IsSingleInstance -SetupPath $SetupPath -ServerUrl $ServerUrl -ServerApiToken $ServerApiToken

    if ($Ensure -eq 'Present')
    {
        return $currentState.Ensure -eq $Ensure -and
               $currentState.SetupVersion -eq $currentState.Version -and
               $currentState.ServerUrl -eq $ServerUrl -and
               $currentState.ServerApiToken -eq $ServerApiToken -and
               $currentState.NodeName -eq $NodeName
    }

    if ($Ensure -eq 'Absent')
    {
        return $currentState.Ensure -eq $Ensure
    }
}