How to Write a Support Ticket

Owned by Robert Schade
Last updated: Feb 13, 2024 by Marcel-Brian Wilkowsky
2 min read

We are constantly trying to improve our documentation on the PC2 systems. Kindly read this before asking questions via help tickets.

To help us serve you better, when you submit a help ticket, please:

  • Open a new ticket for new issues. Replying to email from the ticketing system will append to the existing ticket. New issues need to have their own, new ticket. Do not reply to a previous email if you are starting a new ticket.

  • Provide a descriptive subject line, succinctly summarizing the problem. Something like "HPC problems" is NOT very useful to us.

  • Include

    • your project and your account used at PC2 (e.g. project: hpc-prf-dfgh, account: dfgh001)

    • the name of the cluster you are experiencing a problem with (e.g. Noctua1, Noctua2, etc).

    • The job-IDs, f there are jobs involved in the issue

    • The full path to the job script you used to submit the job, and for the stdout/stderr error files from the jobs.

  • If you received an error message when running a command (not already in the stderr/stdout files above) please provide the message. The script command (see below) might be helpful.

  • Please do NOT attach the contents of the files above, or include them in the body of the message. Just provide the paths to the files on the system. If you plan to submit the job again with a slightly modified version of the file, please copy it and give us the name that you copied it to.

  • Please, PLEASE do NOT attach screen shots of text. https://upb-pc2.atlassian.net/wiki/spaces/PC2DOK/pages/1901995 (see the script command to capture output if needed), and give us the path to that file.

  • If you are reporting what seem to be problems with your jobs being stuck in the pending state in the queue, do NOT delete the jobs unless we tell you to do so. Deleting the jobs makes it harder to diagnose the problems.

  • If you are having connection issues, please include the exact command you are running, the host you are trying to connect to, the username you are using (DO NOT INCLUDE PASSWORDS), the approximate time of the failed attempts (as accurately as you can), and if possible the IP address of the machine you are trying to connect from.

  • For follow ups on the same ticket number, we already have a history of the ticket and so you do NOT have to repeat things in every response.

  • If possible, how can we reproduce the error in a systematic manner?

  • Did you attempt to fix/troubleshoot the problem?

    • If you attempted to debug the problem, provide us the steps you already took and the intermediate results.