Skip to content

Commit

Permalink
Merge branch 'master' into PLAT-330_Azure_docs
Browse files Browse the repository at this point in the history
  • Loading branch information
llewellyn-sl authored Oct 11, 2024
2 parents 3de8eea + f98c291 commit 56c9b3b
Show file tree
Hide file tree
Showing 29 changed files with 2,006 additions and 22 deletions.
2 changes: 2 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -277,11 +277,13 @@ export default async function createConfigAsync() {
"json",
"yaml",
"groovy",
"java",
"ini",
"nginx",
"bash",
"docker",
"python",
"r",
"typescript",
],
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -495,14 +495,21 @@ Do not replace the [Seqera-provided default image](../../functionality_matrix/fu

## Seqera API

Enable the API endpoints to host the Seqera Enterprise OpenAPI specification and use the [tw CLI](https://github.com/seqeralabs/tower-cli).
Enable the API endpoints to host the Seqera Enterprise OpenAPI specification and use the [tw CLI](https://github.com/seqeralabs/tower-cli). Set custom API rate limits and timeouts.

:::note
To configure API rate limit environment variables, you must add `ratelim` to the `MICRONAUT_ENVIRONMENTS`. Without `ratelim` being set, the rate limit configuration variables below are ignored.
:::

<Tabs>
<TabItem value="Environment variables" label="Environment variables" default>

| Environment variable | Description | Value |
| ---------------------- | ----------------------------------------------------------------------------- | --------------- |
| `TOWER_ENABLE_OPENAPI` | Enable the OpenAPI documentation endpoint, e.g., [cloud.seqera.io/openapi/index.html](https://cloud.seqera.io/openapi/index.html). | Default: `true` |
| `TOWER_RATELIMIT_PERIOD` | Specify the maximum number of HTTP requests that can be made during the `TOWER_RATELIMIT_REFRESH` period. | Default: `20` |
| `TOWER_RATELIMIT_REFRESH` | API rate limit refresh period. | Default: `1s` |
| `TOWER_RATELIMIT_TIMEOUT` | The waiting period before rejecting requests over the `TOWER_RATELIMIT_PERIOD` limit during the refresh period. | Default: `500ms` |

</TabItem>
</Tabs>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ To launch pipelines directly with CLI tools, select the **Launch Pipeline** tab
![Launch Seqera Pipeline](assets/seqera-pipelines-launch-cli.png)
:::

### Add nf-core/rnaseq from the Launchpad
### Add nf-core/rnaseq manually

![Add nf-core/rnaseq pipeline](assets/sp-cloud-add-rnaseq.gif)

Expand Down
752 changes: 752 additions & 0 deletions platform_versioned_docs/version-23.4/getting-started/rnaseq.mdx

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -489,14 +489,21 @@ Do not replace the [Seqera-provided default image](../../functionality_matrix/fu

## Seqera API

Enable the API endpoints to host the Seqera Enterprise OpenAPI specification and use the [tw CLI](https://github.com/seqeralabs/tower-cli).
Enable the API endpoints to host the Seqera Enterprise OpenAPI specification and use the [tw CLI](https://github.com/seqeralabs/tower-cli). Set custom API rate limits and timeouts.

:::note
To configure API rate limit environment variables, you must add `ratelim` to the `MICRONAUT_ENVIRONMENTS`. Without `ratelim` being set, the rate limit configuration variables below are ignored.
:::

<Tabs>
<TabItem value="Environment variables" label="Environment variables" default>

| Environment variable | Description | Value |
| ---------------------- | ----------------------------------------------------------------------------- | --------------- |
| `TOWER_ENABLE_OPENAPI` | Enable the OpenAPI documentation endpoint, e.g., [cloud.seqera.io/openapi/index.html](https://cloud.seqera.io/openapi/index.html). | Default: `true` |
| `TOWER_RATELIMIT_PERIOD` | Specify the maximum number of HTTP requests that can be made during the `TOWER_RATELIMIT_REFRESH` period. | Default: `20` |
| `TOWER_RATELIMIT_REFRESH` | API rate limit refresh period. | Default: `1s` |
| `TOWER_RATELIMIT_TIMEOUT` | The waiting period before rejecting requests over the `TOWER_RATELIMIT_PERIOD` limit during the refresh period. | Default: `500ms` |

</TabItem>
</Tabs>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
752 changes: 752 additions & 0 deletions platform_versioned_docs/version-24.1/getting-started/rnaseq.mdx

Large diffs are not rendered by default.

11 changes: 2 additions & 9 deletions platform_versioned_sidebars/version-23.4-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
"label": "Tutorials",
"collapsed": true,
"items": [
"getting-started/quickstart-demo/comm-showcase"
"getting-started/quickstart-demo/comm-showcase",
"getting-started/rnaseq"
]
},
{
Expand Down Expand Up @@ -84,7 +85,6 @@
"type": "category",
"label": "Data",
"items": [
"getting-started/quickstart-demo/add-data",
"data/data-explorer",
"data/datasets"
]
Expand All @@ -93,7 +93,6 @@
"type": "category",
"label": "Pipelines",
"items": [
"getting-started/quickstart-demo/add-pipelines",
"pipeline-schema/overview",
"launch/launchpad",
"labels/overview",
Expand All @@ -117,7 +116,6 @@
"type": "category",
"label": "Administration",
"items": [
"getting-started/workspace-setup",
"administration/overview",
"orgs-and-teams/organizations",
"orgs-and-teams/workspace-management",
Expand Down Expand Up @@ -186,11 +184,6 @@
"label": "Developer tools",
"collapsed": true,
"items": [
{
"type": "doc",
"id": "getting-started/quickstart-demo/automation",
"label": "Overview"
},
"api/overview",
{
"type": "category",
Expand Down
13 changes: 3 additions & 10 deletions platform_versioned_sidebars/version-24.1-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@
"label": "Tutorials",
"collapsed": true,
"items": [
"getting-started/quickstart-demo/comm-showcase"
]
"getting-started/quickstart-demo/comm-showcase",
"getting-started/rnaseq"
]
},
{
"type": "category",
Expand Down Expand Up @@ -85,7 +86,6 @@
"type": "category",
"label": "Data",
"items": [
"getting-started/quickstart-demo/add-data",
"data/data-explorer",
"data/datasets"
]
Expand All @@ -94,7 +94,6 @@
"type": "category",
"label": "Pipelines",
"items": [
"getting-started/quickstart-demo/add-pipelines",
"pipeline-schema/overview",
"launch/launchpad",
"labels/overview",
Expand All @@ -119,7 +118,6 @@
"type": "category",
"label": "Administration",
"items": [
"getting-started/workspace-setup",
"administration/overview",
"orgs-and-teams/organizations",
"orgs-and-teams/workspace-management",
Expand Down Expand Up @@ -190,11 +188,6 @@
"label": "Developer tools",
"collapsed": true,
"items": [
{
"type": "doc",
"id": "getting-started/quickstart-demo/automation",
"label": "Overview"
},
"api/overview",
{
"type": "category",
Expand Down

0 comments on commit 56c9b3b

Please sign in to comment.