pkadmin for Users⚓︎
pkadmin is the prokube command line tool for interacting with the deployed clusters.
It is designed to simplify the routine admin operations like creation of new kubeflow users or corresponding kubeconfigs.
Most of the commands require the user to have admin privileges, but some commands can be executed by regular users as well.
These commands are listed in the following sections.
pkadmin needs the Kubernetes command line utility kubectl to be installed on your system and the kubectl-context set to the cluster you want to interact with.
The default path for the kubectl configuration file is ~/.kube/config.
You can add additional cluster contexts either to this file or to a separate file, and set the KUBECONFIG environment variable to the path of the separate file of your target cluster (e.g. export KUBECONFIG=~/.kube/my-other-config).
To obtain the necessary information to access the cluster, please refer to the Kubernetes Access documentation and to the kubectl documentation for further details.
Commands⚓︎
This sections contains an overview of the syntax of the main commands implemented in the tool. It is divided into subsections corresponding to the relevant prokube component.
Kubeflow pipelines⚓︎
pkadmin pipelines COMMAND [args]
| Operation | Syntax | Description |
|---|---|---|
| clean-pods | pkadmin pipelines clean-pods -n/--namespace <namespace> [-t/--timelimit] [-y/--yes] |
Delete all old inactive kubeflow pipelines pods in a namespace |
Profile Contributor Management⚓︎
Warning
Currently not available for non-admins.
pkadmin user contributor COMMAND [args]
| Operation | Syntax | Description |
|---|---|---|
| add | pkadmin user contributor add [-e/--email <email>] [-n/--namespace <namespace>] |
Add a new contributor to a profile |
| list | pkadmin user contributor list [-n/--namespace <namespace>] |
List all contributors for a profile |
| remove | pkadmin user contributor remove [-e/--email <email>] [-n/--namespace <namespace>] [-y/--yes] |
Remove a contributor from a profile. Use -y/--yes to auto-confirm |
| update | pkadmin user contributor update |
Update contributor's MinIO permissions (for contributors that had been added or removed through the web UI) |