ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-01-31 06:27:22 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add default request method information (#562)

Browse Source
This commit is contained in:
pollfly 2023-05-16 14:28:03 +03:00 committed by GitHub
parent 7f4fd856c5
commit d43b7c3bdf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/configs/clearml_conf.md
View File

@ -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.
:::
<br/>

1
docs/configs/env_vars.md
View File

@ -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|

7
docs/deploying_clearml/clearml_server_gcp.md
View File

@ -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.