diff --git a/docs/configs/clearml_conf.md b/docs/configs/clearml_conf.md index 447fcf8a..383c579a 100644 --- a/docs/configs/clearml_conf.md +++ b/docs/configs/clearml_conf.md @@ -688,6 +688,17 @@ Dictionary of configuration options for the ClearML Server API, web, and file se :::caution You must use a secure protocol with ``api.web_server``, ``api.files_server``, and ``api.api_server``. Use `https`, not `http`. ::: + +--- + +**`api.http.default_method`** (*string*) + +* Set the request method for all API requests and auth login. This could be useful when `GET` requests with payloads are +blocked by a server, and `POST` requests can be used instead. The request options are: "GET", "POST", "PUT". + +:::caution +This configuration option is experimental, and has not been vigorously tested, so it may have unintended consequences. +:::
diff --git a/docs/configs/env_vars.md b/docs/configs/env_vars.md index 0c43bb46..c0a0412d 100644 --- a/docs/configs/env_vars.md +++ b/docs/configs/env_vars.md @@ -48,6 +48,7 @@ Overrides Repository Auto-logging |**CLEARML_API_ACCESS_KEY** | Sets the Server's Public Access Key| |**CLEARML_API_SECRET_KEY** | Sets the Server's Private Access Key| |**CLEARML_API_HOST_VERIFY_CERT** | Enables / Disables server certificate verification (if behind a firewall)| +|**CLEARML_API_DEFAULT_REQ_METHOD**| *Experimental - this option has not been vigorously tested.*. Set the request method for all API requests and auth login. This could be useful when GET requests with payloads are blocked by a server, so POST/PUT requests can be used instead. | |**CLEARML_OFFLINE_MODE** | Sets Offline mode| |**CLEARML_NO_DEFAULT_SERVER** | Disables sending information to demo server when no HOST server is set| diff --git a/docs/deploying_clearml/clearml_server_gcp.md b/docs/deploying_clearml/clearml_server_gcp.md index 7669d78d..bd2e7f54 100644 --- a/docs/deploying_clearml/clearml_server_gcp.md +++ b/docs/deploying_clearml/clearml_server_gcp.md @@ -8,9 +8,14 @@ provides custom images for each released version of ClearML Server. For a list o After deploying ClearML Server, configure the **ClearML Python Package** for it, see [Configuring ClearML for ClearML Server](clearml_config_for_clearml_server.md). +:::info +In order for `clearml` to work with a ClearML Server on GCP, set `CLEARML_API_DEFAULT_REQ_METHOD=PUT` or +set `api.http.default_method` to `"PUT"` in the [`clearml.conf`](../configs/clearml_conf.md) file. +::: + For information about upgrading ClearML server on GCP, see [here](upgrade_server_gcp.md). -:::important +:::note Reinstallation If ClearML Server is being reinstalled, clearing browser cookies for ClearML Server is recommended. 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.