Skip to content

Commit e2b7555

Browse files
jasonnovichRunAIyarongolgal-revach
authored
V2.14-RUN-10061-Ephemeral-volumes (#456)
* get-jobs-example * default-storage-class-sample * default-storage-class-sample * sso-changes * researcher-auth-for-sso * [RUN-11536] update whats new with version content * [RUN-11536] add RUN-10575 description. * [RUN-10061] ephemeral to workspace and training * [RUN-11777] is also included here. * Apply suggestions from code review Co-authored-by: gal-revach <127027411+gal-revach@users.noreply.github.com> * [RUN-10476] add CLI delete time after fail complete * Update docs/Researcher/cli-reference/runai-submit.md Co-authored-by: gal-revach <127027411+gal-revach@users.noreply.github.com> * Update docs/Researcher/user-interface/workspaces/create/workspace-v2.md Co-authored-by: gal-revach <127027411+gal-revach@users.noreply.github.com> * Update docs/Researcher/user-interface/trainings.md Co-authored-by: gal-revach <127027411+gal-revach@users.noreply.github.com> --------- Co-authored-by: Yaron <yaron@run.ai> Co-authored-by: gal-revach <127027411+gal-revach@users.noreply.github.com>
1 parent ca77c4c commit e2b7555

File tree

4 files changed

+58
-8
lines changed

4 files changed

+58
-8
lines changed

docs/Researcher/cli-reference/runai-submit.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,10 @@ runai submit --job-name-prefix -i gcr.io/run-ai-demo/quickstart -g 1
105105
>
106106
> Interactive preemptible jobs can be scheduled above guaranteed quota but may be reclaimed at any time.
107107
108+
#### --auto-deletion-time-after-completion
109+
>
110+
> The timeframe after which a completed or failed job is automatically deleted. Configured in seconds, minutes, or hours (for example 5s, 2m, or 3h). If set to 0, the job will be deleted immediately after completing or failing.
111+
108112
<!-- Start of common content from snippets/common-submit-cli-commands.md -->
109113
### Naming and Shortcuts
110114

docs/Researcher/user-interface/trainings.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ You must have:
1616
* ***Workspaces*** enabled.
1717
* At least one ***Project*** configured.
1818

19-
!!! note
19+
!!! Note
2020
See your system administrator to ensure the prerequisites are enabled and configured.
21+
2122
## Adding Trainings
2223

2324
!!! Note
@@ -31,8 +32,19 @@ To add a training:
3132
4. In the *Training name* pane, enter a name for the *Traninng*, then press continue.
3233
5. In the *Environment* pane select or [create a new environment](workspaces/create/create-env.md). Use the search box to find environments that are not listed.
3334
6. In the *Compute resource* pane, select resources for your tranings or [create a new compute resource](workspaces/create/create-compute.md). Use the search box to find resources that are not listed. Press *More settings* to use **Node Affinity** to limit the resources to a specific node.
34-
7. In the *Data sources* pane, press *add a new data source*. For more information, see [Creating a new data source](workspaces/create/create-ds.md) When complete press, *Create Data Source*.
35-
8. When complete, press *Create training*.
35+
7. Open the *Volume* pane, and press *Volume* to add a volume to your training.
36+
1. Select the *Storage class* from the dropdown.
37+
2. Select the *Access mode* from the dropdown.
38+
3. Enter a claim size, and select the units.
39+
4. Select a *Volume system*, mode from the dropdown.
40+
5. Enter the *Container path* for volume target location.
41+
6. Select a *Volume persistency.
42+
8. In the *Data sources* pane, press *add a new data source*. For more information, see [Creating a new data source](workspaces/create/create-ds.md) When complete press, *Create Data Source*.
43+
9. In the *General* pane, add special settings for your training (optional):
44+
1. Press *Auto-deletion* to delete the training automatically when it either completes or fails. You can configure the timeframe in days, hours, minuets, and seconds. If the timeframe is set to 0, the training will be deleted immediately after it completes or fails.
45+
2. Press *Annotation* to a name and value to annotate the training. Repeat this step to add multiple annotations.
46+
3. Press *Label* to a name and value to label the training. Repeat this step to add multiple labels.
47+
10. When complete, press *Create training*.
3648

3749
## Managing Trainings
3850

@@ -64,4 +76,4 @@ Training details are displayed using the *Show details* action. The details avai
6476

6577
* **Logs**&mdash;a log file of the current status. Use the download button to save the logs.
6678

67-
To hide the training details, press *Hide details*.
79+
To hide the training details, press *Hide details*.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Create a new workspace
2+
A Workspace is assigned to a project and is affected by the project’s quota just like any other workload. A workspace is shared with all project members for collaboration.
3+
4+
To create a new workspace:
5+
6+
1. Press **Workspaces** on left menu, then press *New workspace*.
7+
2. Select a project from the project tiles. If your project is not listed, use the *Search projects* box to find a project.
8+
9+
!!! Note
10+
* You must have at least one project configured in the system. To configure a project, see [Creating a project](../../../../admin/admin-ui-setup/project-setup.md#create-a-project).
11+
* You must have at least 1 researcher assigned to the project.
12+
13+
3. Select a template from the template tiles. If your template is not listed, use the *Search templates* box to find a template. Choose *Start from scratch* if you do not have, or want to use a template.
14+
15+
A template contains a set of predefined building blocks as well as additional configurations which allow the user to immediately create a templated-based workspace.
16+
17+
4. Enter a name for your workspace and press *Continue*.
18+
5. Select an environment from the tiles. If your environment is not listed, use the *Search environments* box to find it. Press *New environment* to create an environment if needed.
19+
1. Press *Commands and Arguments* to add special commands and arguments to your environment selection.
20+
2. Press *Environment variable* to add an environment variable. Press again if you need more environments variables.
21+
6. Select a compute resource from the tiles. If your compute resource is not listed, use the *Search compute resources* box to find it. Press *New compute resource* to create a compute resource if needed.
22+
7. Open the *Volume* pane, and press *Volume* to add a volume to your workspace.
23+
1. Select the *Storage class* from the dropdown.
24+
2. Select the *Access mode* from the dropdown.
25+
3. Enter a claim size, and select the units.
26+
4. Select a *Volume system*, mode from the dropdown.
27+
5. Enter the *Container path* for volume target location.
28+
6. Select a *Volume persistency.
29+
8. Select a data source from the tiles. If your data source is not listed, use the *Search compute resources* box to find it. Press *New data source* to create a new data source if needed.
30+
9. In the *General* pane, add special settings for your workspace:
31+
1. Press *Auto-deletion* to delete the workspace automatically when it either completes or fails. You can configure the timeframe in days, hours, minuets, and seconds. If the timeframe is set to 0, the workspace will be deleted immediately after it completes or fails.
32+
2. Press *Annotation* to a name and value to annotate the workspace. Repeat this step to add multiple annotations.
33+
3. Press *Label* to a name and value to label the workspace. Repeat this step to add multiple labels.
34+
10. Press *Create workspace*

mkdocs.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -280,10 +280,10 @@ nav:
280280
- 'Compute Resources': 'Researcher/user-interface/workspaces/blocks/compute.md'
281281
- 'Data Sources' : 'Researcher/user-interface/workspaces/blocks/datasources.md'
282282
- 'Creation' :
283-
- 'Environments' : 'Researcher/user-interface/workspaces/create/create-env.md'
284-
- 'Compute Resources' : 'Researcher/user-interface/workspaces/create/create-compute.md'
285-
- 'Data Sources' : 'Researcher/user-interface/workspaces/create/create-ds.md'
286-
- 'Workspaces' : 'Researcher/user-interface/workspaces/create/workspace.md'
283+
- 'Create an Environments' : 'Researcher/user-interface/workspaces/create/create-env.md'
284+
- 'Create a Compute Resources' : 'Researcher/user-interface/workspaces/create/create-compute.md'
285+
- 'Create a Data Sources' : 'Researcher/user-interface/workspaces/create/create-ds.md'
286+
- 'Create a Workspace' : 'Researcher/user-interface/workspaces/create/workspace-v2.md'
287287
- 'Statuses' : 'Researcher/user-interface/workspaces/statuses.md'
288288
- 'Trainings' : 'Researcher/user-interface/trainings.md'
289289
- 'CLI Reference' :

0 commit comments

Comments
 (0)