Getting Started

This section will describe the project allocation process for Slate. This is applicable to both the Onyx and Marble OLCF OpenShift clusters.

In addition, we will go over the process to log into Onyx and Marble, and how namespaces work within the OpenShift context.

Requesting A Slate Project Allocation

Please fill out the Slate Request Form in order to use Slate resources. This must be done in order to proceed.

If you have any question please contact User Assistance, via a Help Ticket Submission or by emailing help@olcf.ornl.gov.

Required information:
- Existing OLCF Project ID
- Project PI
- Enclave (i.e. Open or Moderate Enclave - Onyx or Marble respectively)
NOTE: Summit is in Moderate
- Description (i.e. How you will use Slate)
- Resource Request (i.e. CPU/Memory/Storage requirements - Default is
8CPU/16GB/50GB respectively)

Logging in

The web UI for OpenShift is available from all of ORNL (you should be able to reach it from your laptop on ORNL WIFI as well as the VPN).

Cluster URL
Marble (Moderate Production cluster with access to Summit/Alpine) Marble Web Console
Onyx (Open Production Cluster with access to Wolf) Onyx Web Console

Slate Namespaces

Slate Namespaces map directly to OLCF Project ID’s.

Once your Slate Project Allocation Request is approved, you will see your project’s namespace on the appropriate OpenShift Cluster upon login. The terms “namespace” and “project” may get used interchangebly when referring to your project’s useable space within the requested resource boundaries (CPU/Memory/Storage).

Install the OC tool

The OC tool provides CLI access to the OpenShift cluster. It needs to be installed on your machine.

It is a single binary that can be downloaded from a number of places (the choice is yours):

  • Homebrew on MacOS (need Homebrew setup first):

Note

The Homebrew package is not always kept up to date with the latest version of OpenShift so some client features may not be available

$ brew install openshift-cli
  • RHEL/CentOS (requires openshift-origin repo):
$ yum install origin-clients

Test login with OC Tool

Cluster URL
Marble (Moderate Production cluster with access to Summit/Alpine) https://api.marble.ccs.ornl.gov
Onyx (Open Production Cluster with access to Wolf) https://onyx.ccs.ornl.gov/
Replace <URL> with the appropriate cluster link above (Onyx or Marble).
$ oc login <URL>

(NOTE: Marble authentication uses NCCS Usernames and RSA passcodes. Onyx uses XCAMS usernames and passwords).

Once you login, the output will tell you what projects/namespaces you have access to.

You can view/select/switch between projects/namespaces with the oc tool:

#List all projects/namespaces available to you
$ oc get projects

#Use or work within specific project/namespace
$ oc project <project-name>