Skip to content

Commit 2c7c75f

Browse files
committed
almost initial commit
1 parent 5f1bcb7 commit 2c7c75f

4 files changed

Lines changed: 34 additions & 19 deletions

File tree

docs/index.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
# Welcome to MkDocs
1+
# Hunt Cloud interal wiki
22

3-
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
4-
5-
## Commands
6-
7-
* `mkdocs new [dir-name]` - Create a new project.
8-
* `mkdocs serve` - Start the live-reloading docs server.
9-
* `mkdocs build` - Build the documentation site.
10-
* `mkdocs -h` - Print help message and exit.
11-
12-
## Project layout
13-
14-
mkdocs.yml # The configuration file.
15-
docs/
16-
index.md # The documentation homepage.
17-
... # Other markdown pages, images and other files.
3+
This documentation sets up some guiding principles for how we use HUNT Cloud.

docs/off-boarding.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Off-boarding
2+
The responsibility that the off-boarding should be done is the supervisor.
3+
Start by giving a notification a 2 months prior to the contract ending.
4+
5+
The off-boarding procedure consists of cleaning and organizing data. The goal of the off-boarding is to sort the data in finished projects (archive), ongoing project (transferred to other user or lab-coordinator) and killed projects that can be deleted. For finished project that data should be separated into sensitive and non-sensitive data.
6+
7+
Transfer rights on files and folders supervisor/lab-coordinator.
8+
9+
**What happens when you leave now from the HUNT cloud side?** The user is inactivated after 6 months of inactivity. Delete the user 3 months after leaving the group by default unless extended. This is the supervisors responsibility.

docs/on-boarding.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,22 @@
1-
# On boarding
2-
Not good.
1+
# On-boarding
2+
Supervisors should introduce new hires to the on-boarding and off-boarding documents. Understand the hierarchy of the cloud: space, lab and nodes. Understand the roles lab leader and lab coordinator is most important.
3+
4+
Show how to do orders from the service desk. Introduce people to the work-bench and understand how storage is different from the main home lab.
5+
6+
Introduce people to the various ways of accessing hunt cloud; work-bench, ssh terminal, moba and VSCode. Main way of accessing the cloud for new hires will be work-bench.
7+
8+
Explain storage organization. How should new projects be organized. Oraganization is standard enough to be summarized in a single document.
9+
10+
Introduce to the basic functions and commands on linux.
11+
12+
How to use software: what is user specific and what exists on a lab/node level. Anaconda is installed on a lab level. Software on the workbench is not the same as the software in the lab as the software in the workbench is run in a container.
13+
14+
**Who is responsible for introducing all of these concepts?**
15+
16+
**Procedure for new users:**
17+
1. Creare a user folder in /mnt/work/users/username
18+
2. Explain how to organize new folder projects. Enforce good data practices. Explain linux links vs copies.
19+
3. Explain cloud privacy - who can access which data? Who can access your data?
20+
4. Compute nodes - the lab coordinator should create a user for each new user. How are the gpu nodes different from the home instance. We have sudo access on these nodes - we might not give everyone sudo access. **Can we make docker not need sudo and rely on devcontainers from environments?** We have limited resources on gpus - coordinate with other people on the gpus space. Make an install script to install user specific mamba and install docker system wide. Make sure to set up the usergroup for users to use docker. **Ask if docker is already installed on the spot/gpu machines?**
21+
5. Never download data - if you need that you should have explicit written permission from Tone. Even if working with the data locally is easier. However, anything you can put in a publication can be downloaded.
22+
6. **Recommendations:** use git, but be careful what you upload. Keep data outside git repo in a separate repo to prevent fuck-ups.

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
site_name: Big Docs Energy
1+
site_name: Hunt cloud internal documentation
22
theme:
33
name: material
44
palette:

0 commit comments

Comments
 (0)