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 Kubernetes integration section to ClearML Agent docs (#386)

Browse Source
This commit is contained in:
pollfly 2022-11-27 16:06:06 +02:00 committed by GitHub
parent 3df55208be
commit 1c193fd975
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/clearml_agent.md
View File

@ -178,7 +178,7 @@ In case a `clearml.conf` file already exists, add a few ClearML Agent specific c
1. Save the configuration.
## Execution
## Deployment
### Spinning Up an Agent
You can spin up an agent on any machine: on-prem and/or cloud instance. When spinning up an agent, you assign it to
@ -253,6 +253,17 @@ the SSH keys provided in the environment variable.
SSH_AUTH_SOCK=<file_socket> clearml-agent daemon --gpus <your config> --queue <your queue name> --docker
```
### Kubernetes
Agents can be deployed bare-metal or as dockers in a Kubernetes cluster. ClearML Agent adds the missing scheduling
capabilities to Kubernetes, allows for more flexible automation from code, and gives access to all of ClearML Agent’s
features (scheduling, job prioritization, and more).
There are two options for deploying the ClearML Agent to a Kubernetes cluster:
* Spin ClearML Agent as a long-lasting service pod
* Map ClearML jobs directly to K8s jobs with Kubernetes Glue (available in the ClearML Enterprise plan)
See more details [here](https://github.com/allegroai/clearml-agent#kubernetes-integration-optional).
### Explicit Task Execution
ClearML Agent can also execute specific tasks directly, without listening to a queue.