Skip to content

Commit 3276469

Browse files
Update README.md
* Minor improvements in the description about the configuration file. * Adding a note about the prebuilt EC2 image.
1 parent a86de91 commit 3276469

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,16 @@ Creating clusters with _CloudClusters.jl_ requires specifying some configuration
2929
* a path pointed by the CLOUD_CLUSTERS_CONFIG environment variable, if it exists;
3030
* the current path.
3131

32-
Section [Configuration parameters](https://github.com/PlatformAwareProgramming/CloudClusters.jl#configuration-parameters) describes configuration parameters and how they can be overridden in programs.
33-
34-
Default configuration parameters can be overridden in programs.
32+
Section [Configuration parameters](https://github.com/PlatformAwareProgramming/CloudClusters.jl#configuration-parameters) describes default configuration parameters and how they can be overridden in programs.
3533

3634
A [_CCconfig.toml_](https://raw.githubusercontent.com/PlatformAwareProgramming/CloudClusters.jl/refs/heads/main/CCconfig.toml) file is provided in the repository's top-level directory. It is configured to create clusters using prebuilt virtual machine images for each supported cloud provider. These images are based on the latest version of Ubuntu and include a Julia installation of a recent stable version with all the packages needed to instantiate the clusters added and precompiled. Users can create customized images, possibly derived from the provided image, using their preferred version of Julia and adding the packages they need.
3735

38-
> [!NOTE]
36+
> [!WARNING]
3937
> The version of Julia on the host computer using _CloudClusters.jl_ must be the same version as the image used to deploy the clusters.
4038
39+
> [!NOTE]
40+
> The current prebuilt image for EC2 is located at the _us-east-1_ (North Virginia) region. Suppose the user is going to deploy a cluster in another region. In that case, they must create a copy of the image for that region in their account and assign their id to the ```imageid``` parameter of _CCConfig.toml_.
41+
4142
### The _PlatformAware.jl_ package
4243

4344
_CloudClusters.jl_ relies on an experimental package called [_PlatformAware.jl_](https://github.com/PlatformAwareProgramming/PlatformAware.jl) for the specification of _platform types_, aimed at specifying assumptions about architectural features of virtual machines instances. Indeed, _PlatformAware.jl_ may be used with _CloudClusters.jl_ to write functions specifically tuned according to the features of VM instances that comprise the clusters. This is called _platform-aware programming_. The users of _CloudClusters.jl_, particularly package developers, are invited to explore and use the ideas behind _PlatformAware.jl_.

0 commit comments

Comments
 (0)