Skip to content

Commit 5f4a85e

Browse files
Update README.md
In "How to create a cluster", a better explanation of the meaning of EC2Type_T3_xLarge identifier in the example of the @cluster command and how to list instance types declared in PlatformAware.jl by using the subtypes function.
1 parent 161ac33 commit 5f4a85e

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,8 @@ _A package for creating, using, and managing clusters of virtual machine (VM) in
1313

1414
_CloudClusters.jl_ targets Julia programming language users who need on-demand access to cutting-edge computing resources that IaaS cloud providers provide to meet high-performance computing (HPC) application requirements.
1515

16-
1716
## Pre-requisites
1817

19-
2018
### Cloud providers' credentials
2119

2220
Even though _CloudClusters.jl_ currently only supports AWS EC2, it plans to support multiple IaaS cloud providers in the future.
@@ -71,13 +69,14 @@ First, let's try a simple scenario where a user creates a cluster comprising fou
7169

7270
```julia
7371
using CloudClusters
74-
using PlatformAware
7572

76-
my_first_cluster_contract = @cluster node_count => 4 node_machinetype => EC2Type_T3_xLarge
73+
my_first_cluster_contract = @cluster node_count => 4 node_machinetype => PlatformAware.EC2Type_T3_xLarge
7774

7875
```
76+
```EC2Type_T3_xLarge``` is a Julia type from the _PlatformAware.jl_ package that represents the ___t3.xlarge___ of EC2. _PlatformAware.jl_ offers a hierarchy of types representing instance types of supported providers (e.g., ```MachineType``````EC2Type``````EC2Type_T3``````EC2Type_T3_xLarge```).
77+
For example, the user may list all the supported EC2 instance types by executing ```subtypes(PlatformAware.EC2Type)``` in the REPL, or ```subtypes(PlatformAware.EC2Type_T3)``` if the user intends to list only ___t3___ instance types.
7978

80-
Using __@cluster__ is not sufficient to instantiate the cluster. It creates a _cluster contract_ and returns a handle for it. In the example, the _contract handle_ is stored in the _my_first_cluster_contract_ variable, from which the user can create one or more clusters later.
79+
__@cluster__ does not instantiate a cluster yet. It creates a _cluster contract_ and returns a handle for it. In the example, the _contract handle_ is stored in the _my_first_cluster_contract_ variable, from which the user can create one or more clusters later.
8180

8281
> [!NOTE]
8382
> In _CloudClusters.jl_, a handle is a symbol comprising 15 randomly calculated lower and upper case alphabetic characters (e.g.,```:FXqElAnSeTEpQAm``` ). As symbols, they are printable and may be used directly to refer to a cluster contract.

0 commit comments

Comments
 (0)