# Onboard a new tenant demo with API.

In this demonstration, we will show you how to use the API to create a new billing account with a suitable quota configuration. We will first create a new account, then a new user, and grant the user cooperation permissions. Finally, we'll assign the new account quota to our Slurm and k8s cluster.

<table border="1" id="bkmrk-first%2C-we-need-to-re-1" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 72.0586%;"></col><col style="width: 27.9414%;"></col></colgroup><tbody><tr><td>[![image.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/image.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/image.png)

</td><td>First, we need to retrieve our token for API access. Go to the dashboard and obtain your own API access key and secret.</td></tr></tbody></table>

There are various ways to store the API key and secret. In the following demo, we will use the shell command to export it as a shell environment variable. However, this method is not secure for storing API access. If you have any security concerns, please generate a new API key.

```bash
export OASIS_KEY=<API KEY>
export OASIS_SECRET=<API KEY SECRET>
export OASIS_HOST=<API DOMAIN>
```

<table border="1" id="bkmrk-all-the-preparations" style="border-collapse: collapse; width: 100.494%; height: 201px;"><colgroup><col style="width: 100%;"></col></colgroup><thead><tr style="height: 140.547px;"><td style="height: 140.547px;">All the preparations are complete; let's begin. First, we need to understand what billing accounts currently exist. Considering that the billing account structure is hierarchical, the root billing account is 'ALL'.

```bash
#get parentOpts
curl -k -XGET https://$OASIS_DOMAIN/admin/accounts/new \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET"
```

The result should be like the following:

</td></tr></thead><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">[![image.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/o76image.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/o76image.png)

</td></tr></tbody></table>

<table border="1" id="bkmrk-now%2C-we-can-create-a" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 99.8765%;"></col></colgroup><thead><tr><td>Now, we can create a new billing account. For example, let's say we want to create an account under OneAsia, owned by 'Test'. This account can have a maximum of 10 users, with a unique GID of 4001.

```bash
# create a new billing account
curl -k -XPOST https://$OASIS_DOMAIN/admin/accounts/new \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET" \
-d '{"name":"test","parent":"oneasia","type":"billing","owner_name":"test","owner_email":"test@test.com","fairshare":100,"user_quota":10,"gid":4001}'
```

The result should be like the following:

</td></tr></thead><tbody><tr><td>[![image.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/N6yimage.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/N6yimage.png)

</td></tr></tbody></table>

<table border="1" id="bkmrk-after-that%2C-we-can-c" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 99.8765%;"></col></colgroup><tbody><tr><td>After that, we can create a consumer account under the newly created billing account. The consumer account is the actual account that the researcher will be working on.

```bash
# create a consumer account
curl -k -XPOST https://$OASIS_DOMAIN/my-accounts/oneasiaai/child-accounts/new-account \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET" \
-d '{"gid":1031,"fairshare":100,"user_quota":10,"parent":"test","type":"consumer","owner_email":"test2@test.com","name":"test_child"}'
```

The result should be like the following:

</td></tr><tr><td>[![image.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/glXimage.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/glXimage.png)

</td></tr></tbody></table>

<table border="1" id="bkmrk-than%2C-we-can-can-cre" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 99.881%;"></col></colgroup><tbody><tr><td>Than, we can can create a user

```bash
# create a new user
curl -k -XPOST https://$OASIS_DOMAIN/my-accounts/account/test/create-user \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET" \
-d '{"login_id":"test","full_name":"test test","email":"test@test.com","password":"password12345678","mobile":91235678}'
```

The result should be like the following:

</td></tr><tr><td>[![image.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/itEimage.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/itEimage.png)

</td></tr></tbody></table>

<table border="1" id="bkmrk-we-need-to-assign-co" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 99.881%;"></col></colgroup><tbody><tr><td>We need to assign coordinator permissions to the manager's account. The account coordinator has the authority to modify the configuration of that account and its subordinate accounts.

```bash
# grant coordinator permission to that account
curl -k -XPOST https://$OASIS_DOMAIN/admin/accounts/test/user/test/set-coordinator \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET" \
-d '{"value":true}'
```

The result should be like the following:

</td></tr><tr><td>[![image.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/EW5image.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/EW5image.png)

</td></tr></tbody></table>

Finally, we onboard a new billing account, facilitated by a coordinator.

[![Screenshot from 2024-04-30 10-46-39.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/screenshot-from-2024-04-30-10-46-39.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/screenshot-from-2024-04-30-10-46-39.png)

The next section is assign a proper quota in slurm. In the web interface, it is in the setting section.

[![Screenshot from 2024-04-30 10-49-17.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/screenshot-from-2024-04-30-10-49-17.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/screenshot-from-2024-04-30-10-49-17.png)

<table border="1" id="bkmrk-first%2C-we-can-disabl" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 99.881%;"></col></colgroup><tbody><tr><td>First, we can disable the setting that allows the coordinator to edit the quota.

```bash
#change slurm quota editable from coordinator
curl -k -XPOST https://$OASIS_DOMAIN/my-accounts/test/set-quota-editable-by-coordinator \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET" \
-d '{"value":"No"}'
```

The result should be like the following:

</td></tr><tr><td>[![image.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/kxuimage.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/kxuimage.png)

</td></tr></tbody></table>

<table border="1" id="bkmrk-next%2C-we-can-set-the" style="border-collapse: collapse; width: 100%; height: 470.156px;"><colgroup><col style="width: 99.881%;"></col></colgroup><tbody><tr style="height: 440.359px;"><td style="height: 440.359px;">Next, we can set the Slurm quota by resource pool. This example assumes that the Slurm cluster has two resource pools: 'builtin' and 'shared'.

```bash
#set slurm quota to that account, for example if cluster has two resource pool: builtin and shared
curl -XPOST https://$OASIS_DOMAIN/my-accounts/test/set-quota/builtin_csu \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET" \
-d '{"value":50}'
curl -XPOST https://$OASIS_DOMAIN/my-accounts/test/set-quota/builtin_gsu \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET" \
-d '{"value":50}'
curl -XPOST https://$OASIS_DOMAIN/my-accounts/test/set-quota/shared_csu \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET" \
-d '{"value":50}'
curl -XPOST https://$OASIS_DOMAIN/my-accounts/test/set-quota/shared_gsu \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET" \
-d '{"value":50}'
```

The result should be like the following:

</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">[![image.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/MS8image.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/MS8image.png)

</td></tr></tbody></table>

<table border="1" id="bkmrk-the-default-action-w" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><colgroup><col style="width: 99.881%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">The default action when a quota is exceeded is inaction. However, we can modify this to either notify us or automatically terminate jobs.

```bash
#change the slurm quota exceeded action: option include: auto_kill_jobs, no_action,notify_only
curl -XPOST https://$OASIS_DOMAIN/my-accounts/oneasiaai/settings/update/quota-exceeded-action \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET" \
-d '{"value":"auto_kill_jobs"}'
```

The result should be like the following:

</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">[![image.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/rrKimage.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/rrKimage.png)

</td></tr></tbody></table>

<table border="1" id="bkmrk-next%2C-we-can-adjust-" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 99.881%;"></col></colgroup><tbody><tr><td>Next, we can adjust the budget settings. Both quota and budget are limitations on team usage. The quota is from a resource perspective, while the budget is from a financial perspective.

```
#change slurm budget editable from coordinator
curl -XPOST https://$OASIS_DOMAIN/my-accounts/test/set-budget-editable-by-coordinator \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET" \
-d '{"value":"No"}'
```

The result should be like the following:

</td></tr><tr><td>[![image.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/ipoimage.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/ipoimage.png)

</td></tr></tbody></table>

<table border="1" id="bkmrk-in-this-demo%2C-we-set" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 99.881%;"></col></colgroup><tbody><tr><td>In this demo, we set 20000 as budget

```bash
#set money-wise budget to that account
curl -XPOST https://$OASIS_DOMAIN/my-accounts/test/set-budget \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET" \
-d '{"value":20000}'
```

The result should be like the following:

</td></tr><tr><td>[![image.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/lDJimage.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/lDJimage.png)

</td></tr></tbody></table>

<table border="1" id="bkmrk-in-a-slurm-budget%2C-y" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 99.881%;"></col></colgroup><tbody><tr><td>In a Slurm budget, you can set notifications and job launch restrictions to activate when an account exceeds 50% of its budget.

```bash
#set notifification when budget consumed over certain ratio
curl -XPOST https://$OASIS_DOMAIN/my-accounts/test/settings/update/budget-exceeded-ratio/notify \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET" \
-d '{"value":50}'
# set job restriction when budget consumed over certain ratio, which take 60 minutes to apply
curl -XPOST https://$OASIS_DOMAIN/my-accounts/test/settings/update/budget-exceeded-ratio/restrict \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET" \
-d '{"value":50}'
```

The result should be like the following:

</td></tr><tr><td>[![image.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/zmuimage.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/zmuimage.png)

</td></tr></tbody></table>

We finish config slurm quota and budget. you can see the change is already show in web UI.

[![Screenshot from 2024-04-30 11-06-47.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/screenshot-from-2024-04-30-11-06-47.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/screenshot-from-2024-04-30-11-06-47.png)

#### Kubernetes Quota

Now we set up quota in k8s. we can use subscriptions to control account storage and GPU usage

<table border="1" id="bkmrk-%23get-all-plan-curl--" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><colgroup><col style="width: 99.881%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">```bash
#get all plan
curl -XGET https://$OASIS_DOMAIN/my-accounts/test/subscription-plans/view \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET"
```

The result should be like the following:  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">[![image.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/poAimage.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/poAimage.png)

</td></tr></tbody></table>

<table border="1" id="bkmrk-next%2C-subscribe-to-a" style="border-collapse: collapse; width: 100%; height: 210.125px;"><colgroup><col style="width: 99.881%;"></col></colgroup><tbody><tr style="height: 180.328px;"><td style="height: 180.328px;">Next, subscribe to a plan.

```bash
#subscribe a plan to that account
curl -XPOST https://$OASIS_DOMAIN/my-accounts/test/subscription-plans/new \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET" \
-d '{"plan":"spk7yes","billing_account_id":"test","activation_start_date":"2022.01.01","auto_renew":"on","timezone":"-480"}'
```

The result should be like the following:

</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">[![image.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/zdTimage.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/zdTimage.png)

</td></tr></tbody></table>

After subscribing, you'll notice that the Kubernetes quota has been updated in the newly created billing account.

[![Screenshot from 2024-04-30 11-12-59.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/screenshot-from-2024-04-30-11-12-59.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/screenshot-from-2024-04-30-11-12-59.png)

Okay, we have finished configuring the billing account. Let's move on to the consumer account

[![Screenshot from 2024-04-30 11-24-47.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/screenshot-from-2024-04-30-11-24-47.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/screenshot-from-2024-04-30-11-24-47.png)

<table border="1" id="bkmrk-let%27s-begin-by-assig" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 99.881%;"></col></colgroup><tbody><tr><td>Let's begin by assigning a Kubernetes (k8s) storage quota to a specific account. Suppose the k8s cluster has a storage class named 'default'. We plan to allocate 1GB to the test account.

```bash
curl -XPOST https://$OASIS_DOMAIN/my-accounts/test_child/set-storage-quota \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET" \
-d '{"cluster":"dev","scName":"default","value":"1"}'
```

The result should be like the following:

</td></tr><tr><td>[![image.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/pJ0image.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/pJ0image.png)

</td></tr></tbody></table>

<table border="1" id="bkmrk-next%2C-set-the-kubern" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 99.881%;"></col></colgroup><tbody><tr><td>Next, set the Kubernetes (k8s) GPU quota for that account. Assume that you are setting 1 guaranteed GPU and 1 max gpu in the dev cluster for the test account.

```bash
curl -XPOST https://$OASIS_DOMAIN/my-accounts/test_child/set-guaranteed-gpu \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET" \
-d '{"value":"1","cluster":"dev"}'

curl -XPOST https://$OASIS_DOMAIN/my-accounts/test_child/set-max-gpu \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET" \
-d '{"value":"1","cluster":"dev"}'
```

The result should be like the following:

</td></tr><tr><td>[![image.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/Q23image.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/Q23image.png)

</td></tr></tbody></table>

finish, that is the web UI display after our work

[![Screenshot from 2024-04-30 11-30-17.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/screenshot-from-2024-04-30-11-30-17.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/screenshot-from-2024-04-30-11-30-17.png)

<table border="1" id="bkmrk-you-can-also-verify--1" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 99.881%;"></col></colgroup><tbody><tr><td>You can also verify this through the API.

```bash
#verify the consumer account
curl -XGET https://$OASIS_DOMAIN/my-accounts/test_child/settings \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET"
#verify the setting
curl -XGET https://$OASIS_DOMAIN/my-accounts/test/settings \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OASIS_KEY:$OASIS_SECRET"
```

The result should be like the following:

</td></tr><tr><td>[![image.png](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/scaled-1680-/toqimage.png)](https://doc.oasishpc.hk/uploads/images/gallery/2024-05/toqimage.png)

</td></tr></tbody></table>