Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add login cluster only recipe #881

Merged
merged 4 commits into from
Oct 30, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions source/installation/cluster-config-schema.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ Cluster Config Schema v2

The cluster config controls many OnDemand features including job submission, shell access, names in menus.

*****************
First an example:
*****************

Expand Down Expand Up @@ -58,7 +57,6 @@ Below is the production configuration for OSC's Owens cluster.

.. _the YAML spec: http://yaml.org/spec/1.2/spec.html#id2777534

************
A Break Down
************

Expand Down Expand Up @@ -190,3 +188,26 @@ See :ref:`Disable Host Link in Batch Connect Session Card <disable-host-link-bat
.. note::

The user is responsible for providing the `%s` that is used to place the script content. If a `script_wrapper` is provided without `%s` then batch connect applications are unlikely to work properly.

Login Cluster Only
******************

Suppose you need want to create a *login cluster that does not schedule or run jobs*. It is used purely as a login/shell cluster only.

To accomplish this, you need to simply leave out the ``v2.job`` stanza that associates a scheduler with the cluster.

An example config file in ``ondemand.d/pitzer_01_login.yml``:

.. code-block:: yaml

---
v2:
metadata:
title: "Pitzer Login"
url: "https://www.osc.edu/supercomputing/computing/pitzer"
hidden: false
login:
host: "pitzer-login01.hpc.osu.edu"

Again, the thing to note here is we've left off the ``v2.job`` which renders the cluster useable only for logins, i.e.
*no jobs will be scheduleable on this cluster.*
Loading