-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add CIROH JupyterHub File System and Storage documentation (#191)
- Loading branch information
Showing
5 changed files
with
92 additions
and
7 deletions.
There are no files selected for viewing
4 changes: 2 additions & 2 deletions
4
...jupyterhub/documentation/requestimages.md → ...rhub/documentation/custom-images/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
24 changes: 24 additions & 0 deletions
24
docs/services/cloudservices/ciroh jupyterhub/documentation/directory/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
sidebar_position: 1 | ||
title: "JupyterHub User Directory" | ||
description: "2i2c JupyterHub File System" | ||
tags: | ||
- 2i2c | ||
- JupyterHub | ||
- GCP | ||
- notebook | ||
- directory | ||
- filesystem | ||
--- | ||
|
||
This is a guide for understanding the File System in CIROH JupyterHub. You can find detailed explanation on [2i2c docs site](https://docs.2i2c.org/user/topics/data/filesystem/). | ||
|
||
### 1. `/home/jovyan` | ||
This is your home directory and is same for all JupyterHub users. **Only you can access files in your home directory.** Any files you place in your home directory persists between sessions. It is recommended to use only for notebooks and code since it is not suitable for large datasets. | ||
|
||
### 2. `/home/jovyan/shared` | ||
This is the shared **readonly** directory. All users can access and read from the shared directory. Only the hub admins can add and delete data from this directory. | ||
|
||
### 3. `/tmp` | ||
This is a non persistient directory. This means any files you add under /tmp direcotry will be deleted once you log out. This directory can be used to store data temporary data. | ||
|
61 changes: 61 additions & 0 deletions
61
...rvices/cloudservices/ciroh jupyterhub/documentation/gcp-object-storage/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
--- | ||
sidebar_position: 2 | ||
title: "Manage files in GCP bucket" | ||
description: "2i2c JupyterHub Google Cloud Buckets" | ||
tags: | ||
- 2i2c | ||
- JupyterHub | ||
- GCP | ||
- notebook | ||
- custom images | ||
- tutorial | ||
--- | ||
|
||
This guide is for managing objects in GCP buckets available on 2i2c CIROH JupyterHub. For more detailed explanation, you can visit [2i2c docs site](https://docs.2i2c.org/user/topics/data/object-storage/manage-object-storage-gcp/). | ||
|
||
### 1. Overview | ||
CIROH JupyterHub uses object Google Cloud Storage to store data in buckets (containers for objects). Currently, there are two buckets available to use on CIROH JupyterHub. | ||
- **Scratch Buckets**: It is intended for storing temporary files since any files in scratch buckets get deleted after seven days. Open a terminal in CIROH JupyterHub and run this command to display your scratch bucket name: | ||
|
||
``` | ||
echo $SCRATCH_BUCKET | ||
gs://awi-ciroh-scratch/<username> | ||
``` | ||
- **Persistent Buckets**: It is recommended to use for storing files that you will be using for a longer period of time. Open a terminal in CIROH JupyterHub and run this command to display your persistent bucket name: | ||
|
||
``` | ||
echo $PERSISTENT_BUCKET | ||
gs://awi-ciroh-persistent/<username> | ||
``` | ||
|
||
### 2. Copying file to a bucket | ||
You can copy files on your CIROH JupyterHub to an available bucket using the following command. | ||
|
||
``` | ||
gcloud storage ls cp <filepath> $PERSISTENT_BUCKET/<filepath> | ||
``` | ||
|
||
### 3. Copying file from a bucket to CIROH JupyterHub | ||
You can copy files from an accessible bucket to your CIROH JupyterHub using the following command. | ||
|
||
``` | ||
gcloud storage ls cp $PERSISTENT_BUCKET/<filepath> <destination-filepath> | ||
``` | ||
|
||
### 4. Deleting file from a bucket | ||
You can delete a file in a bucket with the following command: | ||
|
||
``` | ||
gcloud storage ls rm $PERSISTENT_BUCKET/<filepath> | ||
``` | ||
|
||
|
||
:::note | ||
Anyone can access each other's files in persistent buckets on the hub. Please be careful not to delete other user's files. Your actions impact the entire organization's storage. If unsure, consult with the team lead or ciroh IT support. | ||
::: | ||
|
||
## Where to go for help: | ||
|
||
- Email ciroh-it-admin@ua.edu UA CIROH Cloud Team | ||
- CIROH Cloud Slack Channel - #ciroh-ua-it-admin | ||
- CIROH Infrastructure Support Slack Channel - #ciroh-infrastructure-support |
4 changes: 2 additions & 2 deletions
4
...es/ciroh jupyterhub/documentation/push.md → ...terhub/documentation/github-push/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters