Updating docs to match CfnCluster naming

dougalb · dougalb · commit 4a1258de5df0 · 2015-04-15T16:38:50.000-07:00
diff --git a/docs/source/autoscaling.rst b/docs/source/autoscaling.rst
@@ -1,16 +1,16 @@
 .. _autoscaling:
 
-cfncluster auto-scaling
+CfnCluster auto-scaling
 =======================
 
-Clusters deployed with cfncluster are elastic in several ways. The first is by 
+Clusters deployed with CfnCluster are elastic in several ways. The first is by 
 simply setting the initial_queue_size and max_queue_size parameters of a cluster 
 settings. The initial_queue_size sets minimum size value of the ComputeFleet 
 Auto Scaling Group(ASG) and also the desired capacity value . The max_queue_size 
-sets maximum size value of the ComputeFleet ASG. As part of the cfncluster, two 
+sets maximum size value of the ComputeFleet ASG. As part of the CfnCluster, two 
 Amazon CloudWatch alarms are created. These alarms monitor a custom Amazon 
 CloudWatch metric[1] that is published by the MasterServer of each cluster, this 
-is the second elastic nature of cfncluster. This metric is called pending and is 
+is the second elastic nature of CfnCluster. This metric is called pending and is 
 created per Stack and unique to each cluster. These Amazon CloudWatch alarms 
 call ScaleUp policies associated with the ComputeFleet ASG. This is what handles 
 the automatic addition of compute nodes when there is pending tasks in the 
@@ -32,7 +32,7 @@ affecting any running jobs and also enables an elastic cluster with a fixed base
 number of instances.
 
 The value of the auto scaling is the same for HPC as with any other workloads, 
-the only difference here is cfncluster has code to specifically make it interact 
+the only difference here is CfnCluster has code to specifically make it interact 
 in a more intelligent manner. If a static cluster is required, this can be 
 achieved by setting initial_queue_size and max_queue_size parameters to the size 
 of cluster required and also setting the maintain_initial_size parameter to 
diff --git a/docs/source/aws_services.rst b/docs/source/aws_services.rst
@@ -1,9 +1,9 @@
 .. _aws_services:
 
-AWS Services used in cfncluster
+AWS Services used in CfnCluster
 ===============================
 
-The following Amazon Web Services (AWS) services are used in cfncluster. 
+The following Amazon Web Services (AWS) services are used in CfnCluster. 
 
 * AWS CloudFormation
 * AWS Identity and Access Management (IAM)
@@ -19,21 +19,21 @@ The following Amazon Web Services (AWS) services are used in cfncluster.
 AWS CloudFormation
 ------------------
 
-AWS CloudFormation is the core service used by cfncluster. Each cluster is representated as a stack. All resources required by the cluster are defined within the cfncluster CloudFormation template. cfncluster cli commands typically map to CloudFormation stack commands, such as create, update and delete. Instances launched within a cluster make HTTPS calls to the CloudFormation Endpoint for the region the cluster is launched in.
+AWS CloudFormation is the core service used by CfnCluster. Each cluster is representated as a stack. All resources required by the cluster are defined within the CfnCluster CloudFormation template. CfnCluster cli commands typically map to CloudFormation stack commands, such as create, update and delete. Instances launched within a cluster make HTTPS calls to the CloudFormation Endpoint for the region the cluster is launched in.
 
 For more details about AWS CloudFormation, see http://aws.amazon.com/cloudformation/
 
 AWS Identity and Access Management (IAM)
 ----------------------------------------
 
-IAM is used within cfncluster to provide an Amazon EC2 IAM Role for the instances. This role is a least privilged role specifically created for each cluster. cfncluster instances are given access only to the specific API calls that are required to deploy and manage the cluster. 
+IAM is used within CfnCluster to provide an Amazon EC2 IAM Role for the instances. This role is a least privilged role specifically created for each cluster. CfnCluster instances are given access only to the specific API calls that are required to deploy and manage the cluster. 
 
 For more details about AWS Identity and Access Management, see http://aws.amazon.com/iam/
 
 Amazon SNS
 ----------
 
-Amazon Simple Notification Service is used to receive notifications from Auto Scaling. These events are called life cycle events, and are generated when an instance lauches or terminates in an Autoscaling Grpoup. Within cfncluster, the Amazon SNS topic for the Autoscaling Group is subnscibred to an Amazon SQS queue.
+Amazon Simple Notification Service is used to receive notifications from Auto Scaling. These events are called life cycle events, and are generated when an instance lauches or terminates in an Autoscaling Grpoup. Within CfnCluster, the Amazon SNS topic for the Autoscaling Group is subnscibred to an Amazon SQS queue.
 
 For more details about Amazon SNS, see http://aws.amazon.com/sns/
 
@@ -47,7 +47,7 @@ For more details about Amazon SQS, see http://aws.amazon.com/sqs/
 Amazon EC2
 ----------
 
-Amazon EC2 provides the compute for cfncluster. The MasterServer and ComputeFleet are EC2 instances. Any instance type that support HVM can be selected. The MasterServer and ComputeFleet can be different instance types and the ComputeFleet can also be laucnhed as Spot instances. Ephmeral storage found on the instances is mounted as a RAID0 volume.
+Amazon EC2 provides the compute for CfnCluster. The MasterServer and ComputeFleet are EC2 instances. Any instance type that support HVM can be selected. The MasterServer and ComputeFleet can be different instance types and the ComputeFleet can also be laucnhed as Spot instances. Ephmeral storage found on the instances is mounted as a RAID0 volume.
 
 For more details about Amazon EC2, see http://aws.amazon.com/ec2/
 
@@ -68,14 +68,14 @@ For more details about Amazon EBS, see http://aws.amazon.com/ebs/
 Amazon Cloud Watch
 ------------------
 
-Amazon Cloud Watch provides metric collection and alarms for cfncluster. The MasterServer publishs pending tasks(jobs) for each cluster. Two alarms are defined that based on parameters defined in the config will automatically increase the size of the ComputeFleet Auto Scaling group.
+Amazon Cloud Watch provides metric collection and alarms for CfnCluster. The MasterServer publishs pending tasks(jobs) for each cluster. Two alarms are defined that based on parameters defined in the config will automatically increase the size of the ComputeFleet Auto Scaling group.
 
 For more details, see http://aws.amazon.com/cloudwatch/
 
 Amazon S3
 ---------
 
-Amazon S3 is used to store the cfncluster templates. Each region has a bucket with all templates. Within cfncluster, access to S3 can be controlled to allow CLI/SDK tools to use S3.
+Amazon S3 is used to store the CfnCluster templates. Each region has a bucket with all templates. Within CfnCluster, access to S3 can be controlled to allow CLI/SDK tools to use S3.
 
 For more details, see http://aws.amazon.com/s3/
 
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -45,7 +45,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'cfncluster'
+project = u'CfnCluster'
 copyright = u'2014-2015, Amazon Web Services'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -201,7 +201,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'cfncluster.tex', u'cfncluster Documentation',
+  ('index', 'cfncluster.tex', u'CfnCluster Documentation',
    u'Dougal Ballantyne', u'Amazon Web Services', 'manual'),
 ]
 
@@ -266,7 +266,7 @@
 # -- Options for Epub output ----------------------------------------------
 
 # Bibliographic Dublin Core info.
-epub_title = u'cfncluster'
+epub_title = u'CfnCluster'
 epub_author = u'Dougal Ballantyne'
 epub_publisher = u'Dougal Ballantyne'
 epub_copyright = u'2014-2015, Dougal Ballantyne'
diff --git a/docs/source/functional.rst b/docs/source/functional.rst
@@ -1,9 +1,9 @@
 .. _functional
 
-How cfncluster Works
+How CfnCluster Works
 ####################
 
-cfncluster was built not only as a way to manage clusters, but as a reference on how to use AWS services to build your HPC environment
+CfnCluster was built not only as a way to manage clusters, but as a reference on how to use AWS services to build your HPC environment
 
 .. toctree::
 
diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -4,15 +4,15 @@
    :maxdepth: 2
 
 ###############################
-Getting started with cfncluster
+Getting started with CfnCluster
 ###############################
 
-cfncluster is a framework that deploys and maintains HPC clusters on AWS. It is reasonably agnostic to what the cluster is for and can easily be extended to support different frameworks. The CLI is stateless, everything is done using CloudFormation or resources within AWS.
+CfnCluster ("cloud formation cluster") is a framework that deploys and maintains high performance computing clusters on Amazon Web Services (AWS). Developed by AWS, CfnCluster facilitates both quick start proof of concepts (POCs) and production deployments. CfnCluster supports many different types of clustered applications and can easily be extended to support different frameworks. Download CfnCluster today to see how CfnCluster's command line interface leverages AWS CloudFormation templates and other AWS cloud services.
 
-Installing cfncluster
+Installing CfnCluster
 =====================
 
-The current working version is cfncluster-0.0.19. The CLI is written in python and uses BOTO for AWS actions. You can install the CLI with the following commands, depending on your OS.
+The current working version is CfnCluster-0.0.20. The CLI is written in python and uses BOTO for AWS actions. You can install the CLI with the following commands, depending on your OS.
 
 Linux/OSX
 ---------
@@ -39,12 +39,12 @@ Now it should be possible to run the following within a command prompt window:
 
 ::
 
-	C:\> easy_install cfncluster
+	C:\> easy_install CfnCluster
 
 Upgrading
 ---------
 
-To upgrade an older version of cfncluster, you can use either of the following commands, depening on how it was originally installed:
+To upgrade an older version of CfnCluster, you can use either of the following commands, depening on how it was originally installed:
 
 ::
 
@@ -58,7 +58,7 @@ or
 
 **Remember when upgrading to check that the exiting config is compatible with the latest version installed.**
 
-Configuring cfncluster
+Configuring CfnCluster
 ======================
 
 Once installed you will need to setup some initial config. The easiest way to do this is below:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -4,10 +4,10 @@
    contain the root `toctree` directive.
 
 
-cfncluster
+CfnCluster
 ##########
 
-cfncluster is a framework that deploys and maintains High Performance Clusters (HPC) on AWS. It is reasonably agnostic to what the cluster is for and can easily be extended to support different frameworks. The CLI is stateless, everything is done using CloudFormation or resources within AWS.
+CfnCluster ("cloud formation cluster") is a framework that deploys and maintains high performance computing clusters on Amazon Web Services (AWS). Developed by AWS, CfnCluster facilitates both quick start proof of concepts (POCs) and production deployments. CfnCluster supports many different types of clustered applications and can easily be extended to support different frameworks. Download CfnCluster today to see how CfnCluster's command line interface leverages AWS CloudFormation templates and other AWS cloud services.
 
 .. toctree::
     :maxdepth: 2
@@ -21,23 +21,23 @@ cfncluster is a framework that deploys and maintains High Performance Clusters (
 Getting Started
 ---------------
 
-If you've never used ``cfncluster`` before, you should read the :doc:`Getting Started with cfncluster <getting_started>` guide to get familiar with ``cfncluster`` & its usage.
+If you've never used ``CfnCluster`` before, you should read the :doc:`Getting Started with cfncluster <getting_started>` guide to get familiar with ``cfncluster`` & its usage.
 
 Additional Docs
 ---------------
 
 * :doc:`pre & post install actions <pre_post_install>`
-* :doc:`cfncluster auto-scaling <autoscaling>`
-* :doc:`AWS services used in cfncluster <aws_services>`
-* :doc:`cfncluster networking configurations <networking>`
+* :doc:`CfnCluster auto-scaling <autoscaling>`
+* :doc:`AWS services used in CfnCluster <aws_services>`
+* :doc:`CfnCluster networking configurations <networking>`
 * :doc:`working with S3 <s3_resources>`
 
 Additional Resources
 --------------------
 
-* `cfncluster Source Repository`_
-* `cfncluster Issue Tracker`_
-* `cfncluster Webcast - HPC Scalability in the Cloud`_
+* `CfnCluster Source Repository`_
+* `CfnCluster Issue Tracker`_
+* `CfnCluster Webcast - HPC Scalability in the Cloud`_
 
 .. _cfncluster Issue Tracker: https://github.com/awslabs/cfncluster/issues
 .. _cfncluster Source Repository: https://github.com/awslabs/cfncluster
diff --git a/docs/source/networking.rst b/docs/source/networking.rst
@@ -3,7 +3,7 @@
 Network Configurations
 ======================
 
-cfncluster leverages Amazon Virtual Private Cloud(VPC) for networking. This provides a very flexiable and configurable networking platform to deploy clusters within. cfncluster support the following high-level configurations:
+CfnCluster leverages Amazon Virtual Private Cloud(VPC) for networking. This provides a very flexiable and configurable networking platform to deploy clusters within. CfnCluster support the following high-level configurations:
 
 * Single subnet, master and compute in the same subnet
 * Two subnets, master in one subnet and compute new private subnet
@@ -14,9 +14,9 @@ All of these configurations can operate with or without public IP addressing. It
 Below are some architeture diagrams for some of those scenarios:
 
 .. figure:: images/networking_single_subnet.jpg
-   :alt: cfncluster single subnet
+   :alt: CfnCluster single subnet
 
-   cfncluster in a single public subnet
+   CfnCluster in a single public subnet
 
 The configuration for this architecture, requires the following settings:
 
@@ -29,9 +29,9 @@ The configuration for this architecture, requires the following settings:
   master_subnet_id = subnet-a1b2c3d4
 
 .. figure:: images/networking_two_subnets.jpg
-   :alt: cfncluster two subnets
+   :alt: CfnCluster two subnets
 
-   cfncluster using two subnets(new private)
+   CfnCluster using two subnets(new private)
 
 The configuration for this architecture, requires the following settings:
 
@@ -45,9 +45,9 @@ The configuration for this architecture, requires the following settings:
   compute_subnet_cidr = 10.0.1.0/24
 
 .. figure:: images/networking_private_dx.jpg
-   :alt: cfncluster private with DX
+   :alt: CfnCluster private with DX
 
-   cfncluster in a private subnet connected using Direct Connect
+   CfnCluster in a private subnet connected using Direct Connect
 
 The configuration for this architecture, requires the following settings:
 
diff --git a/docs/source/pre_post_install.rst b/docs/source/pre_post_install.rst
@@ -3,7 +3,7 @@
 Custom Bootstrap Actions
 ========================
 
-cfncluster can execute arbritary code either before(pre) or after(post) the main bootstrap action during cluster creation. This code is typically stored in S3 and accessed via HTTP(S) during cluster creation. The code will be executed as root and can be in any script language supppoted by the cluster OS, typically `bash` or `python`. 
+CfnCluster can execute arbritary code either before(pre) or after(post) the main bootstrap action during cluster creation. This code is typically stored in S3 and accessed via HTTP(S) during cluster creation. The code will be executed as root and can be in any script language supppoted by the cluster OS, typically `bash` or `python`. 
 
 pre-install actions are called before any cluster deployment bootstrap such as configuring NAT, EBS and the scheduler. Typical pre-install actions may include modifying storage, adding extra users or packages. 
 
@@ -50,7 +50,7 @@ The following are some steps to create a simple post install script that install
 
 ``aws s3 cp --acl public-read /path/to/myscript.sh s3://<bucket-name>/myscript.sh``
 
-3. Update cfncluster config to include the new post install action
+3. Update CfnCluster config to include the new post install action
 
 ::
 
diff --git a/docs/source/s3_resources.rst b/docs/source/s3_resources.rst
@@ -3,7 +3,7 @@
 Working with S3
 ===============
 
-Accessing S3 within cfncluster can be controlled through two parameters in the cfncluster config.
+Accessing S3 within CfnCluster can be controlled through two parameters in the CfnCluster config.
 
 ::
 
diff --git a/docs/source/tutorials.rst b/docs/source/tutorials.rst
@@ -3,7 +3,7 @@
 Tutorials
 #########
 
-Here you can find tutorials for best practices guides for getting started with cfncluster.
+Here you can find tutorials for best practices guides for getting started with CfnCluster.
 
 .. toctree::
 
