Upgrading Seldon Core

This page provides with instructions on how to upgrade from previous versions. Each of these have to be run sequentially if it’s expected for previous running models to be upgraded without disruption (i.e if you are running version 0.4.2, you will first have to upgrade to 0.5.2 and then to 1.1, etc).

If you were running our Openshift 0.4.2 certified operator and are looking to upgrade to our 1.1 certified operator, you will also need to follow the “upgrading process” steps in the “Upgrading to 0.5.2 from previous versions” section.

Make sure you also read the CHANGELOG to see the detailed features and bug-fixes in each version.

Upgrading to 1.1 from previous versions

As we moved to 1.x+ there are several breaking changes that need to be considered. These are outlined below

New Features / Breaking Changes

New Service Orchestrator

From version 1.1 Seldon Core comes with a new service orchestrator written in Go which replaces the previous Java engine. Some breaking changes are present:

  • Metadata fields in the Seldon Protocol are no longer added. Any custom metata data will need to be added and exposed to Prometheus metrics by the individual components in the graph
  • All components in the graph must either be REST or gRPC and only the given protocol is exposed externally.

The new service orchestrator comes with several advantages including ability to handle Tensorflow REST and gRPC protocols and full metrics and tracing support for both REST and gRPC.

For those wishing to use the deprecated Java engine service orchestrator see the service orchestrator docs for details.

Upgrading process

Wrapper compatibility table

To verify if Seldon Core v1.0 and v.1.1 is compatible with older s2i wrapper versions we conducted a simple test with a one-node model. The model has been deployed both with REST and GRPC API with both new orchestrator and the deprecated Java engine (v1.0 only with Java Engine). Test verifies if model can successfully serve inference requests.

NOTE: Full support of custom metrics and tags with new orchestrator is only available from Python wrapper version 0.19. If you need to use older version of Python wrapper you can continue to use Java engine as described above until the next release.

Language Wrapper Version API Type New Orchestrator Deprecated Java engine Notes
Python 0.19 both yes yes full support of custom metrics and tags
Python 0.11 … 0.18 both yes yes .
Python 0.10 REST no yes .
Python 0.10 GRPC yes yes .
Python < 0.10 GRPC ? ? .
Java 0.2 & 0.1 REST yes yes minor difference in request format
Java 0.2 & 0.1 GRPC yes yes .

Example of request format difference with Java wrapper deployed with REST API:

  1. Using new orchestrator:

    curl -s -X POST \
     -d 'json={"data": {"names": ["a", "b"], "ndarray": [[1.0, 2.0]]}}' \
     localhost:8003/seldon/seldon/compat-rest-java-02-executor/api/v1.0/predictions
    
  2. Using deprecated Java engine:

    curl -s -X POST -H 'Content-Type: application/json' \
     -d '{"data": {"names": ["a", "b"], "ndarray": [[1.0, 2.0]]}}' \
     localhost:8003/seldon/seldon/compat-rest-java-02-engine/api/v1.0/predictions
    

Upgrading to 0.5.2 from previous versions

This version included significant improvements and features, including the addition of pre-packaged model servers, fixing several critical bugs.

This was the version that also dropped support for kubernetes 1.11, and added changes in the mutating and validating webhooks that you need to make sure are transitioned as outlined below.

Upgrading process

In order to upgrade, the main requirement is to make sure that the Kubernetes cluster is updated to 1.12 or higher.

Once this is done, it’s necessary to delete the old webhooks. This can be done with the following commands (you need to make sure that the commands are executed in the namespace in which seldon core was installed).

Upgrading to 0.2.8 from previous versions.

Upgrading process

Installation process now with Helm

The helm charts to install Seldon Core have changed. There is now a single Helm chart seldon-core-operator that installs the CRD and its controller. Ingress options are now separate and you need to choose between the available options which are at present:

  • Ambassador - via its official Helm chart
  • Istio

For more details see the install docs.

The Helm chart seldon-core-operator will require clusterwide RBAC and should be installed by a cluster admin.

Dropping support for KSonnet

Ksonnet is now deprecated. You should convert to using Helm to install Seldon Core.