Small edits
Some checks failed
CI / build (push) Has been cancelled

This commit is contained in:
Noam Wasersprung 2025-06-03 12:40:08 +03:00 committed by GitHub
commit 23c5a3afbe
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 15 additions and 15 deletions

View File

@ -34,7 +34,7 @@ It can only configure access for ClearML Tasks within its own namespace.
### Login
``` bash
```bash
helm repo add clearml-enterprise https://raw.githubusercontent.com/clearml/clearml-enterprise-helm-charts/gh-pages --username <GITHUB_TOKEN> --password <GITHUB_TOKEN>
```
@ -80,7 +80,7 @@ tcpSession:
The full list of supported configuration is available with the command:
``` bash
```bash
helm show readme clearml-enterprise/clearml-enterprise-app-gateway
```
@ -88,7 +88,7 @@ helm show readme clearml-enterprise/clearml-enterprise-app-gateway
To install the App Gateway component via Helm use the following command:
``` bash
```bash
helm upgrade --install <RELEASE_NAME> -n <WORKLOAD_NAMESPACE> clearml-enterprise/clearml-enterprise-app-gateway --version <CHART_VERSION> -f clearml-app-gateway-values.override.yaml
```

View File

@ -47,7 +47,7 @@ devicePlugin:
Install the `gpu-operator`:
``` bash
```bash
helm install -n gpu-operator gpu-operator nvidia/gpu-operator --create-namespace -f gpu-operator.override.yaml
```

View File

@ -203,7 +203,7 @@ This label is used by the CFGI to assign the correct portion of GPU resources to
Starting from version 1.3.0, there is no need to specify the resources field. You only need to set the labels:
``` yaml
```yaml
agentk8sglue:
createQueues: true
queues:

View File

@ -46,12 +46,12 @@ For optimal performance, a Kubernetes cluster with at least 3 nodes is recommend
Add the ClearML Helm repository:
``` bash
```bash
helm repo add clearml-enterprise https://raw.githubusercontent.com/clearml/clearml-enterprise-helm-charts/gh-pages --username <HELM_REPO_TOKEN> --password <HELM_REPO_TOKEN>
```
Update the local repository:
``` bash
```bash
helm repo update
```
@ -64,7 +64,7 @@ In the following configuration, replace the `<BASE_DOMAIN>` placeholders with a
pointing to the cluster's Ingress Controller. This will be the base domain for reaching your ClearML installation.
:::
``` yaml
```yaml
imageCredentials:
password: "<CLEARML_DOCKERHUB_TOKEN>"
clearml:
@ -126,7 +126,7 @@ Kubernetes.
If you need to define your own credentials to be used instead, replace the default key and secret values in `clearml-values.override.yaml`.
``` yaml
```yaml
clearml:
# Replace the following values to use custom internal credentials.
apiserverKey: ""
@ -140,7 +140,7 @@ clearml:
In a shell, if `openssl` is installed, you can use this simple command to generate random strings suitable as keys and secrets:
``` bash
```bash
openssl rand -hex 16
```
@ -151,7 +151,7 @@ installations. This is an optional step in case the SSO (Identity provider) conf
Please note that this setup is not ideal for multi-tenant setups as fixed users will only be associated with the default tenant.
``` yaml
```yaml
apiserver:
additionalConfigs:
apiserver.conf: |

View File

@ -287,7 +287,7 @@ For each group you define in the configuration, you need to specify the followin
| `name` | Display name for the group (should match `<GroupName>` used in the variable path) | `CLEARML__services__auth__default_groups__<GroupName>__name` | `"My Group Name"`, `"MLOps Team"` |
| `features` | JSON list of features to enable for this group . For the complete list of available features, see [Available Features](#available-features). Note that the features must be defined for the tenant or for the entire server in order to affect the group. By default, all the features of the tenant are available to all users. | `CLEARML__services__auth__default_groups__<GroupName>__features` | `'["applications", "experiments", "pipelines", "reports", "show_dashboard", "show_projects"]'` (Note the single quotes wrapping the JSON string if setting via YAML/environment variables). |
| `assignable` | Whether admins can assign users to this group from the ClearML Web UI (`true`/`false`). If `false`, group membership is managed externally or implicitly. | `CLEARML__services__auth__default_groups__<GroupName>__assignable` | `"false"` |
| `system` | Always set to `"false"` for custom groups | ``CLEARML__services__auth__default_groups__<GroupName>__system` | `"false"` |
| `system` | Always set to `"false"` for custom groups | `CLEARML__services__auth__default_groups__<GroupName>__system` | `"false"` |
##### Example Configuration
@ -475,7 +475,7 @@ The following features can be assigned to groups via the `features` configuratio
| `sso_management` | Enables the SSO (Single Sign-On) configuration wizard. | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
| `service_users` | Enables support for creating and managing service accounts (API keys). | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
| `resource_policy` | Enables the [Resource Policies](../../webapp/resource_policies.md) feature. | May default to a trial feature if not explicitly enabled. |
| `model_serving` | Enables access to the [Model Endpoints](../../webapp/webapp_model_endoints.md) feature. | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
| `model_serving` | Enables access to the [Model Endpoints](../../webapp/webapp_model_endpoints.md) feature. | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
| `show_dashboard` | Makes the "Dashboard" menu item visible in the UI sidebar. | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
| `show_model_view` | Makes the "Models" menu item visible in the UI sidebar. | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
| `show_projects` | Makes the "Projects" menu item visible in the UI sidebar. | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |

View File

@ -12,7 +12,7 @@ on a remote or local machine, from a remote repository and your local machine.
### Executing Code from a Remote Repository
``` bash
```bash
clearml-task --project keras_examples --name remote_test --repo https://github.com/clearml/events.git --branch master --script /webinar-0620/keras_mnist.py --args batch_size=64 epochs=1 --queue default
```

View File

@ -309,7 +309,7 @@ Scalar graph view (<img src="/docs/latest/icons/ico-charts-view.svg" alt="Graph
shows scalar series plotted as a time series line chart. By default, a single plot is shown for each scalar metric,
with all variants overlaid within.
The series are sub-sampled for
The series are subsampled for
display efficiency. For high resolution, view a series in full screen mode by hovering over the graph and clicking <img src="/docs/latest/icons/ico-maximize.svg" alt="Maximize plot icon" className="icon size-md space-sm" />.
:::info Full Screen Refresh