diff options
author | Jake Buchholz <tomalok@gmail.com> | 2019-06-03 22:06:48 -0700 |
---|---|---|
committer | Mike Crute <mike@crute.us> | 2019-07-05 12:52:57 -0700 |
commit | ba46c43caa189938cfc5d6c3328b055afa9dc1ab (patch) | |
tree | 4048ae673518d47474ac2bbbd20f0c822c3022ce | |
parent | 66c3babaf9a5e0186bb58e4acc1e6282b5a78adb (diff) | |
download | tiny-ec2-bootstrap-ba46c43caa189938cfc5d6c3328b055afa9dc1ab.tar.bz2 tiny-ec2-bootstrap-ba46c43caa189938cfc5d6c3328b055afa9dc1ab.tar.xz tiny-ec2-bootstrap-ba46c43caa189938cfc5d6c3328b055afa9dc1ab.zip |
some README proofreading
-rw-r--r-- | README.md | 12 |
1 files changed, 6 insertions, 6 deletions
@@ -2,7 +2,7 @@ | |||
2 | 2 | ||
3 | This is designed to do the minimal amount of work required to bootstrap an EC2 | 3 | This is designed to do the minimal amount of work required to bootstrap an EC2 |
4 | instance based on the local settings assigned at boot time as well as the | 4 | instance based on the local settings assigned at boot time as well as the |
5 | user's configured settings. This is in-concept similar to | 5 | user'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 |
7 | and cloud platform support for small size and limited external dependencies. | 7 | and 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 | ||
11 | The most important feature of this bootstrapper is the very limited set of | 11 | The most important feature of this bootstrapper is the very limited set of |
12 | dependencies. In-fact, this works with just busybox -- provided the wget applet | 12 | dependencies. In-fact, this works with just busybox -- provided the wget applet |
13 | is built-in. The only required dependencies are: | 13 | is 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 | ||
21 | cloud-init has support for many different cloud providers. This project only | 21 | cloud-init has support for many different cloud providers. This project only |
22 | supports EC2, specifically the [EC2 metadata | 22 | supports EC2; [EC2 metadata |
23 | service](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) | 23 | service](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) |
24 | is a hard requirement of using this bootstrapper. All of the data for the | 24 | is a hard requirement of using this bootstrapper. All of the data for the |
25 | supported features below is sourced from the EC2 instance metadata service | 25 | supported 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 | ||
52 | User data is provided at instance boot time and can be any arbitrary string of | 52 | User data is provided at instance boot time and can be any arbitrary string of |
53 | data. The bootstrapper will consider any user data that begins with the ASCII | 53 | data. The bootstrapper will consider any user data that begins with the ASCII |
54 | characters '#!' to be a script. It will write the entire contents of the user | 54 | characters `#!` to be a script. It will write the entire contents of the user |
55 | data to `/var/lib/cloud/user-data.sh`, make the file executable, and execute | 55 | data to `/var/lib/cloud/user-data.sh`, make the file executable, and execute |
56 | the file piping any output to `/var/log/cloud-bootstrap.log`. | 56 | the file piping any output to `/var/log/cloud-bootstrap.log`. |
57 | 57 | ||
58 | The user data script can do anything it pleases with the instance. It will be | 58 | The user data script can do anything it pleases with the instance. It will be |
59 | run as root and networking will be up. No other grantees about system state are | 59 | run as root and networking will be up. No other guarantees about system state |
60 | made at the point the script runs. | 60 | are made at the point the script runs. |
61 | 61 | ||
62 | ## Assumptions | 62 | ## Assumptions |
63 | 63 | ||