ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-02-07 13:21:46 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add environment variable config ref (#61)

Browse Source
This commit is contained in:
pollfly 2021-09-02 14:03:22 +03:00 committed by GitHub
parent dc57b18b0a
commit de82df937e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/configs/clearml_conf.md
View File

@ -6,15 +6,15 @@ This reference page provides detailed information about the configurable options
This reference page is organized by configuration file section: This reference page is organized by configuration file section:
* [agent](#agent) - Contains **ClearML Agent** configuration options. If **ClearML Agent** was not installed, the configuration * [agent](#agent-section) - Contains **ClearML Agent** configuration options. If **ClearML Agent** was not installed, the configuration
file will not have an `agent` section. file will not have an `agent` section.
* [api](#api) - Contains **ClearML** and **ClearML Agent** configuration options for **ClearML Server**. * [api](#api-section) - Contains **ClearML** and **ClearML Agent** configuration options for **ClearML Server**.
* [sdk](#sdk) - Contains **ClearML** and **ClearML Agent** configuration options for **ClearML Python Package** and **ClearML Server**. * [sdk](#sdk-section) - Contains **ClearML** and **ClearML Agent** configuration options for **ClearML Python Package** and **ClearML Server**.
An example configuration file is located [here](https://github.com/allegroai/clearml-agent/blob/master/docs/clearml.conf), An example configuration file is located [here](https://github.com/allegroai/clearml-agent/blob/master/docs/clearml.conf),
in the **ClearML** GitHub repositories in the **ClearML** GitHub repositories
### Editing your configuration file ## Editing your configuration file
To add, change, or delete options, edit your configuration file. To add, change, or delete options, edit your configuration file.
@ -29,10 +29,27 @@ To add, change, or delete options, edit your configuration file.
1. In the required section (sections listed on this page), add, modify, or remove required options. 1. In the required section (sections listed on this page), add, modify, or remove required options.
1. Save configuration file. 1. Save configuration file.
## Environment variables
ClearML's configuration file uses [HOCON](https://github.com/lightbend/config/blob/main/HOCON.md) configuration format,
which supports environment variable reference.
For example:
```editorconfig
google.storage {
# # Default project and credentials file
# # Will be used when no bucket configuration is found
project: "clearml"
credentials_json: "${GOOGLE_APPLICATION_CREDENTIALS}"
}
```
`${GOOGLE_APPLICATION_CREDENTIALS}` will automatically be substituted by the environment variable value.
See [Note on Windows](https://github.com/lightbend/config/blob/main/HOCON.md#note-on-windows-and-case-sensitivity-of-environment-variables)
for information about using environment variables with Windows in the configuration file.
<a class="tr_top_negative" name="agent"></a> ## Configuration file sections
### agent section ### agent section

2
docs/configs/env_vars.md
View File

@ -3,7 +3,7 @@ title: Environment Variables
--- ---
:::info :::info
ClearML's environment variables overide the clearml.conf file and SDK ClearML's environment variables override the clearml.conf file and SDK
::: :::
## ClearML SDK Variables ## ClearML SDK Variables