diff --git a/docs/source/common/images/vscode/01_code_status.png b/docs/source/common/images/vscode/01_code_status.png new file mode 100644 index 00000000..b9692111 Binary files /dev/null and b/docs/source/common/images/vscode/01_code_status.png differ diff --git a/docs/source/common/index.rst b/docs/source/common/index.rst index 7b60856d..a2fee5c5 100644 --- a/docs/source/common/index.rst +++ b/docs/source/common/index.rst @@ -13,4 +13,5 @@ Documentation on topics that are applicable across multiple NCSA computing resou quotas transfer relocate-conda-directory + vscode diff --git a/docs/source/common/quotas.rst b/docs/source/common/quotas.rst index 116a689a..d7e71cba 100644 --- a/docs/source/common/quotas.rst +++ b/docs/source/common/quotas.rst @@ -3,6 +3,11 @@ Quotas ======= +See :ref:`vscode-access-quota` if you are having issues logging in with VS Code. + +Quota Command +--------------- + Execute the ``quota`` command to check the usage, soft quotas, and hard limits of your home directory and the shared directories you have access to. Block Used vs File Used diff --git a/docs/source/common/vscode.rst b/docs/source/common/vscode.rst new file mode 100644 index 00000000..11271b35 --- /dev/null +++ b/docs/source/common/vscode.rst @@ -0,0 +1,63 @@ +.. _vscode-on-ncsa: + +VS Code on NCSA Resources +=========================== + +Use Policy +------------ + +- **Do not run large processing work on login nodes**, this type of work should be run on compute nodes. + + Login nodes are intended for moving files around and setting up computational jobs, not for processing large amounts of data. Processes that do a lot of work on login nodes can interfere with other user login sessions and are subject to being killed without notice. + +- Be aware of VS Code plugins that may attempt to endlessly auto-reconnect to a system. Unusual activity like this can result in your access to the system being blocked until the issue is identified and resolved. + +System-Specific Information +------------------------------- + +- `Delta VS Code `_ +- `DeltaAI VS Code `_ +- `HAL VS Code `_ + +.. _vscode-trouble: + +Troubleshooting +----------------- + +.. _vscode-access-quota: + +Cannot Log in with VS Code - Disk Quota Exceeded +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +When you log in to a system with VS Code, VS Code must be able to write to your home directory (``~/``) on log in. Therefore, if your home directory is at its quota/limit, you will not be able to log in to the system via VS Code. To resolve this: + +#. Use ``ssh`` to log in to the system in a **terminal**. Go to the system user guide for instructions on how to log in with ``ssh``: + + - `Delta Login `_ + - `DeltaAI Login `_ + - `HAL Login `_ + - `Hydro Login `_ + - `Illinois Campus Cluster Login `_ + - `Illinois HTC Login `_ + - `Nightingale Login `_ + +#. Run the ``quota`` command on the system to see how much above the quota/limit you are in your **home directory**. Note, you may have reached your "Block Used" and/or "File Used" quota/limit. For a detailed explanation of the ``quota`` command output, see :ref:`quotas`. + +#. Delete files in your home directory (or move them to the ``/projects``, ``/scratch``, or ``/work`` directory, as appropriate) until you are below the quota/limit. + +#. After you have returned your home directory below the quota/limit, try to log in to the system using VS Code. + +We have also seen cases where it was necessary to remove ``$HOME/.vscode`` on the system, similar the `VS Code documentation - clean uninstall `_. + +VS Code Performance Issues +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Go to `Microsoft's VS Code Performance Issues Guide `_ for steps to try to resolve different performance issues. + +You can run ``code --status`` in a VS Code terminal to display status information about your running VS Code and the workspace you have opened. + +.. image:: images/vscode/01_code_status.png + :alt: Using the code --status command with vscode. + :width: 700 + +| diff --git a/docs/source/index.rst b/docs/source/index.rst index 92cc0c94..35015401 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -107,6 +107,7 @@ Addititional user documentation on topics common across two or more NCSA resourc - :ref:`transfer` - :ref:`quotas` - :ref:`conda` +- :ref:`vscode-trouble` .. toctree:: @@ -133,6 +134,7 @@ Addititional user documentation on topics common across two or more NCSA resourc common/transfer common/quotas common/relocate-conda-directory + common/vscode .. toctree:: :caption: Software Documentation