Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[develop] Add custom munge key config logic #2451

Merged
merged 6 commits into from
Sep 13, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions cookbooks/aws-parallelcluster-slurm/kitchen.slurm-config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -176,3 +176,19 @@ suites:
cluster:
node_type: ComputeFleet
head_node_private_ip: '127.0.0.1'
- name: config_head_node_munge
run_list:
- recipe[aws-parallelcluster-tests::setup]
- recipe[aws-parallelcluster-slurm::config_head_node]
verifier:
controls:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

controls should be nested under verifier.

- /tag:config_munge/
attributes:
node_type: HeadNode
scheduler: 'slurm'
cluster:
region: 'us-east-2'
config:
DevSettings:
SlurmSettings:
MungeKeySecretArn: 'arn:aws:secretsmanager:us-east-2:249582277112:secret:TestMungeKey-jDtnqi'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This configuration will only work for this specific account and region. Let's sync on how to proceed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

18 changes: 5 additions & 13 deletions cookbooks/aws-parallelcluster-slurm/libraries/helpers.rb
Original file line number Diff line number Diff line change
Expand Up @@ -66,19 +66,11 @@ def enable_munge_service
end

def setup_munge_head_node
# Generate munge key
bash 'generate_munge_key' do
not_if { ::File.exist?('/etc/munge/munge.key') }
user node['cluster']['munge']['user']
group node['cluster']['munge']['group']
cwd '/tmp'
code <<-HEAD_CREATE_MUNGE_KEY
set -e
# Generates munge key in /etc/munge/munge.key
/usr/sbin/mungekey --verbose
# Enforce correct permission on the key
chmod 0600 /etc/munge/munge.key
HEAD_CREATE_MUNGE_KEY
# Generate munge key or get it's value from secrets manager
munge_key_manager 'manage_munge_key' do
munge_key_secret_arn lazy {
node['cluster']['config'].dig(:DevSettings, :SlurmSettings, :MungeKeySecretArn)
}
end

enable_munge_service
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# frozen_string_literal: true

#
# Cookbook:: aws-parallelcluster-slurm
# Recipe:: config_head_node
#
# Copyright:: 2013-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the
# License. A copy of the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "LICENSE.txt" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
# OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions and
# limitations under the License.

resource_name :munge_key_manager
provides :munge_key_manager
unified_mode true

property :munge_key_secret_arn, String

default_action :setup_munge_key

action :setup_munge_key do
if new_resource.munge_key_secret_arn
# This block will fetch the munge key from Secrets Manager
bash 'fetch_and_decode_munge_key' do
user 'root'
group 'root'
cwd '/tmp'
code <<-FETCH_AND_DECODE
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add set -e to avoid script completion if a step fails

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

# Get encoded munge key from secrets manager
encoded_key=$(aws secretsmanager get-secret-value --secret-id #{new_resource.munge_key_secret_arn} --query 'SecretString' --output text --region #{node['cluster']['region']})
# If encoded_key doesn't have a value, error and exit
if [ -z "$encoded_key" ]; then
echo "Error fetching munge key from Secrets Manager or the key is empty"
exit 1
fi

# Decode munge key and write to /etc/munge/munge.key
decoded_key=$(echo $encoded_key | base64 -d)
if [ $? -ne 0 ]; then
echo "Error decoding the munge key with base64"
exit 1
fi

echo "$decoded_key" > /etc/munge/munge.key

# Set ownership on the key
chown #{node['cluster']['munge']['user']}:#{node['cluster']['munge']['group']} /etc/munge/munge.key
# Enforce correct permission on the key
chmod 0600 /etc/munge/munge.key
FETCH_AND_DECODE
end
else
# This block will generate a munge key if it doesn't exist
bash 'generate_munge_key' do
not_if { ::File.exist?('/etc/munge/munge.key') }
user node['cluster']['munge']['user']
group node['cluster']['munge']['group']
cwd '/tmp'
code <<-GENERATE_KEY
set -e
/usr/sbin/mungekey --verbose
chmod 0600 /etc/munge/munge.key
GENERATE_KEY
end
end
end
28 changes: 28 additions & 0 deletions cookbooks/aws-parallelcluster-slurm/test/controls/munge_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,31 @@
it { should be_running }
end
end

control 'tag:config_munge_check_munge_key_exists' do
title 'Check if the munge key exists'

describe file('/etc/munge/munge.key') do
it { should exist }
its('mode') { should cmp '0600' }
its('owner') { should eq node['cluster']['munge']['user'] }
its('group') { should eq node['cluster']['munge']['group'] }
end
end unless os_properties.redhat_on_docker?

control 'tag:config_munge_check_munge_key_content' do
title 'Check if the munge key content is not empty'

describe file('/etc/munge/munge.key') do
its('content') { should_not be_empty }
end
end unless os_properties.redhat_on_docker?

control 'tag:config_munge_check_munge_key_error_messages' do
title 'Check for error messages related to munge key'

describe file('/var/log/chef-client.log') do
its('content') { should_not match /Error fetching munge key/ }
its('content') { should_not match /Error decoding the munge key/ }
end
end unless os_properties.redhat_on_docker?