Install on Kubernetes

Prerequisites

  • Kubernetes v1.11 or newer.
  • Istio v1.1.5 and newer.
  • Your Istio installation must have at least the istio-pilot, telemetry and Prometheus enabled.

Install iter8 on Kubernetes and Istio

iter8 has two components, iter8_analytics and iter8_controller. To install them, follow the instructions below. When installing iter8 on Red Hat OpenShift, use these instructions instead.

Quick Installation

To install iter8 with the default settings, you can run the following install script:

curl -L -s https://raw.githubusercontent.com/iter8-tools/iter8/v1.0.0-rc2/install/install.sh \
| /bin/bash -

Customized installation via Helm charts

In case you need to customize the installation of iter8, use the Helm charts listed below:

Note on Prometheus: In order to make assessments, iter8-analytics needs to query metrics collected by Istio and stored on Prometheus. The default values for the helm chart parameters (used in the quick installation) point iter8-analytics to the Prometheus server at http://prometheus.istio-system:9090 (the default internal Kubernetes URL of Prometheus installed as an Istio addon) without specifying any need for authentication. If your Istio installation is shipping metrics to a different Prometheus service, or if you need to configure authentication to access Prometheus, you need to set appropriate iter8-analytics Helm chart parameters. Look in the section metricsBackend of the Helm chart’s values.yaml file for details.

Note on Istio Telemetry: When deploying iter8-controller using helm, make sure to set the parameter istioTelemetry to conform with your environment. Possible values are v1 or v2. Use v1 if the Istio mixer is not disabled. You can determine if the mixer is not disabled using this command:

kubectl -n $ISTIO_NAMESPACE get cm istio -o json | jq .data.mesh | grep -o 'disableMixerHttpReports: [A-Za-z]\+' | cut -d ' ' -f2

Verify the installation

After installing iter8-analytics and iter8-controller, you should see the following pods and services in the newly created iter8 namespace:

$ kubectl get pods -n iter8
NAME                                  READY   STATUS    RESTARTS   AGE
iter8-controller-5f54bb4b88-drr8s     1/1     Running   0          4s
iter8-analytics-5c5758ccf9-p575b      1/1     Running   0          61s
$ kubectl get svc -n iter8
NAME                     TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)   AGE
iter8-controller         ClusterIP   172.21.62.217   <none>        443/TCP   20s
iter8-analytics          ClusterIP   172.21.106.44   <none>        80/TCP    76s

Uninstalling iter8

If you want to uninstall all of iter8 components from your Kubernetes cluster, first delete all instances of Experiment from all namespaces. Then, you can delete iter8 by running the following command:

kubectl delete -f https://raw.githubusercontent.com/iter8-tools/iter8/v1.0.0-rc2/install/iter8-controller.yaml

Uninstall is stuck?

Iter8 uses K8s finalizer to ensure things are cleaned up properly. However, if one removes iter8-controller, e.g., by running the above uninstall command before the workload namespace is cleaned up, removing the workload namespace afterward could get stuck. To unstuck, one would need to manually edit (with kubectl edit) the Experiment CRs and remove their finalizer, i.e., the following 2 lines:

  finalizers:
  - finalizer.iter8-tools