diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 26 |
1 files changed, 17 insertions, 9 deletions
@@ -9,8 +9,8 @@ and cloud platform support for small size and limited external dependencies. | |||
9 | ## Requirements | 9 | ## Requirements |
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 is | 12 | dependencies. In-fact, this works with just busybox -- provided the wget applet |
13 | built-in. The only required dependencies are: | 13 | is built-in. 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 |
@@ -30,15 +30,23 @@ installing packages, and many other things. This bootstrap does not support | |||
30 | those things. Instead it supports: | 30 | those things. Instead it supports: |
31 | 31 | ||
32 | - setting system hostname | 32 | - setting system hostname |
33 | - install user's configured SSH keys to the alpine user's authorized_keys file | 33 | - installing the instance's SSH keys in the EC2 user's authorized_keys file |
34 | - run any script-like user data (must start with #!) | 34 | - running any script-like user data (must start with #!) |
35 | - disable root and alpine password | 35 | - disabling root and the EC2 user's password |
36 | - resize root partition to available disk space | 36 | - resizing root partition to available disk space |
37 | 37 | ||
38 | These steps only run once. After the initial bootstrap the bootstrapper script | 38 | These steps only run once. After the initial bootstrap the bootstrapper script |
39 | is a no-op. To force the script to run again at boot time remove the file | 39 | is a no-op. To force the script to run again at boot time remove the file |
40 | `/var/lib/cloud/.bootstrap-complete` and reboot the instance. | 40 | `/var/lib/cloud/.bootstrap-complete` and reboot the instance. |
41 | 41 | ||
42 | The default EC2 user is `alpine`; this can be overriden with a | ||
43 | `/etc/conf.d/tiny-ec2-bootstrap` containing... | ||
44 | ``` | ||
45 | EC2-USER="otheruser" | ||
46 | ``` | ||
47 | The EC2 user *must* already exist in the AMI -- `tiny-ec2-bootstrap` will | ||
48 | **NOT** add the user automatically. | ||
49 | |||
42 | ## User Data | 50 | ## User Data |
43 | 51 | ||
44 | 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,7 +61,7 @@ made at the point the script runs. | |||
53 | 61 | ||
54 | ## Assumptions | 62 | ## Assumptions |
55 | 63 | ||
56 | - This was written for Alpine Linux and thus assumes that the login user is | 64 | - This was written for Alpine Linux; use on other distributions has not been |
57 | called alpine. This could be configurable in the future but currently is not. | 65 | tested. |
58 | 66 | ||
59 | - The script is run by OpenRC | 67 | - The script is run by OpenRC. |