diff --git a/docs/deployment/schedulers/k3s.md b/docs/deployment/schedulers/k3s.md index c357332ea6c..039ca589c94 100644 --- a/docs/deployment/schedulers/k3s.md +++ b/docs/deployment/schedulers/k3s.md @@ -35,6 +35,9 @@ dokku scheduler:set node-js-app k3s ## Usage +> [!IMPORTANT] +> The k3s plugin requires usage of a docker registry to store deployed image artifacts. See the [registry documentation](/docs/advanced-usage/registry-management.md) for more details on how to configure a registry. + ### Initializing a cluster > [!WARNING] @@ -289,7 +292,7 @@ Dokku injects certain annotations into each created resource by default, but it dokku scheduler-k3s:annotations:set node-js-app annotation.key annotation.value --resource-type deployment ``` -If not specified, the annotation will be applied to all processes within an app, though it may be further scoped to a specific process type via the `--process-type` flag. +If not specified, the annotation will be applied to all processes within an app, though it may be further scoped to a specific process type via the `--process-type` flag. ```shell dokku scheduler-k3s:annotations:set node-js-app annotation.key annotation.value --resource-type deployment --process-type web @@ -326,7 +329,7 @@ Dokku injects certain labels into each created resource by default, but it may b dokku scheduler-k3s:labels:set node-js-app label.key label.value --resource-type deployment ``` -If not specified, the label will be applied to all processes within an app, though it may be further scoped to a specific process type via the `--process-type` flag. +If not specified, the label will be applied to all processes within an app, though it may be further scoped to a specific process type via the `--process-type` flag. ```shell dokku scheduler-k3s:labels:set node-js-app label.key label.value --resource-type deployment --process-type web @@ -409,7 +412,7 @@ Each value in the `metadata` stanza can use the following interpolated strings: Most Keda triggers require some form of authentication to query for data. In the Kubernetes API, they are represented by `TriggerAuthentication` and `ClusterTriggerAuthentication` resources. Dokku can manage these via the `scheduler-k3s:autoscaling-auth` commands, and includes generated resources with each helm release generated by a deploy. -If no app-specific authentication is provided for a given trigger type, Dokku will fallback to any globally defined `ClusterTriggerAuthentication` resources. Autoscaling triggers within an app all share the same `TriggerAuthentication` resources, while `ClusterTriggerAuthentication` resources can be shared across all apps deployed by Dokku within a given cluster. +If no app-specific authentication is provided for a given trigger type, Dokku will fallback to any globally defined `ClusterTriggerAuthentication` resources. Autoscaling triggers within an app all share the same `TriggerAuthentication` resources, while `ClusterTriggerAuthentication` resources can be shared across all apps deployed by Dokku within a given cluster. ##### Creating Authentication Resources