From 8151ca5439bbe6ef598c5a44776a4d008366352d Mon Sep 17 00:00:00 2001 From: William Warriner <6930772+wwarriner@users.noreply.github.com> Date: Wed, 12 Aug 2026 12:21:18 -0500 Subject: [PATCH 1/4] initial --- .../_macro/template_config_table_rows.md.j2 | 11 ++++++ docs/tickets/account/cloud.rc/index.md | 0 docs/tickets/account/rcs/create.md | 32 ++++++++++++++++++ .../res/example_uab_directory_entry.png | Bin docs/{ => tickets}/res/snow_catalog_tasks.png | Bin docs/{ => tickets}/res/snow_id_search_1.png | Bin docs/{ => tickets}/res/snow_id_search_2.png | Bin docs/{ => tickets}/res/snow_new_task.png | Bin docs/{ => tickets}/res/snow_new_task_form.png | Bin .../res/snow_requested_for_guest.png | Bin docs/tickets/snow_templates.md | 11 ++++++ docs/{ => tickets}/tickets.md | 10 ------ mkdocs.yml | 15 +++++++- 13 files changed, 68 insertions(+), 11 deletions(-) create mode 100644 docs/tickets/_macro/template_config_table_rows.md.j2 create mode 100644 docs/tickets/account/cloud.rc/index.md create mode 100644 docs/tickets/account/rcs/create.md rename docs/{ => tickets}/res/example_uab_directory_entry.png (100%) rename docs/{ => tickets}/res/snow_catalog_tasks.png (100%) rename docs/{ => tickets}/res/snow_id_search_1.png (100%) rename docs/{ => tickets}/res/snow_id_search_2.png (100%) rename docs/{ => tickets}/res/snow_new_task.png (100%) rename docs/{ => tickets}/res/snow_new_task_form.png (100%) rename docs/{ => tickets}/res/snow_requested_for_guest.png (100%) create mode 100644 docs/tickets/snow_templates.md rename docs/{ => tickets}/tickets.md (98%) diff --git a/docs/tickets/_macro/template_config_table_rows.md.j2 b/docs/tickets/_macro/template_config_table_rows.md.j2 new file mode 100644 index 0000000..bf3ee5f --- /dev/null +++ b/docs/tickets/_macro/template_config_table_rows.md.j2 @@ -0,0 +1,11 @@ +{% macro config_rows(name, description) -%} +| Configuration Field | Type | Enabled? | Value | +|---------------------|-----------|----------|------------------------------| +| Name | text | yes | {{ name }} | +| User | text | no | your name | +| Table | drop-down | yes | Requested Item [sc_req_item] | +| Groups | text | no | -- | +| Active | checkbox | yes | "checked" | +| Global | checkbox | no | -- | +| Short Description | text | yes | {{ description }} | +{%- endmacro %} diff --git a/docs/tickets/account/cloud.rc/index.md b/docs/tickets/account/cloud.rc/index.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/tickets/account/rcs/create.md b/docs/tickets/account/rcs/create.md new file mode 100644 index 0000000..5062085 --- /dev/null +++ b/docs/tickets/account/rcs/create.md @@ -0,0 +1,32 @@ +--- +hide: + toc: true +--- + +# RCS Account Creation Procedures + +{% from "tickets/_macro/template_config_table_rows.md.j2" import config_rows %} + +RCS account creation is self-managed. All eligible UAB and XIAS people can create an RCS account by visiting and filling out a form. Eligibility is verified as part of the automated account creation process. + +## How Do I Handle a Support Request? + +Reply with the following, then close the ticket. + +```text +Greeting and welcome message here ... + +You can create a Research Computing Systems (RCS) account by visiting and filling out a short form. All UAB students, faculty, and staff are eligible to create an account. External collaborators with XIAS accounts may also be eligible, with some restrictions. For more information, please visit our "RCS Account Creation" documentation at . Be sure to check the "Next Steps" section when you've created your account to see what services and platforms we offer. + +If you need additional support in the future ... +``` + +## Creating a Template in ServiceNow + +See [How Do I Create a Template?](../../snow_templates.md#how-do-i-create-a-new-template) for general instructions. Use the following table to guide filling out the fields. + +{{ config_rows("account_rcs_create", "Response to RCS or Cheaha account request") }} +| | | | | +| **Template Fields** | | | | +| Additional comments | text | yes | [Canned Response](#how-do-i-handle-a-support-request) | +| Assignment group | drop-down | yes | Research Computing | diff --git a/docs/res/example_uab_directory_entry.png b/docs/tickets/res/example_uab_directory_entry.png similarity index 100% rename from docs/res/example_uab_directory_entry.png rename to docs/tickets/res/example_uab_directory_entry.png diff --git a/docs/res/snow_catalog_tasks.png b/docs/tickets/res/snow_catalog_tasks.png similarity index 100% rename from docs/res/snow_catalog_tasks.png rename to docs/tickets/res/snow_catalog_tasks.png diff --git a/docs/res/snow_id_search_1.png b/docs/tickets/res/snow_id_search_1.png similarity index 100% rename from docs/res/snow_id_search_1.png rename to docs/tickets/res/snow_id_search_1.png diff --git a/docs/res/snow_id_search_2.png b/docs/tickets/res/snow_id_search_2.png similarity index 100% rename from docs/res/snow_id_search_2.png rename to docs/tickets/res/snow_id_search_2.png diff --git a/docs/res/snow_new_task.png b/docs/tickets/res/snow_new_task.png similarity index 100% rename from docs/res/snow_new_task.png rename to docs/tickets/res/snow_new_task.png diff --git a/docs/res/snow_new_task_form.png b/docs/tickets/res/snow_new_task_form.png similarity index 100% rename from docs/res/snow_new_task_form.png rename to docs/tickets/res/snow_new_task_form.png diff --git a/docs/res/snow_requested_for_guest.png b/docs/tickets/res/snow_requested_for_guest.png similarity index 100% rename from docs/res/snow_requested_for_guest.png rename to docs/tickets/res/snow_requested_for_guest.png diff --git a/docs/tickets/snow_templates.md b/docs/tickets/snow_templates.md new file mode 100644 index 0000000..cfb3175 --- /dev/null +++ b/docs/tickets/snow_templates.md @@ -0,0 +1,11 @@ +# ServiceNow Templates + +They help with responding to tickets more efficiently, but require some one-time, upfront setup. There is currently no way to share templates with others directly, each person has to set them up individually. + +## How Do I Enable Templates? + +## How Do I Create a New Template? + +## How Do I Edit an Existing Template? + +## How Do I Delete a Template? diff --git a/docs/tickets.md b/docs/tickets/tickets.md similarity index 98% rename from docs/tickets.md rename to docs/tickets/tickets.md index 2cb9692..7938350 100644 --- a/docs/tickets.md +++ b/docs/tickets/tickets.md @@ -4,16 +4,6 @@ ## Account Registration -### General Cheaha Account Request - -All UAB users can request their own Cheaha account by going to and filling out a short form. No intervention on our end is required. - -**Canned Response**: - -> Hi, -> -> All UAB students, faculty, and staff can create their own Cheaha account by going to https://rc.uab.edu and filling out a short form. Once the form is complete, your account will be immediately ready for use. All accounts have 5 TB of personal space on the cluster. Please read through our Cheaha documentation at https://docs.rc.uab.edu/cheaha/getting_started/ to familiarize yourself with how the cluster operates. If you are able to create your account or run into any errors, please let us know in this ticket. Thank you - ### Cloud Account Request Cloud accounts must be created by Clyde or John as of now and is not linked with SSO. Go through the following steps: diff --git a/mkdocs.yml b/mkdocs.yml index 91c76ee..1cfecc1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -74,6 +74,12 @@ plugins: type: date strict: false - glightbox + - macros: + j2_extensions: + - jinja2_workarounds.MultiLineInclude + on_undefined: strict + render_by_default: true + verbose: true - table-reader: data_path: docs - title-casing @@ -102,7 +108,14 @@ nav: - Identity: - Saml: saml/saml.md - SP Metadata Generation: saml/create-sp-metadata.md - - Ticket Issues: tickets.md + - Customer Service & Tickets: + - Account Management: + - Research Computing System (RCS): + - Create: tickets/account/rcs/create.md + - Cloud.rc: + - tickets/account/cloud.rc/index.md + - ServiceNow Templates: tickets/snow_templates.md + - Uncategorized: tickets/tickets.md validation: nav: From b0378ab3ba3429f45b3bfc32bdcb8febabd03bc0 Mon Sep 17 00:00:00 2001 From: Premas Date: Wed, 9 Sep 2026 15:06:39 -0500 Subject: [PATCH 2/4] add cloud request --- docs/tickets/account/cloud.rc/create.md | 46 +++++++++++++++++++++++++ docs/tickets/account/cloud.rc/index.md | 0 macros/main.py | 4 +++ mkdocs.yml | 3 +- 4 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 docs/tickets/account/cloud.rc/create.md delete mode 100644 docs/tickets/account/cloud.rc/index.md create mode 100644 macros/main.py diff --git a/docs/tickets/account/cloud.rc/create.md b/docs/tickets/account/cloud.rc/create.md new file mode 100644 index 0000000..a8a9bad --- /dev/null +++ b/docs/tickets/account/cloud.rc/create.md @@ -0,0 +1,46 @@ +--- +hide: + toc: true +--- + +# RC Cloud Account Creation Procedures + +{% from "tickets/_macro/template_config_table_rows.md.j2" import config_rows %} + +Cloud accounts are currently created by the Ops team and are not linked to SSO. Follow the steps below to process a Cloud account request. + +## How Do I Handle a Support Request? + +### Review the Use Case and Obtain Manager Approval + +Cloud accounts are currently limited due to resource constraints, each request must receive Manager approval before proceeding. + +1. Review the ticket to see whether the user has provided a use case. If the use case is not provided, ask the user to explain what they need the Cloud account for and what they plan to accomplish. +1. Determine whether the use case can be accomplished using existing resources, such as Cheaha, or through alternate solution. +1. If an alternative solution is not suitable, discuss the request with the Manager to determine whether the Cloud account request can be approved. +1. If approved, document the approval reason in the work notes and proceed with the next steps. + +Reply with the following to create intial discussion, and wait for follow-up + +#### Response to RC Cloud Account Request +```text +Greeting and welcome message here ... + +Cloud accounts are currently limited due to resource constraints, so we evaluate the use case before approving requests. Could you please provide some details about your intended use of the Cloud account? This will help us determine whether your use case can be supported through Cloud or if we can provide the best possible alternative solution. +{{ office_hours }} +``` + +### Create a ServiceNow Task + +1. Create a new [task](#creating-a-servicenow-task) on the ticket giving the BlazerID or XIAS name for the person requesting the account. Use `Request to create Cloud account` as the short description and `Create Cloud account for ` as the description. Omit any `@uab.edu` string for BlazerIDs, but keep the email host for XIAS accounts. +1. Copy the task link from the main ticket page (looks like `TASK0000000`) and put in the Slack tickets channel something like `@rc-ops-grp Request to create cloud account for `. Make sure the task is an actual link to the task to make it easier for Ops. + +## Creating a Template in ServiceNow + +See [How Do I Create a Template?](../../snow_templates.md#how-do-i-create-a-new-template) for general instructions. Use the following table to guide filling out the fields. + +{{ config_rows("account_cloud_create", "Response to RC Cloud account request") }} +| | | | | +| **Template Fields** | | | | +| Additional comments | text | yes | [Canned Response](#response-to-rc-cloud-account-request) | +| Assignment group | drop-down | yes | Research Computing diff --git a/docs/tickets/account/cloud.rc/index.md b/docs/tickets/account/cloud.rc/index.md deleted file mode 100644 index e69de29..0000000 diff --git a/macros/main.py b/macros/main.py new file mode 100644 index 0000000..83d01f6 --- /dev/null +++ b/macros/main.py @@ -0,0 +1,4 @@ +def define_env(env): + env.variables.office_hours = """ +Please reach out to us if you have any questions. You can also drop by our Zoom office hours between 10 AM and 12 PM to discuss. Zoom details are available here: https://docs.rc.uab.edu/#how-to-contact-us. +""" diff --git a/mkdocs.yml b/mkdocs.yml index 1cfecc1..3da17e7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -75,6 +75,7 @@ plugins: strict: false - glightbox - macros: + module_name: macros/main j2_extensions: - jinja2_workarounds.MultiLineInclude on_undefined: strict @@ -113,7 +114,7 @@ nav: - Research Computing System (RCS): - Create: tickets/account/rcs/create.md - Cloud.rc: - - tickets/account/cloud.rc/index.md + - Create: tickets/account/cloud.rc/create.md - ServiceNow Templates: tickets/snow_templates.md - Uncategorized: tickets/tickets.md From 8b7de34b779f9cd7fdbce00b842528f1dab00a8b Mon Sep 17 00:00:00 2001 From: Premas Date: Wed, 9 Sep 2026 15:18:46 -0500 Subject: [PATCH 3/4] add cloud request --- docs/tickets/account/cloud.rc/create.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tickets/account/cloud.rc/create.md b/docs/tickets/account/cloud.rc/create.md index a8a9bad..d18fad4 100644 --- a/docs/tickets/account/cloud.rc/create.md +++ b/docs/tickets/account/cloud.rc/create.md @@ -32,7 +32,7 @@ Cloud accounts are currently limited due to resource constraints, so we evaluate ### Create a ServiceNow Task -1. Create a new [task](#creating-a-servicenow-task) on the ticket giving the BlazerID or XIAS name for the person requesting the account. Use `Request to create Cloud account` as the short description and `Create Cloud account for ` as the description. Omit any `@uab.edu` string for BlazerIDs, but keep the email host for XIAS accounts. +1. Create a new [task](../../tickets.md#creating-a-servicenow-task) on the ticket giving the BlazerID or XIAS name for the person requesting the account. Use `Request to create Cloud account` as the short description and `Create Cloud account for ` as the description. Omit any `@uab.edu` string for BlazerIDs, but keep the email host for XIAS accounts. 1. Copy the task link from the main ticket page (looks like `TASK0000000`) and put in the Slack tickets channel something like `@rc-ops-grp Request to create cloud account for `. Make sure the task is an actual link to the task to make it easier for Ops. ## Creating a Template in ServiceNow From 4ddb7de032878521eb2dab8b05337d6c95a0f312 Mon Sep 17 00:00:00 2001 From: Premas Date: Wed, 9 Sep 2026 15:24:55 -0500 Subject: [PATCH 4/4] typo --- docs/tickets/account/cloud.rc/create.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/tickets/account/cloud.rc/create.md b/docs/tickets/account/cloud.rc/create.md index d18fad4..dfcc41e 100644 --- a/docs/tickets/account/cloud.rc/create.md +++ b/docs/tickets/account/cloud.rc/create.md @@ -11,7 +11,7 @@ Cloud accounts are currently created by the Ops team and are not linked to SSO. ## How Do I Handle a Support Request? -### Review the Use Case and Obtain Manager Approval +### Review the Use Case and Obtain Manager Approval Cloud accounts are currently limited due to resource constraints, each request must receive Manager approval before proceeding. @@ -23,6 +23,7 @@ Cloud accounts are currently limited due to resource constraints, each request m Reply with the following to create intial discussion, and wait for follow-up #### Response to RC Cloud Account Request + ```text Greeting and welcome message here ...