chore(contrib/ec2): rename ec2 to aws

carmstrong · carmstrong · commit e26bac45ef0c · 2015-07-15T12:48:40.000-07:00
We were incorrectly using "AWS" and "EC2" interchangeably, when in
fact EC2 is one of the services that compose AWS. Deis clusters on
AWS make use of EC2 and CloudFormation and other AWS services,
so calling it EC2 is incorrect, and using both terms is inconsistent.
diff --git a/.gitignore b/.gitignore
@@ -66,8 +66,8 @@ contrib/coreos/user-data
 # Local controller settings file
 controller/deis/local_settings.py
 
-# EC2 CloudFormation Setup
-contrib/ec2/cloudformation.json
+# AWS CloudFormation Setup
+contrib/aws/cloudformation.json
 
 # GCE generated user-data
 contrib/gce/gce-user-data
diff --git a/contrib/aws/README.md b/contrib/aws/README.md
diff --git a/contrib/aws/cloudformation.json b/contrib/aws/cloudformation.json
diff --git a/contrib/aws/deis.template.json b/contrib/aws/deis.template.json
diff --git a/contrib/aws/gen-json.py b/contrib/aws/gen-json.py
@@ -5,7 +5,7 @@
 
 CURR_DIR = os.path.dirname(os.path.realpath(__file__))
 
-# Add EC2-specific units to the shared user-data
+# Add AWS-specific units to the shared user-data
 FORMAT_DOCKER_VOLUME = '''
   [Unit]
   Description=Formats the added EBS volume for Docker
diff --git a/contrib/aws/provision-aws-cluster.sh b/contrib/aws/provision-aws-cluster.sh
@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 #
-# Usage: ./provision-ec2-cluster.sh [name]
+# Usage: ./provision-aws-cluster.sh [name]
 # The [name] is the CloudFormation stack name, and defaults to 'deis'
 
 if [ -z "$1" ]
@@ -17,7 +17,7 @@ CONTRIB_DIR=$(dirname $THIS_DIR)
 
 source $CONTRIB_DIR/utils.sh
 
-# check for EC2 API tools in $PATH
+# check for AWS API tools in $PATH
 if ! which aws > /dev/null; then
   echo_red 'Please install the AWS command-line tool and ensure it is in your $PATH.'
   exit 1
@@ -47,7 +47,7 @@ bailout() {
   aws cloudformation delete-stack --stack-name $STACK_NAME
 }
 
-# create an EC2 cloudformation stack based on CoreOS's default template
+# create an AWS cloudformation stack based on CoreOS's default template
 aws cloudformation create-stack \
     --template-body "$($THIS_DIR/gen-json.py)" \
     --stack-name $STACK_NAME \
@@ -68,7 +68,7 @@ until [ $(wc -w <<< $INSTANCE_IDS) -eq $DEIS_NUM_INSTANCES -a "$STACK_STATUS" =
     fi
 
     STACK_STATUS=$(aws --output text cloudformation describe-stacks --stack-name $STACK_NAME --query 'Stacks[].StackStatus' $EXTRA_AWS_CLI_ARGS)
-    if [ $STACK_STATUS != "CREATE_IN_PROGRESS" -a $STACK_STATUS != "CREATE_COMPLETE" ] ; then 
+    if [ $STACK_STATUS != "CREATE_IN_PROGRESS" -a $STACK_STATUS != "CREATE_COMPLETE" ] ; then
       echo "error creating stack: "
       aws --output text cloudformation describe-stack-events \
           --stack-name $STACK_NAME \
diff --git a/contrib/aws/route53-wildcard.py b/contrib/aws/route53-wildcard.py
diff --git a/contrib/aws/update-aws-cluster.sh b/contrib/aws/update-aws-cluster.sh
@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 #
-# Usage: ./update-ec2-cluster.sh [name]
+# Usage: ./update-aws-cluster.sh [name]
 # The [name] is the CloudFormation stack name, and defaults to 'deis'
 
 if [ -z "$1" ]
@@ -17,7 +17,7 @@ CONTRIB_DIR=$(dirname $THIS_DIR)
 
 source $CONTRIB_DIR/utils.sh
 
-# check for EC2 API tools in $PATH
+# check for AWS API tools in $PATH
 if ! which aws > /dev/null; then
   echo_red 'Please install the AWS command-line tool and ensure it is in your $PATH.'
   exit 1
@@ -30,7 +30,7 @@ fi
 # check that the CoreOS user-data file is valid
 $CONTRIB_DIR/util/check-user-data.sh
 
-# update the deis EC2 cloudformation
+# update the AWS CloudFormation stack
 aws cloudformation update-stack \
     --template-body "$($THIS_DIR/gen-json.py)" \
     --stack-name $NAME \
diff --git a/docs/installing_deis/aws.rst b/docs/installing_deis/aws.rst
@@ -8,7 +8,7 @@ Amazon AWS
 
 In this tutorial, we will show you how to set up your own 3-node cluster on Amazon Web Services.
 
-Please :ref:`get the source <get_the_source>` and refer to the scripts in `contrib/ec2`_
+Please :ref:`get the source <get_the_source>` and refer to the scripts in `contrib/aws`_
 while following this documentation.
 
 .. include:: ../_includes/_deis-pro.rst
@@ -22,7 +22,7 @@ In order to start working with Amazon's API, let's install `awscli`_:
 
     $ pip install awscli
 
-We'll also need `PyYAML`_ for the Deis EC2 provision script to run:
+We'll also need `PyYAML`_ for the Deis AWS provision script to run:
 
 .. code-block:: console
 
@@ -84,7 +84,7 @@ Customize cloudformation.json
 -----------------------------
 
 The configuration files and templates for AWS are located in the directory
-``contrib/ec2/`` in the Deis repository.
+``contrib/aws/`` in the Deis repository.
 
 Any of the parameter defaults defined in ``deis.template.json`` can be
 overridden by setting the value in `cloudformation.json`_. For example, to
@@ -130,7 +130,7 @@ The only entry in cloudformation.json required to launch your cluster is `KeyPai
 already filled out. The defaults will be applied for the other settings. The default values are
 defined in ``deis.template.json``.
 
-If updated with ``update-ec2-cluster.sh``, the InstanceType will only impact newly deployed instances
+If updated with ``update-aws-cluster.sh``, the InstanceType will only impact newly deployed instances
 (`#1758`_).
 
 NOTE: The smallest recommended instance size is ``large``. Having not enough CPU or RAM will result
@@ -187,8 +187,8 @@ Run the cloudformation provision script to spawn a new CoreOS cluster:
 
 .. code-block:: console
 
-    $ cd contrib/ec2
-    $ ./provision-ec2-cluster.sh
+    $ cd contrib/aws
+    $ ./provision-aws-cluster.sh
     Creating CloudFormation stack deis
     {
         "StackId": "arn:aws:cloudformation:us-east-1:69326027886:stack/deis/1e9916b0-d7ea-11e4-a0be-50d2020578e0"
@@ -209,7 +209,7 @@ Run the cloudformation provision script to spawn a new CoreOS cluster:
 .. note::
 
     The default name of the CloudFormation stack will be ``deis``. You can specify a different name
-    with ``./provision-ec2-cluster.sh <name>``.
+    with ``./provision-aws-cluster.sh <name>``.
 
 Remote IPs behind your ELB
 --------------------------
@@ -239,7 +239,7 @@ CloudFormation Updates
 ----------------------
 
 To use CloudFormation to perform update operations to your stack, there is another script:
-`update_ec2_cluster.sh`_. Depending on the parameters that you have changed, CloudFormation
+`update-aws-cluster.sh`_. Depending on the parameters that you have changed, CloudFormation
 may replace the EC2 instances in your stack.
 
 The following parameters can be changed without replacing all instances in a stack:
@@ -255,11 +255,11 @@ Please reference the AWS documentation for `more information about CloudFormatio
 
 .. _`#1758`: https://github.com/deis/deis/issues/1758
 .. _`awscli`: https://github.com/aws/aws-cli
-.. _`contrib/ec2`: https://github.com/deis/deis/tree/master/contrib/ec2
-.. _`cloudformation.json`: https://github.com/deis/deis/blob/master/contrib/ec2/cloudformation.json
+.. _`contrib/aws`: https://github.com/deis/deis/tree/master/contrib/aws
+.. _`cloudformation.json`: https://github.com/deis/deis/blob/master/contrib/aws/cloudformation.json
 .. _`etcd`: https://github.com/coreos/etcd
 .. _`etcd disaster recovery`: https://github.com/coreos/etcd/blob/master/Documentation/admin_guide.md#disaster-recovery
 .. _`PyYAML`: http://pyyaml.org/
-.. _`update_ec2_cluster.sh`: https://github.com/deis/deis/blob/master/contrib/ec2/update-ec2-cluster.sh
+.. _`update-aws-cluster.sh`: https://github.com/deis/deis/blob/master/contrib/aws/update-aws-cluster.sh
 .. _`More information about CloudFormation stack updates`: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html
 .. _`Proxy Protocol`: http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/enable-proxy-protocol.html
diff --git a/docs/managing_deis/configure-dns.rst b/docs/managing_deis/configure-dns.rst
@@ -6,10 +6,17 @@
 Configure DNS
 =============
 
+<<<<<<< HEAD
 For Deis clusters on Amazon Web Services, Azure, DigitalOcean, Google Compute Engine,
 Linode, OpenStack, or bare metal, :ref:`DNS records <dns_records>` must be created.
 The cluster runs multiple routers infront of the Deis controller and apps
 you deploy, so a :ref:`load balancer <configure-load-balancers>` is recommended.
+=======
+For Deis clusters on AWS, GCE, Azure, DigitalOcean, OpenStack, or bare metal,
+:ref:`DNS records <dns_records>` must be created. The cluster runs multiple routers in
+front of the Deis controller and apps you deploy, so a
+:ref:`load balancer <configure-load-balancers>` is recommended.
+>>>>>>> chore(contrib/ec2): rename ec2 to aws
 
 Vagrant
 -------
@@ -36,7 +43,7 @@ apps will live under:
 
 Apps can then be accessed by browsers at ``appname.myapps.com``, and the controller will be available to the Deis client at ``deis.myapps.com``.
 
-`EC2 recommends`_ against creating "A" record entries; instead, create a wildcard "CNAME" record entry for the load balancer's DNS name, or use Amazon `Route 53`_.
+`AWS recommends`_ against creating "A" record entries; instead, create a wildcard "CNAME" record entry for the load balancer's DNS name, or use Amazon `Route 53`_.
 
 These records are necessary for all deployments of Deis other than Vagrant clusters.
 
@@ -52,8 +59,8 @@ An alternative to configuring your own DNS records is to use `xip`_ to reference
 
 You would then create the cluster with ``10.21.12.2.xip.io`` as the cluster domain.
 
-Note that xip does not seem to work for EC2 ELBs - you will have to use an actual DNS record.
+Note that xip does not seem to work for AWS ELBs - you will have to use an actual DNS record.
 
-.. _`EC2 recommends`: https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/using-domain-names-with-elb.html
+.. _`AWS recommends`: https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/using-domain-names-with-elb.html
 .. _`Route 53`: http://aws.amazon.com/route53/
 .. _`xip`: http://xip.io/
diff --git a/docs/managing_deis/configure-load-balancers.rst b/docs/managing_deis/configure-load-balancers.rst
@@ -26,10 +26,10 @@ port 80 on all nodes in the Deis cluster. The health check endpoint returns an H
 the load balancer to serve traffic to whichever hosts happen to be running the deis-router component
 at any moment.
 
-EC2
+AWS
 ===
 
-The Deis provisioning scripts for EC2 automatically create an Elastic Load Balancer for your Deis
+The Deis provisioning scripts for AWS automatically create an Elastic Load Balancer for your Deis
 cluster.
 
 Google Compute Engine
diff --git a/docs/managing_deis/disk_usage.rst b/docs/managing_deis/disk_usage.rst
@@ -17,7 +17,7 @@ location                 purpose                              considerations
 /var/lib/etcd            etcd snapshot data                   etcd writes a relatively small amount of snapshot data here, so access should be as fast as possible (cloud providers use fast, local disks)
 /var/lib/docker          Docker image/volume storage          should be large - on cloud providers with external storage (AWS, GCE, Azure) this is a separate 100GB volume
 /var/lib/deis/store      mounted CephFS for deis-store        none - this is a virtually-mounted filesystem, and the "real" Ceph data lives in a Docker volume (so it's stored in /var/lib/docker)
-/                        everything else (logs, etc.)         should be adequately large enough to prevent out-of-space issues causing service failure (on EC2 this is a 50GB volume)
+/                        everything else (logs, etc.)         should be adequately large enough to prevent out-of-space issues causing service failure (on AWS this is a 50GB volume)
 ===================      =============================        ============================================================================================================================================
 
 Identifying low disk space
diff --git a/docs/managing_deis/ssl-endpoints.rst b/docs/managing_deis/ssl-endpoints.rst
@@ -27,17 +27,17 @@ of Deis will still communicate over HTTP.
 
 .. note::
 
-    On Amazon EC2, Deis enables the :ref:`PROXY protocol <proxy_protocol>` by default, requiring
+    On AWS, Deis enables the :ref:`PROXY protocol <proxy_protocol>` by default, requiring
     installation of :ref:`SSL on the Deis routers <router_ssl>`, as described below.
     Disable the PROXY protocol with ``deisctl config router rm proxyProtocol`` and change
     existing targets and health checks from TCP to HTTP to terminate SSL connections at an
     Amazon ELB instead.
 
 To enable SSL, you will need to open port 443 on the load balancer and forward it to port 80 on the
-routers. For EC2, you'll also need to add port 443 in the security group settings for your load
+routers. For AWS, you'll also need to add port 443 in the security group settings for your load
 balancer.
 
-See your vendor's specific instructions on installing SSL on your load balancer. For EC2, see their
+See your vendor's specific instructions on installing SSL on your load balancer. For AWS, see their
 documentation on `installing an SSL cert for load balancing`_.
 
 .. _router_ssl:
diff --git a/docs/managing_deis/upgrading-deis.rst b/docs/managing_deis/upgrading-deis.rst
@@ -55,10 +55,10 @@ Finally, update ``deisctl`` to the new version and reinstall:
 
 .. note::
 
-    When upgrading an Amazon EC2 cluster older than Deis v1.6, a :ref:`migration_upgrade` is
+    When upgrading an AWS cluster older than Deis v1.6, a :ref:`migration_upgrade` is
     preferable.
 
-    On Amazon EC2, Deis enables the :ref:`PROXY protocol <proxy_protocol>` by default.
+    On AWS, Deis enables the :ref:`PROXY protocol <proxy_protocol>` by default.
     If an in-place upgrade is required, run ``deisctl config router set proxyProtocol=1``,
     enable PROXY protocol for ports 80 and 443 on the ELB, add a ``TCP 443:443`` listener, and
     change existing targets and health checks from HTTP to TCP.
diff --git a/docs/roadmap/test_plan.rst b/docs/roadmap/test_plan.rst
@@ -188,7 +188,7 @@ Risks and Contingencies
 -----------------------
 
 Automated tests do not yet extend to all cloud providers, and it is possible
-that manual testing could miss something. We will address this by adding EC2_
+that manual testing could miss something. We will address this by adding AWS_
 and other testing flavors soon.
 
 Resources are limited, and contention between development needs and testing
@@ -211,4 +211,4 @@ pull requests against this documentation.
 .. _`source code`: https://github.com/deis/deis
 .. _test-integration.sh: https://github.com/deis/deis/blob/master/tests/bin/test-integration.sh
 .. _setup-node.sh: https://github.com/deis/deis/blob/master/tess/bin/setup-node.sh
-.. _EC2: http://aws.amazon.com/
+.. _AWS: http://aws.amazon.com/
diff --git a/tests/bin/test-integration-aws.sh b/tests/bin/test-integration-aws.sh
@@ -20,16 +20,16 @@ export AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY?}
 # install python requirements for this script
 pip install --disable-pip-version-check awscli boto docopt
 
-function cleanup_ec2 {
+function cleanup_aws {
     if [ "$SKIP_CLEANUP" != true ]; then
         log_phase "Cleaning up"
         aws cloudformation delete-stack --stack-name $STACK_NAME
-        python $DEIS_ROOT/contrib/ec2/route53-wildcard.py delete $DEIS_TEST_DOMAIN $ELB_DNS_NAME
+        python $DEIS_ROOT/contrib/aws/route53-wildcard.py delete $DEIS_TEST_DOMAIN $ELB_DNS_NAME
     fi
 }
 
 # setup callbacks on process exit and error
-trap cleanup_ec2 EXIT
+trap cleanup_aws EXIT
 trap dump_logs ERR
 
 log_phase "Running style tests"
@@ -71,7 +71,7 @@ fi
 make discovery-url
 
 # customize cloudformation.json to use m3.medium instances
-cat > $DEIS_ROOT/contrib/ec2/cloudformation.json <<EOF
+cat > $DEIS_ROOT/contrib/aws/cloudformation.json <<EOF
 [
     {
         "ParameterKey":     "KeyPair",
@@ -88,10 +88,10 @@ EOF
 STACK_TAG=${STACK_TAG:-test}-$DEIS_TEST_ID
 STACK_NAME=deis-$STACK_TAG
 echo "Creating CloudFormation stack $STACK_NAME"
-$DEIS_ROOT/contrib/ec2/provision-ec2-cluster.sh $STACK_NAME
+$DEIS_ROOT/contrib/aws/provision-aws-cluster.sh $STACK_NAME
 
 # discard changes to cloudformation.json
-git checkout -- $DEIS_ROOT/contrib/ec2/cloudformation.json
+git checkout -- $DEIS_ROOT/contrib/aws/cloudformation.json
 
 # use the first cluster node for now
 INSTANCE_IDS=$(aws ec2 describe-instances \
@@ -178,7 +178,7 @@ echo "Using ELB $ELB_NAME"
 
 # add or update a route53 alias record set to route queries to the ELB
 # this python script won't return until the wildcard domain is accessible
-python $DEIS_ROOT/contrib/ec2/route53-wildcard.py create $DEIS_TEST_DOMAIN $ELB_DNS_NAME
+python $DEIS_ROOT/contrib/aws/route53-wildcard.py create $DEIS_TEST_DOMAIN $ELB_DNS_NAME
 
 # loop until at least one instance is "in service" with the ELB
 ATTEMPTS=45
