Skip to content

Commit fab3f3d

Browse files
committed
Merge branch 'develop' with doc updates.
2 parents e80cc30 + eb98efe commit fab3f3d

File tree

4 files changed

+17
-17
lines changed

4 files changed

+17
-17
lines changed

docs/source/aws_services.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,35 +47,35 @@ For more details about Amazon SQS, see http://aws.amazon.com/sqs/
4747
Amazon EC2
4848
----------
4949

50-
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.
50+
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. Instance store volumes found on the instances are mounted as a RAID0 volume.
5151

5252
For more details about Amazon EC2, see http://aws.amazon.com/ec2/
5353

5454
Auto Scaling
5555
------------
5656

57-
Auto Scaling is used to manage the ComputeFleet instances. These are managed as an AutoScaling Group and can either be elastic driven by workload or static driven by the config.
57+
Auto Scaling is used to manage the ComputeFleet instances. These instances are managed as an AutoScaling Group and can either be elastically driven by workload or static and driven by the config.
5858

5959
For more details about Auto Scaling, see http://aws.amazon.com/autoscaling/
6060

6161
Amazon EBS
6262
----------
6363

64-
Amazon EBS provides the storage for the shared volume. Any EBS settings can be passed through the config. EBS volumes can either be initialized empty or from an exisiting EBS snapshot.
64+
Amazon EBS provides the persistent storage for the shared volume. Any EBS settings can be passed through the config. EBS volumes can either be initialized empty or from an exisiting EBS snapshot.
6565

6666
For more details about Amazon EBS, see http://aws.amazon.com/ebs/
6767

68-
Amazon Cloud Watch
68+
Amazon CloudWatch
6969
------------------
7070

71-
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.
71+
Amazon CloudWatch provides metric collection and alarms for CfnCluster. The MasterServer publishes 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.
7272

7373
For more details, see http://aws.amazon.com/cloudwatch/
7474

7575
Amazon S3
7676
---------
7777

78-
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.
78+
Amazon S3 is used to store the CfnCluster templates. Each region has a bucket with all templates. CfnCluster can be configured to allow allow CLI/SDK tools to use S3.
7979

8080
For more details, see http://aws.amazon.com/s3/
8181

docs/source/configuration.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ Defaults to false for the default template. ::
133133

134134
scheduler
135135
"""""""""
136-
Scheduler to be used with the cluster. Valid options are sge, openlava, or torque.
136+
Scheduler to be used with the cluster. Valid options are sge, openlava, torque, or slurm.
137137

138138
Defaults to sge for the default template. ::
139139

@@ -149,21 +149,21 @@ Defaults to ondemand for the default template. ::
149149

150150
spot_price
151151
"""""""""""
152-
If cluster_type is set to spot, the maximum spot price for the ComputeFleet. ::
152+
If cluster_type is set to spot, the maximum spot price for the ComputeFleet. See the `Spot Bid Advisor <https://aws.amazon.com/ec2/spot/bid-advisor/>`_ for assistance finding a bid price that meets your needs::
153153

154154
spot_price = 0.00
155155

156156
.. _custom_ami_section:
157157

158158
custom_ami
159159
""""""""""
160-
ID of a Custom AMI, to use instead of default published AMI's. ::
160+
ID of a Custom AMI, to use instead of default `published AMI's <https://github.com/awslabs/cfncluster/blob/master/amis.txt>`_. ::
161161

162162
custom_ami = NONE
163163

164164
s3_read_resource
165165
""""""""""""""""
166-
Specify S3 resource which cfncluster nodes will be granted read-only access
166+
Specify S3 resource for which cfncluster nodes will be granted read-only access
167167

168168
See :doc:`working with S3 <s3_resources>` for details on format.
169169

@@ -173,7 +173,7 @@ Defaults to NONE for the default template. ::
173173

174174
s3_read_write_resource
175175
""""""""""""""""""""""
176-
Specify S3 resource which cfncluster nodes will be granted read-write access
176+
Specify S3 resource for which cfncluster nodes will be granted read-write access
177177

178178
See :doc:`working with S3 <s3_resources>` for details on format.
179179

@@ -229,7 +229,7 @@ placement_group
229229
"""""""""""""""
230230
Cluster placement group. The can be one of three values: NONE, DYNAMIC and an existing placement group name. When DYNAMIC is set, a unique placement group will be created as part of the cluster and deleted when the cluster is deleted.
231231

232-
Defaults to NONE for the default template. ::
232+
Defaults to NONE for the default template. More information on placement groups can be found `here <http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html>`_::
233233

234234
placement_group = NONE
235235

@@ -253,13 +253,13 @@ shared_dir
253253
""""""""""
254254
Path/mountpoint for shared EBS volume
255255

256-
Defaults to /shared in the default template. ::
256+
Defaults to /shared in the default template. See :ref:`EBS Section <ebs_section>` for details on working with EBS volumes::
257257

258258
shared_dir = /shared
259259

260260
encrypted_ephemeral
261261
"""""""""""""""""""
262-
Encrypted ephemeral drives. In-memory keys, non-recoverable.
262+
Encrypted ephemeral drives. In-memory keys, non-recoverable. If true, CfnCluster will generate an ephemeral encryption key in memroy and using LUKS encryption, encrypt your instance store volumes.
263263

264264
Defaults to false in default template. ::
265265

docs/source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ Additional Resources
3737

3838
* `CfnCluster Source Repository`_
3939
* `CfnCluster Issue Tracker`_
40-
* `CfnCluster Webcast - HPC Scalability in the Cloud`_
40+
* `CfnCluster Webcast - ResearchCloud - CfnCluster and Internet2 for Enterprise HPC`_
4141

4242
.. _cfncluster Issue Tracker: https://github.com/awslabs/cfncluster/issues
4343
.. _cfncluster Source Repository: https://github.com/awslabs/cfncluster
44-
.. _cfncluster Webcast - HPC Scalability in the Cloud: https://www.youtube.com/watch?v=iHtzy6_WytE
44+
.. _cfncluster Webcast - ResearchCloud - CfnCluster and Internet2 for Enterprise HPC: https://www.youtube.com/watch?v=2WJcKwAChHE&feature=youtu.be&t=22m17s
4545

4646
Indices and tables
4747
==================

docs/source/s3_resources.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,5 @@ Accessing S3 within CfnCluster can be controlled through two parameters in the C
1414
# (defaults to NONE for the default template)
1515
s3_read_write_resource = NONE
1616

17-
Both parameters except either ``*`` or a valid S3 ARN. For details of how to specify S3 ARNs, please see http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-s3
17+
Both parameters accept either ``*`` or a valid S3 ARN. For details of how to specify S3 ARNs, please see http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-s3
1818

0 commit comments

Comments
 (0)