Skip to content

Commit

Permalink
Document namespace and service account k8s orchestrator settings (#1722)
Browse files Browse the repository at this point in the history
  • Loading branch information
stefannica committed Aug 7, 2023
1 parent a6b64d1 commit 03a5639
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/book/user-guide/component-guide/orchestrators/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,21 @@ python file_that_runs_a_zenml_pipeline.py

#### Additional configuration

The Kubernetes orchestrator will by default use a Kubernetes namespace called
`zenml` to run pipelines. In that namespace, it will automatically create a
Kubernetes service account called `zenml-service-account` and grant it
`edit` RBAC role in that namespace. To customize these settings, you can
configure the following additional attributes in the Kubernetes orchestrator:

* `kubernetes_namespace`: The Kubernetes namespace to use for running the
pipelines. The namespace must already exist in the Kubernetes cluster.
* `service_account_name`: The name of a Kubernetes service account to use for
running the pipelines. If configured, it must point to an existing service
account in the default or configured `namespace` that has associated RBAC roles
granting permissions to create and manage pods in that namespace. This can also
be configured as an individual pipeline setting in addition to the global
orchestrator setting.

For additional configuration of the Kubernetes orchestrator, you can pass `KubernetesOrchestratorSettings` which allows
you to configure (among others) the following attributes:

Expand Down

0 comments on commit 03a5639

Please sign in to comment.