From 7e6c8f1315507cb6fa3039ce8b63972255c6d315 Mon Sep 17 00:00:00 2001 From: Sherif Akoush Date: Tue, 10 Dec 2024 16:32:37 +0000 Subject: [PATCH] fix(docs): add a table for core 2 dependencies in docs (#6139) * add table for core 2 deps in dosc * review comments --- .../kubernetes-installation/README.md | 22 ++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/docs-gb/getting-started/kubernetes-installation/README.md b/docs-gb/getting-started/kubernetes-installation/README.md index bdcbaffad9..bb9c9dd5b5 100644 --- a/docs-gb/getting-started/kubernetes-installation/README.md +++ b/docs-gb/getting-started/kubernetes-installation/README.md @@ -2,9 +2,29 @@ ## Prerequisites -* Ensure that the version of the Kubernetes cluster is v1.27 or later. Seldon Core 2 supports Kubernetes versions 1.27, 1.28, 1.29, 1.30, and 1.31. You can create a [KinD](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) cluster on your local computer for testing with [Ansible](ansible.md). +* Ensure that the version of the Kubernetes cluster meets the requirement listed below. You can create a [KinD](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) cluster on your local computer for testing with [Ansible](ansible.md). * Install the ecosystem components using [Ansible](ansible.md). +## Core 2 Dependencies + +Here is a list of components that Seldon Core 2 depends on, with minimum and maximum supported versions. + +| Component | Minimum Version | Maximum Version | Notes | +| - | - | - | - | +| Kubernetes | 1.27 | 1.31 | Required | +| Envoy`*` | 1.32.2 | 1.32.2 | Required | +| Rclone`*` | 1.68.2 | 1.68.2 | Required | +| Kafka`**` | 3.4 | 3.8 | Optional | +| Prometheus | 2.0 | 2.x | Optional | +| Grafana | 10.0 | `***` | Optional | +| Prometheus-adapter | 0.12 | 0.12 | Optional | +| Opentelemetry Collector | 0.68 | `***` | Optional | + +`*` These components are shipped as part of Seldon Core 2 docker images set, users should not install them separately but they need to be aware of the configuration options that are supported by these versions. +`**` Kafka is only required to operate Seldon Core 2 dataflow Pipelines. If not required then users should not install seldon-modelgateway, seldon-pipelinegateway, and seldon-dataflow-engine. +`***` Not hard limit on the maximum version to be used. + + ## Install Ecosystem Components You also need to install our ecosystem components. For this we provide directions for [Ansible](ansible.md) to install these.