From 0c8c3ee135563ca1ede517a8016f1035c2db4330 Mon Sep 17 00:00:00 2001 From: Gavin Patton Date: Tue, 13 Dec 2022 16:19:26 +0000 Subject: [PATCH] (CONT-370) Reinstate lost sqlserver documentation on feature & tool deprecations Prior to this commit, using puppetlabs-sqlserver with deprecated features/tools would raise a deprecation warning messages in puppet agent runs, although the documentation says the deprecated variable is valid. This is due to a mistake in a puppet-strings run which excluded part of the documentation regarding this issue. This commit reinstate this documentation to avoid future confusion. --- lib/puppet/type/sqlserver_features.rb | 6 ++++-- lib/puppet/type/sqlserver_instance.rb | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/lib/puppet/type/sqlserver_features.rb b/lib/puppet/type/sqlserver_features.rb index 080c71d4..3e26967d 100644 --- a/lib/puppet/type/sqlserver_features.rb +++ b/lib/puppet/type/sqlserver_features.rb @@ -35,8 +35,10 @@ end newproperty(:features, array_matching: :all) do - desc 'Specifies features to install, uninstall, or upgrade. The list of top-level features include - BC, Conn, SSMS, ADV_SSMS, SDK, IS and MDS.' + desc "Specifies features to install, uninstall, or upgrade. The list of top-level features include + BC, Conn, SSMS, ADV_SSMS, SDK, IS and MDS. + + The 'Tools' feature is deprecated. Instead specify 'BC', 'SSMS', 'ADV_SSMS', 'Conn', and 'SDK' explicitly." newvalues(:Tools, :BC, :Conn, :SSMS, :ADV_SSMS, :SDK, :IS, :MDS, :BOL, :DREPLAY_CTLR, :DREPLAY_CLT, :DQC) munge do |value| if PuppetX::Sqlserver::ServerHelper.is_super_feature(value) diff --git a/lib/puppet/type/sqlserver_instance.rb b/lib/puppet/type/sqlserver_instance.rb index 9c2510bc..fa633e7c 100644 --- a/lib/puppet/type/sqlserver_instance.rb +++ b/lib/puppet/type/sqlserver_instance.rb @@ -25,8 +25,10 @@ end newproperty(:features, array_matching: :all) do - desc 'Specifies features to install, uninstall, or upgrade. The list of top-level features include - SQLEngine, Replication, FullText, DQ AS, and RS.' + desc "Specifies features to install, uninstall, or upgrade. The list of top-level features include + SQLEngine, Replication, FullText, DQ AS, and RS. + + The 'SQL' feature is deprecated. Instead specify 'DQ', 'FullText', 'Replication', and 'SQLEngine' explicitly." newvalues(:SQL, :SQLEngine, :Replication, :FullText, :DQ, :AS, :RS, :POLYBASE, :ADVANCEDANALYTICS) munge do |value| if PuppetX::Sqlserver::ServerHelper.is_super_feature(value)