@@ -19,7 +19,16 @@ You can build higher level workflows, such as a Genomics portal that automates t
1919
2020Quick Start
2121-----------
22- First, install the library:
22+ **IMPORTANT **: you will need an **Amazon EC2 Key Pair ** to be able to complete the following steps.
23+ Please see the `Official AWS Guide <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html >`_.
24+
25+ First, make sure you have installed the `AWS Command Line Interface <http:// >`_:
26+
27+ .. code-block :: sh
28+
29+ $ pip install awscli
30+
31+ Then you can install AWS ParallelCluster:
2332
2433.. code-block :: sh
2534
@@ -35,34 +44,59 @@ Next, configure your aws credentials and default region:
3544 Default region name [us-east-1]:
3645 Default output format [None]:
3746
38- Then, run pcluster configure:
47+ Then, run ``pcluster configure ``. A list of valid options will be displayed for each
48+ configuration parameter. Type an option number and press ``Enter `` to select a specific option,
49+ or just press ``Enter `` to accept the default option.
3950
4051.. code-block :: ini
4152
4253 $ pcluster configure
43- Cluster Template [default]:
44- Acceptable Values for AWS Region ID:
45- ap-south-1
46- ...
47- us-west-2
54+ INFO: Configuration file /dir/conf_file will be written.
55+ Press CTRL-C to interrupt the procedure.
56+
57+
58+ Allowed values for AWS Region ID:
59+ 1. eu-north-1
60+ ...
61+ 15. us-west-1
62+ 16. us-west-2
4863 AWS Region ID [us-east-1]:
49- VPC Name [myvpc]:
50- Acceptable Values for Key Name:
51- keypair1
52- keypair-test
53- production-key
54- Key Name []:
55- Acceptable Values for VPC ID:
56- vpc-1kd24879
57- vpc-blk4982d
58- VPC ID []:
59- Acceptable Values for Master Subnet ID:
60- subnet-9k284a6f
61- subnet-1k01g357
62- subnet-b921nv04
63- Master Subnet ID []:
64-
65- Now you can create your first cluster;
64+ ...
65+
66+ Be sure to select a region containing the EC2 key pair you wish to use. You can also import a public key using
67+ `these instructions <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html#how-to-generate-your-own-key-and-import-it-to-aws >`_.
68+
69+ During the process you will be asked to set up your networking environment. The wizard will offer you the choice of
70+ using an existing VPC or creating a new one on the fly.
71+
72+ .. code-block :: ini
73+
74+ Automate VPC creation? (y/n) [n]:
75+
76+ Enter '``n ``' if you already have a VPC suitable for the cluster. Otherwise you can let ``pcluster configure ``
77+ create a VPC for you. The same choice is given for the subnet: you can select a valid subnet ID for
78+ both the master and compute nodes, or you can let ``pcluster configure `` set up everything for you.
79+ The same choice is given for the subnet configuration: you can select a valid subnet ID for both
80+ the master and compute nodes, or you can let pcluster configure set up everything for you.
81+ In the latter case, just select the configuration you prefer.
82+
83+ .. code-block :: ini
84+
85+ Automate Subnet creation? (y/n) [y]: y
86+ Allowed values for Network Configuration:
87+ 1. Master in a public subnet and compute fleet in a private subnet
88+ 2. Master and compute fleet in the same public subnet
89+
90+
91+ At the end of the process a message like this one will be shown:
92+
93+ .. code-block :: ini
94+
95+ Configuration file written to /dir/conf_file
96+ You can edit your configuration file or simply run ' pcluster create -c /dir/conf_file cluster-name' to create your cluster
97+
98+
99+ Now you can create your first cluster:
66100
67101.. code-block :: sh
68102
0 commit comments