You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: kubernetes_platform/python/README.md
+19-9Lines changed: 19 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -1,27 +1,33 @@
1
-
# Kubernetes Platform-specific Features
1
+
# Kubeflow Pipelines SDK kfp-kubernetes API Reference
2
2
3
-
The `kfp-kubernetes` Python library enables authoring [Kubeflow pipelines](https://www.kubeflow.org/docs/components/pipelines/v2/) with Kubernetes-specific features. These features are supported by the [default KFP open source BE](https://github.com/kubeflow/pipelines/tree/master/backend). Specifically, the `kfp-kubernetes` library supports authoring pipelines that use:
3
+
The Kubeflow Pipelines SDK kfp-kubernetes python library (part of the [Kubeflow Pipelines](https://www.kubeflow.org/docs/components/pipelines/) project) is an addon to the [Kubeflow Pipelines SDK](https://kubeflow-pipelines.readthedocs.io/) that enables authoring Kubeflow pipelines with Kubernetes-specific features and concepts, such as:
*[Labels and annotations](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/object-meta/#ObjectMeta)
12
+
* and more
8
13
9
-
See the [`kfp-kubernetes` reference documentation](https://kfp-kubernetes.readthedocs.io/).
14
+
Be sure to check out the full [API Reference](https://kfp-kubernetes.readthedocs.io/) for more details.
10
15
11
16
## Installation
12
-
The `kfp-kubernetes` package can be installed as a `kfp` SDK extra dependency with `kfp==2.x.x`:
13
-
<!-- TODO: remove --pre when kfp v2 goes to GA -->
17
+
The `kfp-kubernetes` package can be installed as a KFP SDK extra dependency.
14
18
```sh
15
-
pip install kfp[kubernetes] --pre
19
+
pip install kfp[kubernetes]
16
20
```
17
21
18
22
Or installed independently:
19
23
```sh
20
24
pip install kfp-kubernetes
21
25
```
22
26
23
-
## Example usage
24
-
<!-- TODO: test these examples once the BE implementation exists -->
27
+
## Getting started
28
+
29
+
The following is an example of a simple pipeline that uses the kfp-kubernetes library to mount a pre-existing secret as an environment variable available in the task's container.
30
+
25
31
### Secret: As environment variable
26
32
```python
27
33
from kfp import dsl
@@ -40,6 +46,10 @@ def pipeline():
40
46
secret_key_to_env={'password': 'SECRET_VAR'})
41
47
```
42
48
49
+
## Other examples
50
+
51
+
Here is a non-exhaustive list of some other examples of how to use the kfp-kubernetes library. Be sure to check out the full [API Reference](https://kfp-kubernetes.readthedocs.io/) for more details.
0 commit comments