Istio Operator

The Istio operator CLI is now suitable for developers to evaluate and experiment with. You can contribute by picking an unassigned open issue, creating a bug or feature request, or just coming to the weekly Environments Working Group meeting to share your ideas.

This document is an overview of how the operator works from a user perspective. For more details about the design and architecture and a code overview, see ARCHITECTURE.md

Introduction

This repo reorganizes the current Helm installation parameters into two groups:

The new platform level installation API, for managing K8s settings like resources, auto scaling, pod disruption budgets and others defined in the KubernetesResourceSpec
The configuration API that currently uses the Helm installation parameters for backwards compatibility. This API is for managing the Istio control plane configuration settings.

Some parameters will temporarily exist in both APIs - for example, setting K8s resources currently can be done through either API above. However, the Istio community recommends using the first API as it is more consistent, is validated, and will naturally follow the graduation process for APIs while the same parameters in the configuration API are planned for deprecation.

This repo currently provides pre-configured Helm values sets for different scenarios as configuration profiles, which act as a starting point for an Istio install and can be customized by creating customization overlay files or passing parameters when calling Helm. Similarly, the operator API uses the same profiles (expressed internally through the new API), which can be selected as a starting point for the installation. For comparison, the following example shows the command needed to install Istio using the SDS configuration profile using Helm:

helm template install/kubernetes/helm/istio --name istio --namespace istio-system \
    --values install/kubernetes/helm/istio/values-istio-sds-auth.yaml | kubectl apply -f -

In the new API, the same profile would be selected through a CustomResource (CR):

# sds-install-cr.yaml

apiVersion: install.istio.io/v1alpha2
kind: IstioControlPlane
spec:
  profile: sds

See Select a profile for more information.

If you don't specify a configuration profile, Istio is installed using the default configuration profile. All profiles listed in istio.io are available by default, or profile: can point to a local file path to reference a custom profile base to use as a starting point for customization. See the API reference for details.

Developer quick start

The quick start describes how to install and use the operator mesh CLI command.

Installation

git clone https://github.com/istio/operator.git
cd operator
make mesh

Flags

The mesh command supports the following flags:

logtostderr: log to console (by default logs go to ./mesh-cli.log).
dry-run: console output only, nothing applied to cluster or written to files (default is true until the tool is robust enough).
verbose: display entire manifest contents and other debug info (default is false).

Quick tour of CLI commands

Basic default manifest

The following command generates a manifest with the compiled in default profile and charts:

mesh manifest generate

You can see these sources for the compiled in profiles in the repo under data/profiles, while the compiled in Helm charts are under data/charts. Note: this will change shortly. Charts/profiles will be released separately and the by default the mesh command will point to a version of the released charts.

Output to dirs

The output of the manifest is concatenated into a single file. To generate a directory hierarchy with subdirectory levels representing a child dependency, use the following command:

mesh manifest generate -o istio_manifests

(Note that the default dry-run setting only writes the intended actions to log.) Use depth first search to traverse the created directory hierarchy when applying your YAML files. This is needed for correct sequencing of dependencies. Child manifest directories must wait for their parent directory to be fully applied, but not their sibling manifest directories.

Just apply it for me

The following command generates the manifests and applies them in the correct dependency order, waiting for the dependencies to have the needed CRDs available:

mesh manifest apply

The default dry-run=true displays the manifest only. Set dry-run=false to apply the Istio configuration to Kubernetes. --dry-run=false to actually apply the generated configuration to the cluster.

Review the values of the current configuration profile

The following command shows the values of the current configuration profile:

mesh profile dump

The profile dump sub-command supports a couple of useful flags:

config-path: select the root for the configuration subtree you want to see e.g. just show Pilot:

mesh profile dump --config-path trafficManagement.components.pilot

set: set a value in the configuration before dumping the resulting profile e.g. show the minimal profile:

mesh profile dump --set profile=minimal

Select a specific configuration profile

The simplest customization is to select a profile different to default e.g. sds. Create the following config file:

# sds-install.yaml
apiVersion: install.istio.io/v1alpha2
kind: IstioControlPlane
spec:
  profile: sds

Use the Istio operator mesh binary to apply the new configuration profile:

mesh manifest generate -f sds-install.yaml

After running the command, the Helm charts are rendered using data/profiles/sds.yaml.

Install from file path

The compiled in charts and profiles are used by default, but you can specify a file path, for example:

apiVersion: install.istio.io/v1alpha2
kind: IstioControlPlane
spec:
  profile: file:///usr/home/bob/go/src/github.com/ostromart/istio-installer/data/profiles/default.yaml
  customPackagePath: file:///usr/home/bob/go/src/github.com/ostromart/istio-installer/data/charts/

You can mix and match these approaches. For example, you can use a compiled-in configuration profile with charts in your local file system.

New API customization

The new platform level installation API defines install time parameters like feature and component enablement and namespace, and K8s settings like resources, HPA spec etc. in a structured way. The simplest customization is to turn features and components on and off. For example, to turn off all policy:

apiVersion: install.istio.io/v1alpha2
kind: IstioControlPlane
spec:
  profile: sds
  policy:
    enabled: false

The operator validates the configuration and automatically detects syntax errors. Helm lacks this capability. If you are using Helm values that are incompatible, the schema validation used in the operator may reject input that is valid for Helm. Another customization is to define custom namespaces for features:

apiVersion: install.istio.io/v1alpha2
kind: IstioControlPlane
spec:
  profile: sds

  trafficManagement:
    namespace: istio-control-custom

The traffic management feature comprises Pilot and Proxy components. Each of these components has K8s settings, and these can be overridden from the defaults using official K8s APIs (rather than Istio defined schemas):

apiVersion: install.istio.io/v1alpha2
kind: IstioControlPlane
spec:
  trafficManagement:
    components:
      pilot:
        k8s:
          resources:
            requests:
              cpu: 1000m # override from default 500m
              memory: 4096Mi # ... default 2048Mi
          hpaSpec:
            maxReplicas: 10 # ... default 5
            minReplicas: 2  # ... default 1

The K8s settings are defined in detail in the operator API. The settings are the same for all components, so a user can configure pilot K8s settings in exactly the same, consistent way as galley settings. Supported K8s settings currently include:

All of these K8s settings use the K8s API definitions, so K8s documentation can be used for reference. All K8s overlay values are also validated in the operator.

Customizing the old values.yaml API

The new platform install API above deals with K8s level settings. The remaining values.yaml parameters deal with Istio control plane operation rather than installation. For the time being, the operator just passes these through to the Helm charts unmodified (but validated through a schema). Values.yaml settings are overridden the same way as the new API, though a customized CR overlaid over default values for the selected profile. Here's an example of overriding some global level default values:

apiVersion: install.istio.io/v1alpha2
kind: IstioControlPlane
spec:
  profile: sds
  values:
    logging:
      level: "default:warning" # override from info

Since from 1.3 Helm charts are split up per component, values overrides should be specified under the appropriate component e.g.

apiVersion: install.istio.io/v1alpha2
kind: IstioControlPlane
spec:
  trafficManagement:
    components:
      pilot:
        common:
          values:
            traceSampling: 0.1 # override from 1.0

Advanced K8s resource overlays

Advanced users may occasionally have the need to customize parameters (like container command line flags) which are not exposed through either of the installation or configuration APIs described in this document. For such cases, it's possible to overlay the generated K8s resources before they are applied with user-defined overlays. For example, to override some container level values in the Pilot container:

apiVersion: install.istio.io/v1alpha2
kind: IstioControlPlane
spec:
  trafficManagement:
    enabled: true
    components:
      proxy:
        common:
          enabled: false
      pilot:
        common:
          k8s:
            overlays:
            - kind: Deployment
              name: istio-pilot
              patches:
              - path: spec.template.spec.containers.[name:discovery].args.[30m]
                value: "60m" # OVERRIDDEN
              - path: spec.template.spec.containers.[name:discovery].ports.[containerPort:8080].containerPort
                value: 8090 # OVERRIDDEN
            - kind: Service
              name: istio-pilot
              patches:
              - path: spec.ports.[name:grpc-xds].port
                value: 15099 # OVERRIDDEN

The user-defined overlay uses a path spec that includes the ability to select list items by key. In the example above, the container with the key-value "name: discovery" is selected from the list of containers, and the command line parameter with value "30m" is selected to be modified. The advanced overlay capability is described in more detail in the spec.

Try the demo customization

This customization contains overlays at all three levels: the new API, values.yaml legacy API and the K8s output overlay.

mesh manifest generate -f samples/customize_pilot.yaml

Architecture

WIP, coming soon.

rcaballeromx/operator