dsccommunity / SqlServerDsc

This module contains DSC resources for deployment and configuration of Microsoft SQL Server.
MIT License
360 stars 225 forks source link

Install-SqlDscReportingServices: New command proposal #2010

Open johlju opened 6 months ago

johlju commented 6 months ago

Command proposal

The logic that installs Reporting Services in SqlRSSetup should be moved to external command.

Proposed parameters

Parameter Mandatory DataType Description Default Value Allowed Values
IAcceptLicenseTerms Yes String Accept licens terms. This must be set to 'Yes'. None Yes
SourcePath Yes String The path to the installation media file to be used for installation, e.g an UNC path to a shared resource. Environment variables can be used in the path. None
ProductKey No String Sets the custom license key, e.g. '12345-12345-12345-12345-12345'. This parameter is mutually exclusive with the parameter Edition. None
EditionUpgrade No Boolean Upgrades the edition of the installed product. Requires that either the ProductKey or the Edition parameter is also assigned. By default no edition upgrade is performed. None
VersionUpgrade No Boolean Upgrades installed product version if the major product version of the source executable is higher than the currently installed major version. Requires that either the ProductKey or the Edition parameter is also assigned. Default is $false. None
Edition No String Sets the custom free edition. This parameter is mutually exclusive with the parameter ProductKey. None Development, Evaluation, ExpressAdvanced
LogPath No String Specifies the setup log file location, e.g. log.txt. By default log files are created under %TEMP%. None
InstallFolder No String Sets the install folder, e.g. C:\Program Files\SSRS. Default value is C:\Program Files\Microsoft SQL Server Reporting Services. None
Timeout No UInt32 The timeout, in seconds, to wait for the setup process to finish. Default value is 7200 seconds (2 hours). If the setup process does not finish before this time an error will be thrown. None

Special considerations or limitations

This will always install an instance of Microsoft SQL Server Reporting Service with the name SSRS. This can not be changed as per design (see SQL Server Reporting Services docs).

We might need additional commands for installing Power BI Report Server (e.g Install-SqlDscPowerBIReportServer), but would be great if the commands could use same install logic. See Install Power BI Report Server.