diff --git a/docs/deploying_clearml/enterprise_deploy/app_install_ex_server.md b/docs/deploying_clearml/enterprise_deploy/app_install_ex_server.md index 9b1990a9..098c7aff 100644 --- a/docs/deploying_clearml/enterprise_deploy/app_install_ex_server.md +++ b/docs/deploying_clearml/enterprise_deploy/app_install_ex_server.md @@ -2,6 +2,10 @@ title: Installing External Applications Server --- +:::important Enterprise Feature +This feature is available under the ClearML Enterprise plan. +::: + ClearML supports applications, which are extensions that allow additional capabilities, such as cloud auto-scaling, Hyperparameter Optimizations, etc. For more information, see [ClearML Applications](../../webapp/applications/apps_overview.md). diff --git a/docs/deploying_clearml/enterprise_deploy/app_install_ubuntu_on_prem.md b/docs/deploying_clearml/enterprise_deploy/app_install_ubuntu_on_prem.md index 3fbcb504..1ffdbf2a 100644 --- a/docs/deploying_clearml/enterprise_deploy/app_install_ubuntu_on_prem.md +++ b/docs/deploying_clearml/enterprise_deploy/app_install_ubuntu_on_prem.md @@ -2,6 +2,10 @@ title: Application Installation on On-Prem and VPC Servers --- +:::important Enterprise Feature +This feature is available under the ClearML Enterprise plan. +::: + ClearML Applications are like plugins that allow you to manage ML workloads and automatically run recurring workflows without any coding. Applications are installed on top of the ClearML Server. diff --git a/docs/deploying_clearml/enterprise_deploy/appgw_install_compose.md b/docs/deploying_clearml/enterprise_deploy/appgw_install_compose.md index 70335045..91cc338a 100644 --- a/docs/deploying_clearml/enterprise_deploy/appgw_install_compose.md +++ b/docs/deploying_clearml/enterprise_deploy/appgw_install_compose.md @@ -1,4 +1,10 @@ -# Docker-Compose Deployment +--- +title: Docker-Compose Deployment +--- + +:::important Enterprise Feature +The Application Gateway is available under the ClearML Enterprise plan. +::: ## Requirements diff --git a/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md b/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md index 9eef033b..945a31cb 100644 --- a/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md +++ b/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md @@ -1,4 +1,10 @@ -# Kubernetes Deployment +--- +title: Kubernetes Deployment +--- + +:::important Enterprise Feature +The Application Gateway is available under the ClearML Enterprise plan. +::: This guide details the installation of the ClearML AI Application Gateway, specifically the ClearML Task Router Component. diff --git a/docs/deploying_clearml/enterprise_deploy/custom_billing.md b/docs/deploying_clearml/enterprise_deploy/custom_billing.md index 3c3ee30d..844ca4a0 100644 --- a/docs/deploying_clearml/enterprise_deploy/custom_billing.md +++ b/docs/deploying_clearml/enterprise_deploy/custom_billing.md @@ -2,6 +2,10 @@ title: Custom Billing Events --- +:::important Enterprise Feature +This feature is available under the ClearML Enterprise plan. +::: + ClearML supports sending custom events to selected Kafka topics. Event sending is triggered by API calls and is available only for the companies with the `custom_events` settings set. diff --git a/docs/deploying_clearml/enterprise_deploy/import_projects.md b/docs/deploying_clearml/enterprise_deploy/import_projects.md index 3fd8a624..3a162644 100644 --- a/docs/deploying_clearml/enterprise_deploy/import_projects.md +++ b/docs/deploying_clearml/enterprise_deploy/import_projects.md @@ -1,5 +1,5 @@ --- -title: Exporting and Importing ClearML Projects +title: Project Migration --- When migrating from a ClearML Open Server to a ClearML Enterprise Server, you may need to transfer projects. This is done diff --git a/docs/deploying_clearml/upgrade_server_aws_ec2_ami.md b/docs/deploying_clearml/upgrade_server_aws_ec2_ami.md index 9edd3457..d962e3cb 100644 --- a/docs/deploying_clearml/upgrade_server_aws_ec2_ami.md +++ b/docs/deploying_clearml/upgrade_server_aws_ec2_ami.md @@ -2,14 +2,21 @@ title: AWS EC2 AMIs --- -:::note -For upgrade purposes, the terms **Trains Server** and **ClearML Server** are interchangeable. -::: + + +MongoDB major version was upgraded from `v5.x` to `6.x`. Please note that if your current ClearML Server version is older than +`v1.17` (where MongoDB `v5.x` was first used), you'll need to first upgrade to ClearML Server v1.17. + +First upgrade to ClearML Server v1.17 following the procedure below and using [this `docker-compose` file](https://github.com/clearml/clearml-server/blob/2976ce69cc91550a3614996e8a8d8cd799af2efd/upgrade/1_17_to_2_0/docker-compose.yml). Once successfully upgraded, +you can proceed to upgrade to v2.x. + + + The sections below contain the steps to upgrade ClearML Server on the [same AWS instance](#upgrading-on-the-same-aws-instance), and to upgrade and migrate to a [new AWS instance](#upgrading-and-migrating-to-a-new-aws-instance). -### Upgrading on the Same AWS Instance +## Upgrading on the Same AWS Instance This section contains the steps to upgrade ClearML Server on the same AWS instance. @@ -52,7 +59,7 @@ If upgrading from Trains Server version 0.15 or older, a data migration is requi docker-compose -f docker-compose.yml up -d ``` -### Upgrading and Migrating to a New AWS Instance +## Upgrading and Migrating to a New AWS Instance This section contains the steps to upgrade ClearML Server on the new AWS instance. @@ -67,8 +74,9 @@ This section contains the steps to upgrade ClearML Server on the new AWS instanc 1. On the old AWS instance, [backup your data](clearml_server_aws_ec2_ami.md#backing-up-and-restoring-data-and-configuration) and, if your configuration folder is not empty, backup your configuration. -1. If upgrading from ClearML Server version older than 1.2, you need to migrate your data before upgrading your server. See instructions [here](clearml_server_mongo44_migration.md). - If upgrading from Trains Server version 0.15 or older, a data migration is required before continuing this upgrade. See instructions [here](clearml_server_es7_migration.md). +1. If upgrading from Trains Server version 0.15 or older, you need to migrate your data before upgrading your server. See instructions [here](clearml_server_es7_migration.md). + +1. If upgrading from ClearML Server version 1.1 or older, you need to migrate your data before upgrading your server. See instructions [here](clearml_server_mongo44_migration.md). 1. On the new AWS instance, [restore your data](clearml_server_aws_ec2_ami.md#backing-up-and-restoring-data-and-configuration) and, if the configuration folder is not empty, restore the configuration. diff --git a/docs/deploying_clearml/upgrade_server_gcp.md b/docs/deploying_clearml/upgrade_server_gcp.md index b352ef68..a3d5c020 100644 --- a/docs/deploying_clearml/upgrade_server_gcp.md +++ b/docs/deploying_clearml/upgrade_server_gcp.md @@ -19,11 +19,13 @@ you can proceed to upgrade to v2.x. ``` docker-compose -f docker-compose.yml down ``` + +1. [Backing up data](clearml_server_gcp.md#backing-up-and-restoring-data-and-configuration) is recommended, and if the configuration folder is + not empty, backing up the configuration. 1. If upgrading from **Trains Server** version 0.15 or older to **ClearML Server**, do the following: - 1. Follow these [data migration instructions](clearml_server_es7_migration.md), - and then continue this upgrade. + 1. Follow these [data migration instructions](clearml_server_es7_migration.md). 1. Rename `/opt/trains` and its subdirectories to `/opt/clearml`: @@ -31,9 +33,7 @@ you can proceed to upgrade to v2.x. sudo mv /opt/trains /opt/clearml ``` -1. If upgrading from ClearML Server version older than 1.2, you need to migrate your data before upgrading your server. See instructions [here](clearml_server_mongo44_migration.md). -1. [Backing up data](clearml_server_gcp.md#backing-up-and-restoring-data-and-configuration) is recommended, and if the configuration folder is - not empty, backing up the configuration. +1. If upgrading from ClearML Server version 1.1 or older, you need to migrate your data before upgrading your server. See instructions [here](clearml_server_mongo44_migration.md). 1. Download the latest `docker-compose.yml` file: diff --git a/docs/deploying_clearml/upgrade_server_linux_mac.md b/docs/deploying_clearml/upgrade_server_linux_mac.md index 7be52d46..78f87ac5 100644 --- a/docs/deploying_clearml/upgrade_server_linux_mac.md +++ b/docs/deploying_clearml/upgrade_server_linux_mac.md @@ -40,19 +40,21 @@ For backwards compatibility, the environment variables ``TRAINS_HOST_IP``, ``TRA ``` docker-compose -f docker-compose.yml down ``` - -1. If upgrading from **Trains Server** version 0.15 or older, a data migration is required before continuing this upgrade. See instructions [here](clearml_server_es7_migration.md). - -1. If upgrading from ClearML Server version older than 1.2, you need to migrate your data before upgrading your server. See instructions [here](clearml_server_mongo44_migration.md). 1. [Backing up data](clearml_server_linux_mac.md#backing-up-and-restoring-data-and-configuration) is recommended and, if the configuration folder is not empty, backing up the configuration. + +1. If upgrading from **Trains Server** version 0.15 or older to **ClearML Server**, do the following: -1. If upgrading from **Trains Server** to **ClearML Server**, rename `/opt/trains` and its subdirectories to `/opt/clearml`: + 1. Follow these [data migration instructions](clearml_server_es7_migration.md). + + 1. Rename `/opt/trains` and its subdirectories to `/opt/clearml`: + + ``` + sudo mv /opt/trains /opt/clearml + ``` - ``` - sudo mv /opt/trains /opt/clearml - ``` +1. If upgrading from ClearML Server version 1.1 or older, you need to migrate your data before upgrading your server. See instructions [here](clearml_server_mongo44_migration.md). 1. Download the latest `docker-compose.yml` file: diff --git a/docs/deploying_clearml/upgrade_server_win.md b/docs/deploying_clearml/upgrade_server_win.md index ab22f542..20350cd5 100644 --- a/docs/deploying_clearml/upgrade_server_win.md +++ b/docs/deploying_clearml/upgrade_server_win.md @@ -29,10 +29,7 @@ you can proceed to upgrade to v2.x. ``` docker-compose -f c:\opt\trains\docker-compose-win10.yml down ``` - -1. If upgrading from **Trains Server** version 0.15 or older, a data migration is required before continuing this upgrade. See instructions [here](clearml_server_es7_migration.md). -1. If upgrading from ClearML Server version older than 1.2, you need to migrate your data before upgrading your server. See instructions [here](clearml_server_mongo44_migration.md). 1. Backing up data is recommended, and if the configuration folder is not empty, backing up the configuration. @@ -40,9 +37,15 @@ you can proceed to upgrade to v2.x. For example, if the configuration is in ``c:\opt\clearml``, then backup ``c:\opt\clearml\config`` and ``c:\opt\clearml\data``. Before restoring, remove the old artifacts in ``c:\opt\clearml\config`` and ``c:\opt\clearml\data``, and then restore. ::: - -1. If upgrading from **Trains Server** to **ClearML Server**, rename `/opt/trains` and its subdirectories to `/opt/clearml`. +1. If upgrading from **Trains Server** version 0.15 or older to **ClearML Server**, do the following: + + 1. Follow these [data migration instructions](clearml_server_es7_migration.md). + + 1. Rename `/opt/trains` and its subdirectories to `/opt/clearml`. + +1. If upgrading from ClearML Server version 1.1 or older, you need to migrate your data before upgrading your server. See instructions [here](clearml_server_mongo44_migration.md). + 1. Download the latest `docker-compose.yml` file: ``` diff --git a/docs/webapp/applications/apps_aws_autoscaler.md b/docs/webapp/applications/apps_aws_autoscaler.md index cfab329f..3068db42 100644 --- a/docs/webapp/applications/apps_aws_autoscaler.md +++ b/docs/webapp/applications/apps_aws_autoscaler.md @@ -319,17 +319,10 @@ to an IAM user, and create credentials keys for that user to configure in the au "ssm:GetParameters", "ssm:GetParameter" ], - "Resource": "arn:aws:ssm:*::parameter/aws/service/marketplace/*" - }, - { - "Sid": "AllowUsingDeeplearningAMIAliases", - "Effect": "Allow", - "Action": [ - "ssm:GetParametersByPath", - "ssm:GetParameters", - "ssm:GetParameter" - ], - "Resource": "arn:aws:ssm:*::parameter/aws/service/deeplearning/*" + "Resource": [ + "arn:aws:ssm:*::parameter/aws/service/marketplace/*", + "arn:aws:ssm:*::parameter/aws/service/deeplearning/*" + ] } ] } diff --git a/sidebars.js b/sidebars.js index 273533ad..a6edf4bb 100644 --- a/sidebars.js +++ b/sidebars.js @@ -635,11 +635,19 @@ module.exports = { 'getting_started/architecture', ]},*/ { - 'Enterprise Server Deployment': [ - 'deploying_clearml/enterprise_deploy/multi_tenant_k8s', - 'deploying_clearml/enterprise_deploy/vpc_aws', - 'deploying_clearml/enterprise_deploy/on_prem_ubuntu', - ] + 'Enterprise Server': { + 'Deployment Options': [ + 'deploying_clearml/enterprise_deploy/multi_tenant_k8s', + 'deploying_clearml/enterprise_deploy/vpc_aws', + 'deploying_clearml/enterprise_deploy/on_prem_ubuntu', + ], + 'Maintenance': [ + 'deploying_clearml/enterprise_deploy/import_projects', + 'deploying_clearml/enterprise_deploy/change_artifact_links', + 'deploying_clearml/enterprise_deploy/delete_tenant', + ] + + } }, { type: 'category', @@ -652,11 +660,8 @@ module.exports = { ] }, 'deploying_clearml/enterprise_deploy/custom_billing', - 'deploying_clearml/enterprise_deploy/delete_tenant', - 'deploying_clearml/enterprise_deploy/import_projects', - 'deploying_clearml/enterprise_deploy/change_artifact_links', { - 'Enterprise Applications': [ + 'UI Applications': [ 'deploying_clearml/enterprise_deploy/app_install_ubuntu_on_prem', 'deploying_clearml/enterprise_deploy/app_install_ex_server', 'deploying_clearml/enterprise_deploy/app_custom',