cloudos-cli 2.89.0__tar.gz → 2.89.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/PKG-INFO +107 -105
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/README.md +105 -103
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/__main__.py +1 -1
- cloudos_cli-2.89.2/cloudos_cli/_version.py +1 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/bash/cli.py +16 -16
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/clos.py +50 -50
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/configure/cli.py +2 -2
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/configure/configure.py +6 -6
- cloudos_cli-2.89.2/cloudos_cli/constants.py +75 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/cromwell/cli.py +14 -14
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/datasets/cli.py +31 -31
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/datasets/datasets.py +27 -27
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/import_wf/__init__.py +1 -1
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/interactive_session/cli.py +44 -44
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/interactive_session/interactive_session.py +22 -22
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/jobs/cli.py +79 -79
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/jobs/job.py +35 -35
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/link/cli.py +8 -8
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/link/link.py +2 -2
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/procurement/cli.py +15 -15
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/procurement/images.py +8 -8
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/projects/cli.py +11 -11
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/queue/cli.py +7 -7
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/queue/queue.py +9 -9
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/utils/array_job.py +5 -5
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/utils/details.py +199 -156
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/utils/nextflow_version.py +3 -3
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/workflows/cli.py +10 -10
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli.egg-info/PKG-INFO +107 -105
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli.egg-info/SOURCES.txt +1 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/setup.py +1 -1
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/tests/test_cli_project_create.py +3 -3
- cloudos_cli-2.89.2/tests/test_details.py +444 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/tests/test_interactive_session/test_create_session.py +3 -3
- cloudos_cli-2.89.0/cloudos_cli/_version.py +0 -1
- cloudos_cli-2.89.0/cloudos_cli/constants.py +0 -28
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/LICENSE +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/bash/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/configure/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/cost/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/cost/cost.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/cromwell/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/datasets/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/import_wf/import_wf.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/interactive_session/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/jobs/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/link/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/logging/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/logging/logger.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/procurement/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/projects/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/queue/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/related_analyses/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/related_analyses/related_analyses.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/utils/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/utils/cli_helpers.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/utils/cloud.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/utils/errors.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/utils/last_wf.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/utils/requests.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/utils/resources.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli/workflows/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli.egg-info/dependency_links.txt +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli.egg-info/entry_points.txt +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli.egg-info/requires.txt +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/cloudos_cli.egg-info/top_level.txt +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/setup.cfg +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/tests/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/tests/functions_for_pytest.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/tests/test_cost/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/tests/test_cost/test_job_cost.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/tests/test_error_messages.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/tests/test_interactive_session/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/tests/test_interactive_session/test_list_sessions.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/tests/test_logging/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/tests/test_logging/test_logger.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/tests/test_nextflow_version.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/tests/test_related_analyses/__init__.py +0 -0
- {cloudos_cli-2.89.0 → cloudos_cli-2.89.2}/tests/test_related_analyses/test_related_analyses.py +0 -0
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: cloudos_cli
|
|
3
|
-
Version: 2.89.
|
|
4
|
-
Summary: Python package for interacting with
|
|
3
|
+
Version: 2.89.2
|
|
4
|
+
Summary: Python package for interacting with the Lifebit Platform
|
|
5
5
|
Home-page: https://github.com/lifebit-ai/cloudos-cli
|
|
6
6
|
Author: David Piñeyro
|
|
7
7
|
Author-email: david.pineyro@lifebit.ai
|
|
@@ -37,7 +37,7 @@ Dynamic: summary
|
|
|
37
37
|
|
|
38
38
|
[](https://github.com/lifebit-ai/cloudos-cli/actions/workflows/ci.yml)
|
|
39
39
|
|
|
40
|
-
Python package for interacting with
|
|
40
|
+
Python package for interacting with Lifebit Platform
|
|
41
41
|
|
|
42
42
|
---
|
|
43
43
|
|
|
@@ -203,26 +203,26 @@ To get general information about the tool:
|
|
|
203
203
|
cloudos --help
|
|
204
204
|
```
|
|
205
205
|
```console
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
206
|
+
|
|
207
|
+
Usage: cloudos [OPTIONS] COMMAND [ARGS]...
|
|
208
|
+
|
|
209
|
+
CloudOS python package: a package for interacting with Lifebit Platform.
|
|
210
|
+
|
|
211
211
|
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
212
212
|
│ --debug Show detailed error information and tracebacks │
|
|
213
213
|
│ --version Show the version and exit. │
|
|
214
214
|
│ --help Show this message and exit. │
|
|
215
215
|
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
216
216
|
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
217
|
-
│ bash
|
|
218
|
-
│ configure
|
|
217
|
+
│ bash Lifebit Platform bash functionality. │
|
|
218
|
+
│ configure Lifebit Platform configuration. │
|
|
219
219
|
│ cromwell Cromwell server functionality: check status, start and stop. │
|
|
220
|
-
│ datasets
|
|
221
|
-
│ job
|
|
222
|
-
│ procurement
|
|
223
|
-
│ project
|
|
224
|
-
│ queue
|
|
225
|
-
│ workflow
|
|
220
|
+
│ datasets Lifebit Platform datasets functionality. │
|
|
221
|
+
│ job Lifebit Platform job functionality: run, check and abort jobs in Lifebit Platform. │
|
|
222
|
+
│ procurement Lifebit Platform procurement functionality. │
|
|
223
|
+
│ project Lifebit Platform project functionality: list and create projects in Lifebit Platform. │
|
|
224
|
+
│ queue Lifebit Platform job queue functionality. │
|
|
225
|
+
│ workflow Lifebit Platform workflow functionality: list and import workflows. │
|
|
226
226
|
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
227
227
|
```
|
|
228
228
|
|
|
@@ -233,14 +233,14 @@ cloudos job list --help
|
|
|
233
233
|
```
|
|
234
234
|
```console Usage: cloudos job list [OPTIONS]
|
|
235
235
|
|
|
236
|
-
Collect workspace jobs from a
|
|
236
|
+
Collect workspace jobs from a Lifebit Platform workspace in CSV or JSON format.
|
|
237
237
|
|
|
238
238
|
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
239
|
-
│ * --apikey -k TEXT Your
|
|
240
|
-
│ * --cloudos-url -c TEXT The
|
|
239
|
+
│ * --apikey -k TEXT Your Lifebit Platform API key [required] │
|
|
240
|
+
│ * --cloudos-url -c TEXT The Lifebit Platform url you are trying to access to. │
|
|
241
241
|
│ Default=https://cloudos.lifebit.ai. │
|
|
242
242
|
│ [required] │
|
|
243
|
-
│ * --workspace-id TEXT The specific
|
|
243
|
+
│ * --workspace-id TEXT The specific Lifebit Platform workspace id. [required] │
|
|
244
244
|
│ --output-basename TEXT Output file base name to save jobs list. Default=joblist │
|
|
245
245
|
│ --output-format [csv|json] The desired file format (file extension) for the output. │
|
|
246
246
|
│ For json option --all-fields will be automatically set to │
|
|
@@ -286,7 +286,7 @@ In the same way, each implemented command has its own subcommands with its own `
|
|
|
286
286
|
|
|
287
287
|
## Configuration
|
|
288
288
|
|
|
289
|
-
CloudOS CLI uses a profile-based configuration system to store your credentials and settings securely. This eliminates the need to provide authentication details with every command and allows you to work with multiple
|
|
289
|
+
CloudOS CLI uses a profile-based configuration system to store your credentials and settings securely. This eliminates the need to provide authentication details with every command and allows you to work with multiple Lifebit Platform environments.
|
|
290
290
|
|
|
291
291
|
Configuration will be saved in the $HOME path folder regardless of operating system. Here, a new folder named `.cloudos` will be created, with files `credentials` and `config` also being created. The structure will look like:
|
|
292
292
|
|
|
@@ -320,8 +320,8 @@ cloudos configure --profile {profile-name}
|
|
|
320
320
|
The same prompts will appear, including the execution platform (aws or azure). If a profile with the same name already exists, the current parameters will appear in square brackets and can be overwritten or left unchanged by pressing Enter/Return.
|
|
321
321
|
|
|
322
322
|
When configuring a profile, you can specify:
|
|
323
|
-
- **API Key**: Your
|
|
324
|
-
- **
|
|
323
|
+
- **API Key**: Your Lifebit Platform API credentials
|
|
324
|
+
- **Platform URL**: The Lifebit Platform instance URL
|
|
325
325
|
- **Project Name**: Default project for commands
|
|
326
326
|
- **Execution Platform**: `aws` (default) or `azure` - determines default instance types and available features
|
|
327
327
|
- **Repository Platform**: Version control system (github, gitlab, etc.)
|
|
@@ -374,7 +374,7 @@ See [Configuration](#configuration) section above for detailed information on se
|
|
|
374
374
|
|
|
375
375
|
### Project
|
|
376
376
|
|
|
377
|
-
Projects in
|
|
377
|
+
Projects in Lifebit Platform provide logical separation of datasets, workflows, and results, making it easier to manage complex research initiatives. You can list all available projects or create new ones using the CLI.
|
|
378
378
|
|
|
379
379
|
#### List Projects
|
|
380
380
|
|
|
@@ -414,7 +414,7 @@ cloudos project list --profile my_profile --output-format json
|
|
|
414
414
|
|
|
415
415
|
#### Create Projects
|
|
416
416
|
|
|
417
|
-
You can create a new project in your
|
|
417
|
+
You can create a new project in your Lifebit Platform workspace using the `project create` command. This command requires the name of the new project and will return the project ID upon successful creation.
|
|
418
418
|
|
|
419
419
|
```bash
|
|
420
420
|
cloudos project create --profile my_profile --new-project "My New Project"
|
|
@@ -429,10 +429,10 @@ The expected output is something similar to:
|
|
|
429
429
|
|
|
430
430
|
### Queue
|
|
431
431
|
|
|
432
|
-
Job queues are required for running jobs using AWS batch executor. The available job queues in your
|
|
432
|
+
Job queues are required for running jobs using AWS batch executor. The available job queues in your Lifebit Platform workspace are listed in the "Compute Resources" section in "Settings".
|
|
433
433
|
|
|
434
434
|
> [!NOTE]
|
|
435
|
-
> **Azure Platform**: Queue listing is not available for
|
|
435
|
+
> **Azure Platform**: Queue listing is not available for Lifebit Platform workspaces configured to use Azure execution platform, as Azure does not use AWS batch queues.
|
|
436
436
|
|
|
437
437
|
#### List Queues
|
|
438
438
|
|
|
@@ -474,11 +474,11 @@ To save queue data to a CSV file:
|
|
|
474
474
|
cloudos queue list --profile my_profile --output-format csv
|
|
475
475
|
```
|
|
476
476
|
|
|
477
|
-
> NOTE: The queue name that is visible in
|
|
477
|
+
> NOTE: The queue name that is visible in Lifebit Platform and must be used with the `--job-queue` parameter is the one in the `label` field.
|
|
478
478
|
|
|
479
479
|
**Job queues for platform workflows**
|
|
480
480
|
|
|
481
|
-
Platform workflows (those provided by
|
|
481
|
+
Platform workflows (those provided by Lifebit Platform in your workspace as modules) run on separate and specific AWS batch queues (system queues). Therefore, Lifebit Platform will automatically assign the valid queue and you should not specify any queue using the `--job-queue` parameter. Any attempt to use this parameter will be ignored. Examples of such platform workflows are "System Tools" and "Data Factory" workflows.
|
|
482
482
|
|
|
483
483
|
|
|
484
484
|
### Workflow
|
|
@@ -525,19 +525,19 @@ Executing list...
|
|
|
525
525
|
Workflow list saved to workflow_list.json
|
|
526
526
|
```
|
|
527
527
|
|
|
528
|
-
The collected workflows are those that can be found in the "WORKSPACE TOOLS" section in
|
|
528
|
+
The collected workflows are those that can be found in the "WORKSPACE TOOLS" section in Lifebit Platform.
|
|
529
529
|
|
|
530
530
|
#### Import a Nextflow Workflow
|
|
531
531
|
|
|
532
|
-
You can import new workflows to your
|
|
532
|
+
You can import new workflows to your Lifebit Platform workspaces. The requirements are:
|
|
533
533
|
|
|
534
534
|
- The workflow must be a Nextflow pipeline
|
|
535
535
|
- The workflow repository must be located at GitHub, GitLab or BitBucket Server (specified by the `--repository-platform` option. Available options: `github`, `gitlab` and `bitbucketServer`)
|
|
536
|
-
- If your repository is private, you must have access to the repository and have linked your GitHub, Gitlab or Bitbucket server accounts to
|
|
536
|
+
- If your repository is private, you must have access to the repository and have linked your GitHub, Gitlab or Bitbucket server accounts to Lifebit Platform
|
|
537
537
|
|
|
538
538
|
**Usage of the workflow import command**
|
|
539
539
|
|
|
540
|
-
To import GitHub workflows to
|
|
540
|
+
To import GitHub workflows to Lifebit Platform:
|
|
541
541
|
|
|
542
542
|
```bash
|
|
543
543
|
# Example workflow to import: https://github.com/lifebit-ai/DeepVariant
|
|
@@ -547,7 +547,7 @@ cloudos workflow import --profile my_profile --workflow-url "https://github.com/
|
|
|
547
547
|
The expected output will be:
|
|
548
548
|
|
|
549
549
|
```console
|
|
550
|
-
|
|
550
|
+
Lifebit Platform workflow functionality: list and import workflows.
|
|
551
551
|
|
|
552
552
|
Executing workflow import...
|
|
553
553
|
|
|
@@ -562,16 +562,16 @@ Optionally, you can add a link to your workflow documentation by providing the U
|
|
|
562
562
|
cloudos workflow import --profile my_profile --workflow-url "https://github.com/lifebit-ai/DeepVariant" --workflow-name "new_name_for_the_github_workflow" --workflow-docs-link "https://github.com/lifebit-ai/DeepVariant/blob/master/README.md" --repository-platform github
|
|
563
563
|
```
|
|
564
564
|
|
|
565
|
-
> NOTE: Importing workflows using cloudos-cli is not yet available in all
|
|
565
|
+
> NOTE: Importing workflows using cloudos-cli is not yet available in all Lifebit Platform workspaces. If you try to use this feature in a non-prepared workspace you will get the following error message: `It seems your API key is not authorised. Please check if your workspace has support for importing workflows using cloudos-cli`.
|
|
566
566
|
|
|
567
567
|
|
|
568
568
|
### Nextflow Jobs
|
|
569
569
|
|
|
570
|
-
The job commands allow you to submit, monitor, and manage computational workflows on
|
|
570
|
+
The job commands allow you to submit, monitor, and manage computational workflows on Lifebit Platform. This includes both Nextflow pipelines and bash scripts, with support for various execution platforms.
|
|
571
571
|
|
|
572
572
|
#### Submit a Job
|
|
573
573
|
|
|
574
|
-
You can submit Nextflow workflows to
|
|
574
|
+
You can submit Nextflow workflows to Lifebit Platform using either configuration files or command-line parameters. Jobs can be configured with specific compute resources, execution platforms, parameters, etc.
|
|
575
575
|
|
|
576
576
|
First, configure your local environment to ease parameter input. We will try to submit a small toy example already available:
|
|
577
577
|
|
|
@@ -651,7 +651,7 @@ If everything went well, you should see something like:
|
|
|
651
651
|
|
|
652
652
|
```console
|
|
653
653
|
Executing run...
|
|
654
|
-
Job successfully launched to
|
|
654
|
+
Job successfully launched to Lifebit Platform, please check the following link: https://cloudos.lifebit.ai/app/advanced-analytics/analyses/62c83a1191fe06013b7ef355
|
|
655
655
|
Your assigned job id is: 62c83a1191fe06013b7ef355
|
|
656
656
|
Your current job status is: initializing
|
|
657
657
|
To further check your job status you can either go to https://cloudos.lifebit.ai/app/advanced-analytics/analyses/62c83a1191fe06013b7ef355 or use the following command:
|
|
@@ -675,7 +675,7 @@ If the job takes less than `--wait-time` (3600 seconds by default), the previous
|
|
|
675
675
|
|
|
676
676
|
```console
|
|
677
677
|
Executing run...
|
|
678
|
-
Job successfully launched to
|
|
678
|
+
Job successfully launched to Lifebit Platform, please check the following link: https://cloudos.lifebit.ai/app/advanced-analytics/analyses/62c83a6191fe06013b7ef363
|
|
679
679
|
Your assigned job id is: 62c83a6191fe06013b7ef363
|
|
680
680
|
Please, wait until job completion or max wait time of 3600 seconds is reached.
|
|
681
681
|
Your current job status is: initializing.
|
|
@@ -712,7 +712,7 @@ cloudos job run --profile my_profile --workflow-name rnatoy --job-config cloudos
|
|
|
712
712
|
|
|
713
713
|
**AWS Executor Support**
|
|
714
714
|
|
|
715
|
-
|
|
715
|
+
Lifebit Platform supports [AWS batch](https://www.nextflow.io/docs/latest/executor.html?highlight=executors#aws-batch) executor by default.
|
|
716
716
|
You can specify the AWS batch queue to use from the ones available in your workspace (see [here](#list-job-queues)) by specifying its name with the `--job-queue` parameter. If none is specified, the most recent suitable queue in your workspace will be selected by default.
|
|
717
717
|
|
|
718
718
|
Example command:
|
|
@@ -721,13 +721,13 @@ Example command:
|
|
|
721
721
|
cloudos job run --profile my_profile --workflow-name rnatoy --job-config cloudos_cli/examples/rnatoy.config --resumable
|
|
722
722
|
```
|
|
723
723
|
|
|
724
|
-
> Note: From cloudos-cli 2.7.0, the default executor is AWS batch. The previous Apache [ignite](https://www.nextflow.io/docs/latest/ignite.html#apache-ignite) executor is being removed progressively from
|
|
724
|
+
> Note: From cloudos-cli 2.7.0, the default executor is AWS batch. The previous Apache [ignite](https://www.nextflow.io/docs/latest/ignite.html#apache-ignite) executor is being removed progressively from Lifebit Platform, so most likely will not be available in your Lifebit Platform. Cloudos-cli still supports ignite during this period by adding the `--ignite` flag to the `cloudos job run` command. Please note that if you use the `--ignite` flag in a Lifebit Platform without ignite support, the command will fail.
|
|
725
725
|
|
|
726
726
|
**Azure Execution Platform Support**
|
|
727
727
|
|
|
728
|
-
|
|
728
|
+
Lifebit Platform can also be configured to use Microsoft Azure compute platforms. If your Lifebit Platform is configured to use Azure, you will need to take into consideration the following:
|
|
729
729
|
|
|
730
|
-
- When sending jobs to
|
|
730
|
+
- When sending jobs to Lifebit Platform using `cloudos job run` command, please use the option `--execution-platform azure`
|
|
731
731
|
- Azure only supports Nextflow version `22.11.1-edge`. If you specify a different version, CloudOS CLI will display a warning and automatically use `22.11.1-edge` instead
|
|
732
732
|
- Due to the lack of AWS batch queues in Azure, `cloudos queue list` command is not working
|
|
733
733
|
|
|
@@ -739,7 +739,7 @@ cloudos job run --profile my_profile --workflow-name rnatoy --job-config cloudos
|
|
|
739
739
|
|
|
740
740
|
**HPC Execution Support**
|
|
741
741
|
|
|
742
|
-
|
|
742
|
+
Lifebit Platform is also prepared to use an HPC compute infrastructure. For such cases, you will need to take into account the following for your job submissions using `cloudos job run` command:
|
|
743
743
|
|
|
744
744
|
- Use the following parameter: `--execution-platform hpc`
|
|
745
745
|
- Indicate the HPC ID using: `--hpc-id XXXX`
|
|
@@ -799,19 +799,21 @@ The output shows a rich table with job information and pagination details:
|
|
|
799
799
|
```console
|
|
800
800
|
Executing list...
|
|
801
801
|
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
│
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
└────────┴──────────────┴─────────────┴──────────┴──────────────┴─────────────────────────┴──────────────┘
|
|
802
|
+
┏━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
|
|
803
|
+
┃ Status ┃ ID ┃ Pipeline ┃ Name ┃ Project ┃ Owner ┃ Runtime ┃
|
|
804
|
+
┡━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
|
|
805
|
+
│ ✓ │ 692ee71c40e98ed6ed529e43 │ rnatoy │ analysis_run │ test-proj │ John Doe │ 15m 30s │
|
|
806
|
+
│ ◐ │ 692ee81d50f98ed7fe639f54 │ VEP │ test_job │ research │ Jane Sm… │ 2m 15s │
|
|
807
|
+
└────────┴──────────────────────────┴──────────────┴────────────────┴──────────────┴──────────┴─────────┘
|
|
808
|
+
|
|
809
|
+
Legend: ✓ = Completed | ◐ = Running | ✗ = Failed | ■ = Aborted | ○ = Initialising | ? = Unknown
|
|
811
810
|
|
|
812
811
|
Showing 10 of 45 total jobs | Page 1 of 5
|
|
813
812
|
```
|
|
814
813
|
|
|
814
|
+
> [!NOTE]
|
|
815
|
+
> **Responsive Table Display**: The table automatically adapts to your terminal width, intelligently selecting which columns to display. Narrow terminals show essential columns (Status, ID, Pipeline, Name), while wider terminals progressively add more information (Project, Owner, Runtime, Cost, timestamps, etc.). The table ensures only complete columns are shown and always renders with proper borders.
|
|
816
|
+
|
|
815
817
|
**Status Indicators**
|
|
816
818
|
|
|
817
819
|
Jobs are displayed with colored visual status indicators:
|
|
@@ -823,7 +825,7 @@ Jobs are displayed with colored visual status indicators:
|
|
|
823
825
|
|
|
824
826
|
**Clickable Job IDs**
|
|
825
827
|
|
|
826
|
-
Job IDs in the table are clickable hyperlinks (when supported by your terminal) that open the job details page in
|
|
828
|
+
Job IDs in the table are clickable hyperlinks (when supported by your terminal) that open the job details page in Lifebit Platform.
|
|
827
829
|
|
|
828
830
|
**Job Listing Control Options**
|
|
829
831
|
|
|
@@ -964,7 +966,7 @@ cloudos job list --profile my_profile --last-n-jobs all --filter-workflow rnatoy
|
|
|
964
966
|
|
|
965
967
|
#### Get Job Results
|
|
966
968
|
|
|
967
|
-
The following command allows you to get the path where
|
|
969
|
+
The following command allows you to get the path where Lifebit Platform stores the output files for a job. This can be used only on your user's jobs and for jobs with "completed" status.
|
|
968
970
|
|
|
969
971
|
Example:
|
|
970
972
|
```bash
|
|
@@ -1096,7 +1098,7 @@ cloudos job resume \
|
|
|
1096
1098
|
|
|
1097
1099
|
#### Abort Jobs
|
|
1098
1100
|
|
|
1099
|
-
Aborts jobs in the
|
|
1101
|
+
Aborts jobs in the Lifebit Platform workspace that are either running or initializing. It can be used with one or more job IDs provided as a comma-separated string using the `--job-ids` parameter.
|
|
1100
1102
|
|
|
1101
1103
|
##### Basic Usage
|
|
1102
1104
|
|
|
@@ -1125,9 +1127,9 @@ Job 680a3cf80e56949775c02f16 aborted successfully.
|
|
|
1125
1127
|
|
|
1126
1128
|
##### Additional Options
|
|
1127
1129
|
|
|
1128
|
-
- `--workspace-id`: The
|
|
1129
|
-
- `--apikey`: Your
|
|
1130
|
-
- `--cloudos-url`: The
|
|
1130
|
+
- `--workspace-id`: The Lifebit Platform workspace ID (can be set in profile)
|
|
1131
|
+
- `--apikey`: Your Lifebit Platform API key (can be set in profile)
|
|
1132
|
+
- `--cloudos-url`: The Lifebit Platform URL (default: https://cloudos.lifebit.ai)
|
|
1131
1133
|
- `--verbose`: Print detailed information messages
|
|
1132
1134
|
- `--disable-ssl-verification`: Disable SSL certificate verification (not recommended)
|
|
1133
1135
|
- `--ssl-cert`: Path to your SSL certificate file
|
|
@@ -1206,7 +1208,7 @@ This file can later be used when running a job with `cloudos job run --job-confi
|
|
|
1206
1208
|
|
|
1207
1209
|
#### Get Job Workdir
|
|
1208
1210
|
|
|
1209
|
-
To get the working directory of a job submitted to
|
|
1211
|
+
To get the working directory of a job submitted to Lifebit Platform:
|
|
1210
1212
|
|
|
1211
1213
|
```shell
|
|
1212
1214
|
cloudos job workdir \
|
|
@@ -1217,7 +1219,7 @@ cloudos job workdir \
|
|
|
1217
1219
|
The output should be something similar to:
|
|
1218
1220
|
|
|
1219
1221
|
```console
|
|
1220
|
-
|
|
1222
|
+
Lifebit Platform job functionality: run, check and abort jobs in Lifebit Platform.
|
|
1221
1223
|
|
|
1222
1224
|
Finding working directory path...
|
|
1223
1225
|
Working directory for job 68747bac9e7fe38ec6e022ad: az://123456789000.blob.core.windows.net/cloudos-987652349087/projects/455654676/jobs/54678856765/work
|
|
@@ -1295,9 +1297,9 @@ cloudos job logs --profile my_profile --job-id "12345678910" --link --session-id
|
|
|
1295
1297
|
|
|
1296
1298
|
#### Get Job Costs
|
|
1297
1299
|
|
|
1298
|
-
You can retrieve detailed cost information for any job in your
|
|
1300
|
+
You can retrieve detailed cost information for any job in your Lifebit Platform workspace using the `job cost` command. This provides insights into compute costs, storage usage, and runtime metrics to help optimize workflows and manage expenses.
|
|
1299
1301
|
|
|
1300
|
-
The cost information is retrieved from
|
|
1302
|
+
The cost information is retrieved from Lifebit Platform and can be displayed in multiple formats:
|
|
1301
1303
|
|
|
1302
1304
|
- **Console display**: Rich formatted tables with pagination for easy viewing
|
|
1303
1305
|
- **CSV**: Structured data for analysis and reporting
|
|
@@ -1442,9 +1444,9 @@ cat 62c83a1191fe06013b7ef355_costs.json
|
|
|
1442
1444
|
|
|
1443
1445
|
#### Get Job Related Analyses
|
|
1444
1446
|
|
|
1445
|
-
You can view related jobs that share the same working directory in a
|
|
1447
|
+
You can view related jobs that share the same working directory in a Lifebit Platform workspace by using the `job related` command. This feature helps track job lineages, resume workflows, and understand job relationships.
|
|
1446
1448
|
|
|
1447
|
-
The information is retrieved from
|
|
1449
|
+
The information is retrieved from Lifebit Platform and can be displayed in multiple formats:
|
|
1448
1450
|
|
|
1449
1451
|
- **Console display**: Rich formatted tables with pagination
|
|
1450
1452
|
- **JSON**: Complete job data for programmatic processing
|
|
@@ -1482,7 +1484,7 @@ The table displays key information for each related job:
|
|
|
1482
1484
|
- **Status**: Current job state (initializing, running, completed, aborting, aborted, failed)
|
|
1483
1485
|
- **Name**: Job name assigned when submitted
|
|
1484
1486
|
- **Owner**: User who submitted the job (first name and last name)
|
|
1485
|
-
- **ID**: Job identifier in
|
|
1487
|
+
- **ID**: Job identifier in Lifebit Platform
|
|
1486
1488
|
- **Submit time**: When the job was submitted (formatted as YYYY-MM-DD HH:MM:SS)
|
|
1487
1489
|
- **Run time**: Actual execution time (formatted as hours, minutes, seconds)
|
|
1488
1490
|
- **Total Cost**: Compute cost in USD
|
|
@@ -1550,7 +1552,7 @@ Related analyses are particularly useful for:
|
|
|
1550
1552
|
|
|
1551
1553
|
#### Delete Job Results
|
|
1552
1554
|
|
|
1553
|
-
|
|
1555
|
+
Lifebit Platform allows you to permanently delete job results directories to manage storage and clean up completed analyses. This feature provides a safe way to remove final analysis results with built-in confirmation prompts and status tracking.
|
|
1554
1556
|
|
|
1555
1557
|
> [!WARNING]
|
|
1556
1558
|
> Deleting job results is **irreversible**. All data and backups will be permanently removed and cannot be recovered. Use this feature with caution.
|
|
@@ -1626,7 +1628,7 @@ For bulk deletion of job results and working directories across multiple jobs in
|
|
|
1626
1628
|
|
|
1627
1629
|
#### Archive Jobs
|
|
1628
1630
|
|
|
1629
|
-
|
|
1631
|
+
Lifebit Platform allows you to archive completed jobs to organize and manage your analysis history.
|
|
1630
1632
|
|
|
1631
1633
|
> [!NOTE]
|
|
1632
1634
|
> Archiving jobs does not delete any data or results. It simply adds metadata to mark jobs as archived for organizational purposes.
|
|
@@ -1711,14 +1713,14 @@ Job 'valid_job' archived successfully.
|
|
|
1711
1713
|
- `--verbose`: Display detailed information about the archiving process
|
|
1712
1714
|
- `--profile`: Use a specific configuration profile
|
|
1713
1715
|
- `--workspace-id`: Specify the workspace ID (if not using profiles)
|
|
1714
|
-
- `--apikey`: Your
|
|
1716
|
+
- `--apikey`: Your Lifebit Platform API key (if not using profiles)
|
|
1715
1717
|
|
|
1716
1718
|
> [!TIP]
|
|
1717
1719
|
> Use the `cloudos job list` command to identify jobs you want to archive. You can filter by status, project, or other criteria to find specific jobs for archiving.
|
|
1718
1720
|
|
|
1719
1721
|
#### Unarchive Jobs
|
|
1720
1722
|
|
|
1721
|
-
|
|
1723
|
+
Lifebit Platform allows you to restore archived jobs back to their active state. Unarchiving removes the archived status while preserving all job data, results, and history.
|
|
1722
1724
|
|
|
1723
1725
|
> [!NOTE]
|
|
1724
1726
|
> Unarchiving jobs does not modify any data or results. It simply removes the archived metadata flag, making jobs appear as regular (non-archived) jobs again.
|
|
@@ -1803,7 +1805,7 @@ Job 'valid_job' unarchived successfully.
|
|
|
1803
1805
|
- `--verbose`: Display detailed information about the unarchiving process
|
|
1804
1806
|
- `--profile`: Use a specific configuration profile
|
|
1805
1807
|
- `--workspace-id`: Specify the workspace ID (if not using profiles)
|
|
1806
|
-
- `--apikey`: Your
|
|
1808
|
+
- `--apikey`: Your Lifebit Platform API key (if not using profiles)
|
|
1807
1809
|
|
|
1808
1810
|
**Managing Job Lifecycle**
|
|
1809
1811
|
|
|
@@ -1817,12 +1819,12 @@ Use the archive and unarchive commands together to manage your job organization:
|
|
|
1817
1819
|
> Archived jobs remain fully accessible - archiving is purely for organizational purposes. Use `cloudos job list` with appropriate filters to view and manage both archived and active jobs.
|
|
1818
1820
|
|
|
1819
1821
|
### Bash Jobs
|
|
1820
|
-
Execute bash scripts on
|
|
1822
|
+
Execute bash scripts on Lifebit Platform for custom processing workflows. Bash jobs allow you to run shell commands with custom parameters and are ideal for data preprocessing or simple computational tasks.
|
|
1821
1823
|
|
|
1822
1824
|
#### Send Array Job
|
|
1823
1825
|
|
|
1824
1826
|
|
|
1825
|
-
A bash job can be sent to
|
|
1827
|
+
A bash job can be sent to Lifebit Platform using the command `bash` and the subcommand `job`. In this case, the `--workflow-name` must be a bash job already present in the platform. Bash jobs are identified by bash icon (unlike Nextflow jobs, which are identified with Nextflow icon).
|
|
1826
1828
|
|
|
1827
1829
|
```bash
|
|
1828
1830
|
cloudos bash job \
|
|
@@ -1846,9 +1848,9 @@ Each `--parameter` can have a different prefix, either '--', '-', or '', dependi
|
|
|
1846
1848
|
If everything went well, you should see something like:
|
|
1847
1849
|
|
|
1848
1850
|
```console
|
|
1849
|
-
|
|
1851
|
+
Lifebit Platform bash functionality.
|
|
1850
1852
|
|
|
1851
|
-
Job successfully launched to
|
|
1853
|
+
Job successfully launched to Lifebit Platform, please check the following link: https://cloudos.lifebit.ai/app/advanced-analytics/analyses/682622d09f305de717327334
|
|
1852
1854
|
Your assigned job id is: 682622d09f305de717327334
|
|
1853
1855
|
|
|
1854
1856
|
Your current job status is: initializing
|
|
@@ -2180,8 +2182,8 @@ cloudos interactive-session create \
|
|
|
2180
2182
|
- `--shutdown-in`: Auto-shutdown duration (e.g., `8h`, `2d`, `30m`, default: `12h`)
|
|
2181
2183
|
|
|
2182
2184
|
**Data & Storage Management:**
|
|
2183
|
-
- `--mount`: Mount a data file into the session. Supports both
|
|
2184
|
-
- `--link`: Link a folder into the session for read/write access (AWS only). Supports S3 folders and
|
|
2185
|
+
- `--mount`: Mount a data file into the session. Supports both Lifebit Platform datasets and S3 files (AWS only). Format: `project_name/dataset_path` (e.g., `leila-test/Data/file.csv`) or `s3://bucket/path/to/file` (e.g., `s3://my-bucket/data/file.csv`). Can be used multiple times.
|
|
2186
|
+
- `--link`: Link a folder into the session for read/write access (AWS only). Supports S3 folders and Lifebit Platform folders. Format: `s3://bucket/prefix` (e.g., `s3://my-bucket/data/`) or `project_name/folder_path` (e.g., `leila-test/AnalysesResults/analysis_id/results`). Can be used multiple times. **Note:** Linking is not supported on Azure. Use Lifebit Platform file explorer for data access.
|
|
2185
2187
|
|
|
2186
2188
|
**Backend-Specific:**
|
|
2187
2189
|
- `--r-version`: R version for RStudio (options: `4.4.2`, `4.5.2`) - **optional for rstudio** (default: `4.4.2`)
|
|
@@ -2531,7 +2533,7 @@ The command automatically loads from profile (via `@with_profile_config` decorat
|
|
|
2531
2533
|
|
|
2532
2534
|
**Optional Overrides from Profile:**
|
|
2533
2535
|
- `--apikey` (optional): Override API key from profile
|
|
2534
|
-
- `--cloudos-url` (optional): Override
|
|
2536
|
+
- `--cloudos-url` (optional): Override Lifebit Platform URL from profile
|
|
2535
2537
|
- `--workspace-id` (optional): Override workspace ID from profile
|
|
2536
2538
|
|
|
2537
2539
|
**Optional Behavior Flags:**
|
|
@@ -2604,11 +2606,11 @@ All configuration parameters are optional. If not specified, the session resumes
|
|
|
2604
2606
|
|
|
2605
2607
|
### Datasets
|
|
2606
2608
|
|
|
2607
|
-
Manage files and folders within your
|
|
2609
|
+
Manage files and folders within your Lifebit Platform File Explorer programmatically. These commands provide comprehensive file management capabilities for organizing research data and results.
|
|
2608
2610
|
|
|
2609
2611
|
#### List Files
|
|
2610
2612
|
|
|
2611
|
-
Browse files and folders within your
|
|
2613
|
+
Browse files and folders within your Lifebit Platform projects. Use the `--details` flag to get comprehensive information about file ownership, sizes, and modification dates.
|
|
2612
2614
|
|
|
2613
2615
|
```bash
|
|
2614
2616
|
cloudos datasets ls <path> --profile <profile>
|
|
@@ -2768,7 +2770,7 @@ cloudos datasets mkdir <new_folder_path> --profile my_profile
|
|
|
2768
2770
|
|
|
2769
2771
|
#### Remove Files or Folders
|
|
2770
2772
|
|
|
2771
|
-
Remove unnecessary files or empty folders from your File Explorer. Note that this removes files from
|
|
2773
|
+
Remove unnecessary files or empty folders from your File Explorer. Note that this removes files from Lifebit Platform but not from underlying cloud storage.
|
|
2772
2774
|
|
|
2773
2775
|
> [!NOTE]
|
|
2774
2776
|
> Files and folders can be removed in the `Data` datasets and its subfolders.
|
|
@@ -2817,12 +2819,12 @@ cloudos link "Data/MyFolder" --project-name my-project --session-id <SESSION_ID>
|
|
|
2817
2819
|
**Command options:**
|
|
2818
2820
|
|
|
2819
2821
|
- `PATH`: S3 path to link (positional argument, required if `--job-id` is not provided)
|
|
2820
|
-
- `--apikey` / `-k`: Your
|
|
2821
|
-
- `--cloudos-url` / `-c`: The
|
|
2822
|
-
- `--workspace-id`: The specific
|
|
2823
|
-
- `--session-id`: The specific
|
|
2824
|
-
- `--job-id`: The job ID in
|
|
2825
|
-
- `--project-name`:
|
|
2822
|
+
- `--apikey` / `-k`: Your Lifebit Platform API key (required)
|
|
2823
|
+
- `--cloudos-url` / `-c`: The Lifebit Platform URL (default: https://cloudos.lifebit.ai)
|
|
2824
|
+
- `--workspace-id`: The specific Lifebit Platform workspace ID (required)
|
|
2825
|
+
- `--session-id`: The specific Lifebit Platform interactive session ID (required)
|
|
2826
|
+
- `--job-id`: The job ID in Lifebit Platform (links results, workdir, and logs by default)
|
|
2827
|
+
- `--project-name`: Lifebit Platform project name (required for File Explorer paths)
|
|
2826
2828
|
- `--results`: Link only results folder (only works with `--job-id`)
|
|
2827
2829
|
- `--workdir`: Link only working directory (only works with `--job-id`)
|
|
2828
2830
|
- `--logs`: Link only logs folder (only works with `--job-id`)
|
|
@@ -2866,7 +2868,7 @@ The command provides clear error messages for common scenarios:
|
|
|
2866
2868
|
|
|
2867
2869
|
### Procurement
|
|
2868
2870
|
|
|
2869
|
-
|
|
2871
|
+
Lifebit Platform supports procurement functionality to manage and list images associated with organizations within a given procurement. This feature is useful for administrators and users who need to view available container images across different organizations in their procurement.
|
|
2870
2872
|
|
|
2871
2873
|
#### List Procurement Images
|
|
2872
2874
|
|
|
@@ -2882,9 +2884,9 @@ cloudos procurement images ls \
|
|
|
2882
2884
|
|
|
2883
2885
|
**Command options:**
|
|
2884
2886
|
|
|
2885
|
-
- `--apikey` / `-k`: Your
|
|
2886
|
-
- `--cloudos-url` / `-c`: The
|
|
2887
|
-
- `--procurement-id`: The specific
|
|
2887
|
+
- `--apikey` / `-k`: Your Lifebit Platform API key (required)
|
|
2888
|
+
- `--cloudos-url` / `-c`: The Lifebit Platform URL you are trying to access (default: https://cloudos.lifebit.ai)
|
|
2889
|
+
- `--procurement-id`: The specific Lifebit Platform procurement ID (required)
|
|
2888
2890
|
- `--page`: The response page number (default: 1)
|
|
2889
2891
|
- `--limit`: The page size limit (default: 10)
|
|
2890
2892
|
- `--disable-ssl-verification`: Disable SSL certificate verification
|
|
@@ -2918,7 +2920,7 @@ This is particularly useful for understanding what container images are availabl
|
|
|
2918
2920
|
|
|
2919
2921
|
#### Set Procurement Organization Image
|
|
2920
2922
|
|
|
2921
|
-
You can set a custom image ID or name for an organization within a procurement using the `cloudos procurement images set` command. This allows you to override the default
|
|
2923
|
+
You can set a custom image ID or name for an organization within a procurement using the `cloudos procurement images set` command. This allows you to override the default Lifebit Platform images with your own custom images for specific organizations.
|
|
2922
2924
|
|
|
2923
2925
|
To set a custom image for an organization, use the following command:
|
|
2924
2926
|
|
|
@@ -2928,11 +2930,11 @@ cloudos procurement images set --profile procurement_profile --image-type "JobDe
|
|
|
2928
2930
|
|
|
2929
2931
|
**Set command options:**
|
|
2930
2932
|
|
|
2931
|
-
- `--apikey` / `-k`: Your
|
|
2932
|
-
- `--cloudos-url` / `-c`: The
|
|
2933
|
-
- `--procurement-id`: The specific
|
|
2933
|
+
- `--apikey` / `-k`: Your Lifebit Platform API key (required)
|
|
2934
|
+
- `--cloudos-url` / `-c`: The Lifebit Platform URL you are trying to access (default: https://cloudos.lifebit.ai)
|
|
2935
|
+
- `--procurement-id`: The specific Lifebit Platform procurement ID (required)
|
|
2934
2936
|
- `--organisation-id`: The organization ID where the change will be applied (required)
|
|
2935
|
-
- `--image-type`: The
|
|
2937
|
+
- `--image-type`: The Lifebit Platform resource image type (required). Possible values:
|
|
2936
2938
|
- `RegularInteractiveSessions`
|
|
2937
2939
|
- `SparkInteractiveSessions`
|
|
2938
2940
|
- `RStudioInteractiveSessions`
|
|
@@ -2957,7 +2959,7 @@ cloudos procurement images set --profile procurement_profile --image-type "JobDe
|
|
|
2957
2959
|
|
|
2958
2960
|
#### Reset Procurement Organization Image
|
|
2959
2961
|
|
|
2960
|
-
You can reset an organization's image configuration back to
|
|
2962
|
+
You can reset an organization's image configuration back to Lifebit Platform defaults using the `cloudos procurement images reset` command. This removes any custom image configurations and restores the original Lifebit Platform defaults.
|
|
2961
2963
|
|
|
2962
2964
|
To reset an organization's image to defaults, use the following command:
|
|
2963
2965
|
|
|
@@ -2967,11 +2969,11 @@ cloudos procurement images reset --profile procurement_profile --image-type "Job
|
|
|
2967
2969
|
|
|
2968
2970
|
**Reset command options:**
|
|
2969
2971
|
|
|
2970
|
-
- `--apikey` / `-k`: Your
|
|
2971
|
-
- `--cloudos-url` / `-c`: The
|
|
2972
|
-
- `--procurement-id`: The specific
|
|
2972
|
+
- `--apikey` / `-k`: Your Lifebit Platform API key (required)
|
|
2973
|
+
- `--cloudos-url` / `-c`: The Lifebit Platform URL you are trying to access (default: https://cloudos.lifebit.ai)
|
|
2974
|
+
- `--procurement-id`: The specific Lifebit Platform procurement ID (required)
|
|
2973
2975
|
- `--organisation-id`: The organization ID where the change will be applied (required)
|
|
2974
|
-
- `--image-type`: The
|
|
2976
|
+
- `--image-type`: The Lifebit Platform resource image type (required). Same values as for `set` command
|
|
2975
2977
|
- `--provider`: The cloud provider (required). Currently only `aws` is supported
|
|
2976
2978
|
- `--region`: The cloud region (required). Currently only AWS regions are supported
|
|
2977
2979
|
- `--disable-ssl-verification`: Disable SSL certificate verification
|
|
@@ -2981,7 +2983,7 @@ cloudos procurement images reset --profile procurement_profile --image-type "Job
|
|
|
2981
2983
|
**Reset command example:**
|
|
2982
2984
|
|
|
2983
2985
|
```bash
|
|
2984
|
-
# Reset image configuration to
|
|
2986
|
+
# Reset image configuration to Lifebit Platform defaults
|
|
2985
2987
|
cloudos procurement images reset --profile procurement_profile --image-type "JobDefault" --provider "aws" --region "us-east-1" --procurement-id "your_procurement_id_here" --organisation-id "your_organization_id"
|
|
2986
2988
|
```
|
|
2987
2989
|
|
|
@@ -2990,7 +2992,7 @@ cloudos procurement images reset --profile procurement_profile --image-type "Job
|
|
|
2990
2992
|
|
|
2991
2993
|
#### Manage Cromwell Server
|
|
2992
2994
|
|
|
2993
|
-
In order to run WDL pipelines, a Cromwell server in
|
|
2995
|
+
In order to run WDL pipelines, a Cromwell server in Lifebit Platform should be running. This server can be accessed to check its status, restart it or stop it, using the following commands:
|
|
2994
2996
|
|
|
2995
2997
|
```bash
|
|
2996
2998
|
# Check Cromwell status
|
|
@@ -3028,7 +3030,7 @@ Stopping Cromwell server...
|
|
|
3028
3030
|
|
|
3029
3031
|
To run WDL workflows, `cloudos job run` command can be used normally, but adding two extra parameters:
|
|
3030
3032
|
|
|
3031
|
-
- `--wdl-mainfile`: name of the mainFile (*.wdl) file used by the
|
|
3033
|
+
- `--wdl-mainfile`: name of the mainFile (*.wdl) file used by the Lifebit Platform workflow.
|
|
3032
3034
|
- `--wdl-importsfile` [Optional]: name of the workflow imported file (importsFile, *.zip).
|
|
3033
3035
|
|
|
3034
3036
|
All the rest of the `cloudos job run` functionality is available.
|
|
@@ -3077,7 +3079,7 @@ Executing run...
|
|
|
3077
3079
|
--workspace-id $WORKSPACE_ID
|
|
3078
3080
|
*******************************************************************************
|
|
3079
3081
|
|
|
3080
|
-
Job successfully launched to
|
|
3082
|
+
Job successfully launched to Lifebit Platform, please check the following link: ****
|
|
3081
3083
|
Your assigned job id is: ****
|
|
3082
3084
|
Please, wait until job completion or max wait time of 3600 seconds is reached.
|
|
3083
3085
|
Your current job status is: initializing.
|