Skip to content

Commit 20b10e9

Browse files
committed
add info for projects and quotas
Signed-off-by: Gabin L <gabin.lanore@gmail.com>
1 parent 057c3ac commit 20b10e9

6 files changed

Lines changed: 109 additions & 4 deletions

File tree

docs/cloud/cert.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
# Install Certificates
22

3+
You can download the Public ROOT CA of the laboinfra at [Laboinfra_Root_CA_2024.pem](https://docs.laboinfra.net/assets/Laboinfra_Root_CA_2024.pem)

docs/cloud/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
TODO
44

5-
If you need to get help use the `--help` or contact us
5+
If you need to get help use `labctl --help` or contact us with a discord ticket

docs/cloud/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,4 @@ For the domain, use `esgi` and for the username, use the username you use to log
8282

8383
## Next steps
8484

85-
For more information about how to use labctl, check the [CLI documentation](cli.md).
85+
You will need to give quota to the project you created to be able to create resources. You can check the [Projects and Quotas](projects_quotas.md) documentation for more information.

docs/cloud/projects_quotas.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Manage projects and quotas
2+
3+
## Introduction
4+
5+
On Laboinfra, you get a quota assigned by an admin. This quota includes resources like RAM, CPU, and storage, and it’s yours to distribute across different projects as needed.
6+
7+
Using the API or the labctl CLI, you can:
8+
9+
- Create new projects,
10+
- Add members to your projects,
11+
- Allocate your quota however you want between your projects.
12+
13+
This gives you full control over how you use your resources, making it easy to collaborate and work on multiple school projects efficiently.
14+
15+
## Projects
16+
17+
### Create a new project
18+
19+
```bash
20+
labctl project create PROJECT_NAME
21+
```
22+
23+
!!! info
24+
Project names are suffixed with a unique identifier to ensure they are unique across the platform.
25+
26+
### List your projects
27+
28+
```bash
29+
labctl project list
30+
```
31+
32+
### Add a member to a project
33+
34+
```bash
35+
labctl project add-user PROJECT_NAME MEMBER_NAME
36+
```
37+
38+
### Remove a member from a project
39+
40+
```bash
41+
labctl project del-user PROJECT_NAME MEMBER_NAME
42+
```
43+
44+
!!! info
45+
Before removing a member from a project, make sure your project have enough resources quota to accommodate
46+
47+
### Delete a project
48+
49+
```bash
50+
labctl project delete PROJECT_NAME
51+
```
52+
53+
??? warning
54+
In order to delete a project, you must first delete all the resources associated with it (VMs, disks, etc.) and remove all quotas allocated to it.
55+
56+
## Quotas
57+
58+
Type of quotas:
59+
60+
| Type | Description |
61+
|-------|-------------|
62+
| `cpu` | CPU cores |
63+
| `mem` | RAM in GB |
64+
| `sto` | Disk in GB |
65+
66+
### Display your quota
67+
68+
With the me command you get global information about your account, including your quota.
69+
70+
```bash
71+
labctl me
72+
```
73+
74+
### Allocate quota to a project
75+
76+
```bash
77+
labctl quota set PROJECT_NAME TYPE VALUE
78+
```
79+
80+
### Display quota for a project
81+
82+
With this command you can see how much quota is allocated to a project and who share the quota to the project.
83+
84+
```bash
85+
labctl quota show-project PROJECT_NAME
86+
```
87+
88+
### Remove quota from a project
89+
90+
If you just want to decrease the quota allocated to a project, you can use the same command as allocating quota, but with the new value you want to set.
91+
92+
```bash
93+
labctl quota set PROJECT_NAME TYPE VALUE
94+
```
95+
96+
If you want to remove all the quota allocated to a project, you can use the following command:
97+
98+
```bash
99+
labctl quota unset PROJECT_NAME TYPE
100+
```

docs/cloud/tos.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ Access is restricted to ESGI students and teachers. Each user must use their own
1414

1515
## 4. Best Practices and Restrictions
1616

17-
### What You Can Do:
17+
### What You Can Do
1818

1919
- Deploy virtual machines and use resources for educational purposes.
2020
- Test applications, develop projects, and experiment with cloud technologies.
2121
- Use the cloud for academic projects and research.
2222
- Respect the quotas allocated to your account.
2323
- Secure your access and data.
2424

25-
### What Is Prohibited:
25+
### What Is Prohibited
2626

2727
- Hosting publicly accessible services without authorization.
2828
- Engaging in illegal activities (hacking, DDoS, cryptomining, etc.).
@@ -36,6 +36,7 @@ Access is restricted to ESGI students and teachers. Each user must use their own
3636

3737
- Each user is responsible for actions performed with their account.
3838
- Any suspicious or non-compliant activity may be reported and investigated.
39+
- Monitoring and Intervention: The Infrastructure Lab team reserves the right to access any hosted resources if suspicious activity is detected that could compromise the security, stability, or integrity of the services. This includes, but is not limited to, unauthorized access attempts, abuse of resources, or any actions that violate the platform’s acceptable use policies. Any attempt to obstruct an investigation or restrict administrator access will result in an immediate account suspension and an official report to the ESGI administration.
3940
- If a user performs unauthorized actions or endangers the infrastructure, the incident will be immediately reported to the ESGI administration. The user may be required to explain their actions at a disciplinary committee.
4041
- VM updates and security are the user’s responsibility.
4142
- In case of issues, contact the team via the #ticket-help channel on Discord.

mkdocs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ nav:
2121
- Cloud:
2222
- Getting started: cloud/getting-started.md
2323
- Install certificate: cloud/cert.md
24+
- Manage projects and quotas: cloud/projects_quotas.md
2425
- CLI reference: cloud/cli.md
2526
- Terms of service: cloud/tos.md
2627
- Game:
@@ -38,6 +39,8 @@ markdown_extensions:
3839
- pymdownx.inlinehilite
3940
- pymdownx.snippets
4041
- pymdownx.superfences
42+
- admonition
43+
- pymdownx.details
4144
- attr_list
4245
- pymdownx.emoji:
4346
emoji_index: !!python/name:material.extensions.emoji.twemoji

0 commit comments

Comments
 (0)