Added changes to readme for user friendliness (#361)
* Added changes to readme for user friendliness
* Created section headers
* Includes feedback from code reviews
diff --git a/README.md b/README.md
index 98630b9..3265c24 100644
--- a/README.md
+++ b/README.md
@@ -48,7 +48,8 @@
Muchos requires the following for EC2 installations:
-* [awscli] & [boto3] libraries - Install using `pip3 install awscli boto3 --upgrade --user`
+* [awscli] (version 2) & [boto3] libraries - Install using `pip3 install awscli2 boto3 --upgrade`
+* Note: if using Ubuntu you may need to install botocore separately using `pip3 install awscli boto3 botocore`
* An AWS account with your SSH public key uploaded. When you configure [muchos.props], set `key.name`
to name of your key pair in AWS.
* `~/.aws` [configured][aws-config] on your machine. Can be created manually or using [aws configure][awscli-config].
@@ -113,6 +114,8 @@
cluster, this file will be appended on each node to the `~/.ssh/authorized_keys` file for the user
set by the `cluster.username` property.
+### Configuring the AMI
+
You might also need to configure the `aws_ami` property in [muchos.props]. Muchos by default uses a free
CentOS 7 image that is hosted in the AWS marketplace but managed by the
CentOS organization. If you have never used this image in EC2 before, you will need to go to the
@@ -121,6 +124,8 @@
You will need to changes this value if a newer image has been released or if you are running in different region
than `us-east-1`.
+### Launching the cluster
+
After following the steps above, run the following command to launch an EC2 cluster called `mycluster`:
./bin/muchos launch -c mycluster
diff --git a/conf/muchos.props.example b/conf/muchos.props.example
index 1747189..d37c005 100644
--- a/conf/muchos.props.example
+++ b/conf/muchos.props.example
@@ -50,12 +50,12 @@
java_package=java-1.8.0-openjdk-devel
# The package to use for java 11
# java_package=java-11-openjdk-devel
-# Please read the High-Availability section of the README before switching to 'True'
+# Please read the High-Availability section of the README before switching to 'True'
hdfs_ha = False
# Give a logical name for the cluster, all one word no special characters. Required to support HDFS HA.
nameservice_id = muchoshacluster
# number of accumulo tablet servers to run per host. This is only effective when systemd is set to 'True'. Needs changes in
-# accumulo-service script inorder to support non-systemd cases.
+# accumulo-service script inorder to support non-systemd cases.
num_tservers = 1
# If accumulo services are to be run under systemd, set this to 'True'
use_systemd = False
@@ -166,7 +166,7 @@
# Do not update "azure_client_id", it will be populated dynamically during launch phase of muchos
azure_client_id =
# Do not update "principal_id", it will be populated dynamically during launch phase of muchos when "use_hdfs = False"
-principal_id =
+principal_id =
# Optional Azure fileshare to mount on all nodes.
# Path and credentials must be updated to enable this.
#azure_fileshare_mount = /mnt/azure-fileshare
@@ -178,8 +178,8 @@
# For details on how to get a workspace ID and key, see the link below
# https://docs.microsoft.com/en-us/azure/azure-monitor/learn/quick-collect-linux-computer#obtain-workspace-id-and-key
az_oms_integration_needed = False
-#az_logs_id =
-#az_logs_key =
+#az_logs_id =
+#az_logs_key =
[existing]
# Root of data dirs
