From af2dfb2a84ca8202ac3d863af479e75c5d991596 Mon Sep 17 00:00:00 2001 From: Llewellyn vd Berg <113503285+llewellyn-sl@users.noreply.github.com> Date: Tue, 22 Oct 2024 16:43:08 +0200 Subject: [PATCH 1/2] Differentiate paid vs free limits, add audit log retention config --- .../configtables/tower_logging.yml | 17 ++++++--- .../version-23.4/monitoring/audit-logs.mdx | 8 +++- .../configtables/tower_logging.yml | 17 ++++++--- .../version-24.1/limits/limits.mdx | 38 +++++++++---------- .../version-24.1/monitoring/audit-logs.mdx | 8 +++- 5 files changed, 53 insertions(+), 35 deletions(-) diff --git a/platform_versioned_docs/version-23.4/enterprise/configuration/configtables/tower_logging.yml b/platform_versioned_docs/version-23.4/enterprise/configuration/configtables/tower_logging.yml index 4422d6c8f..7022b6a38 100644 --- a/platform_versioned_docs/version-23.4/enterprise/configuration/configtables/tower_logging.yml +++ b/platform_versioned_docs/version-23.4/enterprise/configuration/configtables/tower_logging.yml @@ -1,23 +1,28 @@ --- +- + Environment variable: '`TOWER_CRON_AUDIT_LOG_CLEAN_UP_TIME_OFFSET`' + Description: > + Application event audit log retention period. Logged events older than this period are deleted. Value includes units (`30d`, `24h`, `60m`, etc.). + Value: 'Default: `365d`' - Environment variable: '`TOWER_LOG_APPENDER`' Description: > - The output format of Seqera logs. + The output format of Platform logs. Value: 'Options: `STDOUT`, `JSON`' - Environment variable: '`TOWER_LOG_LEVEL`' Description: > - Seqera application logging detail level. + Platform backend logging detail level. Value: 'Options: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`' - Environment variable: '`TOWER_SECURITY_LOGLEVEL`' Description: > - Seqera authentication logging detail level. + Platform authentication logging detail level. Value: 'Options: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`' - Environment variable: '`TOWER_LOG_DIR`' Description: > - Base directory to store Seqera logs. + Base directory to store Platform logs. Value: - Environment variable: '`TOWER_LOG_PATTERN`' @@ -27,12 +32,12 @@ - Environment variable: '`TOWER_LOG_MAX_HISTORY`' Description: > - The maximum number of log files retained by the logging system. + The maximum number of backend log files retained by the system. Value: - Environment variable: '`TOWER_LOG_MAX_SIZE`' Description: > - The maximum file size of the Seqera backend log file. When this limit is reached, a new log file is created. + The maximum file size of the Platform backend log file. When this limit is reached, a new log file is created. Value: - Environment variable: '`LOGGER_LEVELS_IO_SEQERA_TOWER_AGENT`' diff --git a/platform_versioned_docs/version-23.4/monitoring/audit-logs.mdx b/platform_versioned_docs/version-23.4/monitoring/audit-logs.mdx index 9270d12c0..3f00d0ce6 100644 --- a/platform_versioned_docs/version-23.4/monitoring/audit-logs.mdx +++ b/platform_versioned_docs/version-23.4/monitoring/audit-logs.mdx @@ -7,7 +7,11 @@ tags: [logging, audit logs, admin panel] Root users can view application event audit logs from the [Admin panel](../administration/overview.mdx) **Audit logs** tab. -## Audit log event format +:::info +Application event audit logs are retained for 365 days by default. In Platform Enterprise, this retention period can be [customized](../enterprise/configuration/overview.mdx#logging). +::: + +### Audit log event format Audit log entries record the following event details: @@ -22,7 +26,7 @@ Audit log entries record the following event details: - **Client IP**: IP address of user/client initiating the event. Empty for Seqera-initiated events. - **Creation date**: Event timestamp in `YYYY-MM-DD-HH-MM-SS` format. -## Audit log events +### Audit log events Audit logs include administration, security, and application resource events. diff --git a/platform_versioned_docs/version-24.1/enterprise/configuration/configtables/tower_logging.yml b/platform_versioned_docs/version-24.1/enterprise/configuration/configtables/tower_logging.yml index 4422d6c8f..7022b6a38 100644 --- a/platform_versioned_docs/version-24.1/enterprise/configuration/configtables/tower_logging.yml +++ b/platform_versioned_docs/version-24.1/enterprise/configuration/configtables/tower_logging.yml @@ -1,23 +1,28 @@ --- +- + Environment variable: '`TOWER_CRON_AUDIT_LOG_CLEAN_UP_TIME_OFFSET`' + Description: > + Application event audit log retention period. Logged events older than this period are deleted. Value includes units (`30d`, `24h`, `60m`, etc.). + Value: 'Default: `365d`' - Environment variable: '`TOWER_LOG_APPENDER`' Description: > - The output format of Seqera logs. + The output format of Platform logs. Value: 'Options: `STDOUT`, `JSON`' - Environment variable: '`TOWER_LOG_LEVEL`' Description: > - Seqera application logging detail level. + Platform backend logging detail level. Value: 'Options: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`' - Environment variable: '`TOWER_SECURITY_LOGLEVEL`' Description: > - Seqera authentication logging detail level. + Platform authentication logging detail level. Value: 'Options: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`' - Environment variable: '`TOWER_LOG_DIR`' Description: > - Base directory to store Seqera logs. + Base directory to store Platform logs. Value: - Environment variable: '`TOWER_LOG_PATTERN`' @@ -27,12 +32,12 @@ - Environment variable: '`TOWER_LOG_MAX_HISTORY`' Description: > - The maximum number of log files retained by the logging system. + The maximum number of backend log files retained by the system. Value: - Environment variable: '`TOWER_LOG_MAX_SIZE`' Description: > - The maximum file size of the Seqera backend log file. When this limit is reached, a new log file is created. + The maximum file size of the Platform backend log file. When this limit is reached, a new log file is created. Value: - Environment variable: '`LOGGER_LEVELS_IO_SEQERA_TOWER_AGENT`' diff --git a/platform_versioned_docs/version-24.1/limits/limits.mdx b/platform_versioned_docs/version-24.1/limits/limits.mdx index 34fb23b72..6d676bf43 100644 --- a/platform_versioned_docs/version-24.1/limits/limits.mdx +++ b/platform_versioned_docs/version-24.1/limits/limits.mdx @@ -9,14 +9,14 @@ Seqera Platform elements and features have default limits per workspace and orga ### Workspaces -| Description | Value | -| ------------ | ----- | -| Active runs | 5 | -| Members | 50 | -| Participants | 50 | -| Pipelines | 100 | -| Datasets | 100 | -| Labels | 1000 | +| Description | Free | Cloud Pro + Enterprise | +| ------------ | ---- | ---------------------- | +| Active runs | 5 | Per license | +| Members | 50 | Per license | +| Participants | 50 | Per license | +| Pipelines | 100 | Per license | +| Datasets | 100 | Per license | +| Labels | 1000 | 1000 | :::note Some Enterprise instances on older licenses are limited to 100 labels per workspace. [Contact support](mailto:support@seqera.io) to upgrade your license. @@ -24,22 +24,22 @@ Some Enterprise instances on older licenses are limited to 100 labels per worksp ### Organizations -| Description | Value | -| ----------- | ----- | -| Workspaces | 50 | -| Teams | 20 | +| Description | Free | Cloud Pro + Enterprise | +| ----------- | ---- | ---------------------- | +| Workspaces | 50 | Per license | +| Teams | 20 | Per license | ### Datasets -| Description | Value | -| -------------------- | ----- | -| File size | 10 MB | -| Versions per dataset | 100 | +| Description | Default limit | +| -------------------- | ------------- | +| File size | 10 MB | +| Versions per dataset | 100 | ### Data Studios -| Description | Value | -| -------------------- | ----- | -| Running Data Studio sessions | 100 | +| Description | Free | Cloud Pro + Enterprise | +| ---------------------------- | ---- | ---------------------- | +| Running data studio sessions | 1 | 100 | If you need higher limits and capabilities, [contact us](https://seqera.io/contact-us/) to discuss your application requirements. diff --git a/platform_versioned_docs/version-24.1/monitoring/audit-logs.mdx b/platform_versioned_docs/version-24.1/monitoring/audit-logs.mdx index 9270d12c0..3f00d0ce6 100644 --- a/platform_versioned_docs/version-24.1/monitoring/audit-logs.mdx +++ b/platform_versioned_docs/version-24.1/monitoring/audit-logs.mdx @@ -7,7 +7,11 @@ tags: [logging, audit logs, admin panel] Root users can view application event audit logs from the [Admin panel](../administration/overview.mdx) **Audit logs** tab. -## Audit log event format +:::info +Application event audit logs are retained for 365 days by default. In Platform Enterprise, this retention period can be [customized](../enterprise/configuration/overview.mdx#logging). +::: + +### Audit log event format Audit log entries record the following event details: @@ -22,7 +26,7 @@ Audit log entries record the following event details: - **Client IP**: IP address of user/client initiating the event. Empty for Seqera-initiated events. - **Creation date**: Event timestamp in `YYYY-MM-DD-HH-MM-SS` format. -## Audit log events +### Audit log events Audit logs include administration, security, and application resource events. From 8adfebf6a3ca27cf8788c43e1e4b51d59ad31e64 Mon Sep 17 00:00:00 2001 From: Llewellyn vd Berg <113503285+llewellyn-sl@users.noreply.github.com> Date: Wed, 23 Oct 2024 09:50:09 +0200 Subject: [PATCH 2/2] Update Enterprise default limits --- .../version-23.4/limits/limits.mdx | 32 +++++++++---------- .../version-24.1/limits/limits.mdx | 18 +++++------ 2 files changed, 25 insertions(+), 25 deletions(-) diff --git a/platform_versioned_docs/version-23.4/limits/limits.mdx b/platform_versioned_docs/version-23.4/limits/limits.mdx index e58280568..b834f6ea3 100644 --- a/platform_versioned_docs/version-23.4/limits/limits.mdx +++ b/platform_versioned_docs/version-23.4/limits/limits.mdx @@ -9,14 +9,14 @@ Seqera Platform elements and features have default limits per workspace and orga ### Workspaces -| Description | Value | -| ------------ | ----- | -| Active runs | 5 | -| Members | 50 | -| Participants | 50 | -| Pipelines | 100 | -| Datasets | 100 | -| Labels | 1000 | +| Description | Free | Cloud Pro + Enterprise | +| ------------ | ---- | ---------------------- | +| Active runs | 5 | 100, or per license | +| Members | 50 | 50, or per license | +| Participants | 50 | 50, or per license | +| Pipelines | 100 | 100, or per license | +| Datasets | 100 | 1000, or per license | +| Labels | 1000 | 1000, or per license | :::note Some Enterprise instances on older licenses are limited to 100 labels per workspace. [Contact support](mailto:support@seqera.io) to upgrade your license. @@ -24,16 +24,16 @@ Some Enterprise instances on older licenses are limited to 100 labels per worksp ### Organizations -| Description | Value | -| ----------- | ----- | -| Workspaces | 50 | -| Teams | 20 | +| Description | Free | Cloud Pro + Enterprise | +| ----------- | ---- | ---------------------- | +| Workspaces | 50 | 50, or per license | +| Teams | 20 | 20, or per license | ### Datasets -| Description | Value | -| -------------------- | ----- | -| File size | 10 MB | -| Versions per dataset | 100 | +| Description | Default limit | +| -------------------- | ------------- | +| File size | 10 MB | +| Versions per dataset | 100 | If you need higher limits and capabilities, [contact us](https://seqera.io/contact-us/) to discuss your application requirements. diff --git a/platform_versioned_docs/version-24.1/limits/limits.mdx b/platform_versioned_docs/version-24.1/limits/limits.mdx index 6d676bf43..8e78f33da 100644 --- a/platform_versioned_docs/version-24.1/limits/limits.mdx +++ b/platform_versioned_docs/version-24.1/limits/limits.mdx @@ -11,12 +11,12 @@ Seqera Platform elements and features have default limits per workspace and orga | Description | Free | Cloud Pro + Enterprise | | ------------ | ---- | ---------------------- | -| Active runs | 5 | Per license | -| Members | 50 | Per license | -| Participants | 50 | Per license | -| Pipelines | 100 | Per license | -| Datasets | 100 | Per license | -| Labels | 1000 | 1000 | +| Active runs | 5 | 100, or per license | +| Members | 50 | 50, or per license | +| Participants | 50 | 50, or per license | +| Pipelines | 100 | 100, or per license | +| Datasets | 100 | 1000, or per license | +| Labels | 1000 | 1000, or per license | :::note Some Enterprise instances on older licenses are limited to 100 labels per workspace. [Contact support](mailto:support@seqera.io) to upgrade your license. @@ -26,8 +26,8 @@ Some Enterprise instances on older licenses are limited to 100 labels per worksp | Description | Free | Cloud Pro + Enterprise | | ----------- | ---- | ---------------------- | -| Workspaces | 50 | Per license | -| Teams | 20 | Per license | +| Workspaces | 50 | 50, or per license | +| Teams | 20 | 20, or per license | ### Datasets @@ -40,6 +40,6 @@ Some Enterprise instances on older licenses are limited to 100 labels per worksp | Description | Free | Cloud Pro + Enterprise | | ---------------------------- | ---- | ---------------------- | -| Running data studio sessions | 1 | 100 | +| Running data studio sessions | 1 | 1000, or per license | If you need higher limits and capabilities, [contact us](https://seqera.io/contact-us/) to discuss your application requirements.