Skip to content

Commit 08c0ab0

Browse files
vtaskowtyndria
andauthored
docs(installation): Update Installation pages (#7077)
* Update Installation docs * Add installation steps for install from a GitHub release and from the GCS bucket * Update docs-gb/install/installation.md Co-authored-by: Antanina Vertsinskaya <antanina.vertsinskaya@seldon.io> --------- Co-authored-by: Antanina Vertsinskaya <antanina.vertsinskaya@seldon.io>
1 parent eaf5472 commit 08c0ab0

File tree

5 files changed

+69
-211
lines changed

5 files changed

+69
-211
lines changed

docs-gb/install/aws.md

Lines changed: 1 addition & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -137,49 +137,7 @@ For custom configuration and more details on installing Seldon Core with Istio p
137137

138138
## Install Seldon Core
139139

140-
Before we install Seldon Core, we'll create a new namespace `seldon-system` for the operator to run in:
141-
142-
```bash
143-
kubectl create namespace seldon-system
144-
```
145-
146-
We're now ready to install Seldon Core in our cluster. Run the following command for your choice of Ingress:
147-
148-
{% tabs %}
149-
150-
{% tab title="Istio" %}
151-
152-
```bash
153-
helm install seldon-core seldon-core-operator \
154-
--repo https://storage.googleapis.com/seldon-charts \
155-
--set usageMetrics.enabled=true \
156-
--set istio.enabled=true \
157-
--namespace seldon-system
158-
```
159-
160-
{% endtab %}
161-
162-
{% tab title="Ambassador" %}
163-
164-
```bash
165-
helm install seldon-core seldon-core-operator \
166-
--repo https://storage.googleapis.com/seldon-charts \
167-
--set usageMetrics.enabled=true \
168-
--set ambassador.enabled=true \
169-
--namespace seldon-system
170-
```
171-
172-
{% endtab %}
173-
174-
{% endtabs %}
175-
176-
You can check that your Seldon Controller is running by doing:
177-
178-
```bash
179-
kubectl get pods -n seldon-system
180-
```
181-
182-
You should see a `seldon-controller-manager` pod with `STATUS=Running`.
140+
To install Seldon Core, you can refer to [this](./installation.md#install-seldon-core-with-helm) page.
183141

184142
## Accessing your models
185143

docs-gb/install/azure.md

Lines changed: 1 addition & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -136,49 +136,7 @@ For custom configuration and more details on installing Seldon Core with Istio p
136136

137137
## Install Seldon Core
138138

139-
Before we install Seldon Core, we'll create a new namespace `seldon-system` for the operator to run in:
140-
141-
```bash
142-
kubectl create namespace seldon-system
143-
```
144-
145-
We're now ready to install Seldon Core in our cluster. Run the following command for your choice of Ingress:
146-
147-
{% tabs %}
148-
149-
{% tab title="Istio" %}
150-
151-
```bash
152-
helm install seldon-core seldon-core-operator \
153-
--repo https://storage.googleapis.com/seldon-charts \
154-
--set usageMetrics.enabled=true \
155-
--set istio.enabled=true \
156-
--namespace seldon-system
157-
```
158-
159-
{% endtab %}
160-
161-
{% tab title="Ambassador" %}
162-
163-
```bash
164-
helm install seldon-core seldon-core-operator \
165-
--repo https://storage.googleapis.com/seldon-charts \
166-
--set usageMetrics.enabled=true \
167-
--set ambassador.enabled=true \
168-
--namespace seldon-system
169-
```
170-
171-
{% endtab %}
172-
173-
{% endtabs %}
174-
175-
You can check that your Seldon Controller is running by doing:
176-
177-
```bash
178-
kubectl get pods -n seldon-system
179-
```
180-
181-
You should see a `seldon-controller-manager` pod with `STATUS=Running`.
139+
To install Seldon Core, you can refer to [this](./installation.md#install-seldon-core-with-helm) page.
182140

183141
## Accessing your models
184142

docs-gb/install/gcp.md

Lines changed: 1 addition & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -136,49 +136,7 @@ For custom configuration and more details on installing Seldon Core with Istio p
136136

137137
## Install Seldon Core
138138

139-
Before we install Seldon Core, we'll create a new namespace `seldon-system` for the operator to run in:
140-
141-
```bash
142-
kubectl create namespace seldon-system
143-
```
144-
145-
We're now ready to install Seldon Core in our cluster. Run the following command for your choice of Ingress:
146-
147-
{% tabs %}
148-
149-
{% tab title="Istio" %}
150-
151-
```bash
152-
helm install seldon-core seldon-core-operator \
153-
--repo https://storage.googleapis.com/seldon-charts \
154-
--set usageMetrics.enabled=true \
155-
--set istio.enabled=true \
156-
--namespace seldon-system
157-
```
158-
159-
{% endtab %}
160-
161-
{% tab title="Ambassador" %}
162-
163-
```bash
164-
helm install seldon-core seldon-core-operator \
165-
--repo https://storage.googleapis.com/seldon-charts \
166-
--set usageMetrics.enabled=true \
167-
--set ambassador.enabled=true \
168-
--namespace seldon-system
169-
```
170-
171-
{% endtab %}
172-
173-
{% endtabs %}
174-
175-
You can check that your Seldon Controller is running by doing:
176-
177-
```bash
178-
kubectl get pods -n seldon-system
179-
```
180-
181-
You should see a `seldon-controller-manager` pod with `STATUS=Running`.
139+
To install Seldon Core, you can refer to [this](./installation.md#install-seldon-core-with-helm) page.
182140

183141
## Accessing your models
184142

docs-gb/install/installation.md

Lines changed: 65 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
## Pre-requisites
44

55
- Kubernetes cluster >= 1.23
6-
- For Openshift it requires version >= 4.10
76
- Installer method
87
- Helm version >= 3.0
98
- Kustomize version >= 0.1.0
109
- Ingress
11-
- Istio : we recommend >= 1.16
10+
- Istio: we recommend >= 1.16
1211
- Ambassador v1 and v2
1312

1413
### Kubernetes Compatibility Matrix
@@ -17,48 +16,77 @@ Seldon Core 1.16 bumps minimum Kubernetes version to 1.23. This is because as pa
1716

1817
Following table provides a summary of Seldon Core / Kubernetes version compatibility for recent version of Seldon Core.
1918

20-
| Core Version \ K8s Version | 1.21 | 1.22 | 1.23 | 1.24 | 1.25 | 1.26 | 1.27 |
21-
|---------------------------|------|------|------|------|------|------|------|
22-
| 1.11 || | | | | | |
23-
| 1.12 ||||| | | |
24-
| 1.13 ||||| | | |
25-
| 1.14 ||||| | | |
26-
| 1.15 ||||| | | |
27-
| 1.16 | | ||||||
28-
| 1.17 | | ||||||
29-
| 1.18 | | ||||||
19+
| Core Version \ K8s Version | 1.23 | 1.24 | 1.25 | 1.26 | 1.27 | 1.28 | 1.29 | 1.30 | 1.31 | 1.32 | 1.33 | 1.34 | 1.35 |
20+
|----------------------------|------|------|------|------|------|------|------|------|------|------|------|------|------|
21+
| 1.16 |||||| | | | | | | | |
22+
| 1.17 |||||| | | | | | | | |
23+
| 1.18 |||||| | | | | | | | |
24+
| 1.19 ||||||||||||||
3025

3126
It is always recommended to first upgrade Seldon Core to the latest supported version on your Kubernetes cluster and then upgrade the Kubernetes cluster.
3227

3328
### Running older versions of Seldon Core?
3429

35-
Make sure you read the [Upgrading Seldon Core Guide](../reference/upgrading.md)
30+
Make sure you read the [Upgrading Seldon Core Guide](../upgrading.md) to understand breaking changes and best practices for upgrading.
3631

3732
- **Seldon Core will stop supporting versions prior to 1.0 so make sure you upgrade.**
38-
- If you are running an older version of Seldon Core, and will be upgrading it please make sure you read the [Upgrading Seldon Core docs](../reference/upgrading.md) to understand breaking changes and best practices for upgrading.
39-
- Please see [Migrating from Helm v2 to Helm v3](https://helm.sh/docs/topics/v2_v3_migration/) if you are already running Seldon Core using Helm v2 and wish to upgrade.
4033

4134
# Install Seldon Core with Helm
4235

43-
First [install Helm 3.x](https://docs.helm.sh/docs/intro/install/). When helm is installed you can deploy the seldon controller to manage your Seldon Deployment graphs.
36+
You will first need to add the seldonio Helm repo:
37+
```bash
38+
helm repo add seldonio https://storage.googleapis.com/seldon-charts
39+
helm repo update
40+
```
4441

45-
If you want to provide advanced parameters with your installation you can check the full [Seldon Core Helm Chart Reference](../reference/helm.html).
42+
And then install the `seldon-core-operator` chart:
43+
```bash
44+
kubectl create namespace seldon-system
45+
helm install seldon-core-operator seldonio/seldon-core-operator --namespace seldon-system
46+
```
4647

47-
The namespace `seldon-system` is preferred, so we can create it:
48+
To install a specific version of the chart, you can list the available versions:
49+
```bash
50+
helm search repo seldon/seldon-core-operator --versions
51+
```
4852

53+
And then either install it from scratch:
4954
```bash
50-
kubectl create namespace seldon-system
55+
helm install seldon-core-operator seldonio/seldon-core-operator \
56+
--namespace seldon-system \
57+
--version 1.17.1
58+
```
59+
Or, upgrade your existing installation:
60+
```bash
61+
helm upgrade --install seldon-core-operator seldon/seldon-core-operator \
62+
--version 1.17.1 \
63+
--namespace seldon-system
5164
```
5265

53-
Now we can install Seldon Core in the `seldon-system` namespace.
66+
To install it from a locally downloaded chart(GitHub Release):
67+
1. Download the chart - https://github.com/SeldonIO/helm-charts/releases/tag/seldon-core-operator-1.18.2
68+
2. Install the archive from the folder you downloaded it in:
69+
```bash
70+
helm install seldon-core-operator \
71+
./seldon-core-operator-1.18.2.tgz \
72+
--namespace seldon-system
73+
```
74+
75+
To install it from our GCS bucket:
76+
```bash
77+
helm install seldon-core-operator \
78+
https://storage.googleapis.com/seldon-charts/seldon-core-operator-1.17.1.tgz \
79+
--namespace seldon-system
80+
```
5481

82+
If you want to provide advanced parameters with your installation you can check the full [Seldon Core Helm Chart Reference](./advanced-helm-chart-configuration.md).
83+
For example, if you want to install the operator with Istio or Ambassador enabled, and usage metrics enabled you can
5584
{% tabs %}
5685

5786
{% tab title="Istio" %}
5887

5988
```bash
60-
helm install seldon-core seldon-core-operator \
61-
--repo https://storage.googleapis.com/seldon-charts \
89+
helm install seldon-core-operator seldonio/seldon-core-operator \
6290
--set usageMetrics.enabled=true \
6391
--set istio.enabled=true \
6492
--namespace seldon-system
@@ -69,8 +97,7 @@ helm install seldon-core seldon-core-operator \
6997
{% tab title="Ambassador" %}
7098

7199
```bash
72-
helm install seldon-core seldon-core-operator \
73-
--repo https://storage.googleapis.com/seldon-charts \
100+
helm install seldon-core-operator seldonio/seldon-core-operator \
74101
--set usageMetrics.enabled=true \
75102
--set ambassador.enabled=true \
76103
--namespace seldon-system
@@ -80,14 +107,18 @@ helm install seldon-core seldon-core-operator \
80107

81108
{% endtabs %}
82109

83-
For full instructions on installation with Istio and Ambassador read the following pages:
110+
You can check that the operator is running:
111+
```bash
112+
kubectl get pods -n seldon-system
113+
```
84114

85-
- [Ingress with Istio](../ingress/istio.md)
86-
- [Ingress with Ambassador](../ingress/ambassador.md)
115+
You should see a `seldon-controller-manager` pod with `STATUS=Running`.
87116

88-
### Install a specific version
89117

90-
In order to install a specific version you can do so by running the same command above with the `--version` flag, followed by the version you want to run.
118+
For full instructions on installation with Istio and Ambassador read the following pages:
119+
120+
- [Ingress with Istio](../routing/istio.md)
121+
- [Ingress with Ambassador](../routing/ambassador.md)
91122

92123
### Install a SNAPSHOT version
93124

@@ -97,13 +128,7 @@ This means that you can try out a dev version of master if you want to try a spe
97128

98129
For this you would be able to clone the repository, and then checkout the relevant SNAPSHOT branch.
99130

100-
Once you have done that you can install seldon-core using the following command:
101-
102-
```bash
103-
helm install helm-charts/seldon-core-operator seldon-core-operator
104-
```
105-
106-
In this case `helm-charts/seldon-core-operator` is the folder within the repository that contains the charts.
131+
Once you have done that you can install the `seldon-core-operator`, as described above in the page.
107132

108133
### Install with cert-manager
109134

@@ -169,7 +194,7 @@ You can install Seldon Core from [Operator Hub](https://operatorhub.io/operator/
169194

170195
# Upgrading from Previous Versions
171196

172-
See our [upgrading notes](../reference/upgrading.md)
197+
See our [upgrading notes](../upgrading.md)
173198

174199
# Advanced Usage
175200

@@ -191,7 +216,8 @@ We label the namespace with `seldon.io/controller-id=<namespace>` to ensure if t
191216
Install the Operator into the namespace:
192217

193218
```bash
194-
helm install seldon-namespaced seldon-core-operator --repo https://storage.googleapis.com/seldon-charts \
219+
helm install seldon-namespaced seldon-core-operator \
220+
--repo https://storage.googleapis.com/seldon-charts \
195221
--set singleNamespace=true \
196222
--set image.pullPolicy=IfNotPresent \
197223
--set usageMetrics.enabled=false \
@@ -247,7 +273,7 @@ An example install is provided in the Makefile in the Operator folder:
247273
make deploy-controllerid
248274
```
249275

250-
See the [multiple server example notebook](../examples/multiple_operators.html).
276+
See the [multiple server example notebook](../notebooks/multiple_operators.md).
251277

252278
## Install behind a proxy
253279

docs-gb/install/kind.md

Lines changed: 1 addition & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -183,49 +183,7 @@ For custom configuration and more details on installing Seldon Core with Istio p
183183

184184
## Install Seldon Core
185185

186-
Before we install Seldon Core, we'll create a new namespace `seldon-system` for the operator to run in:
187-
188-
```bash
189-
kubectl create namespace seldon-system
190-
```
191-
192-
We're now ready to install Seldon Core in our cluster. Run the following command for your choice of Ingress:
193-
194-
{% tabs %}
195-
196-
{% tab title="Istio" %}
197-
198-
```bash
199-
helm install seldon-core seldon-core-operator \
200-
--repo https://storage.googleapis.com/seldon-charts \
201-
--set usageMetrics.enabled=true \
202-
--set istio.enabled=true \
203-
--namespace seldon-system
204-
```
205-
206-
{% endtab %}
207-
208-
{% tab title="Ambassador" %}
209-
210-
```bash
211-
helm install seldon-core seldon-core-operator \
212-
--repo https://storage.googleapis.com/seldon-charts \
213-
--set usageMetrics.enabled=true \
214-
--set ambassador.enabled=true \
215-
--namespace seldon-system
216-
```
217-
218-
{% endtab %}
219-
220-
{% endtabs %}
221-
222-
You can check that your Seldon Controller is running by doing:
223-
224-
```bash
225-
kubectl get pods -n seldon-system
226-
```
227-
228-
You should see a `seldon-controller-manager` pod with `STATUS=Running`.
186+
To install Seldon Core, you can refer to [this](./installation.md#install-seldon-core-with-helm) page.
229187

230188
## Local Port Forwarding
231189

0 commit comments

Comments
 (0)