An SRE's dream: Keep Istio's data-plane up-to-date without toil.

The name comes from the Greek phrase "Όρτσα τα πανιά!" meaning roughly "Full Sail Ahead"

When updating Istio, one particular task is pretty much impossible to do with a GitOps-style workflow: Restarting all the pods running the previous versions of Istio's sidecar proxy. This is an onerous task even when doing everything via scripts or using something like Ansible. It can take hours - or even longer - and it's easy to make mistakes. An that's just for a single medium-sized cluster. If you have many clusters, keeping Istio's data-plane up-to-date can be a full-time job!

This project is a Kubernetes Operator that automates away the whole task, as much as possible.

In the spirit of being as simple as possible, there are currently no CRDs and no dependencies other than running in a cluster that uses Istio. Note that we've only tested this when using Istio's default envoy-based proxy.

This project was inspired by my experience with the toil of keeping the istio data-plane up-to-date and then discovering the solution Google had come up with, described in this YouTube video: https://youtu.be/R86ZsYH7Ka4

• go version v1.21.0+
• docker version 17.03+.
• kubectl version v1.11.3+.
• Access to a Kubernetes v1.11.3+ cluster running Istio

Build and push your image to the location specified by IMG:

make docker-buildx IMG=sscaffidi/istio-fortsa:tag

NOTE: This image ought to be published in the personal registry you specified. And it is required to have access to pull the image from the working environment. Make sure you have the proper permission to the registry if the above commands don’t work.

Install the CRDs into the cluster:

make install

Deploy the Manager to the cluster with the image specified by IMG:

make deploy IMG=sscaffidi/istio-fortsa:tag

NOTE: If you encounter RBAC errors, you may need to grant yourself cluster-admin privileges or be logged in as admin.

Create instances of your solution You can apply the samples (examples) from the config/sample:

kubectl apply -k config/samples/

NOTE: Ensure that the samples has default values to test it out.

Delete the instances (CRs) from the cluster:

kubectl delete -k config/samples/

Delete the APIs(CRDs) from the cluster:

make uninstall

UnDeploy the controller from the cluster:

make undeploy

Following are the steps to build the installer and distribute this project to users.

1. Build the installer for the image built and published in the registry:

make build-installer IMG=sscaffidi/istio-fortsa:tag

NOTE: The makefile target mentioned above generates an 'install.yaml' file in the dist directory. This file contains all the resources built with Kustomize, which are necessary to install this project without its dependencies.

2. Using the installer

Users can just run kubectl apply -f to install the project, i.e.:

kubectl apply -f https://raw.githubusercontent.com/hercynium/istio-fortsa/<tag or branch>/dist/install.yaml

There's lots to do! If you want to help, see the Contributing section, below.

This is a young project and we can use all the help we can get! Feature requests, bug reports, patches, documentation, testing, CI/CD, helm charts, you name it!

NOTE: Run make help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation

Copyright 2024 Stephen R. Scaffidi

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.