puppet: fix splunk-otel-js installation (#4765)

Author: jeffreyc-splunk

deployments/puppet/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## puppet-v0.15.0
+
+- Fix installation of `splunk-otel-js` for Node.js auto instrumentation.
+
 ## puppet-v0.14.0
 
 - For Splunk Otel Collector version `0.97.0` or greater, `GOMEMLIMIT` env var is introduced. The default is set to 90% of the `SPLUNK_TOTAL_MEM_MIB`. For more information regarding the usage, please follow the instructions ([here](https://github.com/signalfx/splunk-otel-collector?tab=readme-ov-file#from-0961-to-0970)).

deployments/puppet/README.md

@@ -373,6 +373,7 @@
     $zeroconfig_java_config_path = '/etc/splunk/zeroconfig/java.conf'
     $zeroconfig_node_config_path = '/etc/splunk/zeroconfig/node.conf'
     $zeroconfig_systemd_config_path = '/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf'
+    $with_new_instrumentation = $auto_instrumentation_version == 'latest' or versioncmp($auto_instrumentation_version, '0.87.0') >= 0
 
     if $::osfamily == 'debian' {
       package { $auto_instrumentation_package_name:
@@ -388,13 +389,33 @@
       fail("Splunk OpenTelemetry Auto Instrumentation is not supported for your OS family (${::osfamily})")
     }
 
+    if 'nodejs' in $with_auto_instrumentation_sdks and $with_new_instrumentation {
+      $splunk_otel_js_path = '/usr/lib/splunk-instrumentation/splunk-otel-js.tgz'
+      $splunk_otel_js_prefix = '/usr/lib/splunk-instrumentation/splunk-otel-js'
+
+      file { [$splunk_otel_js_prefix, "${$splunk_otel_js_prefix}/node_modules"]:
+        ensure  => 'directory',
+        require => Package[$auto_instrumentation_package_name],
+      }
+      -> exec { 'Install splunk-otel-js':
+        command  => "${$auto_instrumentation_npm_path} install ${$splunk_otel_js_path}",
+        provider => shell,
+        cwd      => $splunk_otel_js_prefix,
+        require  => Package[$auto_instrumentation_package_name],
+      }
+    }
+
     file { $ld_so_preload_path:
       ensure  => file,
       content => template('splunk_otel_collector/ld.so.preload.erb'),
       require => Package[$auto_instrumentation_package_name],
     }
 
     if $auto_instrumentation_systemd {
+      file { [$zeroconfig_java_config_path, $zeroconfig_node_config_path]:
+        ensure  => absent,
+        require => Package[$auto_instrumentation_package_name],
+      }
       file { ['/usr/lib/systemd', '/usr/lib/systemd/system.conf.d']:
         ensure => directory,
       }
@@ -408,7 +429,7 @@
       file { $zeroconfig_systemd_config_path:
         ensure => absent,
       }
-      if $auto_instrumentation_version == 'latest' or versioncmp($auto_instrumentation_version, '0.87.0') >= 0 {
+      if $with_new_instrumentation {
         if 'java' in $with_auto_instrumentation_sdks {
           file { $zeroconfig_java_config_path:
             ensure  => file,
@@ -417,21 +438,10 @@
           }
         }
         if 'nodejs' in $with_auto_instrumentation_sdks {
-          $splunk_otel_js_path = '/usr/lib/splunk-instrumentation/splunk-otel-js.tgz'
-          $splunk_otel_js_prefix = '/usr/lib/splunk-instrumentation/splunk-otel-js'
-
-          file { "${$splunk_otel_js_prefix}/node_modules":
-            ensure => 'directory',
-          }
-          exec { 'Install splunk-otel-js':
-            command  => "${$auto_instrumentation_npm_path} install ${$splunk_otel_js_path}",
-            provider => shell,
-            cwd      => $splunk_otel_js_prefix,
-          }
           file { $zeroconfig_node_config_path:
             ensure  => file,
             content => template('splunk_otel_collector/node.conf.erb'),
-            require => Package[$auto_instrumentation_package_name],
+            require => Exec['Install splunk-otel-js'],
           }
         }
       } else {

deployments/puppet/manifests/init.pp

@@ -1,6 +1,6 @@
 {
   "name": "signalfx-splunk_otel_collector",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "author": "Splunk, Inc.",
   "summary": "This module installs the Splunk OpenTelemetry Collector via distro packages and configures it.",
   "license": "Apache-2.0",

deployments/puppet/metadata.json

@@ -9,7 +9,12 @@ RUN wget https://apt.puppetlabs.com/puppet${PUPPET_RELEASE}-release-bullseye.deb
     apt-get update && \
     apt-get install -y puppet-agent
 
-ENV PATH=/opt/puppetlabs/bin:$PATH
+RUN wget -O /tmp/nodejs.tar.gz https://nodejs.org/dist/v16.20.2/node-v16.20.2-linux-x64.tar.gz && \
+    mkdir -p /opt/ && \
+    tar -C /opt/ -xzf /tmp/nodejs.tar.gz && \
+    mv /opt/node* /opt/node
+
+ENV PATH=/opt/puppetlabs/bin:/opt/node/bin:$PATH
 
 ENV container docker
 

internal/buildscripts/packaging/tests/deployments/puppet/images/deb/Dockerfile.debian-bullseye

@@ -9,7 +9,12 @@ RUN wget https://apt.puppetlabs.com/puppet${PUPPET_RELEASE}-release-buster.deb &
     apt-get update && \
     apt-get install -y puppet-agent
 
-ENV PATH=/opt/puppetlabs/bin:$PATH
+RUN wget -O /tmp/nodejs.tar.gz https://nodejs.org/dist/v16.20.2/node-v16.20.2-linux-x64.tar.gz && \
+    mkdir -p /opt/ && \
+    tar -C /opt/ -xzf /tmp/nodejs.tar.gz && \
+    mv /opt/node* /opt/node
+
+ENV PATH=/opt/puppetlabs/bin:/opt/node/bin:$PATH
 
 ENV container docker
 

internal/buildscripts/packaging/tests/deployments/puppet/images/deb/Dockerfile.debian-buster

@@ -12,7 +12,12 @@ RUN wget https://apt.puppetlabs.com/puppet${PUPPET_RELEASE}-release-stretch.deb
     apt-get update && \
     apt-get install -y puppet-agent
 
-ENV PATH=/opt/puppetlabs/bin:$PATH
+RUN wget -O /tmp/nodejs.tar.gz https://nodejs.org/dist/v16.20.2/node-v16.20.2-linux-x64.tar.gz && \
+    mkdir -p /opt/ && \
+    tar -C /opt/ -xzf /tmp/nodejs.tar.gz && \
+    mv /opt/node* /opt/node
+
+ENV PATH=/opt/puppetlabs/bin:/opt/node/bin:$PATH
 
 ENV container docker
 

internal/buildscripts/packaging/tests/deployments/puppet/images/deb/Dockerfile.debian-stretch

@@ -9,7 +9,12 @@ RUN wget https://apt.puppetlabs.com/puppet${PUPPET_RELEASE}-release-bionic.deb &
     apt-get update && \
     apt-get install -y puppet-agent
 
-ENV PATH=/opt/puppetlabs/bin:$PATH
+RUN wget -O /tmp/nodejs.tar.gz https://nodejs.org/dist/v16.20.2/node-v16.20.2-linux-x64.tar.gz && \
+    mkdir -p /opt/ && \
+    tar -C /opt/ -xzf /tmp/nodejs.tar.gz && \
+    mv /opt/node* /opt/node
+
+ENV PATH=/opt/puppetlabs/bin:/opt/node/bin:$PATH
 
 ENV container docker
 

internal/buildscripts/packaging/tests/deployments/puppet/images/deb/Dockerfile.ubuntu-bionic

@@ -9,7 +9,12 @@ RUN wget https://apt.puppetlabs.com/puppet${PUPPET_RELEASE}-release-focal.deb &&
     apt-get update && \
     apt-get install -y puppet-agent
 
-ENV PATH=/opt/puppetlabs/bin:$PATH
+RUN wget -O /tmp/nodejs.tar.gz https://nodejs.org/dist/v16.20.2/node-v16.20.2-linux-x64.tar.gz && \
+    mkdir -p /opt/ && \
+    tar -C /opt/ -xzf /tmp/nodejs.tar.gz && \
+    mv /opt/node* /opt/node
+
+ENV PATH=/opt/puppetlabs/bin:/opt/node/bin:$PATH
 
 ENV container docker
 

internal/buildscripts/packaging/tests/deployments/puppet/images/deb/Dockerfile.ubuntu-focal

@@ -1,18 +1,20 @@
 FROM ubuntu:22.04
 
-# puppetlabs does not currently provide packages for jammy,
-# so install the puppet package provided by ubuntu instead.
-
 RUN apt-get update &&\
-    apt-get install -yq ca-certificates procps systemd wget apt-transport-https libcap2-bin curl gnupg lsb-release puppet
+    apt-get install -yq ca-certificates procps systemd wget apt-transport-https libcap2-bin curl gnupg lsb-release
+
+ARG PUPPET_RELEASE="6"
+RUN wget https://apt.puppetlabs.com/puppet${PUPPET_RELEASE}-release-jammy.deb && \
+    dpkg -i puppet${PUPPET_RELEASE}-release-jammy.deb && \
+    apt-get update && \
+    apt-get install -y puppet-agent
 
-#ARG PUPPET_RELEASE="6"
-#RUN wget https://apt.puppetlabs.com/puppet${PUPPET_RELEASE}-release-jammy.deb && \
-#    dpkg -i puppet${PUPPET_RELEASE}-release-jammy.deb && \
-#    apt-get update && \
-#    apt-get install -y puppet-agent
+RUN wget -O /tmp/nodejs.tar.gz https://nodejs.org/dist/v16.20.2/node-v16.20.2-linux-x64.tar.gz && \
+    mkdir -p /opt/ && \
+    tar -C /opt/ -xzf /tmp/nodejs.tar.gz && \
+    mv /opt/node* /opt/node
 
-#ENV PATH=/opt/puppetlabs/bin:$PATH
+ENV PATH=/opt/puppetlabs/bin:/opt/node/bin:$PATH
 
 ENV container docker
 
@@ -29,7 +31,7 @@ ENV init /lib/systemd/systemd
 RUN puppet module install puppetlabs-stdlib --version 4.24.0
 RUN puppet module install puppetlabs-apt --version 7.0.0
 
-COPY deployments/puppet /etc/puppet/code/environments/production/modules/splunk_otel_collector
+COPY deployments/puppet /etc/puppetlabs/code/environments/production/modules/splunk_otel_collector
 
 VOLUME [ "/sys/fs/cgroup" ]
 

internal/buildscripts/packaging/tests/deployments/puppet/images/deb/Dockerfile.ubuntu-jammy

@@ -9,7 +9,12 @@ RUN wget https://apt.puppetlabs.com/puppet${PUPPET_RELEASE}-release-xenial.deb &
     apt-get update && \
     apt-get install -y puppet-agent
 
-ENV PATH=/opt/puppetlabs/bin:$PATH
+RUN wget -O /tmp/nodejs.tar.gz https://nodejs.org/dist/v16.20.2/node-v16.20.2-linux-x64.tar.gz && \
+    mkdir -p /opt/ && \
+    tar -C /opt/ -xzf /tmp/nodejs.tar.gz && \
+    mv /opt/node* /opt/node
+
+ENV PATH=/opt/puppetlabs/bin:/opt/node/bin:$PATH
 
 ENV container docker
 

internal/buildscripts/packaging/tests/deployments/puppet/images/deb/Dockerfile.ubuntu-xenial

@@ -2,12 +2,17 @@ FROM amazonlinux:2
 
 ENV container docker
 
-RUN yum install -y systemd procps initscripts
+RUN yum install -y systemd procps initscripts wget
 
 ARG PUPPET_RELEASE="6"
 RUN rpm -Uvh https://yum.puppet.com/puppet${PUPPET_RELEASE}-release-el-7.noarch.rpm && \
     yum install -y puppet-agent
 
+RUN wget -O /tmp/nodejs.tar.gz https://nodejs.org/dist/v16.20.2/node-v16.20.2-linux-x64.tar.gz && \
+    mkdir -p /opt/ && \
+    tar -C /opt/ -xzf /tmp/nodejs.tar.gz && \
+    mv /opt/node* /opt/node
+
 RUN (cd /lib/systemd/system/sysinit.target.wants/; for i in *; do [ $i = \
     "systemd-tmpfiles-setup.service" ] || rm -f $i; done); \
     rm -f /lib/systemd/system/multi-user.target.wants/*;\
@@ -19,7 +24,7 @@ RUN (cd /lib/systemd/system/sysinit.target.wants/; for i in *; do [ $i = \
 
 VOLUME [ "/sys/fs/cgroup" ]
 
-ENV PATH=/opt/puppetlabs/bin:$PATH
+ENV PATH=/opt/puppetlabs/bin:/opt/node/bin:$PATH
 
 RUN puppet module install puppetlabs-stdlib --version 4.24.0
 RUN puppet module install puppet-yum --version 4.3.0

internal/buildscripts/packaging/tests/deployments/puppet/images/rpm/Dockerfile.amazonlinux-2

@@ -2,12 +2,17 @@ FROM amazonlinux:2023
 
 ENV container docker
 
-RUN yum install -y systemd procps initscripts
+RUN yum install -y systemd procps initscripts wget
 
 ARG PUPPET_RELEASE="6"
 RUN rpm -Uvh https://yum.puppet.com/puppet${PUPPET_RELEASE}-release-el-9.noarch.rpm && \
     yum install -y puppet-agent
 
+RUN wget -O /tmp/nodejs.tar.gz https://nodejs.org/dist/v16.20.2/node-v16.20.2-linux-x64.tar.gz && \
+    mkdir -p /opt/ && \
+    tar -C /opt/ -xzf /tmp/nodejs.tar.gz && \
+    mv /opt/node* /opt/node
+
 RUN (cd /lib/systemd/system/sysinit.target.wants/; for i in *; do [ $i = \
     "systemd-tmpfiles-setup.service" ] || rm -f $i; done); \
     rm -f /lib/systemd/system/multi-user.target.wants/*;\
@@ -19,7 +24,7 @@ RUN (cd /lib/systemd/system/sysinit.target.wants/; for i in *; do [ $i = \
 
 VOLUME [ "/sys/fs/cgroup" ]
 
-ENV PATH=/opt/puppetlabs/bin:$PATH
+ENV PATH=/opt/puppetlabs/bin:/opt/node/bin:$PATH
 
 RUN puppet module install puppetlabs-stdlib --version 4.24.0
 RUN puppet module install puppet-yum --version 4.3.0

internal/buildscripts/packaging/tests/deployments/puppet/images/rpm/Dockerfile.amazonlinux-2023

@@ -2,12 +2,17 @@ FROM centos:7
 
 ENV container docker
 
-RUN yum install -y systemd procps initscripts deltarpm
+RUN yum install -y systemd procps initscripts deltarpm wget
 
 ARG PUPPET_RELEASE="6"
 RUN rpm -Uvh https://yum.puppet.com/puppet${PUPPET_RELEASE}-release-el-7.noarch.rpm && \
     yum install -y puppet-agent
 
+RUN wget -O /tmp/nodejs.tar.gz https://nodejs.org/dist/v16.20.2/node-v16.20.2-linux-x64.tar.gz && \
+    mkdir -p /opt/ && \
+    tar -C /opt/ -xzf /tmp/nodejs.tar.gz && \
+    mv /opt/node* /opt/node
+
 RUN (cd /lib/systemd/system/sysinit.target.wants/; for i in *; do [ $i = \
     "systemd-tmpfiles-setup.service" ] || rm -f $i; done); \
     rm -f /lib/systemd/system/multi-user.target.wants/*;\
@@ -19,7 +24,7 @@ RUN (cd /lib/systemd/system/sysinit.target.wants/; for i in *; do [ $i = \
 
 VOLUME [ "/sys/fs/cgroup" ]
 
-ENV PATH=/opt/puppetlabs/bin:$PATH
+ENV PATH=/opt/puppetlabs/bin:/opt/node/bin:$PATH
 
 RUN puppet module install puppetlabs-stdlib --version 4.24.0
 RUN puppet module install puppet-yum --version 4.3.0

internal/buildscripts/packaging/tests/deployments/puppet/images/rpm/Dockerfile.centos-7

@@ -3,12 +3,17 @@ FROM quay.io/centos/centos:stream8
 ENV container docker
 
 RUN echo 'fastestmirror=1' >> /etc/yum.conf
-RUN dnf install -y systemd procps initscripts
+RUN dnf install -y systemd procps initscripts wget
 
 ARG PUPPET_RELEASE="6"
 RUN rpm -Uvh https://yum.puppet.com/puppet${PUPPET_RELEASE}-release-el-8.noarch.rpm && \
     dnf install -y puppet-agent
 
+RUN wget -O /tmp/nodejs.tar.gz https://nodejs.org/dist/v16.20.2/node-v16.20.2-linux-x64.tar.gz && \
+    mkdir -p /opt/ && \
+    tar -C /opt/ -xzf /tmp/nodejs.tar.gz && \
+    mv /opt/node* /opt/node
+
 RUN (cd /lib/systemd/system/sysinit.target.wants/; for i in *; do [ $i = \
     "systemd-tmpfiles-setup.service" ] || rm -f $i; done); \
     rm -f /lib/systemd/system/multi-user.target.wants/*;\
@@ -20,7 +25,7 @@ RUN (cd /lib/systemd/system/sysinit.target.wants/; for i in *; do [ $i = \
 
 VOLUME [ "/sys/fs/cgroup" ]
 
-ENV PATH=/opt/puppetlabs/bin:$PATH
+ENV PATH=/opt/puppetlabs/bin:/opt/node/bin:$PATH
 
 RUN puppet module install puppetlabs-stdlib --version 4.24.0
 RUN puppet module install puppet-yum --version 4.3.0

internal/buildscripts/packaging/tests/deployments/puppet/images/rpm/Dockerfile.centos-8

@@ -4,12 +4,17 @@ ENV container docker
 
 RUN rpm --import /etc/pki/rpm-gpg/RPM-GPG-KEY-centosofficial
 RUN echo 'fastestmirror=1' >> /etc/yum.conf
-RUN dnf install -y systemd procps initscripts
+RUN dnf install -y systemd procps initscripts wget
 
 ARG PUPPET_RELEASE="6"
 RUN rpm -Uvh https://yum.puppet.com/puppet${PUPPET_RELEASE}-release-el-9.noarch.rpm && \
     dnf install -y puppet-agent
 
+RUN wget -O /tmp/nodejs.tar.gz https://nodejs.org/dist/v16.20.2/node-v16.20.2-linux-x64.tar.gz && \
+    mkdir -p /opt/ && \
+    tar -C /opt/ -xzf /tmp/nodejs.tar.gz && \
+    mv /opt/node* /opt/node
+
 RUN (cd /lib/systemd/system/sysinit.target.wants/; for i in *; do [ $i = \
     "systemd-tmpfiles-setup.service" ] || rm -f $i; done); \
     rm -f /lib/systemd/system/multi-user.target.wants/*;\
@@ -21,7 +26,7 @@ RUN (cd /lib/systemd/system/sysinit.target.wants/; for i in *; do [ $i = \
 
 VOLUME [ "/sys/fs/cgroup" ]
 
-ENV PATH=/opt/puppetlabs/bin:$PATH
+ENV PATH=/opt/puppetlabs/bin:/opt/node/bin:$PATH
 
 RUN puppet module install puppetlabs-stdlib --version 4.24.0
 RUN puppet module install puppet-yum --version 4.3.0

internal/buildscripts/packaging/tests/deployments/puppet/images/rpm/Dockerfile.centos-9

@@ -15,6 +15,11 @@ RUN rpm -Uvh https://yum.puppet.com/puppet${PUPPET_RELEASE}-release-sles-12.noar
     zypper --gpg-auto-import-keys -n refresh && \
     zypper install -y puppet-agent
 
+RUN wget -O /tmp/nodejs.tar.gz https://nodejs.org/dist/v16.20.2/node-v16.20.2-linux-x64.tar.gz && \
+    mkdir -p /opt/ && \
+    tar -C /opt/ -xzf /tmp/nodejs.tar.gz && \
+    mv /opt/node* /opt/node
+
 RUN (cd /usr/lib/systemd/system/sysinit.target.wants/; for i in *; do [ $i = \
     "systemd-tmpfiles-setup.service" ] || rm -f $i; done); \
     rm -f /usr/lib/systemd/system/multi-user.target.wants/*;\
@@ -26,7 +31,7 @@ RUN (cd /usr/lib/systemd/system/sysinit.target.wants/; for i in *; do [ $i = \
 
 VOLUME [ "/sys/fs/cgroup" ]
 
-ENV PATH=/opt/puppetlabs/bin:$PATH
+ENV PATH=/opt/puppetlabs/bin:/opt/node/bin:$PATH
 
 RUN puppet module install puppetlabs-stdlib --version 4.24.0
 

internal/buildscripts/packaging/tests/deployments/puppet/images/rpm/Dockerfile.opensuse-12

@@ -14,6 +14,11 @@ RUN rpm -Uvh https://yum.puppet.com/puppet${PUPPET_RELEASE}-release-sles-15.noar
     zypper --gpg-auto-import-keys -n refresh && \
     zypper install -y puppet-agent
 
+RUN wget -O /tmp/nodejs.tar.gz https://nodejs.org/dist/v16.20.2/node-v16.20.2-linux-x64.tar.gz && \
+    mkdir -p /opt/ && \
+    tar -C /opt/ -xzf /tmp/nodejs.tar.gz && \
+    mv /opt/node* /opt/node
+
 RUN (cd /usr/lib/systemd/system/sysinit.target.wants/; for i in *; do [ $i = \
     "systemd-tmpfiles-setup.service" ] || rm -f $i; done); \
     rm -f /usr/lib/systemd/system/multi-user.target.wants/*;\
@@ -24,7 +29,7 @@ RUN (cd /usr/lib/systemd/system/sysinit.target.wants/; for i in *; do [ $i = \
 
 VOLUME [ "/sys/fs/cgroup" ]
 
-ENV PATH=/opt/puppetlabs/bin:$PATH
+ENV PATH=/opt/puppetlabs/bin:/opt/node/bin:$PATH
 
 RUN puppet module install puppetlabs-stdlib --version 4.24.0