<p>Discussion about this site, its organization, how it works, and how we can improve it.</p>

About the Site Feedback category

<p>(Replace this first paragraph with a brief description of your new category. This guidance will appear in the category selection area, so try to keep it below 200 characters.)</p>
<p>Use the following paragraphs for a longer description, or to establish category guidelines or rules:</p>
<ul>
<li>
<p>Why should people use this category? What is it for?</p>
</li>
<li>
<p>How exactly is this different than the other categories we already have?</p>
</li>
<li>
<p>What should topics in this category generally contain?</p>
</li>
<li>
<p>Do we need this category? Can we merge with another category, or subcategory?</p>
</li>
</ul>

About the slurm-charms category

<p>Omnivector’s slurm charms support exporting cluster metrics to prometheus via the <code>prometheus</code> endpoint. Follow along below to understand better how this works.</p>
<h4>Deploy Slurm on LXD</h4>
<p>Get a local slurm deploy up and running:</p>
<pre><code class="lang-bash">sudo snap install lxd
sudo snap install juju --classic

git clone https://github.com/omnivector-solutions/slurm-charms -b add_prometheus_exporter &amp;&amp; \
    cd slurm-charms
make charms
make deploy-focal-bundle-on-lxd-from-edge-with-snap-prometheus
</code></pre>
<p>The deployment should take a few moments to complete, once everything is ready to go, <code>juju status</code> should resemble:</p>
<pre><code class="lang-bash">Model  Controller           Cloud/Region         Version  SLA          Timestamp
test   localhost-localhost  localhost/localhost  2.8.1    unsupported  00:51:26Z

App              Version  Status  Scale  Charm            Store       Rev  OS      Notes
percona-cluster  5.7.20   active      1  percona-cluster  jujucharms  291  ubuntu
slurmctld        20.02.1  active      1  slurmctld        local         8  ubuntu
slurmd           20.02.1  active      1  slurmd           local         3  ubuntu
slurmdbd         20.02.1  active      1  slurmdbd         local         3  ubuntu

Unit                Workload  Agent  Machine  Public address  Ports               Message
percona-cluster/3*  active    idle   16       10.232.132.14   3306/tcp            Unit is ready
slurmctld/7*        active    idle   25       10.232.132.28                       Slurmctld Available
slurmd/3*           active    idle   18       10.232.132.20                       Slurmd Available
slurmdbd/3*         active    idle   19       10.232.132.27                       Slurmdbd Available

Machine  State    DNS             Inst id         Series  AZ  Message
16       started  10.232.132.14   juju-58dca4-16  bionic      Running
18       started  10.232.132.20   juju-58dca4-18  focal       Running
19       started  10.232.132.27   juju-58dca4-19  focal       Running
25       started  10.232.132.28   juju-58dca4-25  focal       Running
</code></pre>
<p>After the slurm deployment settles, add the prometheus2 and grafana charms to the model.</p>
<pre><code class="lang-bash">juju deploy prometheus2
juju deploy grafana
juju relate prometheus2:grafana-source grafana
</code></pre>
<p>Now relate <code>slurmctld</code> to <code>prometheus2</code>.</p>
<pre><code class="lang-bash">juju relate slurmctld prometheus2
</code></pre>
<p>Following these operations, your should have a juju model that resembles the following:</p>
<pre><code class="lang-bash">juju status --relations
</code></pre>
<pre><code class="lang-bash">Model  Controller           Cloud/Region         Version  SLA          Timestamp
test   localhost-localhost  localhost/localhost  2.8.1    unsupported  00:51:26Z

App              Version  Status  Scale  Charm            Store       Rev  OS      Notes
grafana                   active      1  grafana          jujucharms   37  ubuntu
percona-cluster  5.7.20   active      1  percona-cluster  jujucharms  291  ubuntu
prometheus2               active      1  prometheus2      jujucharms   19  ubuntu
slurmctld        20.02.1  active      1  slurmctld        local         8  ubuntu
slurmd           20.02.1  active      1  slurmd           local         3  ubuntu
slurmdbd         20.02.1  active      1  slurmdbd         local         3  ubuntu

Unit                Workload  Agent  Machine  Public address  Ports               Message
grafana/0*          active    idle   26       10.232.132.214  3000/tcp            Started grafana-server
percona-cluster/3*  active    idle   16       10.232.132.14   3306/tcp            Unit is ready
prometheus2/1*      active    idle   21       10.232.132.110  9090/tcp,12321/tcp  Ready
slurmctld/7*        active    idle   25       10.232.132.28                       Slurmctld Available
slurmd/3*           active    idle   18       10.232.132.20                       Slurmd Available
slurmdbd/3*         active    idle   19       10.232.132.27                       Slurmdbd Available

Machine  State    DNS             Inst id         Series  AZ  Message
16       started  10.232.132.14   juju-58dca4-16  bionic      Running
18       started  10.232.132.20   juju-58dca4-18  focal       Running
19       started  10.232.132.27   juju-58dca4-19  focal       Running
21       started  10.232.132.110  juju-58dca4-21  focal       Running
25       started  10.232.132.28   juju-58dca4-25  focal       Running
26       started  10.232.132.214  juju-58dca4-26  focal       Running

Relation provider           Requirer                 Interface        Type     Message
percona-cluster:cluster     percona-cluster:cluster  percona-cluster  peer
percona-cluster:db          slurmdbd:db              mysql            regular
prometheus2:grafana-source  grafana:grafana-source   grafana-source   regular
slurmctld:prometheus        prometheus2:scrape       prometheus       regular
slurmd:slurmd               slurmctld:slurmd         slurmd           regular
slurmdbd:slurmdbd           slurmctld:slurmdbd       slurmdbd         regular
</code></pre>
<p>Notice the relation</p>
<pre><code class="lang-auto">slurmctld:prometheus        prometheus2:scrape       prometheus       regular
</code></pre>
<p>This is what enables slurmctld to inform prometheus of its scrape endpoint.</p>
<p>Now that the juju environment has been configured, login to the grafana dashboard and import the prometheus-slurm-exporter dashboard to get started.</p>
<h5>Import the prometheus-slurm-exporter dashboard</h5>
<p>From the grafana ui, click the import dashboard button<br>
<img src="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/original/1X/e2a9d06d6e598dabd6d949d6ec9cf74cba9b6bb5.png" alt="Screen Shot 2020-08-16 at 5.42.09 PM" data-base62-sha1="wl9JtA8y8fhUcigFIEVZTkrB4GN" width="376" height="328"></p>
<p>Import the grafana dashboard with id <code>4323</code> and choose the prometheus2 datasource.<br>
<div class="lightbox-wrapper"><a class="lightbox" href="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/original/1X/b63acc9c04dd53a4752112c8cc205cc370232e29.png" data-download-href="/uploads/short-url/q04Sl3Ck4icW0pLOVylBKPotXRL.png?dl=1" title="Screen Shot 2020-08-16 at 5.42.29 PM"><img src="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/b63acc9c04dd53a4752112c8cc205cc370232e29_2_690x446.png" alt="Screen Shot 2020-08-16 at 5.42.29 PM" data-base62-sha1="q04Sl3Ck4icW0pLOVylBKPotXRL" width="690" height="446" srcset="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/b63acc9c04dd53a4752112c8cc205cc370232e29_2_690x446.png, https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/original/1X/b63acc9c04dd53a4752112c8cc205cc370232e29.png 1.5x, https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/original/1X/b63acc9c04dd53a4752112c8cc205cc370232e29.png 2x" data-small-upload="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/b63acc9c04dd53a4752112c8cc205cc370232e29_2_10x10.png"><div class="meta"><svg class="fa d-icon d-icon-far-image svg-icon" aria-hidden="true"><use xlink:href="#far-image"></use></svg><span class="filename">Screen Shot 2020-08-16 at 5.42.29 PM</span><span class="informations">936×606 31.7 KB</span><svg class="fa d-icon d-icon-discourse-expand svg-icon" aria-hidden="true"><use xlink:href="#discourse-expand"></use></svg></div></a></div></p>
<p>After importing the dashboard, you should be redirected to a page with some pre-made visualizations that are populated with information coming from the <code>prometheus-slurm-exporter</code> running on the <code>slurmctld</code> node.<br>
<div class="lightbox-wrapper"><a class="lightbox" href="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/original/1X/2db21e915022995ac5842b118c0dfbe76c5ffa30.png" data-download-href="/uploads/short-url/6wf6wwruMpRuKFob4Po6QYeYaiI.png?dl=1" title="Screen Shot 2020-08-16 at 5.41.41 PM"><img src="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/2db21e915022995ac5842b118c0dfbe76c5ffa30_2_690x331.png" alt="Screen Shot 2020-08-16 at 5.41.41 PM" data-base62-sha1="6wf6wwruMpRuKFob4Po6QYeYaiI" width="690" height="331" srcset="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/2db21e915022995ac5842b118c0dfbe76c5ffa30_2_690x331.png, https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/2db21e915022995ac5842b118c0dfbe76c5ffa30_2_1035x496.png 1.5x, https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/2db21e915022995ac5842b118c0dfbe76c5ffa30_2_1380x662.png 2x" data-small-upload="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/2db21e915022995ac5842b118c0dfbe76c5ffa30_2_10x10.png"><div class="meta"><svg class="fa d-icon d-icon-far-image svg-icon" aria-hidden="true"><use xlink:href="#far-image"></use></svg><span class="filename">Screen Shot 2020-08-16 at 5.41.41 PM</span><span class="informations">1921×924 104 KB</span><svg class="fa d-icon d-icon-discourse-expand svg-icon" aria-hidden="true"><use xlink:href="#discourse-expand"></use></svg></div></a></div></p>
<p>You can immediately start to create your own visualizations for metrics you care about by adding another panel to the dashboard and selecting your data point from the scrape metrics being returned by the prometheus-slurm-exporter.<br>
<img src="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/original/1X/590bbc9abd17872e9e304dd3ba5e9451b0f754e4.png" alt="Screen Shot 2020-08-16 at 6.01.06 PM" data-base62-sha1="cHJDITp5IjE6Ma64omIlLnemch6" width="459" height="324"></p>
<p>We are excited to hear about user experiences, so don’t be afraid to reach out and say hello!</p>
<p>Thank you!</p>

Prometheus-Slurm-Exporter Integration

<p>Over the past few months we have been working on a rewrite of the <a href="https://github.com/omnivector-solutions/slurm-charms">slurm-charms</a> and an initial release of the <a href="https://github.com/omnivector-solutions/snap-slurm">slurm snap</a>. We have assembled a beta release of the new stack. Follow the directions below to get started.</p>
<p>The following demo uses LXD as the underlying cloud on which the slurm charms are deployed.</p>
<h4>Technologies used</h4>
<ul>
<li><a href="https://snapcraft.io">snapcraft</a></li>
<li><a href="https://juju.is">juju</a></li>
<li><a href="https://linuxcontainers.org/">lxd</a></li>
</ul>
<h4>Install and Bootstrap Juju</h4>
<p>Install the <code>juju</code> snap and use it to bootstrap a lxd cloud</p>
<pre><code class="lang-bash">sudo snap install juju --classic

juju bootstrap localhost
</code></pre>
<h4>Deploy the Slurm Charms</h4>
<p>Clone the <a href="https://github.com/omnivector-solutions/slurm-charms">slurm-charms</a> repo and run the <code>make</code> command to pull down and deploy the charms to the localhost/lxd cloud we just bootstrapped.<br>
The following command will pull down the slurm charms (and snap) and deploy them in LXD containers on your local machine.</p>
<pre><code class="lang-bash">git clone https://github.com/omnivector-solutions/slurm-charms &amp;&amp; cd slurm-charms
make deploy-focal-bundle-on-lxd-from-edge-with-snap
</code></pre>
<h4>What’s under the hood?</h4>
<p>When you run the <code>make</code> command above, the provided script pulls down the slurm charms from our public s3 bucket, pulls the slurm snap from github and deploys them to the local cloud using the juju charm bundle contained with in the slurm-charms codebase.</p>
<h4>Run juju status to find out what is going on</h4>
<pre><code class="lang-bash">juju status
</code></pre>
<p>The above command will provide some high level detail of what is happening in our juju model.</p>
<p>To <code>watch</code> your slurm deployment from <code>juju</code>'s perspective you can use the following command.</p>
<pre><code class="lang-bash">watch -n 0.5 -c juju status --color
</code></pre>
<p>Which should provide some “real time” information about the applications as they come up.</p>
<p>For example, a few moments after running the <code>make</code> command my <code>juju status</code> resembles</p>
<pre><code class="lang-bash">Model       Controller           Cloud/Region         Version  SLA          Timestamp
slurm-core  localhost-localhost  localhost/localhost  2.8.1    unsupported  18:52:32Z

App              Version  Status   Scale  Charm            Store       Rev  OS      Notes
percona-cluster  5.7.20   waiting      1  percona-cluster  jujucharms  290  ubuntu
slurmctld                 waiting    0/1  slurmctld        local         0  ubuntu
slurmd                    waiting    0/1  slurmd           local         0  ubuntu
slurmdbd                  waiting    0/1  slurmdbd         local         0  ubuntu

Unit                Workload  Agent       Machine  Public address  Ports  Message
percona-cluster/0*  waiting   executing   0        10.232.132.249         (config-changed) Unit waiting to bootstrap
slurmctld/0         waiting   allocating  1        10.232.132.74          installing agent
slurmd/0            waiting   allocating  2        10.232.132.50          waiting for machine
slurmdbd/0          waiting   allocating  3        10.232.132.8           installing agent

Machine  State    DNS             Inst id        Series  AZ  Message
0        started  10.232.132.249  juju-5b78e4-0  bionic      Running
1        started  10.232.132.74   juju-5b78e4-1  focal       Running
2        pending  10.232.132.50   juju-5b78e4-2  focal       Running
3        started  10.232.132.8    juju-5b78e4-3  focal       Running
</code></pre>
<p>But after a few more moments as the services come up and configure themselves <code>juju status</code> will show applications with <code>active</code> status and <code>idle</code> workload state.</p>
<pre><code class="lang-bash">Model       Controller           Cloud/Region         Version  SLA          Timestamp
slurm-core  localhost-localhost  localhost/localhost  2.8.1    unsupported  19:00:03Z

App              Version  Status  Scale  Charm            Store       Rev  OS      Notes
percona-cluster  5.7.20   active      1  percona-cluster  jujucharms  290  ubuntu
slurmctld        20.02.1  active      1  slurmctld        local         0  ubuntu
slurmd           20.02.1  active      1  slurmd           local         0  ubuntu
slurmdbd         20.02.1  active      1  slurmdbd         local         0  ubuntu

Unit                Workload  Agent  Machine  Public address  Ports     Message
percona-cluster/0*  active    idle   0        10.232.132.249  3306/tcp  Unit is ready
slurmctld/0*        active    idle   1        10.232.132.74             Slurmctld Available
slurmd/0*           active    idle   2        10.232.132.50             Slurmd Available
slurmdbd/0*         active    idle   3        10.232.132.8              Slurmdbd Available

Machine  State    DNS             Inst id        Series  AZ  Message
0        started  10.232.132.249  juju-5b78e4-0  bionic      Running
1        started  10.232.132.74   juju-5b78e4-1  focal       Running
2        started  10.232.132.50   juju-5b78e4-2  focal       Running
3        started  10.232.132.8    juju-5b78e4-3  focal       Running
</code></pre>

Deploy OmniVector&rsquo;s Slurm Core

Deploy OmniVector's Slurm Core

<h2>To create a new account in Jobbergate, follow these steps:</h2>
<blockquote>
<ol>
<li>
<p>Visit <a href="https://www.jobbergate.io/signup">https://www.jobbergate.io/signup</a></p>
</li>
<li>
<p>Fill in your First Name, Last Name, Email Address, password and click the “Sign up” button.</p>
</li>
<li>
<p>You will receive an email with a link to verify your address. Click this link and follow the prompts on screen to complete your registration.</p>
</li>
</ol>
</blockquote>
<h2>New users have no permissions:</h2>
<blockquote>
<p>A system administrator must login to the admin console and add the appropriate permissions to each new user.</p>
</blockquote>
<p>Please contact your system administrator or <a href="https://support@omnivector.solutions">support@omnivector.solutions</a> for additional support.</p>
<p><div class="lightbox-wrapper"><a class="lightbox" href="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/original/1X/ca007aa1fe1ff137ff39b555d6cfb1645531e4ea.jpeg" data-download-href="/uploads/short-url/sOZttgSArxSNQMQwsVQyK5yvEWS.jpeg?dl=1" title="sign-up-flow"><img src="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/ca007aa1fe1ff137ff39b555d6cfb1645531e4ea_2_386x499.jpeg" alt="sign-up-flow" data-base62-sha1="sOZttgSArxSNQMQwsVQyK5yvEWS" width="386" height="499" srcset="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/ca007aa1fe1ff137ff39b555d6cfb1645531e4ea_2_386x499.jpeg, https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/ca007aa1fe1ff137ff39b555d6cfb1645531e4ea_2_579x748.jpeg 1.5x, https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/ca007aa1fe1ff137ff39b555d6cfb1645531e4ea_2_772x998.jpeg 2x" data-small-upload="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/ca007aa1fe1ff137ff39b555d6cfb1645531e4ea_2_10x10.png"><div class="meta"><svg class="fa d-icon d-icon-far-image svg-icon" aria-hidden="true"><use xlink:href="#far-image"></use></svg><span class="filename">sign-up-flow</span><span class="informations">1224×1584 61.2 KB</span><svg class="fa d-icon d-icon-discourse-expand svg-icon" aria-hidden="true"><use xlink:href="#discourse-expand"></use></svg></div></a></div></p>

Jobbergate: Self Sign up

<h2>To create a new permission group in Jobbergate, follow these steps:</h2>
<blockquote>
<ol>
<li>
<p>Log in at: <a href="https://jobbergate-api-production.omnivector.solutions/admin/">https://jobbergate-api-production.omnivector.solutions/admin/</a></p>
</li>
<li>
<p>Click the Add button to create a new group:<br>
<img src="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/original/1X/16357551406187cba85b8274dcb2d8ad4a0e9ca4.png" alt="Screen Shot 2020-11-02 at 4.34.12 PM" data-base62-sha1="3at2mIm07QXjPZXdpsHv3JXqKa0" width="626" height="83"></p>
</li>
<li>
<p>Give the new Group a name:<br>
<img src="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/original/1X/d0af0bf7561b2f943432eb5d6d854ffd2ba78940.png" alt="Screen Shot 2020-11-02 at 4.36.22 PM" data-base62-sha1="tM6lGw2aHRnNkjAg06qUiUFssvu" width="534" height="48"></p>
</li>
<li>
<p>Choose permissions from the Available permissions list by selecting one or many and clicking the choose button:<br>
<div class="lightbox-wrapper"><a class="lightbox" href="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/original/1X/2976956c146555574f6565c5eca8676a542532ac.png" data-download-href="/uploads/short-url/5UNDIFiJCbGrQ9cUUh17ULIAPvu.png?dl=1" title="Screen Shot 2020-11-02 at 5.06.55 PM"><img src="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/2976956c146555574f6565c5eca8676a542532ac_2_690x255.png" alt="Screen Shot 2020-11-02 at 5.06.55 PM" data-base62-sha1="5UNDIFiJCbGrQ9cUUh17ULIAPvu" width="690" height="255" srcset="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/2976956c146555574f6565c5eca8676a542532ac_2_690x255.png, https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/original/1X/2976956c146555574f6565c5eca8676a542532ac.png 1.5x, https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/original/1X/2976956c146555574f6565c5eca8676a542532ac.png 2x" data-small-upload="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/2976956c146555574f6565c5eca8676a542532ac_2_10x10.png"><div class="meta"><svg class="fa d-icon d-icon-far-image svg-icon" aria-hidden="true"><use xlink:href="#far-image"></use></svg><span class="filename">Screen Shot 2020-11-02 at 5.06.55 PM</span><span class="informations">1028×381 44.6 KB</span><svg class="fa d-icon d-icon-discourse-expand svg-icon" aria-hidden="true"><use xlink:href="#discourse-expand"></use></svg></div></a></div></p>
</li>
<li>
<p>Click Save<br>
<img src="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/original/1X/a9dda3ca9e94c656dd3bc6c3f170ab0584f00d2b.png" alt="Screen Shot 2020-11-02 at 4.39.46 PM" data-base62-sha1="oeHyk4IrUT42opBs8sTkVjzkNJh" width="539" height="78"></p>
</li>
<li>
<p>Your new group is now available to be assigned to users in the “Change user” screen. See the <a href="https://community.omnivector.solutions/t/jobbergate-admin-assign-user-permissions/77">Assign User Permissions</a> topic for more details.</p>
</li>
</ol>
</blockquote>
<p>Please contact <a href="https://support@omnivector.solutions">support@omnivector.solutions</a> for additional support.</p>

Jobbergate Admin: Manage Permission Groups

<h2>To assign permission groups in Jobbergate, follow these steps:</h2>
<blockquote>
<ol>
<li>
<p>Log in at: <a href="https://jobbergate-api-production.omnivector.solutions/admin/">https://jobbergate-api-production.omnivector.solutions/admin/</a></p>
</li>
<li>
<p>Click the Change button:<br>
<img src="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/original/1X/4f892d0edc2b69f9b17e3373e34975616919473c.png" alt="Screen Shot 2020-11-02 at 4.47.18 PM" data-base62-sha1="blBCl9K1qaB786ulbe0ep42O3Zq" width="642" height="80"></p>
</li>
<li>
<p>Use filters to find the account you want to change and click on the email address:<br>
<div class="lightbox-wrapper"><a class="lightbox" href="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/original/1X/3752c132d23b7cab88060615945bd8bc9fe855af.png" data-download-href="/uploads/short-url/7TpyQbpTFVHulhIvUkytXmV5DFZ.png?dl=1" title="Screen Shot 2020-11-02 at 4.48.50 PM"><img src="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/3752c132d23b7cab88060615945bd8bc9fe855af_2_690x117.png" alt="Screen Shot 2020-11-02 at 4.48.50 PM" data-base62-sha1="7TpyQbpTFVHulhIvUkytXmV5DFZ" width="690" height="117" srcset="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/3752c132d23b7cab88060615945bd8bc9fe855af_2_690x117.png, https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/3752c132d23b7cab88060615945bd8bc9fe855af_2_1035x175.png 1.5x, https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/3752c132d23b7cab88060615945bd8bc9fe855af_2_1380x234.png 2x" data-small-upload="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/3752c132d23b7cab88060615945bd8bc9fe855af_2_10x10.png"><div class="meta"><svg class="fa d-icon d-icon-far-image svg-icon" aria-hidden="true"><use xlink:href="#far-image"></use></svg><span class="filename">Screen Shot 2020-11-02 at 4.48.50 PM</span><span class="informations">1801×307 22.4 KB</span><svg class="fa d-icon d-icon-discourse-expand svg-icon" aria-hidden="true"><use xlink:href="#discourse-expand"></use></svg></div></a></div></p>
</li>
<li>
<p>Scroll down to the groups section and add one or more permission groups to the users account:<br>
<div class="lightbox-wrapper"><a class="lightbox" href="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/original/1X/8ef7a76dc035db85ea69c5f6fe7bae1e64279296.png" data-download-href="/uploads/short-url/koKoCpW27rr4BubBcdnWxWnhwlo.png?dl=1" title="Screen Shot 2020-11-02 at 4.50.32 PM"><img src="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/8ef7a76dc035db85ea69c5f6fe7bae1e64279296_2_690x219.png" alt="Screen Shot 2020-11-02 at 4.50.32 PM" data-base62-sha1="koKoCpW27rr4BubBcdnWxWnhwlo" width="690" height="219" srcset="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/8ef7a76dc035db85ea69c5f6fe7bae1e64279296_2_690x219.png, https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/8ef7a76dc035db85ea69c5f6fe7bae1e64279296_2_1035x328.png 1.5x, https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/original/1X/8ef7a76dc035db85ea69c5f6fe7bae1e64279296.png 2x" data-small-upload="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/optimized/1X/8ef7a76dc035db85ea69c5f6fe7bae1e64279296_2_10x10.png"><div class="meta"><svg class="fa d-icon d-icon-far-image svg-icon" aria-hidden="true"><use xlink:href="#far-image"></use></svg><span class="filename">Screen Shot 2020-11-02 at 4.50.32 PM</span><span class="informations">1172×373 17.9 KB</span><svg class="fa d-icon d-icon-discourse-expand svg-icon" aria-hidden="true"><use xlink:href="#discourse-expand"></use></svg></div></a></div></p>
</li>
<li>
<p>Scroll to the bottom of the page and click save:<br>
<img src="https://aws1.discourse-cdn.com/standard10/uploads/omnivector2/original/1X/a9dda3ca9e94c656dd3bc6c3f170ab0584f00d2b.png" alt="Screen Shot 2020-11-02 at 4.39.46 PM" data-base62-sha1="oeHyk4IrUT42opBs8sTkVjzkNJh" width="404" height="58"></p>
</li>
</ol>
</blockquote>
<p>Please contact <a href="https://support@omnivector.solutions">support@omnivector.solutions</a> for additional support.</p>

Jobbergate Admin: Assign User Permissions

<h3>jobbergate.yaml template with required fields:</h3>
<h4>required items in config:</h4>
<ul>
<li>
<code>default_template:</code> This is the job script to be rendered. It is saved as <code>application.sh</code> and executed on  <code>create-job-submission</code> for the associated job-script-id</li>
<li>
<code>supporting_files:</code> This is a list of any additional files that need to be rendered</li>
<li>
<code>supporting_files_output_name:</code> This maps the template from <code>supporting_files</code> to a filename expected by the jobbergate application</li>
<li>
<code>application_config:</code> any application specific parameters belong here</li>
</ul>
<pre><code class="lang-auto">jobbergate_config: 
  default_template: "templates/template.j2"
  supporting_files:
    - "templates/templates_b.j2"
    - "templates/templates_c.j2"
  supporting_files_output_name:
    "templates/templates_b.j2":
      - "template_rendered_b.py"
    "templates/templates_c.j2":
      - "template_rendered_c.py"
application_config: {}
</code></pre>

Jobbergate Application Config: jobbergate.yaml

<h4>Create Job Submission</h4>
<p><strong>Note:</strong> the ID is the Job Script ID that this job submission will execute. (“76” in this example)</p>
<pre><code>jobbergate-cli create-job-submission --name hello_world --id 76
</code></pre>
<h4>You should see the following output:</h4>
<pre><code>-------------------------------  ---------------------------
id                               25
job_submission_name              hello_world
job_submission_description       TEST_DESC
job_submission_owner             2
job_script                       6
created_at                       2020-08-04T17:48:08.132138Z
updated_at                       2020-08-04T17:48:08.132165Z
</code></pre>
<h4>Inspect the job using slurm primitives</h4>
<p>The <code>sacct</code> command will show information about submitted jobs. Run the <code>sacct</code> command and look for the job id of the job we just submitted.</p>
<pre><code>$ sacct

       JobID    JobName  Partition    Account  AllocCPUS      State ExitCode
------------ ---------- ---------- ---------- ---------- ---------- --------
</code></pre>
<p>The <code>sreport</code> command will show detailed information about a specific job. Run the <code>sreport</code> command supplying the target job id to get a detailed view of the job.</p>
<pre><code>$ sreport</code></pre>

Submit a job-script to Slurm using Jobbergate CLI

<p>Jobbergate development workflow is the developer facing process by which jobbergate is developed.</p>
<p>There are two primary codebases that comprise the jobbergate project:</p>
<ul>
<li><a href="https://github.com/omnivector-solutions/jobbergate-api">jobbergate-api</a></li>
<li><a href="https://github.com/omnivector-solutions/jobbergate-cli">jobbergate-cli</a></li>
</ul>
<h4>Development Workflow</h4>
<p>The development workflow for jobbergate-cli and jobbergate-api are fairly similar, but differ in a few ways also. Both jobbergate-api and jobbergate-cli use circleci to run tests and gate against code making it into master branch that doesn’t pass. The cicd for jobbergate-api will deploy the code in the pr to the jobbergate-api staging stack <a href="https://jobbergate-api-staging.omnivector.solutions">https://jobbergate-api-staging.omnivector.solutions</a> (currently an internal/private endpoint at the time of writing).</p>
<h5>jobbergate-cli</h5>
<h5>jobbergate-api</h5>

Jobbergate Development Workflow

<p>This post is part 3 of getting started using Jobbergate CLI. You will need to have the <a href="https://community.omnivector.solutions/t/jobbergate-cli-setup-and-installation/18">CLI installed</a> and have at least one <a href="https://community.omnivector.solutions/t/create-jobbergate-hello-world-application/27">application</a> registered in Jobbergate.</p>
<h4>Create Job Script</h4>
<p><strong>Note:</strong>  the ID parameter is the application ID the Job Script will be linked to.  <em>(“38” in this example)</em></p>
<pre><code class="lang-auto">jobbergate-cli create-job-script \
   --name hello_world \
   --param-file jobbergate-hello-world-application/config.json \
   --id 38
</code></pre>
<p><strong>Note:</strong>  job_script_data_as_string allows the user to review any application files or job scripts rendered with values from the parameter file passed (config.json).</p>
<pre><code class="lang-auto">-------------------------  ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
id                         76
job_script_name            hello_world
job_script_description     TEST_DESC
job_script_data_as_string  NEW_FILE
                           print('hello world from application.py')

                           print('{} executed successfully'.format("Jobbergate-Hello-World"))
                           NEW_FILE
                           #!/bin/sh
                           echo "Hellow World"

                           echo "parameters passed to config file:"
                           {'default_template': 'job-script-template.sh.j2', 'supporting_files': ['application-file-template.j2'], 'supporting_files_output_name': {'application-file-template.j2': 'application.py'}, 'output_directory': '.', 'jobname': 'Jobbergate-Hello-World'}

                           # execute example application.py file
                           python application.py
job_script_owner           2
application                38
created_at                 2020-08-06T15:25:03.577359Z
updated_at                 2020-08-06T15:25:03.577384Z
-------------------------  ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
</code></pre>
<ol start="2">
<li>
<h4>(optional):</h4>
</li>
</ol>
<p><strong>a.</strong>  edit the parameter file (config.json) with your own values and re run the  <code>create-job-script</code>  command above to view the output with new values you added<br>
<strong>b.</strong>  Add a field of your choice to the parameter file (config.json) and edit the job script template (  <code>job-script-template.sh.j2</code>  ) and/or the application file (  <code>application-file-template.j2</code>  ) to use the new field</p>

Create a jobbergate job-script using jobbergate-cli

<p>This post is part 1 of getting started using Jobbergate CLI and details the initial install and setup. In <a href="https://community.omnivector.solutions/t/create-a-jobbergate-job-script-using-jobbergate-cli/36">part 2</a> we walk you through creating a simple Hello World application.</p>
<h2>Setup and Install Steps</h2>
<ol>
<li>
<h4>Virtual Environment</h4>
<p>It is recommended that the user start with a python virtual environment as a workspace for these operations. Details on how to set up a virtual environment can be found <a href="https://docs.python-guide.org/dev/virtualenvs/">here.</a></p>
</li>
<li>
<h4>Install CLI</h4>
<p>Install the jobbergate-cli as a python package from the Omnivector github repo with:</p>
<blockquote>
<p><code>$ pip install git+https://github.com/omnivector-solutions/jobbergate-cli.git</code></p>
</blockquote>
<ul>
<li>If jobbergate-cli returns <code>command not found</code>:
<ul>
<li>Get Location with: <code>$ pip show jobbergate-cli</code>
</li>
<li>Add Location to PATH</li>
</ul>
</li>
</ul>
</li>
<li>
<h4>Confirm install</h4>
<p>Confirm jobbergate-cli install was successful with:</p>
<blockquote>
<p><code>$ jobbergate-cli</code></p>
</blockquote>
<h4>You should see an output of:</h4>
<blockquote>
<pre><code>Usage: jobbergate-cli [OPTIONS] COMMAND [ARGS]...

  ctx --&gt; context @click.pass_context makes username, password, token and
  user_id available to the other cmd

Options:
  -u, --username TEXT  Your Jobbergate API Username
  -p, --password TEXT  Your Jobbergate API password
  --help               Show this message and exit.

Commands:
  create-application
  create-job-script
  create-job-submission
  delete-application
  delete-job-script
  delete-job-submission
  get-application
  get-job-script
  get-job-submission
  list-applications
  list-job-scripts
  list-job-submissions
  update-application
  update-job-script
  update-job-submission
</code></pre>
</blockquote>
</li>
<li>
<h4>Authentication</h4>
<p>User will need API credentials to perform operations - process to automate set up and manage users is TBD</p>
</li>
<li>
<h4>Confirm setup and authentication was successful with</h4>
<blockquote>
<p><code>$ jobbergate-cli list-applications</code></p>
</blockquote>
</li>
</ol>
<h4>Output should be a list of applications created similar to:</h4>
<pre><code>
 id  application_name           application_description    application_location                                                                            application_dir_listing    application_dir_listing_acquired      application_owner  created_at                   updated_at
----  -------------------------  -------------------------  ----------------------------------------------------------------------------------------------  -------------------------  ----------------------------------  -------------------  ---------------------------  ---------------------------
  35  hello_world                TEST_DESC                  jobbergate-resources/2/11b76a7f-16ee-4aaa-be57-3c9677635f2c/application.tar.gz                  TEST_DIR_LISTING           True                                                  2  2020-08-05T20:53:48.651464Z  2020-08-05T20:53:48.651492Z
  36  hello_world                TEST_DESC                  jobbergate-resources/2/a311bcfc-f9ca-4d78-a03d-d2e8ff3b7efd/application.tar.gz                  TEST_DIR_LISTING           True                                                  2  2020-08-05T21:04:20.234166Z  2020-08-05T21:04:20.234191Z
  37  hello_world                TEST_DESC                  jobbergate-resources/2/ffd92e16-5a40-4baa-a3c0-b474e640b3d9/application.tar.gz                  TEST_DIR_LISTING           True                                                  2
</code></pre>
<h4>Now that the CLI is installed, you can create your first application. Read more about it in <a href="https://community.omnivector.solutions/t/create-jobbergate-hello-world-application/27">part 2</a> of this post.</h4>

Jobbergate-cli Setup and Installation

<h3>Jobbergate-CLI provides a layer of abstraction for users submitting jobs to a Slurm cluster. It provides a simple interface for users to manage:</h3>
<ul>
<li>Applications
<ul>
<li><a href="https://app.lucidchart.com/documents/view/9c7c52d5-9c0b-42f7-b1c3-3057d461b796/kntbDLw2f-tw">list-applications</a></li>
<li><a href="https://app.lucidchart.com/documents/view/9c7c52d5-9c0b-42f7-b1c3-3057d461b796/SPiqDHIZuCjf">create-application</a></li>
<li><a href="https://app.lucidchart.com/documents/view/9c7c52d5-9c0b-42f7-b1c3-3057d461b796/ontbZ3Y7Bee.">get-application</a></li>
<li><a href="https://app.lucidchart.com/documents/view/9c7c52d5-9c0b-42f7-b1c3-3057d461b796/wMtbJKX4nI1D">delete-application</a></li>
</ul>
</li>
<li>Job Scripts
<ul>
<li><a href="https://app.lucidchart.com/documents/view/9c7c52d5-9c0b-42f7-b1c3-3057d461b796/WgGb0mmPuPuw">list-job-scripts</a></li>
<li><a href="https://app.lucidchart.com/documents/view/9c7c52d5-9c0b-42f7-b1c3-3057d461b796/PgGbQQBb~FgI">create-job-script</a></li>
<li><a href="https://app.lucidchart.com/documents/view/9c7c52d5-9c0b-42f7-b1c3-3057d461b796/5gGbx-GzbOIp">get-job-script</a></li>
<li><a href="https://app.lucidchart.com/documents/view/9c7c52d5-9c0b-42f7-b1c3-3057d461b796/.gGbDxZn5KDb">delete-job-script</a></li>
</ul>
</li>
<li>Job Submissions
<ul>
<li><a href="https://app.lucidchart.com/documents/view/9c7c52d5-9c0b-42f7-b1c3-3057d461b796/WgGb0mmPuPuw">list-job-submissions</a></li>
<li><a href="https://app.lucidchart.com/documents/view/9c7c52d5-9c0b-42f7-b1c3-3057d461b796/PgGbQQBb~FgI">create-job-submission</a></li>
<li><a href="https://app.lucidchart.com/documents/view/9c7c52d5-9c0b-42f7-b1c3-3057d461b796/5gGbx-GzbOIp">get-job-submission</a></li>
<li><a href="https://app.lucidchart.com/documents/view/9c7c52d5-9c0b-42f7-b1c3-3057d461b796/.gGbDxZn5KDb">delete-job-submission</a></li>
</ul>
</li>
</ul>
<p>A detailed overview of the the CLI operations and the API can be found <a href="https://app.lucidchart.com/publicSegments/view/de6b1417-f86a-4384-9772-60a8344b12d2">here.</a></p>