Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document the namespace and service account k8s orchestrator settings #1722

Merged
merged 1 commit into from
Aug 7, 2023
Merged

Document the namespace and service account k8s orchestrator settings #1722

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/book/user-guide/component-guide/orchestrators/kubernetes.md
View file
Open in desktop
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
Loading