clearml-docs/docs/deploying_clearml/clearml_server_gcp.md

---
title: Google Cloud Platform
---

:::important
This documentation page applies to deploying your own open source ClearML Server. It does not apply to ClearML Hosted Service users.
:::

Deploy **ClearML Server** on the Google Cloud Platform (GCP) using one of the pre-built GCP Custom Images. **ClearML** 
provides custom images for each released version of **ClearML Server**. For a list of the pre-built custom images, see 
[ClearML Server GCP Custom Image](#clearml-server-gcp-custom-image). 

After deploying **ClearML Server**, configure the **ClearML Python Package** for it, see [Configuring ClearML for ClearML Server](clearml_config_for_clearml_server.md).

For information about updgrading **ClearML server on GCP, see [here](upgrade_server_gcp.md).

:::important
If **ClearML Server** is being reinstalled, we recommend clearing browser cookies for **ClearML Server**. For example, 
for Firefox, go to Developer Tools > Storage > Cookies, and for Chrome, go to Developer Tools > Application > Cookies,
and delete all cookies under the **ClearML Server** URL.
:::

## Default ClearML Server Service Ports

After deploying **ClearML Server**, the services expose the following node ports:

* Web server on `8080`
* API server on `8008`
* File Server on `8081`

## Default ClearML Server Storage Paths

The persistent storage configuration:

* MongoDB: `/opt/clearml/data/mongo/`
* Elasticsearch: `/opt/clearml/data/elastic_7/`
* File Server: `/mnt/fileserver/`

## Importing the Custom Image to your GCP account

Before launching an instance using a **ClearML Server** GCP Custom Image, import the image to the custom images list.


:::note 
No upload of the image file is required. We provide links to image files stored in Google Storage.
:::


**To import the image to your custom images list:**

1. In the Cloud Console, go to the [Images](https://console.cloud.google.com/compute/images) page.
1. At the top of the page, click **Create image**.
1. In **Name**, specify a unique name for the image.
1. Optionally, specify an image family for the new image, or configure specific encryption settings for the image.
1. In the **Source** menu, select **Cloud Storage file**.
1. Enter the **ClearML Server** image bucket path (see [ClearML Server GCP Custom Image](#clearml-server-gcp-custom-image)), 
   for example: `allegro-files/clearml-server/clearml-server.tar.gz`.

1. Click **Create** to import the image. The process can take several minutes depending on the size of the boot disk image.

For more information see [Import the image to your custom images list](https://cloud.google.com/compute/docs/import/import-existing-image#import_image) in the [Compute Engine Documentation](https://cloud.google.com/compute/docs).

## Launching


:::warning
By default, **ClearML Server** launches with unrestricted access. To restrict **ClearML Server** access, follow the 
instructions in the [Security](clearml_server_security.md) page.
:::

To launch **ClearML Server** using a GCP Custom Image, see the [Manually importing virtual disks](https://cloud.google.com/compute/docs/import/import-existing-image#overview) in the "Google Cloud Storage" documentation, [Compute Engine documentation](https://cloud.google.com/compute/docs). For more information on Custom Images, see [Custom Images](https://cloud.google.com/compute/docs/images#custom_images) in the "Compute Engine documentation".

The minimum requirements for **ClearML Server** are:

* 2 vCPUs
* 7.5GB RAM

## Restarting

**To restart  ClearML Server Docker deployment:**

* Stop and then restart the Docker containers by executing the following commands:

        docker-compose -f /opt/clearml/docker-compose.yml down
        docker-compose -f /opt/clearml/docker-compose.yml up -d


## Backing Up and Restoring Data and Configuration

The commands in this section are an example of how to back up and restore data and configuration    . 

If data and configuration folders are in `/opt/clearml`, then archive all data into `~/clearml_backup_data.tgz`, and 
configuration into `~/clearml_backup_config.tgz`:

    sudo tar czvf ~/clearml_backup_data.tgz -C /opt/clearml/data .
    sudo tar czvf ~/clearml_backup_config.tgz -C /opt/clearml/config .

If the data and the configuration need to be restored:

1. Verify you have the backup files.
1. Replace any existing data with the backup data:

        sudo rm -fR /opt/clearml/data/* /opt/clearml/config/*
        sudo tar -xzf ~/clearml_backup_data.tgz -C /opt/clearml/data
        sudo tar -xzf ~/clearml_backup_config.tgz -C /opt/clearml/config 
   
1. Grant access to the data:

        sudo chown -R 1000:1000 /opt/clearml

## ClearML Server GCP Custom Image

The following section contains a list of Custom Image URLs (exported in different formats) for each released **ClearML Server** version.

### Latest Version - v1.0.2

- [https://storage.googleapis.com/allegro-files/clearml-server/clearml-server.tar.gz](https://storage.googleapis.com/allegro-files/clearml-server/clearml-server.tar.gz)

### All Release Versions

- v1.0.2 - [https://storage.googleapis.com/allegro-files/clearml-server/clearml-server-1-0-2.tar.gz](https://storage.googleapis.com/allegro-files/clearml-server/clearml-server-1-0-2.tar.gz)
- v1.0.1 - [https://storage.googleapis.com/allegro-files/clearml-server/clearml-server-1-0-1.tar.gz](https://storage.googleapis.com/allegro-files/clearml-server/clearml-server-1-0-1.tar.gz)
- v1.0.0 - [https://storage.googleapis.com/allegro-files/clearml-server/clearml-server-1-0-0.tar.gz](https://storage.googleapis.com/allegro-files/clearml-server/clearml-server-1-0-0.tar.gz)
- v0.17.0 - [https://storage.googleapis.com/allegro-files/clearml-server/clearml-server-0-17-0.tar.gz](https://storage.googleapis.com/allegro-files/clearml-server/clearml-server-0-17-0.tar.gz)
## Next Step

* [Configuring ClearML for ClearML Server](clearml_config_for_clearml_server.md).