From 546258e6106cb1232de8a3989d4f9ea274c7ba84 Mon Sep 17 00:00:00 2001 From: Manjila Singh Date: Mon, 16 Sep 2024 20:40:14 +0100 Subject: [PATCH 1/4] Update homepage css --- docusaurus.config.js | 8 ++++---- src/css/custom.css | 5 +---- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index af64919..9fd2917 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -198,10 +198,10 @@ plugins: [[ require.resolve('docusaurus-lunr-search'), {


Copyright © ${new Date().getFullYear()} CIROH - The University of Alabama`, }, - // prism: { - // theme: prismThemes.github, - // darkTheme: prismThemes.dracula, - // }, + prism: { + theme: prismThemes.github, + darkTheme: prismThemes.dracula, + }, }), }; diff --git a/src/css/custom.css b/src/css/custom.css index 0367061..bce09cd 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -67,10 +67,7 @@ --ifm-color-primary-lightest: #4fddbf; --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); } */ -.container { - max-width: 68%; -} - + .docs-wrapper .container { max-width: 100%; margin-left: 1.3rem; From 3133f5a14d25b36aebd0108d74ecf947e1c7505c Mon Sep 17 00:00:00 2001 From: Manjila Singh Date: Mon, 16 Sep 2024 20:40:52 +0100 Subject: [PATCH 2/4] Added persistent conda env documentation --- .../documentation/conda/index.md | 44 +++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 docs/services/cloudservices/ciroh jupyterhub/documentation/conda/index.md diff --git a/docs/services/cloudservices/ciroh jupyterhub/documentation/conda/index.md b/docs/services/cloudservices/ciroh jupyterhub/documentation/conda/index.md new file mode 100644 index 0000000..5c517f1 --- /dev/null +++ b/docs/services/cloudservices/ciroh jupyterhub/documentation/conda/index.md @@ -0,0 +1,44 @@ +--- +sidebar_position: 5 +title: "Persistent Conda Environment" +description: "2i2c JupyterHub is a cloud-based JupyterHub environment specifically designed for hydrological researchers. It is powered by 2i2c JupyterHub, a cloud-based JupyterHub environment specifically on Google Cloud" +tags: + - 2i2c + - JupyterHub + - conda + - persistent + - tutorial +--- + +# Persistent Conda Environments on CIROH 2i2c Server +To ensure your Conda environments persist across server restarts on the CIROH 2i2c server, create them in your home directory. Follow these steps: + +### 1. Create a directory for Conda environments: +You can set up a directory within your home folder to store all your Conda environments. This prevents them from being removed when the server is restarted. For example: + +```bash +mkdir -p ~/conda_envs +``` +### 2. Create a new environment in that directory: +Use the *--prefix* option with conda create to specify the location where you want to create your environment. For example, to create an environment called *my_env* in *~/conda_envs*: + +```bash +conda create --prefix ~/conda_envs/my_env python=3.9 +``` +### 3. Activate the environment: +You can activate the environment as usual, using the path to where you created it: + +```bash +conda activate ~/conda_envs/my_env +``` + +### 4. Autotomatically activate the environment on restart: + If you want this environment to be activated every time you log in or the server restarts, you can add the following to your *.bashrc* or *.bash_profile* file: + +```bash +conda activate ~/conda_envs/my_env +``` + +By creating your environments in your home folder (e.g., *~/conda_envs/*), they will persist across server restarts, ensuring that you don't have to recreate them every time. + + \ No newline at end of file From bc167a6364da7880059010eae85cb28a4ccff7e7 Mon Sep 17 00:00:00 2001 From: Manjila Singh Date: Mon, 16 Sep 2024 21:47:37 +0100 Subject: [PATCH 3/4] Added drawio plugin --- docs/services/access.mdx | 75 +++++ docusaurus.config.js | 9 +- package-lock.json | 45 +++ package.json | 1 + static/files/ciroh-resource-flowchart.drawio | 319 +++++++++++++++++++ 5 files changed, 442 insertions(+), 7 deletions(-) create mode 100644 docs/services/access.mdx create mode 100644 static/files/ciroh-resource-flowchart.drawio diff --git a/docs/services/access.mdx b/docs/services/access.mdx new file mode 100644 index 0000000..e242a01 --- /dev/null +++ b/docs/services/access.mdx @@ -0,0 +1,75 @@ +--- +sidebar_position: 2 +title: "Infrastructure Access" +--- +import Drawio from '@theme/Drawio' +import simpleGraph from '!!raw-loader!@site/static/files/ciroh-resource-flowchart.drawio'; + +# Infrastructure Access at CIROH +CIROH provides access to both public cloud and on-premises infrastructure to support the research projects of its members and partners. + + + + + + +## Public Cloud + +CIROH has partnered with AWS, 2i2c and Google Cloud to provide access to their cloud computing services. To request access to the research cloud, please submit a GitHub template request detailing your project requirements and specifications. Our team will review your request and assist you in obtaining the necessary access. + +### Cost of use: +- Some uses may be covered by CIROH core funds (contact CIROH CyberInfrastructure Team to start a request - ciroh-it-admin@ua.edu) +- Extensive uses may be charged to individual CIROH projects + +### How to get access to CIROH Google Account or CIROH AWS Account? +We encourage PI of the project to start here: (select Public Cloud and fill out details for Google Cloud or AWS). + + Cloud Infrastructure Request Form + +## CIROH JupyterHub + +### How to get access to CIROH JupyterHub? +CIROH JupyterHub provides both CPU and GPU capabilities. Please submit the form below to get access to the CIROH JupyterHub environments: + + JupyterHub (2i2c) CPU Access Request Form + JupyterHub (2i2c) GPU Access Request Form + +### How to request custom images on CIROH JupyterHub? +To request custom images, first create an `environment.yml` file by exporting your conda environment. Then, fill out the JupyterHub (2i2c) Software Install form. + + JupyterHub (2i2c) Software Install Form + +## On-Premises + +CIROH also operates an on-premises infrastructure that includes high-performance computing (HPC) resources and specialized software. To request access to the on-premises infrastructure, please submit a GitHub template request detailing your project requirements and specifications. Our team will review your request and assist you in obtaining the necessary access. + + On-premises Infrastructure Request Form +
+
+:::note +- This form must be submitted by Principal Investigator (PI) of the project. +- Your request will be handled by DevOps staff at CIROH and if permitted will be given access to the research cloud or on-premise infrastructure. + +::: + +### How to get access to Pantarhei? + +**Step 1**: Submit the On-Premise Infrastructure Request Form below to get access to Pantarhei: + +We encourage PI of the project to start here: (select On-Premises Infrastructure Request Form and fill out details) + + Infrastructure Request Form + +--- + +**Step 2**: Submit the On-premise Access Request form for individual user accounts on Pantarhei: + + On-Premise Access Request Form + +--- + +:::note +For UA users, please submit On-Premises Access Request Form. For outside UA users, please start with VPN Access Request Form followed by On-Premises Access Request Form +::: + + diff --git a/docusaurus.config.js b/docusaurus.config.js index 9fd2917..0f5e106 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -50,15 +50,10 @@ const config = { }), ], ], -// markdown: { -// mermaid: true, -// }, -// themes: [ -// '@docusaurus/theme-mermaid', // <-- Add this line to enable Mermaid -// ], + plugins: [[ require.resolve('docusaurus-lunr-search'), { languages: ['en'] // language codes -}]], +}],['drawio', {}]], themeConfig: /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ diff --git a/package-lock.json b/package-lock.json index 74b50b1..0270429 100644 --- a/package-lock.json +++ b/package-lock.json @@ -17,6 +17,7 @@ "clsx": "^2.0.0", "docusaurus": "^1.14.7", "docusaurus-lunr-search": "^3.4.0", + "docusaurus-plugin-drawio": "^0.4.0", "lunr": "^2.3.9", "prism-react-renderer": "^2.3.0", "react": "^18.2.0", @@ -11271,6 +11272,14 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/docusaurus-plugin-drawio": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/docusaurus-plugin-drawio/-/docusaurus-plugin-drawio-0.4.0.tgz", + "integrity": "sha512-7y3cgtwdQ3evWY/phq/iGJectDlRzpRrKzbcBeT79o+w+OStU0noTcTOmVd/oTiylu2OJXhQWF9z+4CoxTgAtA==", + "dependencies": { + "raw-loader": "^4.0.2" + } + }, "node_modules/docusaurus/node_modules/@babel/code-frame": { "version": "7.10.4", "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.10.4.tgz", @@ -25754,6 +25763,42 @@ "node": ">= 0.8" } }, + "node_modules/raw-loader": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/raw-loader/-/raw-loader-4.0.2.tgz", + "integrity": "sha512-ZnScIV3ag9A4wPX/ZayxL/jZH+euYb6FcUinPcgiQW0+UBtEv0O6Q3lGd3cqJ+GHH+rksEv3Pj99oxJ3u3VIKA==", + "dependencies": { + "loader-utils": "^2.0.0", + "schema-utils": "^3.0.0" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^4.0.0 || ^5.0.0" + } + }, + "node_modules/raw-loader/node_modules/schema-utils": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", + "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", + "dependencies": { + "@types/json-schema": "^7.0.8", + "ajv": "^6.12.5", + "ajv-keywords": "^3.5.2" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, "node_modules/rc": { "version": "1.2.8", "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", diff --git a/package.json b/package.json index 8c02388..698fc7d 100644 --- a/package.json +++ b/package.json @@ -23,6 +23,7 @@ "clsx": "^2.0.0", "docusaurus": "^1.14.7", "docusaurus-lunr-search": "^3.4.0", + "docusaurus-plugin-drawio": "^0.4.0", "lunr": "^2.3.9", "prism-react-renderer": "^2.3.0", "react": "^18.2.0", diff --git a/static/files/ciroh-resource-flowchart.drawio b/static/files/ciroh-resource-flowchart.drawio new file mode 100644 index 0000000..e44f8a6 --- /dev/null +++ b/static/files/ciroh-resource-flowchart.drawio @@ -0,0 +1,319 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From 99f9cb5d110c005f460cec1daf712e81e4c9ef15 Mon Sep 17 00:00:00 2001 From: Manjila Singh Date: Mon, 16 Sep 2024 22:11:47 +0100 Subject: [PATCH 4/4] Added drawio file --- docs/services/access.md | 72 -------------------- static/files/ciroh-resource-flowchart.drawio | 45 ++++++------ 2 files changed, 22 insertions(+), 95 deletions(-) delete mode 100644 docs/services/access.md diff --git a/docs/services/access.md b/docs/services/access.md deleted file mode 100644 index ae17279..0000000 --- a/docs/services/access.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -sidebar_position: 2 -title: "Infrastructure Access" ---- - -# Infrastructure Access at CIROH - -CIROH provides access to both public cloud and on-premises infrastructure to support the research projects of its members and partners. -
- ciroh-resource flowchart -
- -## Public Cloud - -CIROH has partnered with AWS, 2i2c and Google Cloud to provide access to their cloud computing services. To request access to the research cloud, please submit a GitHub template request detailing your project requirements and specifications. Our team will review your request and assist you in obtaining the necessary access. - -### Cost of use: -- Some uses may be covered by CIROH core funds (contact CIROH CyberInfrastructure Team to start a request - ciroh-it-admin@ua.edu) -- Extensive uses may be charged to individual CIROH projects - -### How to get access to CIROH Google Account or CIROH AWS Account? -We encourage PI of the project to start here: (select Public Cloud and fill out details for Google Cloud or AWS). - - Cloud Infrastructure Request Form - -## CIROH JupyterHub - -### How to get access to CIROH JupyterHub? -CIROH JupyterHub provides both CPU and GPU capabilities. Please submit the form below to get access to the CIROH JupyterHub environments: - - JupyterHub (2i2c) CPU Access Request Form - JupyterHub (2i2c) GPU Access Request Form - -### How to request custom images on CIROH JupyterHub? -To request custom images, first create an `environment.yml` file by exporting your conda environment. Then, fill out the JupyterHub (2i2c) Software Install form. - - JupyterHub (2i2c) Software Install Form - -## On-Premises - -CIROH also operates an on-premises infrastructure that includes high-performance computing (HPC) resources and specialized software. To request access to the on-premises infrastructure, please submit a GitHub template request detailing your project requirements and specifications. Our team will review your request and assist you in obtaining the necessary access. - - On-premises Infrastructure Request Form -
-
-:::note -- This form must be submitted by Principal Investigator (PI) of the project. -- Your request will be handled by DevOps staff at CIROH and if permitted will be given access to the research cloud or on-premise infrastructure. - -::: - -### How to get access to Pantarhei? - -**Step 1**: Submit the On-Premise Infrastructure Request Form below to get access to Pantarhei: - -We encourage PI of the project to start here: (select On-Premises Infrastructure Request Form and fill out details) - - Infrastructure Request Form - ---- - -**Step 2**: Submit the On-premise Access Request form for individual user accounts on Pantarhei: - - On-Premise Access Request Form - ---- - -:::note -For UA users, please submit On-Premises Access Request Form. For outside UA users, please start with VPN Access Request Form followed by On-Premises Access Request Form -::: - - diff --git a/static/files/ciroh-resource-flowchart.drawio b/static/files/ciroh-resource-flowchart.drawio index e44f8a6..9099c71 100644 --- a/static/files/ciroh-resource-flowchart.drawio +++ b/static/files/ciroh-resource-flowchart.drawio @@ -1,17 +1,11 @@ - + - - - - - - - + @@ -20,30 +14,35 @@ - + - + - + - + + + - + - - - + + + + + + - + @@ -60,20 +59,20 @@ - + - + - + - + - + @@ -134,7 +133,7 @@ - +