Skip to content

Commit

Permalink
Update example READMEs following deployment PR (zenml-io#1555)
Browse files Browse the repository at this point in the history
* update example READMEs

* add kubeflow docs page update
  • Loading branch information
strickvl authored May 24, 2023
1 parent e055d31 commit b84c414
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/book/component-gallery/orchestrators/kubeflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ To deploy the stack, run the following commands:
# Pull the `k3d-modular` recipe to your local system
zenml stack recipe pull k3d-modular
# Deploy the stack using the ZenML CLI:
zenml stack recipe deploy k3d-modular -i kubeflow -i minio --no-server
zenml stack recipe deploy k3d-modular -o kubeflow -a minio --no-server
# run the following command to import the resources as a ZenML stack, manually
zenml stack import <STACK_NAME> -f <PATH_TO_THE_CREATED_STACK_CONFIG_YAML>
# set the imported stack as the active stack
Expand Down
6 changes: 4 additions & 2 deletions examples/kserve_deployment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,11 +103,13 @@ To get a stack with KServe and potential other components, you can make use of Z
Run the following command to deploy the local KServe stack:

```bash
zenml stack recipe deploy k3d-modular --install kserve
zenml stack recipe deploy k3d-modular -d kserve
```

>**Note**:
> This recipe comes with MLflow, Kubeflow and Minio enabled by default. If you want any other components like Seldon or Tekton, you can specify that using the `--install/-i` flag.
> This recipe comes with MLflow, Kubeflow and Minio enabled by default. If you
> want any other components like Seldon or Tekton, you can specify that using
> the relevant flag (i.e. `-o` for orchestrators and so on).
This will deploy a local Kubernetes cluster with KServe installed.
It will also generate a stack YAML file that you can import as a ZenML stack by running
Expand Down
6 changes: 4 additions & 2 deletions examples/kubeflow_pipelines_orchestration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,9 @@ pod.
zenml stack recipe deploy k3d-modular
```
>**Note**:
> This recipe comes with MLflow, Kubeflow and Minio enabled by default. If you want any other components like KServe, Seldon or Tekton, you can specify that using the `--install/-i` flag.
> This recipe comes with MLflow, Kubeflow and Minio enabled by default. If you
> want any other components like Seldon or Tekton, you can specify that using
> the relevant flag (i.e. `-o` for orchestrators and so on).
#### 🏁 Deploy the stack using ZenML CLI

Expand All @@ -150,7 +152,7 @@ zenml stack recipe pull k3d-modular
3. Deploy the stack using the ZenML CLI:

```shell
zenml stack recipe deploy k3d-modular -i kubeflow -i minio --no-server
zenml stack recipe deploy k3d-modular -o kubeflow -a minio --no-server
```

> **Note**
Expand Down
4 changes: 3 additions & 1 deletion examples/mlflow_registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,9 @@ zenml stack recipe deploy k3d-modular
```

>**Note**:
> This recipe comes with MLflow, Kubeflow and Minio enabled by default. If you want any other components like KServe, Seldon or Tekton, you can specify that using the `--install/-i` flag.
> This recipe comes with MLflow, Kubeflow and Minio enabled by default. If you
> want any other components like Seldon or Tekton, you can specify that using
> the relevant flag (i.e. `-o` for orchestrators and so on).
This will deploy a local Kubernetes cluster with MLflow installed.
It will also generate a stack YAML file that you can import as a ZenML stack by running:
Expand Down
4 changes: 3 additions & 1 deletion examples/mlflow_tracking/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,9 @@ zenml stack recipe deploy k3d-modular
```

>**Note**:
> This recipe comes with MLflow, Kubeflow and Minio enabled by default. If you want any other components like KServe, Seldon or Tekton, you can specify that using the `--install/-i` flag.
> This recipe comes with MLflow, Kubeflow and Minio enabled by default. If you
> want any other components like Seldon or Tekton, you can specify that using
> the relevant flag (i.e. `-o` for orchestrators and so on).
This will deploy a local Kubernetes cluster with MLflow installed.
It will also generate a stack YAML file that you can import as a ZenML stack by running
Expand Down
10 changes: 6 additions & 4 deletions examples/seldon_deployment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,14 +82,16 @@ To get a stack with Seldon Core and potential other components, you can make use
Run the following command to deploy the local Seldon stack:

```bash
zenml stack recipe deploy k3d-modular --install seldon
zenml stack recipe deploy k3d-modular -d seldon
```

>**Note**:
> This recipe comes with MLflow, Kubeflow and Minio enabled by default. If you want any other components like KServe or Tekton, you can specify that using the `--install/-i` flag.
> This recipe comes with MLflow, Kubeflow and Minio enabled by default. If you
> want any other components like Seldon or Tekton, you can specify that using
> the relevant flag (i.e. `-o` for orchestrators and so on).
This will deploy a local Kubernetes cluster with Seldon installed.
It will also generate a stack YAML file that you can import as a ZenML stack by running
This will deploy a local Kubernetes cluster with Seldon installed.
It will also generate a stack YAML file that you can import as a ZenML stack by running:

```bash
zenml stack import -f <path-to-stack-yaml>
Expand Down
6 changes: 4 additions & 2 deletions examples/tekton_pipelines_orchestration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,13 @@ To get a stack with Tekton Pipelines and potential other components, you can mak
Run the following command to deploy the local Tekton Pipelines stack:

```bash
zenml stack recipe deploy k3d-modular --install tekton
zenml stack recipe deploy k3d-modular -o tekton
```

>**Note**:
> This recipe comes with MLflow, Kubeflow and Minio enabled by default. If you want any other components like KServe, or Seldon, you can specify that using the `--install/-i` flag.
> This recipe comes with MLflow, Kubeflow and Minio enabled by default. If you
> want any other components like Seldon or Tekton, you can specify that using
> the relevant flag (i.e. `-o` for orchestrators and so on).
This will deploy a local Kubernetes cluster with Tekton Pipelines installed. You can verify this by running `kubectl get pods` and checking if the Tekton Pipelines pods are running.
It will also generate a stack YAML file that you can import as a ZenML stack by running
Expand Down

0 comments on commit b84c414

Please sign in to comment.