aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJake Buchholz <tomalok@gmail.com>2019-06-03 22:06:48 -0700
committerMike Crute <mike@crute.us>2019-07-05 12:52:57 -0700
commitba46c43caa189938cfc5d6c3328b055afa9dc1ab (patch)
tree4048ae673518d47474ac2bbbd20f0c822c3022ce
parent66c3babaf9a5e0186bb58e4acc1e6282b5a78adb (diff)
downloadtiny-ec2-bootstrap-ba46c43caa189938cfc5d6c3328b055afa9dc1ab.tar.bz2
tiny-ec2-bootstrap-ba46c43caa189938cfc5d6c3328b055afa9dc1ab.tar.xz
tiny-ec2-bootstrap-ba46c43caa189938cfc5d6c3328b055afa9dc1ab.zip
some README proofreading
-rw-r--r--README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.md b/README.md
index 41c184a..a202f9b 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
2 2
3This is designed to do the minimal amount of work required to bootstrap an EC2 3This is designed to do the minimal amount of work required to bootstrap an EC2
4instance based on the local settings assigned at boot time as well as the 4instance based on the local settings assigned at boot time as well as the
5user's configured settings. This is in-concept similar to 5user's configured settings. This is, in-concept, similar to
6[cloud-init](https://cloudinit.readthedocs.io/en/latest/) but trades features 6[cloud-init](https://cloudinit.readthedocs.io/en/latest/) but trades features
7and cloud platform support for small size and limited external dependencies. 7and cloud platform support for small size and limited external dependencies.
8 8
@@ -10,7 +10,7 @@ and cloud platform support for small size and limited external dependencies.
10 10
11The most important feature of this bootstrapper is the very limited set of 11The most important feature of this bootstrapper is the very limited set of
12dependencies. In-fact, this works with just busybox -- provided the wget applet 12dependencies. In-fact, this works with just busybox -- provided the wget applet
13is built-in. The only required dependencies are: 13is built-in -- and resize2fs. The only required dependencies are:
14 14
15- bash-like shell (e.g. bash, dash, ash) 15- bash-like shell (e.g. bash, dash, ash)
16- wget 16- wget
@@ -19,7 +19,7 @@ is built-in. The only required dependencies are:
19## Supported Features and Environments 19## Supported Features and Environments
20 20
21cloud-init has support for many different cloud providers. This project only 21cloud-init has support for many different cloud providers. This project only
22supports EC2, specifically the [EC2 metadata 22supports EC2; [EC2 metadata
23service](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) 23service](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html)
24is a hard requirement of using this bootstrapper. All of the data for the 24is a hard requirement of using this bootstrapper. All of the data for the
25supported features below is sourced from the EC2 instance metadata service 25supported features below is sourced from the EC2 instance metadata service
@@ -51,13 +51,13 @@ The EC2 user *must* already exist in the AMI -- `tiny-ec2-bootstrap` will
51 51
52User data is provided at instance boot time and can be any arbitrary string of 52User data is provided at instance boot time and can be any arbitrary string of
53data. The bootstrapper will consider any user data that begins with the ASCII 53data. The bootstrapper will consider any user data that begins with the ASCII
54characters '#!' to be a script. It will write the entire contents of the user 54characters `#!` to be a script. It will write the entire contents of the user
55data to `/var/lib/cloud/user-data.sh`, make the file executable, and execute 55data to `/var/lib/cloud/user-data.sh`, make the file executable, and execute
56the file piping any output to `/var/log/cloud-bootstrap.log`. 56the file piping any output to `/var/log/cloud-bootstrap.log`.
57 57
58The user data script can do anything it pleases with the instance. It will be 58The user data script can do anything it pleases with the instance. It will be
59run as root and networking will be up. No other grantees about system state are 59run as root and networking will be up. No other guarantees about system state
60made at the point the script runs. 60are made at the point the script runs.
61 61
62## Assumptions 62## Assumptions
63 63