Add configurable working directory #1231

cartermckinnon · 2023-03-24T23:01:46Z

Issue #, if available:

Description of changes:

This aims to address issues brought up in #1230 and #1198.

The underlying issue is the base working directory used throughout the AMI template (/tmp) may not be suitable for all use cases. Resources are staged in this directory (/tmp/worker) before being moved into their final position (such as the contents of files/) and this directory is also used to stash the AWS CLI installer, among other things.

After this change:

remote_folder can still be used to control the location of Packer scripts on the builder instance.
working_dir will default to a sub-directory of remote_folder, and can be adjusted as needed. All provisioners that create files on the builder instance will do so within this directory. This directory is deleted at the end of the build.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Testing Done

Defaults succeed:

make 1.25

Different remote_folder succeeds:

make 1.25 remote_folder=/home/ec2-user
# working_dir will be /home/ec2-user/worker

Different working_directory succeeds:

make 1.25 working_directory=/tmp/foo

im-wanyama · 2023-03-25T00:40:56Z

LGTM

matt-corbalt · 2023-03-27T14:09:36Z

@cartermckinnon This PR fixes the issues we were having with hardened linux builds. Thanks again!

eks-worker-al2-variables.json

dims · 2023-03-28T20:46:44Z

one question inline. LGTM otherwise!

eks-worker-al2-variables.json

eks-worker-al2.json

scripts/install-worker.sh

eks-worker-al2-variables.json

scripts/install-worker.sh

matt-corbalt · 2023-04-13T20:39:47Z

Hey @cartermckinnon, any idea when this might be merged to master? Thanks again for the work

hack/generate-template-variable-doc.py

matt-corbalt · 2023-04-28T13:28:30Z

Hi @cartermckinnon, another friendly ping as this PR solves some issues we've been having and we're pinned on it until merged. Let me know if there's anything I can do to help work towards merging this. Thanks!

im-wanyama · 2023-05-18T09:45:51Z

Hi @cartermckinnon any update on when this is going to get merged?

cartermckinnon · 2023-05-18T12:39:31Z

Sorry folks, I was out of the office and had some other priorities. I'll resolve the conflicts and wrap this one up.

alexkimin · 2023-06-13T13:13:40Z

Hi, any update on this PR?

mmerkes · 2023-06-13T23:05:12Z

eks-worker-al2.json

+        "mkdir -p {{user `working_dir`}}",
+        "mkdir -p {{user `working_dir`}}/log-collector-script"


Can't this just be combined into one line?

Yeah. I think I separated this to make it very obvious what the intent of this provisioner is, I don't feel too strongly either way.

Ya. I had mixed feelings. It's unnecessary, but removes the illusion that we're creating this just for the log collector script.

mmerkes · 2023-06-13T23:07:09Z

eks-worker-al2.json

+    {
+      "type": "shell",
+      "inline": [
+        "rm -rf {{user `working_dir`}}"


Is it possible bad things will happen here? I think not since we're creating {{user remote_folder}}/worker? I don't how we could accidentally delete anything too problematic.

Yup, we're using /tmp right now and deleting it in the cleanup script. I added this to directly mirror the provisioner up top where we create this dir.

mmerkes

LGTM

alexkimin · 2023-06-15T04:01:25Z

Thanks for the good PR to allow using this repo with CIS hardened Amazon Linux 2. Hope it merges soon and works again.

Sandeepsac · 2023-06-19T07:34:34Z

@cartermckinnon still i am getting this error

/sandeep/amazon-eks-ami/scripts/generate-version-info.sh
2023-06-19T07:29:38Z: amazon-ebs: ctr: failed to dial "/run/containerd/containerd.sock": context deadline exceeded: connection error: desc = "transport: error while dialing: dial unix:///run/containerd/containerd.sock: timeout"
2023-06-19T07:29:38Z: ==> amazon-ebs: Downloading /home/ec2-user/worker/version-info.json => amazon-eks-node-1.27-v20230619-version-info.json
2023-06-19T07:29:38Z: ==> amazon-ebs: Provisioning step had errors: Running the cleanup provisioner, if present...
2023-06-19T07:29:38Z: ==> amazon-ebs: Terminating the source AWS instance...
2023-06-19T07:30:39Z: ==> amazon-ebs: Cleaning up any extra volumes...
2023-06-19T07:30:39Z: ==> amazon-ebs: No volumes to clean up, skipping
2023-06-19T07:30:39Z: ==> amazon-ebs: Deleting temporary security group...
2023-06-19T07:30:39Z: ==> amazon-ebs: Deleting temporary keypair...

Command :
make 1.27 aws_region=$AWS_REGION source_ami_id=$AMI_ID source_ami_owners=$AMI_OWNER_ACCOUNT_ID source_ami_filter_name="$AMI_NAME" subnet_id=subnet-*** remote_folder=/home/ec2-user

EKS version 1.27
CIS hardening AMI : CIS Amazon Linux 2 Benchmark - Level 2
https://aws.amazon.com/marketplace/pp/prodview-wm36yptaecjnu?sr=0-1&ref_=beagle&applicationId=AWSMPContessa#pdp-pricing

mmerkes · 2023-06-19T15:00:36Z

@Sandeepsac Doesn't look like it's one of the errors that this PR is meant to fix. Looks like it's a new one. You probably need to look at the containerd logs. Looks like containerd hasn't started.

cartermckinnon · 2023-06-19T18:41:25Z

The ctr line is just a warning, and it's not causing the build failure (I can see that the subsequent provisioner is running, the one that downloads the version-info.json file).

@Sandeepsac are you using the default for working_dir?

Sandeepsac · 2023-06-20T05:22:02Z

yes @cartermckinnon I am using default for working_dir

"working_dir": "{{user remote_folder}}/worker" which is available in eks-worker-al2-variables.json file

cartermckinnon · 2023-06-21T16:23:51Z

@Sandeepsac My guess is there's a permissions error at rm -rf {{user 'working_dir'}}. If you add a complete make line here, I can try to reproduce. I'd also try different values for remote_folder.

Sandeepsac · 2023-06-22T05:20:12Z

@cartermckinnon I will check the permission , Thanks
make command:
make 1.27 aws_region=$AWS_REGION source_ami_id=$AMI_ID source_ami_owners=$AMI_OWNER_ACCOUNT_ID source_ami_filter_name="$AMI_NAME" subnet_id=subnet-*** remote_folder=/home/ec2-user

and referring this blog for custom AMI creation
https://aws.amazon.com/blogs/containers/building-amazon-linux-2-cis-benchmark-amis-for-amazon-eks/

CIS hardening AMI : CIS Amazon Linux 2 Benchmark - Level 2
Region : us-west-1
eks-version: V1.27

im-wanyama · 2023-06-27T10:05:31Z

Hi there, is there an ETA on when this is going to get tagged?

Sandeepsac · 2023-07-03T07:21:24Z

@cartermckinnon any update for this error

2023-07-03T06:53:02Z: ==> amazon-ebs: Provisioning with shell script: /eks-1.26/amazon-eks-ami/scripts/generate-version-info.sh
2023-07-03T06:53:13Z: amazon-ebs: ctr: failed to dial "/run/containerd/containerd.sock": context deadline exceeded: connection error: desc = "transport: error while dialing: dial unix:///run/containerd/containerd.sock: timeout"
2023-07-03T06:53:13Z: ==> amazon-ebs: Downloading /home/ec2-user/worker/version-info.json => amazon-eks-node-1.26-v20230703-version-info.json
2023-07-03T06:53:13Z: ==> amazon-ebs: Provisioning step had errors: Running the cleanup provisioner, if present...
2023-07-03T06:53:13Z: ==> amazon-ebs: Terminating the source AWS instance...
2023-07-03T06:54:44Z: ==> amazon-ebs: Cleaning up any extra volumes...
2023-07-03T06:54:44Z: ==> amazon-ebs: No volumes to clean up, skipping
2023-07-03T06:54:44Z: ==> amazon-ebs: Deleting temporary security group...
2023-07-03T06:54:44Z: ==> amazon-ebs: Deleting temporary keypair...
2023-07-03T06:54:44Z: Build 'amazon-ebs' errored after 5 minutes 47 seconds: open amazon-eks-node-1.26-v20230703-version-info.json: permission denied

==> Wait completed after 5 minutes 47 seconds

==> Some builds didn't complete successfully and had errors:
--> amazon-ebs: open amazon-eks-node-1.26-v20230703-version-info.json: permission denied

==> Builds finished but no artifacts were created.
make[1]: *** [k8s] Error 1

This was referenced Mar 24, 2023

Move file copy after kernel upgrade #1230

Closed

Updating install worker script to accept a user defined directory whe… #1198

Closed

dims reviewed Mar 28, 2023

View reviewed changes

eks-worker-al2-variables.json Show resolved Hide resolved

mmerkes reviewed Mar 28, 2023

View reviewed changes

eks-worker-al2-variables.json Show resolved Hide resolved

eks-worker-al2.json Show resolved Hide resolved

eks-worker-al2.json Show resolved Hide resolved

scripts/install-worker.sh Show resolved Hide resolved

eks-worker-al2-variables.json Show resolved Hide resolved

guessi reviewed Apr 1, 2023

View reviewed changes

scripts/install-worker.sh Show resolved Hide resolved

cartermckinnon mentioned this pull request Apr 4, 2023

Improve scripts readability and prevent word split issues #1244

Closed

cartermckinnon requested a review from mmerkes April 14, 2023 17:21

guessi reviewed Apr 15, 2023

View reviewed changes

cartermckinnon force-pushed the working-dir branch from f41b3c8 to 8a15a9f Compare June 13, 2023 22:41

Add configurable working directory

c35f9d2

cartermckinnon force-pushed the working-dir branch from 8a15a9f to c35f9d2 Compare June 13, 2023 22:52

cartermckinnon added 2 commits June 13, 2023 15:57

Fix indentation

506db53

Add erroneous merge artifact

1e44400

mmerkes reviewed Jun 13, 2023

View reviewed changes

mmerkes approved these changes Jun 13, 2023

View reviewed changes

cartermckinnon mentioned this pull request Jun 15, 2023

Cleanup extracted awscli in isolated regions #1327

Closed

cartermckinnon merged commit 6412bee into master Jun 16, 2023

cartermckinnon deleted the working-dir branch June 16, 2023 17:26

cartermckinnon mentioned this pull request Jun 21, 2023

Temporary files left in /tmp at build-time #1326

Closed

cartermckinnon mentioned this pull request Aug 31, 2023

Make awscli instalation more configurable #1164

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add configurable working directory #1231

Add configurable working directory #1231

cartermckinnon commented Mar 24, 2023 •

edited

Loading

im-wanyama commented Mar 25, 2023

matt-corbalt commented Mar 27, 2023

dims commented Mar 28, 2023

matt-corbalt commented Apr 13, 2023

matt-corbalt commented Apr 28, 2023

im-wanyama commented May 18, 2023

cartermckinnon commented May 18, 2023

alexkimin commented Jun 13, 2023

mmerkes Jun 13, 2023

cartermckinnon Jun 13, 2023

mmerkes Jun 13, 2023

mmerkes Jun 13, 2023

cartermckinnon Jun 13, 2023

mmerkes left a comment

alexkimin commented Jun 15, 2023

Sandeepsac commented Jun 19, 2023 •

edited

Loading

mmerkes commented Jun 19, 2023

cartermckinnon commented Jun 19, 2023

Sandeepsac commented Jun 20, 2023

cartermckinnon commented Jun 21, 2023

Sandeepsac commented Jun 22, 2023 •

edited

Loading

im-wanyama commented Jun 27, 2023

Sandeepsac commented Jul 3, 2023 •

edited

Loading

		"mkdir -p {{user `working_dir`}}",
		"mkdir -p {{user `working_dir`}}/log-collector-script"

Add configurable working directory #1231

Add configurable working directory #1231

Conversation

cartermckinnon commented Mar 24, 2023 • edited Loading

im-wanyama commented Mar 25, 2023

matt-corbalt commented Mar 27, 2023

dims commented Mar 28, 2023

matt-corbalt commented Apr 13, 2023

matt-corbalt commented Apr 28, 2023

im-wanyama commented May 18, 2023

cartermckinnon commented May 18, 2023

alexkimin commented Jun 13, 2023

mmerkes Jun 13, 2023

Choose a reason for hiding this comment

cartermckinnon Jun 13, 2023

Choose a reason for hiding this comment

mmerkes Jun 13, 2023

Choose a reason for hiding this comment

mmerkes Jun 13, 2023

Choose a reason for hiding this comment

cartermckinnon Jun 13, 2023

Choose a reason for hiding this comment

mmerkes left a comment

Choose a reason for hiding this comment

alexkimin commented Jun 15, 2023

Sandeepsac commented Jun 19, 2023 • edited Loading

mmerkes commented Jun 19, 2023

cartermckinnon commented Jun 19, 2023

Sandeepsac commented Jun 20, 2023

cartermckinnon commented Jun 21, 2023

Sandeepsac commented Jun 22, 2023 • edited Loading

im-wanyama commented Jun 27, 2023

Sandeepsac commented Jul 3, 2023 • edited Loading

cartermckinnon commented Mar 24, 2023 •

edited

Loading

Sandeepsac commented Jun 19, 2023 •

edited

Loading

Sandeepsac commented Jun 22, 2023 •

edited

Loading

Sandeepsac commented Jul 3, 2023 •

edited

Loading