diff --git a/ansible/README.md b/ansible/README.md index 0340960274..68c906ab2b 100644 --- a/ansible/README.md +++ b/ansible/README.md @@ -1,4 +1,4 @@ -# Ansible Setup for Seldon Core V2 +## Ansible Setup for Seldon Core V2 To use these playbooks follow the installation of the Ansible collection at https://github.com/SeldonIO/ansible-k8s-collection ```bash @@ -7,14 +7,16 @@ ansible-galaxy collection install git+https://github.com/SeldonIO/ansible-k8s-co Once installed you can use the following Playbooks. -## Create Kind Cluster +### Create Kind Cluster ```bash ansible-playbook playbooks/kind_cluster.yaml ``` -## Setup Ecosystem +### Setup Ecosystem + +Run the following from the ansible folder: ```bash ansible-playbook playbooks/setup-ecosystem.yaml @@ -24,7 +26,7 @@ ansible-playbook playbooks/setup-ecosystem.yaml The ecosystem setup can be parametrized by providing extra Ansible variables, e.g. using `-e` flag to `ansible-playbook` command. -For example +For example run the following from the ansible folder: ```bash ansible-playbook playbooks/setup-ecosystem.yaml -e full_install=no -e install_kafka=yes ``` @@ -45,7 +47,10 @@ will only install Kafka when setting up the ecosystem. | configure_opentelemetry | bool | {{ install_opentelemetry }} | configure OpenTelemetry using V2 specific resources | -## Install Seldon Core V2 +### Install Seldon Core V2 + +Run the following from the ansible folder: + ```bash ansible-playbook playbooks/setup-seldon-v2.yaml ``` diff --git a/docs/source/contents/getting-started/kubernetes-installation/index.md b/docs/source/contents/getting-started/kubernetes-installation/index.md index 5bf097dbf9..111e17be2d 100644 --- a/docs/source/contents/getting-started/kubernetes-installation/index.md +++ b/docs/source/contents/getting-started/kubernetes-installation/index.md @@ -1,6 +1,13 @@ # Kubernetes Installation -## Preparation +For Kubernetes installation we provide Ansible playbooks for the core ecosystem and the install. + +```{include} ../../../../../ansible/README.md +``` + +## Top-level Makefile + +### Preparation 1. Git clone seldon-core-v2 git clone https://github.com/SeldonIO/seldon-core-v2 @@ -9,13 +16,13 @@ 4. Install `make`. -## Extra Optional Requirements +### Extra Optional Requirements * To gain access to metrics you will need to install Prometheus. * To run Pipelines you will need to install Kafka. * To expose inference outside the cluster you will need to integration a service mesh of your choice. Some examples for Istio, Traefik and Ambassador are provided. We welcome help to extend these examples to other service meshes. -## Deploy +### Deploy From the project root run: @@ -23,7 +30,7 @@ From the project root run: make deploy-k8s ``` -## Undeploy +### Undeploy From the project root run: