search

aws-samples / aws-parallelcluster-monitoring

Monitoring Dashboard for AWS ParallelCluster
MIT No Attribution
31 stars 23 forks source link

Add quickstart section to readme #3

Closed sean-smith closed 3 years ago

sean-smith commented 3 years ago

I'm proposing you add a small quickstart session to the README.md that has everything you need to get started, i.e.

Quickstart

Create a cluster using AWS ParallelCluster with the following configuration:

[cluster yourcluster]
...
post_install = https://raw.githubusercontent.com/aws-samples/aws-parallelcluster-monitoring/main/post-install.sh
post_install_args = https://github.com/aws-samples/aws-parallelcluster-monitoring/tarball/main,aws-parallelcluster-monitoring,install-monitoring.sh
additional_iam_policies = arn:aws:iam::aws:policy/CloudWatchFullAccess,arn:aws:iam::aws:policy/AWSPriceListServiceFullAccess,arn:aws:iam::aws:policy/AmazonSSMFullAccess,arn:aws:iam::aws:policy/AWSCloudFormationReadOnlyAccess
tags = {“Grafana” : “true”}
...

The hosting location of the post_install script could also be a release artifact, then each release would have a corresponding versioned post_install script and tar.gz.

Happy to implement this and submit it as a PR just wanted your thoughts before I get started.

nicolaven commented 3 years ago

Thanks Sean! I am totally ok with the Quickstart session.

I was also considering having a versioned post-install, we have to make sure we create the releases with the right nomenclature, and the post-install should always point to the latest release.

Please go ahead with the PR Thanks