diff --git a/assets/coact_menu_tabs.png b/assets/coact_menu_tabs.png new file mode 100644 index 0000000..79d9d01 Binary files /dev/null and b/assets/coact_menu_tabs.png differ diff --git a/czarguide.md b/czarguide.md new file mode 100644 index 0000000..494eb7f --- /dev/null +++ b/czarguide.md @@ -0,0 +1,90 @@ +# Beginner's Guide for Facility Czars + +This guide is intended for facility czars to get started with managing their facility's repos, computing resources, user accounts, and more. The majority of czar tasks can be performed on [coact](https://coact.slac.stanford.edu) but this guide will cover some additional topics. + +List of primary tasks for a facility czar: +* Create/manage repos for computing/storage resources for their facility +* Install and set up facility-specific software (e.g. in `/sdf/group`) +* Add/remove users to facility repos for accessing computing resources +* Add/remove users to Posix group for accessing storage resources (e.g. `/sdf/data` or `/sdf/group`) +* Inform facility users on how to access computing/storage resources on S3DF +* Monitor facility repo and resources utilization +* Communicate facility-wide issues or requests between the S3DF admin team and facility users + +> [!TIP] +> Facility czars play the role of an intermediary between S3DF general users and S3DF admin/support staff. Czars are the primary point-of-contact for users with S3DF issues/requests but not expected to provide full technical support; they can refer users to the [S3DF help Slack channel](slac.slack.com#comp-sdf). + +## Management Systems in Coact + +Coact is the primary interface for facility czars to manage their tasks. The most common tasks involve managing repos and their facility's users. To begin, log into your [coact](https://coact.slac.stanford.edu) account. The tabs in the top left: Facilities, Repos, and Requests each provide different options. + +![Coact Menu Tabs](assets/coact_menu_tabs.png) + +### Coact: Facilities + + + +### Coact: Repos + + + +> [!NOTE] +> **Repos cannot be deleted in Coact!** This is a known limitation and should not be an issue for now as repos can be renamed and allocated to zero users aside from the facility czar. To delete a repo, please contact the S3DF admin team. + + * To create a new repo use the "Request New Repo" button in the top right. + * To add a user to an existing repo, select the person icon next to the repo name to view the users for that repo. Then select the "Manage Users" button to add/remove users. + * To allocate compute resources for a repo, select the "Compute" tab and edit the "Total compute allocation" value for the desired repo/cluster name. + + + +> [!TIP] +> Allocation values less than 100% will restrict the maximum number of CPUs/GPUs that can be used by that repo/cluster at a time as a fraction of the total owned resources by the facility. + +### Coact: Requests + + + +## Other S3DF Czar Tasks + +In addition to managing users and repos through Coact, some additional common tasks include: + +### How to add/remove users from legacy Posix groups + + + + + +### How/where to install software (e.g. Conda) for the facility + + + + + +### How to request/purchase additional resources (e.g. compute nodes) + + + +> [!NOTE] +> Computing and storage resources have finite support lifetimes (usually around 5 years). Be sure to check with the S3DF admin team for available options when nearing the end-of-life of existing resouces. + +