Skip to content

Commit c642949

Browse files
chore(docs): clean up kfp-kubernetes documentation index page (kubeflow#11207)
The entry page for kfp-kubernetes was a little lacking. Clean it up a bit. Signed-off-by: Greg Sheremeta <[email protected]>
1 parent 123ed1e commit c642949

File tree

2 files changed

+20
-10
lines changed

2 files changed

+20
-10
lines changed

kubernetes_platform/python/README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,33 @@
1-
# Kubernetes Platform-specific Features
1+
# Kubeflow Pipelines SDK kfp-kubernetes API Reference
22

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:
44

55
* [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/)
66
* [PersistentVolumeClaims](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)
7-
* [ImagePullPolicy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy)
7+
* [ImagePullPolicies](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy)
8+
* [Ephemeral volumes](https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/)
9+
* [Node selectors](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector)
10+
* [Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/)
11+
* [Labels and annotations](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/object-meta/#ObjectMeta)
12+
* and more
813

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.
1015

1116
## 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.
1418
```sh
15-
pip install kfp[kubernetes] --pre
19+
pip install kfp[kubernetes]
1620
```
1721

1822
Or installed independently:
1923
```sh
2024
pip install kfp-kubernetes
2125
```
2226

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+
2531
### Secret: As environment variable
2632
```python
2733
from kfp import dsl
@@ -40,6 +46,10 @@ def pipeline():
4046
secret_key_to_env={'password': 'SECRET_VAR'})
4147
```
4248

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.
52+
4353
### Secret: As mounted volume
4454
```python
4555
from kfp import dsl

kubernetes_platform/python/docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ def decorator(func):
7777
}
7878

7979
html_theme = 'sphinx_immaterial'
80-
html_title = 'kfp-kubernetes Reference Documentation'
80+
html_title = 'KFP SDK kfp-kubernetes API Reference'
8181
html_static_path = ['_static']
8282
html_css_files = ['custom.css']
8383
html_logo = '_static/kubeflow.png'

0 commit comments

Comments
 (0)