Skip to content

Commit

Permalink
Adding the mailing list and updating the quickstart guide
Browse files Browse the repository at this point in the history
  • Loading branch information
alexlovelltroy committed May 9, 2024
1 parent cdaf1ec commit 2f7a5e8
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 7 deletions.
5 changes: 3 additions & 2 deletions config/_default/menus/menus.en.toml
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,11 @@
weight = 30

[[footer]]
name = "Privacy Policy"
url = "/privacy/"
name = "Join us on Slack"
url = "/slack"
weight = 10


# [[footer]]
# name = "Terms of Service"
# url = "/terms/"
Expand Down
1 change: 1 addition & 0 deletions config/_default/params.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ mainSections = ["docs", "events"]

[social]
github = "openchami"


# Doks (@hyas/doks-core)
[doks]
Expand Down
30 changes: 25 additions & 5 deletions content/guides/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ seo:
noindex: false # false (default) or true
---

OpenCHAMI has everything you need to go from bare hardware to a running cluster in a matter of minutes. In the guide below, we'll show you how to install and run the OpenCHAMI services with all the containers you need to generate an inventory of your compute nodes and boot them.
In the guide below, we'll show you how to install and run the OpenCHAMI services with all the containers you need to generate an inventory of your compute nodes and boot them.

Things move quickly, so the official guide on github may have updated information. See the [quickstart README on Github](https://github.com/OpenCHAMI/deployment-recipes/tree/main/quickstart#readme) for the most current documentation.

Happy HPC!

Expand All @@ -39,12 +41,30 @@ cd deployment-recipes/quickstart/
# This also sets the system name for your certificates. In our case, we'll call our system "foobar". The full url will be https://foobar.openchami.cluster which you can set in /etc/hosts to make life easier for you later
./generate-configs.sh foobar
# Start the services
docker compose -f base.yml -f postgres.yml -f jwt-security.yml -f haproxy-api-gateway.yml -f openchami-svcs.yml -f autocert.yml up -d
docker compose -f base.yml -f postgres.yml -f jwt-security.yml -f haproxy-api-gateway.yml -f openchami-svcs.yml -f autocert.yml up -d
# This shouldn't take too long. A minute or two depending on how long pulling containers takes.
# Once you get the prompt back, you can download the public certificate from your ca.
docker exec -it step-ca step ca root > cacert.pem
```

Once you get the prompt back, you can download the public certificate from your ca and generate your access token.
```bash {title="Obtain your rootca and tokens"}
# Assuming you're using bash as your shell, you can use the included functions to simplify interactions with your new OpenCHAMI system.
source bash_functions.sh
# Download the root ca so you can validate the ssl certificates included with your system
get_ca_cert > cacert.pem
# Create a jwt access token for use with the apis.
ACCESS_TOKEN=$(gen_access_token)
# If you're curious about that token, you can safely copy and paste it into https://jwt.io to learn more.
# Use curl to confirm that everything is working
curl --cacert cacert.pem https://foobar.openchami.cluster/login
curl --cacert cacert.pem -H "Authorization: Bearer $ACCESS_TOKEN" https://foobar.openchami.cluster/hsm/v2/State/Components
# This should respond with an empty set of Components: {"Components":[]}
```

Create a separate token that a script can use to update dnsmasq

```bash {title="Generate a dedicated token and use it with dnsmasq"}
echo "DNSMASQ_ACCESS_TOKEN=$(gen_access_token)" >> .env
docker compose -f base.yml -f postgres.yml -f jwt-security.yml -f haproxy-api-gateway.yml -f openchami-svcs.yml -f autocert.yml -f dnsmasq.yml up -d

```

Explore the environment on [Github](https://github.com/openchami/deployment-recipes/tree/main/lanl/).
Expand Down
14 changes: 14 additions & 0 deletions layouts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,24 @@ <h2 class="h4">Modularity</h2>
<section class="section section-md container-fluid bg-light">
<div class="row justify-content-center text-center">
<div class="col-lg-7">

<h2 class="mt-2">Learn more about using OpenCHAMI</h2>

<a class="btn btn-primary rounded-pill px-4 my-2" href="/docs/introduction-to-openchami/" role="button">Learn More</a>
</div>
</div>
</section>
<section class="section section-md container-fluid ">
<div class="row justify-content-center text-center">
<div class="col-lg-7">

<h2 class="mt-2">Still want more?</h2>

<div class="ml-embedded" data-form="7uAs65"></div>

</div>
</div>
</section>

{{ end }}

10 changes: 10 additions & 0 deletions layouts/partials/footer/script-footer-custom.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,14 @@
mermaid.initialize({ startOnLoad: true });
</script>
{{ end }}

<!-- MailerLite Universal -->

<script>
(function(w,d,e,u,f,l,n){w[f]=w[f]||function(){(w[f].q=w[f].q||[])
.push(arguments);},l=d.createElement(e),l.async=1,l.src=u,
n=d.getElementsByTagName(e)[0],n.parentNode.insertBefore(l,n);})
(window,document,'script','https://assets.mailerlite.com/js/universal.js','ml');
ml('account', '933245');
</script>
<!-- End MailerLite Universal -->

0 comments on commit 2f7a5e8

Please sign in to comment.