Pass api_key as sensitive value

Author: nielstholenaar

environments/etc/installer-manifests/site.pp

@@ -1,6 +1,6 @@
 node default {
   class { 'datadog_agent':
-    api_key                       => 'somenonnullapikeythats32charlong',
+    api_key                       => Sensitive('somenonnullapikeythats32charlong'),
     manage_install                => false,
     datadog_installer_enabled     => true,
     apm_instrumentation_enabled   => 'host',

environments/etc/manifests/site.pp

@@ -1,6 +1,6 @@
 node default {
   class { 'datadog_agent':
-    api_key             => 'somenonnullapikeythats32charlong',
+    api_key             => Sensitive('somenonnullapikeythats32charlong'),
     agent_extra_options => {
       use_http => true,
     },

manifests/installer_telemetry.pp

@@ -1,11 +1,11 @@
 # This class handles the installation telemetry for the Datadog installer.
 #
-# @param api_key String:Your DataDog API Key.
+# @param api_key Sensitive[String]:Your DataDog API Key.
 # @param datadog_site String: The site of the Datadog intake to send Agent data to. Defaults to 'datadoghq.com'.
 # @param packages_to_install String: The packages to be installed by the Datadog installer.
 #
 class datadog_agent::installer_telemetry (
-  String $api_key = 'your_API_key',
+  Sensitive[String] $api_key = 'your_API_key',
   String $datadog_site = 'datadoghq.com',
   String $packages_to_install = 'datadog-agent',
 ) {

manifests/reports.pp

@@ -4,8 +4,7 @@
 # the datadog service.
 #
 # Parameters:
-#   $api_key:
-#       Your DataDog API Key. Please replace with your key value
+# @param api_key Sensitive[String]:Your DataDog API Key.
 #   $datadog_site:
 #       URL to use to talk to the Datadog API
 #
@@ -16,7 +15,7 @@
 # Sample Usage:
 #
 class datadog_agent::reports (
-  String $api_key,
+  Sensitive[String] $api_key = 'your_API_key',
   String $puppetmaster_user,
   String $dogapi_version,
   Boolean $manage_dogapi_gem = true,

manifests/windows.pp

@@ -7,7 +7,7 @@
   String $agent_version = $datadog_agent::params::agent_version,
   Optional[String] $agent_repo_uri = undef,
   String $msi_location = 'C:/Windows/temp',
-  String $api_key = $datadog_agent::api_key,
+  Sensitive[String] $api_key = $datadog_agent::api_key,
   String $hostname = $datadog_agent::host,
   Array  $tags = $datadog_agent::tags,
   String $tags_join = join($tags,','),

spec/classes/datadog_agent_reports_spec.rb

@@ -8,7 +8,7 @@
   context 'all supported operating systems' do
     let(:params) do
       {
-        api_key: 'notanapikey',
+        api_key: Sensitive('notanapikey'),
         puppetmaster_user: 'puppet',
         dogapi_version: 'installed',
       }
@@ -79,7 +79,7 @@
   context 'specific dogapi version' do
     let(:params) do
       {
-        api_key: 'notanapikey',
+        api_key: Sensitive('notanapikey'),
         puppetmaster_user: 'puppet',
         dogapi_version: '1.2.2',
       }
@@ -131,7 +131,7 @@
   context 'specific gem provider' do
     let(:params) do
       {
-        api_key: 'notanapikey',
+        api_key: Sensitive('notanapikey'),
         puppetmaster_user: 'puppet',
         dogapi_version: '1.2.2',
         puppet_gem_provider: 'gem',
@@ -177,7 +177,7 @@
   context 'EU site in report' do
     let(:params) do
       {
-        api_key: 'notanapikey',
+        api_key: Sensitive('notanapikey'),
         puppetmaster_user: 'puppet',
         dogapi_version: 'installed',
         datadog_site: 'https://api.datadoghq.eu',
@@ -226,7 +226,7 @@
   context 'disabled ruby-manage' do
     let(:params) do
       {
-        api_key: 'notanapikey',
+        api_key: Sensitive('notanapikey'),
         hostname_extraction_regex: nil,
         dogapi_version: 'installed',
         puppetmaster_user: 'puppet',

spec/classes/datadog_agent_spec.rb

@@ -287,7 +287,7 @@
           {
             agent_major_version: 7,
             windows_npm_install: true,
-            api_key: 'notakey',
+            api_key: Sensitive('notakey'),
             host: 'notahost',
           }
         end
@@ -304,7 +304,7 @@
         let(:params) do
           {
             agent_major_version: 7,
-            api_key: 'notakey',
+            api_key: Sensitive('notakey'),
             host: 'notahost',
           }
         end