aws / ec2-macos-utils

Amazon EC2 macOS Utils provides common commands for Mac instances.

EC2 macOS Utils

Overview

EC2 macOS Utils is a CLI-based utility that provides commands for customizing AWS EC2 Mac instances. Currently, there exists one command (grow) for resizing volumes to their maximum size. This is done by wrapping diskutil(8), gathering disk information, and resizing the disk.

Usage

The utility will be installed by default for all AMIs vended by AWS after December 8, 2021. ec2-macos-utils is also available as a cask for install and updates via AWS' Homebrew tap.

See the ec2-macos-utils docs for more information.

Global Flags

EC2 macOS Utils supports global flags that can be set with any command. The supported global flags are as follows:

• --verbose or -v this flag enables more detailed information to be outputted.

Growing APFS Containers

ec2-macos-utils grow [flags]

The grow command resizes an APFS container to its maximum size. This is done by fetching all disk and system partition information, repairing the physical device to update partition information, calculating the amount of free space available, and resizing the container to its max size. Repairing the physical device is necessary in order to properly allocate the amount of available free space.

The grow command should be run with sudo as it requires root access in order to repair the physical disk.

See the grow docs for more information.

Building

ec2-macos-utils can be built using the provided Makefile. The default target compiles the executable with other targets provided for development & release activities. Each target has preset values that it uses but these can be overridden and tailored as needed.

Dependencies

This project requires the following build time dependencies:

• Go
• GNU Make

Build

make build
# or, alternatively use the default target to build:
make

This builds the ec2-macos-utils binary.

Generate Docs

make docs

This builds the ec2-macos-utils-docs binary which can be used to generate the latest command docs.

Tests

make test

This runs a cover of all Go tests in the package.

Imports

make imports

Run goimports to reformat source files according to gofmt.

Contributing

Please feel free to submit issues, fork the repository and send pull requests! See CONTRIBUTING for more information.

Security

See the Security section of CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.

ec2-macos-utils's Issues

Add flag to suppress command errors

After adding ec2-macos-utils grow root container command to ec2-macos-init in aws/ec2-macos-init@97875d5, ec2-macos-init can be seen erroring on the new module when there isn't enough free space. For this case, it would be better to not error and return exit status 0 as the default EBS volume size for EC2 mac instances is 100GB with no available space to grow.

A new flag can be introduced to the CLI to suppress any error messages that might crop up due to a lack of available free space. This will allow ec2-macos-init to not log an expected failure case and continue without errors.

Example flag: --ignore-errors

Example usage:

ec2-macos-utils grow --id root --ignore-errors

Related issue - aws/ec2-macos-init#41

ec2-mac-utils missing from AMIs and AWS Homebrew tap

The utility will be installed by default for all AMIs vended by AWS after December 8, 2021. ec2-macos-utils is also available as a cask for install and updates via AWS' Homebrew tap.

The readme mentions the tool should be installed by default on the EC2 Mac AMIs and/or available in the AWS Homebrew tap but this doesn't appear to be the current situation.

https://github.com/aws/homebrew-aws