Skip to content

Commit eebd102

Browse files
enrico-usaisean-smith
authored andcommitted
Rename CfnCluster to AWS ParallelCluster
Signed-off-by: Enrico Usai <[email protected]>
1 parent 94d640e commit eebd102

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+570
-579
lines changed

.travis.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ script:
2727
- if [[ $TRAVIS_PYTHON_VERSION != 2.6 ]]; then
2828
pip install 'boto3==1.7.84' --force-reinstall;
2929
pip install moto
30-
python cli/tests/cfncluster-unittest.py;
30+
python cli/tests/pcluster-unittest.py;
3131
pip install boto3 --upgrade;
3232
fi
3333
- sh tests/test.sh

CHANGELOG.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ CHANGELOG
2828
1.5.2
2929
=====
3030
* feature:``cfncluster``: Added ClusterUser as a stack output. This makes it easier to get the username of the head node.
31-
* feature:``cfncluster``: Added `cfncluster ssh cluster_name`, this allows you to easily ssh into your clusters. It allows arbitrary command execution and extra ssh flags to be provided after the command. See https://cfncluster.readthedocs.io/en/latest/commands.html#ssh
31+
* feature:``cfncluster``: Added `cfncluster ssh cluster_name`, this allows you to easily ssh into your clusters. It allows arbitrary command execution and extra ssh flags to be provided after the command. See https://aws-parallelcluster.readthedocs.io/en/latest/commands.html#ssh
3232
* change:``cfncluster``: Moved global cli flags to the command specific flags. For example `cfncluster --region us-east-1 create` now becomes `cfncluster create --region us-east-1`
3333
* bugfix:``cfncluster-cookbook``: Fix bug that prevented c5d/m5d instances from working
3434
* bugfix:``cfncluster-cookbook``: Set CPU as a consumable resource in slurm
@@ -135,7 +135,7 @@ by incompatible dependencies.
135135
=====
136136
Offiical release of the CfnCluster 1.x CLI, templates and AMIs. Available in all regions except BJS, with
137137
support for Amazon Linux, CentOS 6 & 7 and Ubuntu 14.04 LTS. All AMIs are built via packer from the CfnCluster
138-
Cookbook project (https://github.com/awslabs/cfncluster-cookbook).
138+
Cookbook project (https://github.com/aws/aws-parallelcluster-cookbook).
139139

140140
1.0.0-beta
141141
==========

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ information to effectively respond to your bug report or contribution.
1111

1212
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
1313

14-
When filing an issue, please check [existing open](https://github.com/awslabs/cfncluster/issues), or [recently closed](https://github.com/awslabs/cfncluster/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
14+
When filing an issue, please check [existing open](https://github.com/aws/aws-parallelcluster/issues), or [recently closed](https://github.com/aws/aws-parallelcluster/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
1515
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
1616

1717
* A reproducible test case or series of steps
@@ -41,7 +41,7 @@ GitHub provides additional document on [forking a repository](https://help.githu
4141

4242

4343
## Finding contributions to work on
44-
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/awslabs/cfncluster/labels/help%20wanted) issues is a great place to start.
44+
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws/aws-parallelcluster/labels/help%20wanted) issues is a great place to start.
4545

4646

4747
## Code of Conduct
@@ -56,6 +56,6 @@ If you discover a potential security issue in this project we ask that you notif
5656

5757
## Licensing
5858

59-
See the [LICENSE](https://github.com/awslabs/cfncluster/blob/develop/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
59+
See the [LICENSE](https://github.com/aws/aws-parallelcluster/blob/develop/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
6060

6161
We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

NOTICE.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
cfncluster
2-
Copyright 2013-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
aws-parallelcluster
2+
Copyright 2013-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.

README.rst

+23-23
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
==============================
2-
CfnCluster - HPC for the Cloud
3-
==============================
1+
=======================================
2+
AWS ParallelCluster - HPC for the Cloud
3+
=======================================
44

55
|Build Status| |Version|
66

7-
.. |Build Status| image:: https://travis-ci.org/awslabs/cfncluster.png?branch=develop
8-
:target: https://travis-ci.org/awslabs/cfncluster/
7+
.. |Build Status| image:: https://travis-ci.org/aws/aws-parallelcluster.png?branch=develop
8+
:target: https://travis-ci.org/aws/aws-parallelcluster/
99
:alt: Build Status
10-
.. |Version| image:: https://badge.fury.io/py/cfncluster.png
11-
:target: https://badge.fury.io/py/cfncluster
10+
.. |Version| image:: https://badge.fury.io/py/aws-parallelcluster.png
11+
:target: https://badge.fury.io/py/aws-parallelcluster
1212

13-
CfnCluster ("cloud formation cluster") is a framework that deploys and
13+
AWS ParallelCluster is a framework that deploys and
1414
maintains high performance computing clusters on Amazon Web Services
15-
(AWS). Developed by AWS, CfnCluster facilitates both quick start proof
16-
of concepts (POCs) and production deployments. CfnCluster supports
15+
(AWS). Developed by AWS, AWS ParallelCluster facilitates both quick start proof
16+
of concepts (POCs) and production deployments. AWS ParallelCluster supports
1717
many different types of clustered applications and can easily be
1818
extended to support different frameworks. The CLI is stateless,
1919
everything is done using CloudFormation or resources within AWS.\
@@ -24,7 +24,7 @@ First, install the library:
2424

2525
.. code-block:: sh
2626
27-
$ pip install cfncluster
27+
$ pip install aws-parallelcluster
2828
2929
Next, configure your aws credentials and default region:
3030

@@ -36,11 +36,11 @@ Next, configure your aws credentials and default region:
3636
Default region name [us-east-1]:
3737
Default output format [None]:
3838
39-
Then, run cfncluster configure:
39+
Then, run pcluster configure:
4040

4141
.. code-block:: ini
4242
43-
$ cfncluster configure
43+
$ pcluster configure
4444
Cluster Template [default]:
4545
AWS Access Key ID []:
4646
AWS Secret Access Key ID []:
@@ -69,14 +69,14 @@ Now you can create your first cluster;
6969

7070
.. code-block:: sh
7171
72-
$ cfncluster create myfirstcluster
72+
$ pcluster create myfirstcluster
7373
7474
7575
After the cluster finishes creating, log in:
7676

7777
.. code-block:: sh
7878
79-
$ cfncluster ssh myfirstcluster
79+
$ pcluster ssh myfirstcluster
8080
8181
You can view the running compute hosts:
8282

@@ -86,21 +86,21 @@ You can view the running compute hosts:
8686
8787
For more information on any of these steps see the `Getting Started Guide`_.
8888

89-
.. _`Getting Started Guide`: https://cfncluster.readthedocs.io/en/latest/getting_started.html
89+
.. _`Getting Started Guide`: https://aws-parallelcluster.readthedocs.io/en/latest/getting_started.html
9090

9191
Documentation
9292
-------------
9393

9494
Documentation is part of the project and is published to -
95-
https://cfncluster.readthedocs.io/. Of most interest to new users is
95+
https://aws-parallelcluster.readthedocs.io/. Of most interest to new users is
9696
the Getting Started Guide -
97-
https://cfncluster.readthedocs.io/en/latest/getting_started.html.
97+
https://aws-parallelcluster.readthedocs.io/en/latest/getting_started.html.
9898

9999
Issues
100100
------
101101

102102
Please open a GitHub issue for any feedback or issues:
103-
https://github.com/awslabs/cfncluster. There is also an active AWS
103+
https://github.com/aws/aws-parallelcluster. There is also an active AWS
104104
HPC forum which may be helpful:https://forums.aws.amazon.com/forum.jspa?forumID=192.
105105

106106
Changes
@@ -109,14 +109,14 @@ Changes
109109
CfnCluster 1.6 IAM Change
110110
=========================
111111
Between CfnCluster 1.5.4 and 1.6.0 we made a change to the CfnClusterInstancePolicy that adds “s3:GetObject” permissions
112-
on objects in <REGION>-cfncluster bucket, "autoscaling:SetDesiredCapacity", "autoscaling:DescribeTags" permissions and
113-
"cloudformation:DescribeStacks" permissions on <REGION>:<ACCOUNT_ID>:stack/cfncluster-*.
112+
on objects in <REGION>-aws-parallelcluster bucket, "autoscaling:SetDesiredCapacity", "autoscaling:DescribeTags" permissions and
113+
"cloudformation:DescribeStacks" permissions on <REGION>:<ACCOUNT_ID>:stack/aws-parallelcluster-*.
114114
115-
If you’re using a custom policy (e.g. you specify "ec2_iam_role" in your config) be sure it includes this new permission. See https://cfncluster.readthedocs.io/en/latest/iam.html
115+
If you’re using a custom policy (e.g. you specify "ec2_iam_role" in your config) be sure it includes this new permission. See https://aws-parallelcluster.readthedocs.io/en/latest/iam.html
116116

117117
CfnCluster 1.5 IAM Change
118118
=========================
119-
Between CfnCluster 1.4.2 and 1.5.0 we made a change to the CfnClusterInstancePolicy that adds “ec2:DescribeVolumes” permissions. If you’re using a custom policy (e.g. you specify "ec2_iam_role" in your config) be sure it includes this new permission. See https://cfncluster.readthedocs.io/en/latest/iam.html
119+
Between CfnCluster 1.4.2 and 1.5.0 we made a change to the CfnClusterInstancePolicy that adds “ec2:DescribeVolumes” permissions. If you’re using a custom policy (e.g. you specify "ec2_iam_role" in your config) be sure it includes this new permission. See https://aws-parallelcluster.readthedocs.io/en/latest/iam.html
120120

121121
CfnCluster 1.2 and Earlier
122122
==========================

cli/MANIFEST.in

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
recursive-include cfncluster/cloudformation *
2-
recursive-include cfncluster/examples *
3-
recursive-include cfncluster/resources *
1+
recursive-include pcluster/cloudformation *
2+
recursive-include pcluster/examples *
3+
recursive-include pcluster/resources *

cli/README

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
cfncluster is an example framework for launching clusters.
1+
pcluster is an example framework for launching clusters.
22

3-
usage: cfncluster [-h]
3+
usage: pcluster [-h]
44
{create,update,delete,start,stop,status,list,instances,ssh,configure,version}
55
...
66

7-
cfncluster is a tool to launch and manage a cluster.
7+
pcluster is a tool to launch and manage a cluster.
88

99
positional arguments:
1010
{create,update,delete,start,stop,status,list,instances,ssh,configure,version}
@@ -15,13 +15,13 @@ cfncluster is an example framework for launching clusters.
1515
stop stop the compute fleet, but leave the master server
1616
running for debugging/development
1717
status pull the current status of the cluster
18-
list display a list of stacks associated with cfncluster
18+
list display a list of stacks associated with AWS ParallelCluster
1919
instances display a list of all instances in a cluster
2020
ssh connect to the master server using SSH
21-
configure creating initial cfncluster configuration
22-
version display version of cfncluster
21+
configure creating initial pcluster configuration
22+
version display version of aws-parallelcluster
2323

2424
optional arguments:
2525
-h, --help show this help message and exit
2626

27-
For command specific flags run cfncluster [command] --help
27+
For command specific flags run pcluster [command] --help

cli/awsbatch/common.py

+23-23
Original file line numberDiff line numberDiff line change
@@ -105,25 +105,25 @@ def get_client(self, service):
105105

106106
class AWSBatchCliConfig(object):
107107
"""
108-
CfnCluster AWS Batch CLI configuration object
108+
AWS ParallelCluster AWS Batch CLI configuration object
109109
"""
110110
def __init__(self, log, cluster):
111111
"""
112112
The command will search for the [cluster cluster-name] section in the /etc/awsbatch-cli.cfg
113-
configuration file, if there, or ask to the cfncluster status
113+
configuration file, if there, or ask to the pcluster status
114114
:param log: log
115115
:param cluster: cluster name
116116
"""
117-
# Check if credentials and region have been provided in cfncluster config
117+
# Check if credentials and region have been provided in parallelcluster config
118118
self.aws_access_key_id = None
119119
self.aws_secret_access_key = None
120120
self.region = None
121-
cfncluster_config_file = os.path.expanduser(os.path.join('~', '.cfncluster', 'config'))
122-
if os.path.isfile(cfncluster_config_file):
123-
self.__init_from_cfncluster_config(cfncluster_config_file, log)
121+
parallelcluster_config_file = os.path.expanduser(os.path.join('~', '.parallelcluster', 'config'))
122+
if os.path.isfile(parallelcluster_config_file):
123+
self.__init_from_parallelcluster_config(parallelcluster_config_file, log)
124124

125125
# search for awsbatch-cli config
126-
cli_config_file = os.path.expanduser(os.path.join('~', '.cfncluster', 'awsbatch-cli.cfg'))
126+
cli_config_file = os.path.expanduser(os.path.join('~', '.parallelcluster', 'awsbatch-cli.cfg'))
127127
if os.path.isfile(cli_config_file):
128128
self.__init_from_config(cli_config_file, cluster, log)
129129
elif cluster:
@@ -152,27 +152,27 @@ def __verify_initialization(self, log):
152152
fail("Error getting cluster information from AWS CloudFormation."
153153
"Missing attribute (%s) from the output CloudFormation stack." % e)
154154

155-
def __init_from_cfncluster_config(self, cfncluster_config_file, log):
155+
def __init_from_parallelcluster_config(self, parallelcluster_config_file, log):
156156
"""
157-
init credentials object attributes from cfncluster configuration file
158-
:param cfncluster_config_file: cfncluster config
157+
init credentials object attributes from aws-parallelcluster configuration file
158+
:param parallelcluster_config_file: aws-parallelcluster config
159159
:param log: log
160160
"""
161-
with open(cfncluster_config_file) as config_file:
162-
cfncluster_config = ConfigParser()
163-
cfncluster_config.read_file(config_file)
164-
log.info("Looking for AWS credentials and region in the CfnCluster configuration file %s" %
165-
cfncluster_config_file)
161+
with open(parallelcluster_config_file) as config_file:
162+
parallelcluster_config = ConfigParser()
163+
parallelcluster_config.read_file(config_file)
164+
log.info("Looking for AWS credentials and region in the AWS ParallelCluster configuration file %s" %
165+
parallelcluster_config_file)
166166
try:
167-
self.aws_access_key_id = cfncluster_config.get('aws', 'aws_access_key_id')
167+
self.aws_access_key_id = parallelcluster_config.get('aws', 'aws_access_key_id')
168168
except (NoOptionError, NoSectionError):
169169
pass
170170
try:
171-
self.aws_secret_access_key = cfncluster_config.get('aws', 'aws_secret_access_key')
171+
self.aws_secret_access_key = parallelcluster_config.get('aws', 'aws_secret_access_key')
172172
except (NoOptionError, NoSectionError):
173173
pass
174174
try:
175-
self.region = cfncluster_config.get('aws', 'aws_region_name')
175+
self.region = parallelcluster_config.get('aws', 'aws_region_name')
176176
except (NoOptionError, NoSectionError):
177177
pass
178178

@@ -203,9 +203,9 @@ def __init_from_config(self, cli_config_file, cluster, log):
203203
pass
204204

205205
try:
206-
self.stack_name = 'cfncluster-' + cluster_name
206+
self.stack_name = 'aws-parallelcluster-' + cluster_name
207207
log.info("Stack name is (%s)" % self.stack_name)
208-
# if region is set for the current stack, override the region from the CfnCluster config file
208+
# if region is set for the current stack, override the region from the AWS ParallelCluster config file
209209
# or the region from the [main] section
210210
self.region = config.get(cluster_section, 'region')
211211
self.s3_bucket = config.get(cluster_section, 's3_bucket')
@@ -232,7 +232,7 @@ def __init_from_stack(self, cluster, log):
232232
:param log: log
233233
"""
234234
try:
235-
self.stack_name = 'cfncluster-' + cluster
235+
self.stack_name = 'aws-parallelcluster-' + cluster
236236
log.info("Describing stack (%s)" % self.stack_name)
237237
# get required values from the output of the describe-stack command
238238
# don't use proxy because we are in the client and use default region
@@ -279,12 +279,12 @@ def __init_from_stack(self, cluster, log):
279279

280280
def config_logger(log_level):
281281
"""
282-
Define a logger for cfncluster-awsbatch-cli
282+
Define a logger for aws-parallelcluster-awsbatch-cli
283283
:param log_level logging level
284284
:return: the logger
285285
"""
286286
try:
287-
logfile = os.path.expanduser(os.path.join('~', '.cfncluster', 'awsbatch-cli.log'))
287+
logfile = os.path.expanduser(os.path.join('~', '.parallelcluster', 'awsbatch-cli.log'))
288288
formatter = logging.Formatter('%(asctime)s %(levelname)s [%(module)s:%(funcName)s] %(message)s')
289289

290290
logfile_handler = RotatingFileHandler(logfile, maxBytes=5*1024*1024, backupCount=1)

cli/awsbatch/examples/awsbatch-cli.cfg

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# cfncluster-awsbatch-cli configuration file
1+
# aws-parallelcluster-awsbatch-cli configuration file
22

33
# This is an optional file.
44
# 1. If the file doesn't exist, the CLI command will expect the --cluster parameter and
@@ -28,15 +28,15 @@ region = eu-west-1
2828
# S3 bucket used to temporary store user's script before execution in the compute instances
2929
s3_bucket = <s3-bucket-name>
3030
# Compute Environment ARN
31-
compute_environment = arn:aws:batch:<region>:<account-id>:compute-environment/cfncluster-<cluster-name>
31+
compute_environment = arn:aws:batch:<region>:<account-id>:compute-environment/aws-parallelcluster-<cluster-name>
3232
# Job Queue ARN on which submit the Jobs
33-
job_queue = arn:aws:batch:<region>:<account-id>:job-queue/cfncluster-<cluster-name>
33+
job_queue = arn:aws:batch:<region>:<account-id>:job-queue/aws-parallelcluster-<cluster-name>
3434
# Job Definition ARN used for standard job submission
35-
job_definition = arn:aws:batch:<region>:<account-id>:job-definition/cfncluster-<cluster-name>:1
35+
job_definition = arn:aws:batch:<region>:<account-id>:job-definition/aws-parallelcluster-<cluster-name>:1
3636
# HTTP(S) proxy server, typically http://x.x.x.x:8080, used for internal boto3 calls
3737
proxy = NONE
3838
# Private Master IP, used internally in the job submission phase.
3939
master_ip = x.x.x.x
4040

41-
# NOTE: the CLI will also search for the credentials in the [aws] section of the CfnCluster config file
41+
# NOTE: the CLI will also search for the credentials in the [aws] section of the AWS ParallelCluster config file
4242
# If not defined, boto3 will attempt to use environment or EC2 IAM role.
File renamed without changes.

0 commit comments

Comments
 (0)