[Release-3.14.1] Add chef attribute to optionally skip the installation of dcv (#3076)

* Add chef attribute `['cluster']['dcv']['install_enabled']` to optionally skip the installation of dcv

Author: hehe7318

cookbooks/aws-parallelcluster-platform/attributes/platform.rb

@@ -30,6 +30,7 @@
 default['cluster']['nvidia']['nvlsm']['enabled'] = true
 
 # DCV
+default['cluster']['dcv']['install_enabled'] = true
 default['cluster']['dcv']['authenticator']['user'] = "dcvextauth"
 default['cluster']['dcv']['authenticator']['user_id'] = node['cluster']['reserved_base_uid'] + 3
 default['cluster']['dcv']['authenticator']['group'] = node['cluster']['dcv']['authenticator']['user']

cookbooks/aws-parallelcluster-platform/resources/dcv/partial/_dcv_common.rb

@@ -100,6 +100,10 @@ def optionally_disable_rnd
 end
 
 action :setup do
+  unless node['cluster']['dcv']['install_enabled']
+    Chef::Log.warn("Skipping DCV installation because node['cluster']['dcv']['install_enabled'] is set to false")
+    return
+  end
   return if dcv_installed?
   return if redhat_on_docker?
 

cookbooks/aws-parallelcluster-platform/spec/unit/resources/dcv_spec.rb

@@ -657,6 +657,39 @@ def self.nothing(chef_run)
         end
       end
 
+      context "when install_enabled is false" do
+        cached(:chef_run) do
+          runner = runner(platform: platform, version: version, step_into: ['dcv']) do |node|
+            node_setup.call(node)
+            node.override['cluster']['dcv']['install_enabled'] = false
+          end
+          stubs_for_resource('dcv') do |res|
+            allow(res).to receive(:dcv_sha256sum).and_return(checksum)
+            allow(res).to receive(:dcv_supported?).and_return(true)
+            allow(res).to receive(:prereq_packages).and_return(alinux_prereq_packages) if platform == 'amazon'
+            allow(res).to receive(:dcv_package).and_return(dcv_package)
+            allow(res).to receive(:dcv_server).and_return(dcv_server)
+            allow(res).to receive(:xdcv).and_return(xdcv)
+            allow(res).to receive(:dcv_web_viewer).and_return(dcv_web_viewer)
+            allow(res).to receive(:dcv_url_arch).and_return(dcv_url_arch)
+            allow(res).to receive(:dcv_pkg_arch).and_return(dcv_pkg_arch)
+            allow(res).to receive(:dcv_url).and_return(dcv_url)
+            allow(res).to receive(:dcv_tarball).and_return(dcv_tarball)
+            allow(res).to receive(:dcvauth_virtualenv).and_return(dcvauth_virtualenv)
+            allow(res).to receive(:dcvauth_virtualenv_path).and_return(dcvauth_virtualenv_path)
+          end
+          method_setup.call
+          ConvergeDcv.setup(runner)
+        end
+
+        it 'does not install dcv when install_enabled is false' do
+          is_expected.not_to create_if_missing_cookbook_file("#{scripts_dir}/pcluster_dcv_connect.sh")
+          is_expected.not_to create_group(authenticator_group)
+          is_expected.not_to create_user(authenticator_user)
+          is_expected.not_to run_execute('set default systemd runlevel to multi-user.target')
+        end
+      end
+
       context "when not official ami build" do
         cached(:chef_run) do
           runner = runner(platform: platform, version: version, step_into: ['dcv']) do |node|

cookbooks/aws-parallelcluster-platform/test/controls/dcv_spec.rb

@@ -11,7 +11,7 @@
 
 control 'tag:install_dcv_connect_script_installed' do
   title 'Check pcluster dcv connect script is installed'
-  only_if { !os_properties.redhat_on_docker? }
+  only_if { instance.dcv_install_enabled? && !os_properties.redhat_on_docker? }
 
   describe file("#{node['cluster']['scripts_dir']}/pcluster_dcv_connect.sh") do
     it { should be_file }
@@ -23,7 +23,7 @@
 
 control 'tag:install_dcv_authenticator_user_and_group_set_up' do
   title 'Check that dcv authenticator user and group have been set up'
-  only_if { !os_properties.redhat_on_docker? && !(os_properties.ubuntu? && os_properties.arm?) && !os_properties.alinux2023? }
+  only_if { instance.dcv_install_enabled? && !os_properties.redhat_on_docker? && !(os_properties.ubuntu? && os_properties.arm?) && !os_properties.alinux2023? }
 
   describe group(node['cluster']['dcv']['authenticator']['group']) do
     it { should exist }
@@ -39,7 +39,7 @@
 
 control 'tag:install_dcv_disabled_lock_screen' do
   title 'Check that the lock screen has been disabled'
-  only_if { !os_properties.redhat_on_docker? && !(os_properties.ubuntu? && os_properties.arm?) && !os_properties.alinux2023? }
+  only_if { instance.dcv_install_enabled? && !os_properties.redhat_on_docker? && !(os_properties.ubuntu? && os_properties.arm?) && !os_properties.alinux2023? }
 
   describe bash('gsettings get org.gnome.desktop.lockdown disable-lock-screen') do
     its('exit_status') { should eq 0 }
@@ -54,7 +54,7 @@
 
 control 'tag:install_dcv_installed' do
   title 'Check dcv is installed'
-  only_if { !os_properties.redhat_on_docker? && !(os_properties.ubuntu? && os_properties.arm?) && !os_properties.alinux2023? }
+  only_if { instance.dcv_install_enabled? && !os_properties.redhat_on_docker? && !(os_properties.ubuntu? && os_properties.arm?) && !os_properties.alinux2023? }
 
   pkgs = %W(nice-dcv-server nice-xdcv nice-dcv-web-viewer)
   pkgs.each do |pkg|
@@ -66,7 +66,7 @@
 
 control 'tag:install_dcv_external_authenticator_virtualenv_created' do
   title 'Check dcv external authenticator virtual environment is created'
-  only_if { !os_properties.redhat_on_docker? && !(os_properties.ubuntu? && os_properties.arm?) && !os_properties.alinux2023? }
+  only_if { instance.dcv_install_enabled? && !os_properties.redhat_on_docker? && !(os_properties.ubuntu? && os_properties.arm?) && !os_properties.alinux2023? }
 
   describe file("#{node['cluster']['dcv']['authenticator']['virtualenv_path']}/bin/activate") do
     it { should be_file }
@@ -76,7 +76,7 @@
 
 control 'tag:install_dcv_debian_specific_setup' do
   title 'Check debian specific setup'
-  only_if { os_properties.debian_family? && !(os_properties.ubuntu? && os_properties.arm?) && !os_properties.alinux2023? }
+  only_if { instance.dcv_install_enabled? && os_properties.debian_family? && !(os_properties.ubuntu? && os_properties.arm?) && !os_properties.alinux2023? }
 
   pkgs = %W(whoopsie ubuntu-desktop mesa-utils)
   pkgs.each do |pkg|
@@ -97,7 +97,7 @@
 
 control 'tag:install_dcv_rhel_and_centos_specific_setup' do
   title 'Check rhel and centos specific setup'
-  only_if { !os_properties.on_docker? }
+  only_if { instance.dcv_install_enabled? && !os_properties.on_docker? }
   only_if { !os_properties.alinux2023? }
   only_if { os_properties.centos? || os_properties.redhat? }
 
@@ -136,7 +136,7 @@
 control 'tag:install_dcv_alinux2_specific_setup' do
   title 'Check alinux2 specific setup'
 
-  only_if { os_properties.alinux2? }
+  only_if { instance.dcv_install_enabled? && os_properties.alinux2? }
 
   prereq_packages = %w(gdm gnome-session gnome-classic-session gnome-session-xsession
                        xorg-x11-server-Xorg xorg-x11-fonts-Type1 xorg-x11-drivers
@@ -160,7 +160,7 @@
 
 control 'tag:install_dcv_switch_runlevel_to_multiuser_target' do
   title 'Check that runlevel is switched to multi-user.target'
-  only_if { !os_properties.on_docker? }
+  only_if { instance.dcv_install_enabled? && !os_properties.on_docker? }
   only_if { !os_properties.alinux2023? }
 
   describe bash('systemctl get-default') do

cookbooks/aws-parallelcluster-shared/test/libraries/instance.rb

@@ -39,6 +39,10 @@ def dcv_installed?
     inspec.file("/etc/dcv/dcv.conf").exist?
   end
 
+  def dcv_install_enabled?
+    inspec.node['cluster']['dcv']['install_enabled'] != false
+  end
+
   def imds_token
     @imds_token = inspec.http('http://169.254.169.254/latest/api/token', method: 'PUT', headers: {
       "X-aws-ec2-metadata-token-ttl-seconds": 900,