Skip to content

Commit 2acb589

Browse files
Enrico Usaienrico-usai
authored andcommitted
Cleanup documentation by removing "for the default template" sentence
Signed-off-by: Enrico Usai <[email protected]>
1 parent d0ea4b2 commit 2acb589

File tree

5 files changed

+59
-59
lines changed

5 files changed

+59
-59
lines changed

cli/pcluster/examples/config

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ key_name = mykey
5858
# (defaults to sge)
5959
#scheduler = sge
6060
# Type of cluster to launch i.e. ondemand or spot
61-
# (defaults to ondemand for the default template)
61+
# (defaults to ondemand)
6262
#cluster_type = ondemand
6363
# Spot price for the ComputeFleet
6464
#spot_price = 0.00
@@ -67,55 +67,55 @@ key_name = mykey
6767
# ID of a Custom AMI, to use instead of published AMI's
6868
#custom_ami = NONE
6969
# Specify S3 resource which AWS ParallelCluster nodes will be granted read-only access
70-
# (defaults to NONE for the default template)
70+
# (defaults to NONE)
7171
#s3_read_resource = NONE
7272
# Specify S3 resource which AWS ParallelCluster nodes will be granted read-write access
73-
# (defaults to NONE for the default template)
73+
# (defaults to NONE)
7474
#s3_read_write_resource = NONE
7575
# URL to a preinstall script. This is executed before any of the boot_as_* scripts are run
76-
# (defaults to NONE for the default template)
76+
# (defaults to NONE)
7777
#pre_install = NONE
7878
# Arguments to be passed to preinstall script
79-
# (defaults to NONE for the default template)
79+
# (defaults to NONE)
8080
#pre_install_args = NONE
8181
# URL to a postinstall script. This is executed after any of the boot_as_* scripts are run
82-
# (defaults to NONE for the default template)
82+
# (defaults to NONE)
8383
#post_install = NONE
8484
# Arguments to be passed to postinstall script
85-
# (defaults to NONE for the default template)
85+
# (defaults to NONE)
8686
#post_install_args = NONE
8787
# HTTP(S) proxy server, typically http://x.x.x.x:8080
88-
# (defaults to NONE for the default template)
88+
# (defaults to NONE)
8989
#proxy_server = NONE
9090
# Cluster placement group. This placement group must already exist.
91-
# (defaults to NONE for the default template)
91+
# (defaults to NONE)
9292
#placement_group = NONE
9393
# Cluster placement logic. This enables the whole cluster or only compute to use the placement group
94-
# (defaults to cluster in the default template)
94+
# (defaults to cluster)
9595
#placement = cluster
9696
# Path/mountpoint for ephemeral drives
97-
# (defaults to /scratch in the default template)
97+
# (defaults to /scratch)
9898
#ephemeral_dir = /scratch
9999
# Path/mountpoint for shared EBS volume
100-
# (defaults to /shared in the default template)
100+
# (defaults to /shared)
101101
#shared_dir = /shared
102102
# Encrypted ephemeral drives. In-memory keys, non-recoverable.
103-
# (defaults to false in default template)
103+
# (defaults to false)
104104
#encrypted_ephemeral = false
105105
# MasterServer root volume size in GB. (AMI must support growroot)
106-
# (defaults to 15 in default template)
106+
# (defaults to 15)
107107
#master_root_volume_size = 15
108108
# ComputeFleet root volume size in GB. (AMI must support growroot)
109-
# (defaults to 15 in default template)
109+
# (defaults to 15)
110110
#compute_root_volume_size = 15
111111
# OS type used in the cluster
112-
# (defaults to alinux in the default template)
112+
# (defaults to alinux)
113113
#base_os = alinux
114114
# Existing EC2 IAM role to be associated with the EC2 instances
115-
# (defaults to NONE in the default template)
115+
# (defaults to NONE)
116116
#ec2_iam_role = NONE
117117
# Extra Json to be merged with the dna.json used by Chef
118-
# (defaults to {} in the default template)
118+
# (defaults to {})
119119
#extra_json = {}
120120
# Additional CloudFormation template to launch with the cluster
121121
#additional_cfn_template = NONE
@@ -134,13 +134,13 @@ vpc_id = vpc-
134134
master_subnet_id = subnet-
135135
# SSH from CIDR
136136
# This is only used when AWS ParallelCluster creates the security group
137-
# (defaults to 0.0.0.0/0 in the default template)
137+
# (defaults to 0.0.0.0/0)
138138
#ssh_from = 0.0.0.0/0
139139
# Additional VPC security group Id for all instances
140-
# (defaults to NONE in the default template)
140+
# (defaults to NONE)
141141
#additional_sg = sg-
142142
# Existing EC2 security group to be assosiated with the EC2 instances
143-
# (defaults to NONE in the default template)
143+
# (defaults to NONE)
144144
#vpc_security_group_id = sg-
145145

146146
#[vpc private-new]
@@ -178,7 +178,7 @@ master_subnet_id = subnet-
178178
# (defaults to false)
179179
#encrypted = false
180180
# Existing EBS volume to be attached to the MasterServer
181-
# (defaults to NONE in the default template)
181+
# (defaults to NONE)
182182
#ebs_volume_id = NONE
183183

184184
## Second EBS Settings
@@ -195,5 +195,5 @@ master_subnet_id = subnet-
195195
## Scaling settings
196196
#[scaling custom]
197197
# Amount of time in minutes without a job after which the compute node will terminate
198-
# Defaults to 10 for the default template
198+
# Defaults to 10
199199
#scaledown_idletime = 10

docs/source/configuration.rst

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ The maximum number of EC2 instances that can be launched in the cluster for trad
135135

136136
If you're using awsbatch, use :ref:`max_vcpus <max_vcpus>`.
137137

138-
This defaults to 10 for the default template. ::
138+
This defaults to 10. ::
139139

140140
max_queue_size = 10
141141

@@ -149,7 +149,7 @@ If set to true, the Auto Scaling group will never have fewer members than the va
149149

150150
Setting to false allows the Auto Scaling group to scale down to 0 members, so resources will not sit idle when they aren't needed.
151151

152-
Defaults to false for the default template. ::
152+
Defaults to false. ::
153153

154154
maintain_initial_size = false
155155

@@ -187,15 +187,15 @@ scheduler
187187
"""""""""
188188
Scheduler to be used with the cluster. Valid options are sge, torque, slurm, or awsbatch.
189189

190-
Defaults to sge for the default template. ::
190+
Defaults to sge. ::
191191

192192
scheduler = sge
193193

194194
cluster_type
195195
""""""""""""
196196
Type of cluster to launch i.e. ondemand or spot
197197

198-
Defaults to ondemand for the default template. ::
198+
Defaults to ondemand. ::
199199

200200
cluster_type = ondemand
201201

@@ -233,7 +233,7 @@ For example, 'arn:aws:s3:::my_corporate_bucket/\*' would provide read-only acces
233233

234234
See :doc:`working with S3 <s3_resources>` for details on format.
235235

236-
Defaults to NONE for the default template. ::
236+
Defaults to NONE. ::
237237

238238
s3_read_resource = NONE
239239

@@ -245,7 +245,7 @@ For example, 'arn:aws:s3:::my_corporate_bucket/Development/\*' would provide rea
245245

246246
See :doc:`working with S3 <s3_resources>` for details on format.
247247

248-
Defaults to NONE for the default template. ::
248+
Defaults to NONE. ::
249249

250250
s3_read_write_resource = NONE
251251

@@ -257,15 +257,15 @@ This only gets executed on the master node when using awsbatch as your scheduler
257257

258258
Can be specified in "http://hostname/path/to/script.sh" or "s3://bucketname/path/to/script.sh" format.
259259

260-
Defaults to NONE for the default template. ::
260+
Defaults to NONE. ::
261261

262262
pre_install = NONE
263263

264264
pre_install_args
265265
""""""""""""""""
266266
Quoted list of arguments to be passed to preinstall script
267267

268-
Defaults to NONE for the default template. ::
268+
Defaults to NONE. ::
269269

270270
pre_install_args = NONE
271271

@@ -277,23 +277,23 @@ This only gets executed on the master node when using awsbatch as your scheduler
277277

278278
Can be specified in "http://hostname/path/to/script.sh" or "s3://bucketname/path/to/script.sh" format.
279279

280-
Defaults to NONE for the default template. ::
280+
Defaults to NONE. ::
281281

282282
post_install = NONE
283283

284284
post_install_args
285285
"""""""""""""""""
286286
Arguments to be passed to postinstall script
287287

288-
Defaults to NONE for the default template. ::
288+
Defaults to NONE. ::
289289

290290
post_install_args = NONE
291291

292292
proxy_server
293293
""""""""""""
294294
HTTP(S) proxy server, typically http://x.x.x.x:8080
295295

296-
Defaults to NONE for the default template. ::
296+
Defaults to NONE. ::
297297

298298
proxy_server = NONE
299299

@@ -303,7 +303,7 @@ Cluster placement group. The can be one of three values: NONE, DYNAMIC and an ex
303303

304304
This does not apply to awsbatch.
305305

306-
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>`_::
306+
Defaults to NONE. More information on placement groups can be found `here <http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html>`_::
307307

308308
placement_group = NONE
309309

@@ -313,55 +313,55 @@ Cluster placement logic. This enables the whole cluster or only compute to use t
313313

314314
This does not apply to awsbatch.
315315

316-
Defaults to cluster in the default template. ::
316+
Defaults to cluster. ::
317317

318318
placement = cluster
319319

320320
ephemeral_dir
321321
"""""""""""""
322322
If instance store volumes exist, this is the path/mountpoint they will be mounted on.
323323

324-
Defaults to /scratch in the default template. ::
324+
Defaults to /scratch. ::
325325

326326
ephemeral_dir = /scratch
327327

328328
shared_dir
329329
""""""""""
330330
Path/mountpoint for shared EBS volume. Do not use this option when using multiple EBS volumes; provide shared_dir under each EBS section instead
331331

332-
Defaults to /shared in the default template. The example below mounts to /myshared. See :ref:`EBS Section <ebs_section>` for details on working with multiple EBS volumes::
332+
Defaults to /shared. The example below mounts to /myshared. See :ref:`EBS Section <ebs_section>` for details on working with multiple EBS volumes::
333333

334334
shared_dir = myshared
335335

336336
encrypted_ephemeral
337337
"""""""""""""""""""
338338
Encrypted ephemeral drives. In-memory keys, non-recoverable. If true, AWS ParallelCluster will generate an ephemeral encryption key in memroy and using LUKS encryption, encrypt your instance store volumes.
339339

340-
Defaults to false in default template. ::
340+
Defaults to false. ::
341341

342342
encrypted_ephemeral = false
343343

344344
master_root_volume_size
345345
"""""""""""""""""""""""
346346
MasterServer root volume size in GB. (AMI must support growroot)
347347

348-
Defaults to 15 in default template. ::
348+
Defaults to 15. ::
349349

350350
master_root_volume_size = 15
351351

352352
compute_root_volume_size
353353
""""""""""""""""""""""""
354354
ComputeFleet root volume size in GB. (AMI must support growroot)
355355

356-
Defaults to 15 in default template. ::
356+
Defaults to 15. ::
357357

358358
compute_root_volume_size = 15
359359

360360
base_os
361361
"""""""
362362
OS type used in the cluster
363363

364-
Defaults to alinux in the default template. Available options are: alinux, centos6, centos7, ubuntu1404 and ubuntu1604
364+
Defaults to alinux. Available options are: alinux, centos6, centos7, ubuntu1404 and ubuntu1604
365365

366366
Note: The base_os determines the username used to log into the cluster.
367367

@@ -378,15 +378,15 @@ instances in the cluster. Note that the given name of a role and its Amazon
378378
Resource Name (ARN) are different, and the latter can not be used as an argument
379379
to ec2_iam_role.
380380

381-
Defaults to NONE in the default template. ::
381+
Defaults to NONE. ::
382382

383383
ec2_iam_role = NONE
384384

385385
extra_json
386386
""""""""""
387387
Extra JSON that will be merged into the dna.json used by Chef.
388388

389-
Defaults to {} in the default template. ::
389+
Defaults to {}. ::
390390

391391
extra_json = {}
392392

@@ -396,7 +396,7 @@ An additional CloudFormation template to launch along with the cluster. This all
396396

397397
Must be a HTTP URL to a public template with all parameters provided.
398398

399-
Defaults to NONE in the default template. ::
399+
Defaults to NONE. ::
400400

401401
additional_cfn_template = NONE
402402

@@ -467,15 +467,15 @@ CIDR formatted IP range in which to allow SSH access from.
467467

468468
This is only used when AWS ParallelCluster creates the security group.
469469

470-
Defaults to 0.0.0.0/0 in the default template. ::
470+
Defaults to 0.0.0.0/0. ::
471471

472472
ssh_from = 0.0.0.0/0
473473

474474
additional_sg
475475
"""""""""""""
476476
Additional VPC security group Id for all instances.
477477

478-
Defaults to NONE in the default template. ::
478+
Defaults to NONE. ::
479479

480480
additional_sg = sg-xxxxxx
481481

@@ -511,7 +511,7 @@ vpc_security_group_id
511511
"""""""""""""""""""""
512512
Use an existing security group for all instances.
513513

514-
Defaults to NONE in the default template. ::
514+
Defaults to NONE. ::
515515

516516
vpc_security_group_id = sg-xxxxxx
517517

@@ -602,7 +602,7 @@ Amount of time in minutes without a job after which the compute node will termin
602602

603603
This does not apply to awsbatch.
604604

605-
Defaults to 10 for the default template. ::
605+
Defaults to 10. ::
606606

607607
scaledown_idletime = 10
608608

docs/source/pre_post_install.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ The following config settings are used to define pre/post-install actions and ar
2121
::
2222

2323
# URL to a preinstall script. This is executed before any of the boot_as_* scripts are run
24-
# (defaults to NONE for the default template)
24+
# (defaults to NONE)
2525
pre_install = NONE
2626
# Arguments to be passed to preinstall script
27-
# (defaults to NONE for the default template)
27+
# (defaults to NONE)
2828
pre_install_args = NONE
2929
# URL to a postinstall script. This is executed after any of the boot_as_* scripts are run
30-
# (defaults to NONE for the default template)
30+
# (defaults to NONE)
3131
post_install = NONE
3232
# Arguments to be passed to postinstall script
33-
# (defaults to NONE for the default template)
33+
# (defaults to NONE)
3434
post_install_args = NONE
3535

3636
Arguments

docs/source/s3_resources.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ Accessing S3 within AWS ParallelCluster can be controlled through two parameters
88
::
99

1010
# Specify S3 resource which AWS ParallelCluster nodes will be granted read-only access
11-
# (defaults to NONE for the default template)
11+
# (defaults to NONE)
1212
s3_read_resource = NONE
1313
# Specify S3 resource which AWS ParallelCluster nodes will be granted read-write access
14-
# (defaults to NONE for the default template)
14+
# (defaults to NONE)
1515
s3_read_write_resource = NONE
1616

1717
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

0 commit comments

Comments
 (0)