├── python ├── cli.sh ├── config │ └── canaries.yaml ├── prometheusclient.py ├── aviary.py ├── admin_server.py ├── kubernetesinterface.py └── birdwatcher.py ├── resources ├── tests │ ├── requirements.txt │ ├── Dockerfile │ ├── canaries.yaml │ ├── deploy │ │ ├── deploy-work.yaml │ │ ├── deploy-original.yaml │ │ ├── deploy-direct.yaml │ │ ├── deploy-fail.yaml │ │ └── deploy-fail-in-metrics.yaml │ ├── dummy.py │ └── run.sh ├── kubernetes │ ├── kustomization.yaml │ ├── config.yaml │ ├── serviceaccount.yaml │ └── deploy.yaml └── dockers │ └── Dockerfile ├── requirements.in ├── control-loop.png ├── requirements.txt ├── README.md └── LICENSE /python/cli.sh: -------------------------------------------------------------------------------- 1 | nc localhost 8888 2 | -------------------------------------------------------------------------------- /resources/tests/requirements.txt: -------------------------------------------------------------------------------- 1 | prometheus-client==0.8.0 2 | -------------------------------------------------------------------------------- /requirements.in: -------------------------------------------------------------------------------- 1 | deepdiff 2 | requests 3 | pyyaml 4 | kubernetes 5 | -------------------------------------------------------------------------------- /control-loop.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/SEKOIA-IO/aviary/HEAD/control-loop.png -------------------------------------------------------------------------------- /resources/kubernetes/kustomization.yaml: -------------------------------------------------------------------------------- 1 | resources: 2 | - serviceaccount.yaml 3 | - deploy.yaml 4 | - config.yaml 5 | -------------------------------------------------------------------------------- /resources/tests/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3.7 2 | 3 | WORKDIR /opt/ 4 | COPY dummy.py dummy.py 5 | COPY requirements.txt requirements.txt 6 | 7 | RUN pip install -r requirements.txt 8 | 9 | CMD python -u dummy.py 10 | -------------------------------------------------------------------------------- /resources/tests/canaries.yaml: -------------------------------------------------------------------------------- 1 | prometheus-base-url: https://dashboard.test.sekoia.io/prometheus 2 | namespace: sic 3 | aviary-tester: 4 | breakpoint: 50% 5 | step: 4% 6 | abort: 120s 7 | max_step_duration: 45s 8 | check_success_step_duration: 14s 9 | check_max_failures: 3 10 | success: 11 | - expr: aviary_tester_failures_total{kubernetes_pod_name="<>"} == 0 12 | -------------------------------------------------------------------------------- /python/config/canaries.yaml: -------------------------------------------------------------------------------- 1 | prometheus-base-url: http://myprometheus:9090/ 2 | namespace: default 3 | 4 | my-service-deployment: 5 | breakpoint: 50% 6 | step: 10% 7 | abort: 120s 8 | max_step_duration: 600s 9 | check_max_failures: 4 10 | check_success_step_duration: 120s 11 | start_delay: 60s 12 | success: 13 | - expr: rate(my_service_performance{kubernetes_pod_name="<>"}[1m]) > 500 14 | - expr: my_service_error_total{kubernetes_pod_name="<>"} == 0 15 | -------------------------------------------------------------------------------- /resources/tests/deploy/deploy-work.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: apps/v1 2 | kind: Deployment 3 | metadata: 4 | name: aviary-tester 5 | labels: 6 | app: aviary-tester 7 | spec: 8 | selector: 9 | matchLabels: 10 | app: aviary-tester 11 | template: 12 | metadata: 13 | annotations: 14 | prometheus.io/scrape: "true" 15 | prometheus.io/port: "8000" 16 | labels: 17 | app: aviary-tester 18 | spec: 19 | containers: 20 | - name: aviary-tester 21 | image: sekoialab/aviary-tester:latest 22 | -------------------------------------------------------------------------------- /resources/tests/deploy/deploy-original.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: apps/v1 2 | kind: Deployment 3 | metadata: 4 | name: aviary-tester 5 | labels: 6 | app: aviary-tester 7 | spec: 8 | replicas: 5 9 | selector: 10 | matchLabels: 11 | app: aviary-tester 12 | template: 13 | metadata: 14 | annotations: 15 | prometheus.io/scrape: "true" 16 | prometheus.io/port: "8000" 17 | labels: 18 | app: aviary-tester 19 | spec: 20 | containers: 21 | - name: aviary-tester 22 | image: sekoialab/aviary-tester:1.0 23 | -------------------------------------------------------------------------------- /resources/dockers/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3.7 2 | 3 | RUN apt update && \ 4 | apt install -y curl netcat && \ 5 | curl -LO https://storage.googleapis.com/kubernetes-release/release/`curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt`/bin/linux/amd64/kubectl && \ 6 | chmod +x ./kubectl && \ 7 | mv ./kubectl /usr/local/bin/kubectl 8 | 9 | WORKDIR /app/ 10 | COPY requirements.txt /tmp/requirements.txt 11 | RUN pip install --pre -Ur /tmp/requirements.txt 12 | 13 | COPY python /app/ 14 | 15 | CMD ["python3", "-u", "aviary.py"] 16 | -------------------------------------------------------------------------------- /resources/tests/deploy/deploy-direct.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: apps/v1 2 | kind: Deployment 3 | metadata: 4 | name: aviary-tester 5 | labels: 6 | app: aviary-tester 7 | spec: 8 | selector: 9 | matchLabels: 10 | app: aviary-tester 11 | template: 12 | metadata: 13 | annotations: 14 | prometheus.io/scrape: "true" 15 | prometheus.io/port: "8000" 16 | labels: 17 | app: aviary-tester 18 | spec: 19 | containers: 20 | - name: aviary-tester 21 | image: sekoialab/aviary-tester:1.0 22 | terminationGracePeriodSeconds: 10 23 | -------------------------------------------------------------------------------- /resources/tests/deploy/deploy-fail.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: apps/v1 2 | kind: Deployment 3 | metadata: 4 | name: aviary-tester 5 | labels: 6 | app: aviary-tester 7 | spec: 8 | selector: 9 | matchLabels: 10 | app: aviary-tester 11 | template: 12 | metadata: 13 | annotations: 14 | prometheus.io/scrape: "true" 15 | prometheus.io/port: "8000" 16 | labels: 17 | app: aviary-tester 18 | spec: 19 | containers: 20 | - name: aviary-tester 21 | image: sekoialab/aviary-tester:latest 22 | args: ["python", "-u", "dummy.py", "fail"] 23 | -------------------------------------------------------------------------------- /resources/tests/deploy/deploy-fail-in-metrics.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: apps/v1 2 | kind: Deployment 3 | metadata: 4 | name: aviary-tester 5 | labels: 6 | app: aviary-tester 7 | spec: 8 | selector: 9 | matchLabels: 10 | app: aviary-tester 11 | template: 12 | metadata: 13 | annotations: 14 | prometheus.io/scrape: "true" 15 | prometheus.io/port: "8000" 16 | labels: 17 | app: aviary-tester 18 | spec: 19 | containers: 20 | - name: aviary-tester 21 | image: sekoialab/aviary-tester:latest 22 | args: ["python", "-u", "dummy.py", "fail-in-metrics"] 23 | -------------------------------------------------------------------------------- /resources/kubernetes/config.yaml: -------------------------------------------------------------------------------- 1 | kind: ConfigMap 2 | apiVersion: v1 3 | metadata: 4 | name: aviary 5 | data: 6 | 7 | canaries.yaml: | 8 | prometheus-base-url: http://myprometheus:9090/ 9 | namespace: default 10 | 11 | my-service-deployment: 12 | breakpoint: 50% 13 | step: 10% 14 | abort: 120s 15 | max_step_duration: 600s 16 | check_max_failures: 4 17 | check_success_step_duration: 120s 18 | start_delay: 60s 19 | success: 20 | - expr: rate(my_service_performance{kubernetes_pod_name="<>"}[1m]) > 500 21 | - expr: my_service_error_total{kubernetes_pod_name="<>"} == 0 22 | 23 | -------------------------------------------------------------------------------- /resources/tests/dummy.py: -------------------------------------------------------------------------------- 1 | from prometheus_client import start_http_server, Counter 2 | import time 3 | import sys 4 | 5 | arg = "work" # can be work, fail, fail-in-metrics 6 | if len(sys.argv) > 1: 7 | arg = sys.argv[1] 8 | 9 | print(arg) 10 | 11 | 12 | c = Counter("aviary_tester_failures", "Artificial number of failures") 13 | 14 | if __name__ == "__main__": 15 | # Start up the server to expose the metrics. 16 | start_http_server(8000) 17 | # Generate some requests. 18 | while True: 19 | time.sleep(1) 20 | if arg == "fail-in-metrics": 21 | c.inc() 22 | elif arg == "fail": 23 | print("Guess i'll die") 24 | sys.exit(3) 25 | -------------------------------------------------------------------------------- /resources/kubernetes/serviceaccount.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: v1 2 | kind: ServiceAccount 3 | metadata: 4 | name: aviary 5 | imagePullSecrets: 6 | - name: registry-credentials 7 | --- 8 | apiVersion: rbac.authorization.k8s.io/v1 9 | kind: Role 10 | metadata: 11 | name: aviary 12 | rules: 13 | - apiGroups: 14 | - "" 15 | - extensions 16 | - apps 17 | resources: 18 | - pods 19 | - deployments 20 | - deployments/scale 21 | verbs: 22 | - update 23 | - create 24 | - get 25 | - list 26 | - patch 27 | - watch 28 | --- 29 | apiVersion: rbac.authorization.k8s.io/v1 30 | kind: RoleBinding 31 | metadata: 32 | name: aviary 33 | subjects: 34 | - kind: ServiceAccount 35 | name: aviary 36 | roleRef: 37 | kind: Role 38 | name: aviary 39 | apiGroup: rbac.authorization.k8s.io 40 | -------------------------------------------------------------------------------- /python/prometheusclient.py: -------------------------------------------------------------------------------- 1 | import requests 2 | import time 3 | 4 | 5 | class PrometheusClient: 6 | def __init__(self, url): 7 | self.baseURL = url + "/api/v1" 8 | self.queryURL = self.baseURL + "/query" 9 | 10 | def getLastValue(self, query): 11 | r_time = requests.get(self.queryURL, params={"query": "time()"}) 12 | current_time = time.time() 13 | if r_time.status_code == 200: 14 | result = r_time.json()["data"]["result"] 15 | if len(result): 16 | current_time = result[0] 17 | 18 | r = requests.get(self.queryURL, params={"time": current_time, "query": query}) 19 | if r.status_code == 200: 20 | result = r.json()["data"]["result"] 21 | if len(result): 22 | return result[0]["value"][1] 23 | else: 24 | return None 25 | else: 26 | return False 27 | -------------------------------------------------------------------------------- /resources/kubernetes/deploy.yaml: -------------------------------------------------------------------------------- 1 | kind: Deployment 2 | apiVersion: apps/v1 3 | metadata: 4 | annotations: 5 | io.sekoia.microservice: aviary 6 | name: aviary 7 | labels: 8 | app: aviary 9 | type: intake 10 | service: aviary 11 | spec: 12 | revisionHistoryLimit: 4 13 | selector: 14 | matchLabels: 15 | app: aviary 16 | template: 17 | metadata: 18 | name: aviary 19 | labels: 20 | app: aviary 21 | service: aviary 22 | spec: 23 | serviceAccountName: aviary 24 | volumes: 25 | - name: config 26 | configMap: 27 | name: aviary 28 | items: 29 | - mode: 0555 30 | key: canaries.yaml 31 | path: canaries.yaml 32 | containers: 33 | - name: aviary 34 | image: sekoiaio/aviary:1.0 35 | envFrom: 36 | - configMapRef: 37 | name: aviary 38 | volumeMounts: 39 | - name: config 40 | mountPath: /app/config/ 41 | resources: 42 | limits: 43 | memory: "500Mi" 44 | cpu: "100m" 45 | requests: 46 | memory: "500Mi" 47 | cpu: "100m" 48 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | # 2 | # This file is autogenerated by pip-compile 3 | # To update, run: 4 | # 5 | # pip-compile --no-emit-trusted-host --no-index requirements.in 6 | # 7 | cachetools==4.1.0 # via google-auth 8 | certifi==2020.6.20 # via kubernetes, requests 9 | chardet==3.0.4 # via requests 10 | deepdiff==3.3.0 # via -r requirements.in 11 | google-auth==1.18.0 # via kubernetes 12 | idna==2.9 # via requests 13 | importlib-metadata==1.6.1 # via jsonpickle 14 | jsonpickle==1.4.1 # via deepdiff 15 | kubernetes==11.0.0 # via -r requirements.in 16 | oauthlib==3.1.0 # via requests-oauthlib 17 | pyasn1-modules==0.2.8 # via google-auth 18 | pyasn1==0.4.8 # via pyasn1-modules, rsa 19 | python-dateutil==2.8.1 # via kubernetes 20 | pyyaml==5.3.1 # via -r requirements.in, kubernetes 21 | requests-oauthlib==1.3.0 # via kubernetes 22 | requests==2.24.0 # via -r requirements.in, kubernetes, requests-oauthlib 23 | rsa==4.6 # via google-auth 24 | six==1.15.0 # via google-auth, kubernetes, python-dateutil, websocket-client 25 | urllib3==1.25.9 # via kubernetes, requests 26 | websocket-client==0.57.0 # via kubernetes 27 | zipp==3.1.0 # via importlib-metadata 28 | 29 | # The following packages are considered to be unsafe in a requirements file: 30 | # setuptools 31 | -------------------------------------------------------------------------------- /python/aviary.py: -------------------------------------------------------------------------------- 1 | # std 2 | import os 3 | import threading 4 | import yaml 5 | 6 | # sekoia 7 | from prometheusclient import PrometheusClient 8 | from birdwatcher import BirdWatcher 9 | from kubernetesinterface import KubernetesInterface 10 | from admin_server import AdminServer 11 | 12 | 13 | class Aviary: 14 | def __init__(self): 15 | self.canaries = [] 16 | self.threads = [] 17 | with open(os.path.join(os.path.dirname(os.path.realpath(__file__)), "config", "canaries.yaml")) as f: 18 | self.config = yaml.load(f.read(), Loader=yaml.SafeLoader) 19 | 20 | self.prom = PrometheusClient(self.config["prometheus-base-url"]) 21 | del self.config["prometheus-base-url"] 22 | 23 | self.kube = KubernetesInterface(namespace=self.config.get("namespace", "sic")) 24 | del self.config["namespace"] 25 | 26 | for canary in self.config.keys(): 27 | self.addCanary(canary, self.config[canary]) 28 | 29 | self.cli_server = AdminServer(8888, self.canaries) 30 | 31 | def addCanary(self, deployment, config): 32 | c = BirdWatcher(deployment, config, self.prom, self.kube) 33 | if c.initCanary(): 34 | self.canaries += [c] 35 | self.threads += [threading.Thread(target=c.watch)] 36 | self.threads[-1].start() 37 | return c 38 | return False 39 | 40 | def wait(self): 41 | for t in self.threads: 42 | t.join() 43 | 44 | 45 | a = Aviary() 46 | a.wait() 47 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Aviary 🦜 2 | 3 | This is a progressive canary rollout controller for Kubernetes. It was developed to make deployments safer at [SEKOIA.IO](https://sekoia.io/). 4 | 5 | ## 🔀 Logic 6 | 7 | ![flowchart of aviary](control-loop.png) 8 | 9 | ## 📖 Usage 10 | 11 | 1. Adapt the configuration to the services you want to deploy using Aviary, in `resources/kubernetes/config.yaml` 12 | 13 | ```yaml 14 | prometheus-base-url: http://myprometheus:9090/ 15 | namespace: default 16 | 17 | my-service-deployment: 18 | breakpoint: 50% 19 | step: 10% 20 | abort: 120s 21 | max_step_duration: 600s 22 | check_max_failures: 4 23 | check_success_step_duration: 120s 24 | start_delay: 60s 25 | success: 26 | - expr: rate(my_service_performance{kubernetes_pod_name="<>"}[1m]) > 500 27 | - expr: my_service_error_total{kubernetes_pod_name="<>"} == 0 28 | ``` 29 | 30 | The `<>` tags are dynamically replaced on runtime to watch the state of canary pods. 31 | 32 | 2. Deploy Aviary in your kubernetes cluster : 33 | 34 | ``` 35 | kubectl kustomize ./resources/kubernetes/ | kubectl apply -f - 36 | ``` 37 | 38 | 3. Enjoy 39 | 40 | On startup, the `-primary` and `-canary` deployments will be created from the base deployment. 41 | 42 | Container image changes will be deployed progressively following the flowchart shown above. 43 | 44 | ## 🧰 Operations 45 | 46 | For some reason, you might want to bypass a canary deployment or abort an ongoing one. Aviary features an admin console that can be accessed by using `kubectl exec` on `cli.sh` in the pod, or simply connecting to port 8888 of the pod with `netcat` and `kubectl port-forward`. 47 | 48 | The admin console is self documented and implements commands like `bypass` or `abort`. 49 | -------------------------------------------------------------------------------- /python/admin_server.py: -------------------------------------------------------------------------------- 1 | import socket 2 | import threading 3 | 4 | HELP_STRING = """ 5 | Commands : 6 | 7 | - ls : list services. '*' = bypassed, '~' = currently deploying 8 | - bypass X : next deployment of X will be direct 9 | - nobypass X : next deployment of X will be normal 10 | - abort X : abort running deployment 11 | """ 12 | 13 | 14 | class AdminServer: 15 | def __init__(self, port, canaries): 16 | self.port = port 17 | self.canaries = canaries 18 | self.server_thread = threading.Thread(target=self.server) 19 | self.server_thread.start() 20 | self.server_thread.join() 21 | print("AdminServer crashed") 22 | 23 | def server(self): 24 | with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s: 25 | s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) 26 | s.bind(("127.0.0.1", self.port)) 27 | s.listen(1) 28 | 29 | while True: 30 | self.conn, self.addr = s.accept() 31 | with self.conn: 32 | print("[AdminServer] Connection from", self.addr) 33 | self.reply(HELP_STRING, prompt=False) 34 | self.reply("List of services : ", prompt=False) 35 | self.send_list() 36 | while True: 37 | data = self.conn.recv(1024) 38 | if not data: 39 | print("[AdminServer] Disconnect :", self.addr) 40 | break 41 | self.handle(data) 42 | 43 | def reply(self, data="", prompt=True): 44 | msg = data + "\n" 45 | if prompt: 46 | msg += "_> " 47 | self.conn.sendall(msg.encode("utf-8")) 48 | 49 | def send_list(self): 50 | ls = "" 51 | for i in range(len(self.canaries)): 52 | c = self.canaries[i] 53 | notes = "" 54 | if c.bypass_next_deployment: 55 | notes += "*" 56 | if c.deploying: 57 | notes += "~" 58 | ls += f"[{i}] {notes}{c.baseDeploymentName}\n" 59 | self.reply(ls) 60 | 61 | def handle(self, data): 62 | data = data.strip().decode() 63 | chunks = data.split() 64 | if not len(chunks): 65 | self.reply() 66 | return 67 | if len(chunks) == 2: 68 | try: 69 | canary_i = int(chunks[-1]) 70 | canary = self.canaries[canary_i] 71 | canary_name = canary.baseDeploymentName 72 | except Exception: 73 | self.reply("Invalid command.") 74 | return 75 | 76 | if data == "ls": 77 | return self.send_list() 78 | if chunks[0] == "bypass": 79 | canary.bypass_next_deployment = True 80 | return self.reply( 81 | f"Next deployment of {canary_name} will be done directly.\nCancel with 'nobypass {canary_i}'" 82 | ) 83 | if chunks[0] == "nobypass": 84 | canary.bypass_next_deployment = False 85 | return self.send_list() 86 | if chunks[0] == "abort": 87 | canary.abort = True 88 | return self.reply(f"Aborting deployment of {canary_name} ...") 89 | self.reply("Invalid command") 90 | -------------------------------------------------------------------------------- /python/kubernetesinterface.py: -------------------------------------------------------------------------------- 1 | # deps 2 | from kubernetes import client, config 3 | from kubernetes.client.rest import ApiException 4 | from kubernetes.config.config_exception import ConfigException 5 | 6 | # std 7 | import time 8 | 9 | 10 | class KubernetesInterface: 11 | def __init__(self, namespace="default"): 12 | # try to use in-cluster config, otherwise tries minikube for local dev 13 | try: 14 | config.load_incluster_config() 15 | except ConfigException: 16 | config.load_kube_config(context="minikube") 17 | self.namespace = namespace 18 | 19 | def getDeploy(self, deployment_name: str): 20 | return client.AppsV1Api().read_namespaced_deployment(namespace=self.namespace, name=deployment_name) 21 | 22 | def getReplicas(self, deployment_name: str): 23 | return ( 24 | client.AppsV1Api().read_namespaced_deployment(namespace=self.namespace, name=deployment_name).spec.replicas 25 | ) 26 | 27 | def isDeployExists(self, deployment_name: str): 28 | exist = False 29 | try: 30 | client.AppsV1Api().read_namespaced_deployment(namespace=self.namespace, name=deployment_name) 31 | exist = True 32 | except ApiException: 33 | exist = False 34 | return exist 35 | 36 | def scaleDeploy(self, deployment_name: str, replicas: int): 37 | tmp = {"spec": {"replicas": replicas}} 38 | return client.AppsV1Api().patch_namespaced_deployment(namespace=self.namespace, name=deployment_name, body=tmp) 39 | 40 | def restarted(self, deployment_name: str): 41 | # compute selector matching deployment 42 | selector = self._getSelector(deployment_name) 43 | 44 | # counting restart in init_containers and containers 45 | restart = 0 46 | for pod in client.CoreV1Api().list_namespaced_pod(namespace=self.namespace, label_selector=selector).items: 47 | if not pod.metadata.name.startswith(deployment_name): 48 | continue 49 | for c in pod.status.container_statuses: 50 | restart += c.restart_count 51 | if pod.status.init_container_statuses: 52 | for c in pod.status.init_container_statuses: 53 | restart += c.restart_count 54 | return restart > 0 55 | 56 | def waitDeploymentReady(self, deployment_name: str, maxWait=60): 57 | # this function extract the status from the list of pods, and then compare 58 | # count the pods not in the “Running” state. 59 | def fun(pods): 60 | return len(list(filter(lambda phase: phase != "Running", map(lambda pod: pod.status.phase, pods),))) 61 | 62 | # wait for scale to be active 63 | print(f"waiting for pod to be created of deployment {deployment_name}") 64 | while len(self.getPodsList(deployment_name)) == 0: 65 | time.sleep(1) 66 | 67 | print(f"Waiting for pods of deployment {deployment_name} to run for {maxWait}s") 68 | i = 0 69 | while self._iterOnPods(fun, deployment_name) > 0: 70 | time.sleep(1) 71 | i += 1 72 | if i > maxWait: 73 | print("[KubernetesInterface] Gave up on waiting on {} after {}".format(deployment_name, maxWait)) 74 | return False 75 | return True if i == 0 else i 76 | 77 | def deploy(self, deploy): 78 | res = {} 79 | try: 80 | if self.isDeployExists(deploy.metadata.name): 81 | prev = client.AppsV1Api().read_namespaced_deployment( 82 | namespace=self.namespace, name=deploy.metadata.name 83 | ) 84 | deploy.metadata.generation = prev.metadata.generation + 1 85 | res = client.AppsV1Api().replace_namespaced_deployment( 86 | namespace=self.namespace, name=deploy.metadata.name, body=deploy, 87 | ) 88 | else: 89 | print(f"Deployment {deploy.metadata.name} doesn't exist: creating it.") 90 | res = client.AppsV1Api().create_namespaced_deployment(namespace=self.namespace, body=deploy) 91 | except ApiException as e: 92 | print(f"exception when trying to create or update {deploy.metadata.name}: {e}") 93 | return res 94 | 95 | def getPodsList(self, deployment_name: str): 96 | def fun(pods): 97 | return list(filter(lambda name: deployment_name in name, map(lambda pod: pod.metadata.name, pods),)) 98 | 99 | return self._iterOnPods(fun, deployment_name) 100 | 101 | def _iterOnPods(self, fun, deployment_name: str): 102 | selector = self._getSelector(deployment_name) 103 | pods = client.CoreV1Api().list_namespaced_pod(namespace=self.namespace, label_selector=selector).items 104 | return fun(pods) 105 | 106 | def _getSelector(self, deployment_name: str): 107 | deployment = client.AppsV1Api().read_namespaced_deployment(namespace=self.namespace, name=deployment_name,) 108 | selector = "" 109 | for key in deployment.spec.selector.match_labels: 110 | selector += key + "=" + deployment.spec.selector.match_labels[key] + "," 111 | return selector[:-1] 112 | -------------------------------------------------------------------------------- /resources/tests/run.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | TEST_WORK=true 4 | TEST_FAIL=true 5 | TEST_FAIL_IN_METRICS=true 6 | TEST_DIRECT=true 7 | TEST_SCALE=true 8 | 9 | 10 | green=$(tput setaf 2) 11 | default=$(tput sgr0) 12 | 13 | #copy testing configuration to right location 14 | mkdir python/config 15 | cp resources/tests/canaries.yaml python/config/canaries.yaml 16 | 17 | #cleanup previous testing material 18 | kubectl --namespace sic --context test-sekoia-io delete deployment aviary-tester aviary-tester-primary aviary-tester-canary 19 | sleep 2 20 | kubectl --namespace sic --context test-sekoia-io apply -f resources/tests/deploy/deploy-original.yaml 21 | sleep 2 22 | 23 | #setup logging 24 | now=`date +"%Y-%m-%d-%s"` 25 | python -u python/aviary.py | tee "aviary-${now}.log" | sed "s/.*/$green&$default/" & 26 | 27 | #wait for all 3 deployments to exist 28 | next=`kubectl --namespace sic --context test-sekoia-io get deploy | grep aviary-tester | wc -l` 29 | while [[ $next != "3" ]] 30 | do 31 | sleep 1 32 | next=`kubectl --namespace sic --context test-sekoia-io get deploy | grep aviary-tester | wc -l` 33 | done 34 | sleep 1 35 | kubectl --namespace sic --context test-sekoia-io get deploy | grep aviary-tester 36 | 37 | #wait for the 5 primary pods to be ready, and the only ones running 38 | next=`kubectl --namespace sic --context test-sekoia-io get pods | grep aviary-tester-primary | wc -l` 39 | while [[ $next != "5" ]] 40 | do 41 | sleep 1 42 | next=`kubectl --namespace sic --context test-sekoia-io get pods | grep aviary-tester-primary | wc -l` 43 | done 44 | 45 | #setup is done, any test can be run from here 46 | echo "SETUP DONE" 47 | sleep 1 48 | 49 | 50 | #tests the nominal case, a perfectly working canary release, triggered by an image change 51 | if $TEST_WORK; then 52 | 53 | kubectl --namespace sic --context test-sekoia-io get deploy | grep aviary-tester 54 | echo 55 | echo ">>> DEPLOYING NEW, WORKING VERSION" 56 | echo 57 | kubectl --namespace sic --context test-sekoia-io apply -f resources/tests/deploy/deploy-work.yaml 58 | 59 | 60 | #wait until the primary deployment gets the last image, last step of a successful deployment 61 | next=`kubectl --namespace sic --context test-sekoia-io get deploy aviary-tester-primary -o yaml | grep aviary-tester:latest` 62 | while [[ -z $next ]] 63 | do 64 | sleep 1 65 | next=`kubectl --namespace sic --context test-sekoia-io get deploy aviary-tester-primary -o yaml | grep aviary-tester:latest` 66 | kubectl --namespace sic --context test-sekoia-io get deploy aviary-tester-primary -o yaml | grep aviary-tester:latest 67 | done 68 | 69 | #check final replica count 70 | next=`kubectl --namespace sic --context test-sekoia-io get pods | grep aviary-tester-primary | wc -l` 71 | while [[ $next != "5" ]] 72 | do 73 | sleep 1 74 | next=`kubectl --namespace sic --context test-sekoia-io get pods | grep aviary-tester-primary | wc -l` 75 | done 76 | echo 77 | echo ">>> CANARY-WORK TEST CASE SUCCEEDED" 78 | echo 79 | kubectl --namespace sic --context test-sekoia-io get deploy | grep aviary-tester 80 | kubectl --namespace sic --context test-sekoia-io get deploy aviary-tester-primary -o yaml | grep aviary-tester:latest 81 | 82 | fi 83 | 84 | #tests the rolling back of a deployment if some of the new pods restarts 85 | if $TEST_FAIL; then 86 | 87 | echo 88 | echo ">>> DEPLOYING NEW, HARD FAILING VERSION (restarts)" 89 | echo 90 | kubectl --namespace sic --context test-sekoia-io apply -f resources/tests/deploy/deploy-fail.yaml 91 | 92 | #wait for primary to be rolled back to non-failing 93 | next=`kubectl --namespace sic --context test-sekoia-io get deploy aviary-tester -o yaml | grep " fail"` 94 | until [[ -z $next ]] 95 | do 96 | sleep 1 97 | next=`kubectl --namespace sic --context test-sekoia-io get deploy aviary-tester -o yaml | grep " fail"` 98 | done 99 | 100 | echo "OG deploy rolledback" 101 | 102 | #check final replica count 103 | next=`kubectl --namespace sic --context test-sekoia-io get pods | grep aviary-tester-primary | wc -l` 104 | while [[ $next != "5" ]] 105 | do 106 | sleep 1 107 | next=`kubectl --namespace sic --context test-sekoia-io get pods | grep aviary-tester-primary | wc -l` 108 | done 109 | echo 110 | echo ">>> CANARY-FAIL TEST CASE SUCCEEDED" 111 | echo 112 | kubectl --namespace sic --context test-sekoia-io get deploy | grep aviary-tester 113 | kubectl --namespace sic --context test-sekoia-io get deploy aviary-tester-primary -o yaml | grep aviary-tester:latest 114 | 115 | fi 116 | 117 | sleep 1 118 | 119 | #tests the rolling back of a deployment if some of the new pods report metrics in error 120 | if $TEST_FAIL_IN_METRICS; then 121 | echo 122 | echo ">>> DEPLOYING NEW, FAILING IN METRICS VERSION" 123 | echo 124 | kubectl --namespace sic --context test-sekoia-io apply -f resources/tests/deploy/deploy-fail-in-metrics.yaml 125 | 126 | #wait for primary to be rolled back to non-failing 127 | next=`kubectl --namespace sic --context test-sekoia-io get deploy aviary-tester -o yaml | grep " fail-in-metrics"` 128 | until [[ -z $next ]] 129 | do 130 | sleep 1 131 | next=`kubectl --namespace sic --context test-sekoia-io get deploy aviary-tester -o yaml | grep " fail-in-metrics"` 132 | done 133 | 134 | #check final replica count 135 | next=`kubectl --namespace sic --context test-sekoia-io get pods | grep aviary-tester-primary | wc -l` 136 | while [[ $next != "5" ]] 137 | do 138 | sleep 1 139 | next=`kubectl --namespace sic --context test-sekoia-io get pods | grep aviary-tester-primary | wc -l` 140 | done 141 | echo 142 | echo ">>> CANARY-FAIL-IN-METRICS TEST CASE SUCCEEDED" 143 | echo 144 | kubectl --namespace sic --context test-sekoia-io get deploy | grep aviary-tester 145 | kubectl --namespace sic --context test-sekoia-io get deploy aviary-tester-primary -o yaml | grep aviary-tester:latest 146 | 147 | fi 148 | 149 | sleep 1 150 | 151 | if $TEST_DIRECT; then 152 | echo 153 | echo ">>> DEPLOYING NEW, WORKING DEPLOYMENT WITH NEW UNWATCHED FIELD (direct deployment)" 154 | echo 155 | kill %1 156 | kubectl --namespace sic --context test-sekoia-io apply -f resources/tests/deploy/deploy-original.yaml 157 | python -u python/aviary.py | tee -a "aviary-${now}.log" | sed "s/.*/$green&$default/" & 158 | #wait for all 3 deployments to exist 159 | next=`kubectl --namespace sic --context test-sekoia-io get deploy | grep aviary-tester | wc -l` 160 | while [[ $next != "3" ]] 161 | do 162 | sleep 1 163 | next=`kubectl --namespace sic --context test-sekoia-io get deploy | grep aviary-tester | wc -l` 164 | done 165 | sleep 1 166 | kubectl --namespace sic --context test-sekoia-io get deploy | grep aviary-tester 167 | 168 | #wait for the 5 primary pods to be ready, and the only ones running 169 | next=`kubectl --namespace sic --context test-sekoia-io get pods | grep aviary-tester | wc -l` 170 | while [[ $next != "5" ]] 171 | do 172 | sleep 1 173 | next=`kubectl --namespace sic --context test-sekoia-io get pods | grep aviary-tester | wc -l` 174 | done 175 | echo "SETUP DONE" 176 | 177 | sleep 1 178 | 179 | kubectl --namespace sic --context test-sekoia-io apply -f resources/tests/deploy/deploy-direct.yaml 180 | 181 | #check final replica count 182 | next=`kubectl --namespace sic --context test-sekoia-io get pods | grep aviary-tester-primary | wc -l` 183 | while [[ $next != "5" ]] 184 | do 185 | sleep 1 186 | next=`kubectl --namespace sic --context test-sekoia-io get pods | grep aviary-tester-primary | wc -l` 187 | done 188 | 189 | #wait for primary to get the new label 190 | next=`kubectl --namespace sic --context test-sekoia-io get deploy aviary-tester-primary -o yaml | grep "terminationGracePeriod"` 191 | while [[ -z $next ]] 192 | do 193 | sleep 1 194 | next=`kubectl --namespace sic --context test-sekoia-io get deploy aviary-tester-primary -o yaml | grep "terminationGracePeriod"` 195 | done 196 | 197 | #check final replica count 198 | next=`kubectl --namespace sic --context test-sekoia-io get pods | grep aviary-tester | wc -l` 199 | while [[ $next != "5" ]] 200 | do 201 | sleep 1 202 | next=`kubectl --namespace sic --context test-sekoia-io get pods | grep aviary-tester | wc -l` 203 | done 204 | 205 | echo 206 | echo ">>> CANARY-DIRECT-DEPLOY TEST CASE SUCCEEDED" 207 | echo 208 | kubectl --namespace sic --context test-sekoia-io get deploy | grep aviary-tester 209 | kubectl --namespace sic --context test-sekoia-io get deploy aviary-tester-primary -o yaml | grep aviary-tester:latest 210 | 211 | fi 212 | 213 | if $TEST_SCALE; then 214 | echo 215 | echo ">>> SCALING ORIGINAL DEPLOYMENT TO 9 INSTANCES" 216 | echo 217 | kubectl --namespace sic --context test-sekoia-io scale deploy aviary-tester --replicas=9 218 | 219 | #wait for the 9 primary pods to be ready, and the only ones running 220 | next=`kubectl --namespace sic --context test-sekoia-io get pods | grep aviary-tester-primary | wc -l` 221 | while [[ $next != "9" ]] 222 | do 223 | sleep 1 224 | next=`kubectl --namespace sic --context test-sekoia-io get pods | grep aviary-tester-primary | wc -l` 225 | done 226 | 227 | echo 228 | echo ">>> CANARY-SCALE TEST CASE SUCCEEDED" 229 | echo 230 | kubectl --namespace sic --context test-sekoia-io get deploy | grep aviary-tester 231 | 232 | sleep 1 233 | fi 234 | 235 | echo "DONE" 236 | 237 | kill %1 238 | 239 | echo "CLEANING UP" 240 | kubectl --namespace sic --context test-sekoia-io delete deployment aviary-tester aviary-tester-primary aviary-tester-canary 241 | 242 | -------------------------------------------------------------------------------- /python/birdwatcher.py: -------------------------------------------------------------------------------- 1 | # deps 2 | from deepdiff import DeepDiff 3 | 4 | # std 5 | import math 6 | import time 7 | import copy 8 | import fnmatch 9 | import re 10 | import uuid 11 | import datetime 12 | 13 | 14 | class BirdWatcher: 15 | def __init__(self, deployment, config, prom, kube): 16 | self.baseDeploymentName = deployment # original deployment name 17 | self.primaryName = deployment + "-primary" # primary deployment name 18 | self.canaryName = deployment + "-canary" # canary deployment name 19 | self.replicas = 0 # replicas on original deployment 20 | self.originalBaseDeployment = {} # used to watch changes to original deployment 21 | self.prom = prom # instance of PrometheusClient 22 | self.kube = kube 23 | 24 | # admin console flags 25 | self.bypass_next_deployment = False 26 | self.abort = False 27 | self.deploying = False 28 | 29 | self.config = self._convertConfig(config) # config from canaries.yaml 30 | 31 | def _convertConfig(self, config): 32 | config["breakpoint"] = int(config["breakpoint"][:-1]) / 100 33 | config["step"] = int(config["step"][:-1]) / 100 34 | config["max_step_duration"] = ( 35 | int(config["max_step_duration"][:-1]) * {"s": 1, "m": 60, "h": 3600}[config["max_step_duration"][-1]] 36 | ) 37 | config["abort"] = int(config["abort"][:-1]) * {"s": 1, "m": 60, "h": 3600}[config["abort"][-1]] 38 | config["check_success_step_duration"] = ( 39 | int(config["check_success_step_duration"][:-1]) 40 | * {"s": 1, "m": 60, "h": 3600}[config["check_success_step_duration"][-1]] 41 | ) 42 | config["check_max_failures"] = config.get("check_max_failures", 1) 43 | 44 | if config.get("start_delay"): 45 | config["start_delay"] = ( 46 | int(config["start_delay"][:-1]) * {"s": 1, "m": 60, "h": 3600}[config["start_delay"][-1]] 47 | ) 48 | else: 49 | config["start_delay"] = 0 50 | 51 | # check unbounded value that could lead to ever success of deployment 52 | m = config["check_max_failures"] * config["check_success_step_duration"] 53 | if config["max_step_duration"] < m: 54 | self.warn( 55 | f"'max_step_duration'({config['max_step_duration']}s) is less than " 56 | f"'check_max_failures({config['check_max_failures']}) * " 57 | f"check_success_step_duration({config['check_success_step_duration']}s)' and it shouldn't. " 58 | f"Adjusting it to {m+1}s", 59 | ) 60 | config["max_step_duration"] = m + 1 61 | return config 62 | 63 | def log(self, *args): 64 | print(f"[{self.baseDeploymentName}]: ", *args) 65 | 66 | def warn(self, *args): 67 | print(f"[WARN {self.baseDeploymentName}]: ", *args) 68 | 69 | def initCanary(self): 70 | # To perform a canary deployment, we need : 71 | # - The original deployment scaled to 0 72 | # - A copy of the original deployment, the primary 73 | # - A copy of the new deployment, the canary 74 | # This checks if this is already set up, and applies it otherwise 75 | if not self.kube.isDeployExists(self.baseDeploymentName): 76 | self.log("Couldn't find deployment") 77 | return False 78 | deployment = self.kube.getDeploy(self.baseDeploymentName) 79 | # check if deployment is already ready for the canary setup 80 | if ( 81 | deployment.spec.replicas == 0 82 | and self.kube.isDeployExists(self.primaryName) 83 | and self.kube.isDeployExists(self.canaryName) 84 | ): 85 | return self._checkCanaryInit() 86 | 87 | self.replicas = deployment.spec.replicas 88 | 89 | self.log("Creating mirror and canary deployments ...") 90 | canary = copy.deepcopy(deployment) 91 | primary = copy.deepcopy(deployment) 92 | primary.metadata.name = self.primaryName 93 | self.kube.deploy(self.cleanupDeploy(primary)) 94 | 95 | canary.metadata.name = self.canaryName 96 | canary.spec.replicas = 0 97 | self.kube.deploy(self.cleanupDeploy(canary)) 98 | # scale base deploy to 0 99 | self.kube.scaleDeploy(self.baseDeploymentName, 0) 100 | self.log( 101 | "All primaries ready after {}s, scaling OG to 0".format(self.kube.waitDeploymentReady(self.primaryName)) 102 | ) 103 | return True 104 | 105 | def _checkCanaryInit(self): 106 | # We are in init phase, check if leftover canary has been running 107 | # if it's the case scale primary to canary + primary (risk of having 108 | # nominal +1 instances). rollback primary to base deploy (if canary 109 | # exist, may be because failure happened during rollout). 110 | self.log("Canary setup looks initalized already") 111 | if self.kube.getReplicas(self.canaryName) != 0: 112 | self.log("Found leftovers of canary rollout, rolling back to original primary only") 113 | self.kube.scaleDeploy( 114 | self.primaryName, self.kube.getReplicas(self.canaryName) + self.kube.getReplicas(self.primaryName), 115 | ) 116 | self.rollbackBaseDeployment() 117 | self.kube.scaleDeploy(self.canaryName, 0) 118 | self.log("done in {}s".format(self.kube.waitDeploymentReady(self.primaryName))) 119 | # get the goal of wanted replicas from primary deployment 120 | deployment = self.kube.getDeploy(self.primaryName) 121 | self.replicas = deployment.spec.replicas 122 | return True 123 | 124 | def watch(self): 125 | # This checks changes on the original deployment every 2 seconds, 126 | # and triggers direct or canary deployment following the output of shouldDeploy 127 | self.log("Watching changes on OG deployment ...") 128 | self.originalBaseDeployment = self.kube.getDeploy(self.baseDeploymentName) 129 | 130 | while 1: 131 | """deployment = self.api.list_namespaced_deployment( 132 | namespace="sic", field_selector="metadata.name={}".format(service) 133 | ).items[0]""" 134 | baseDeployment = self.kube.getDeploy(self.baseDeploymentName) 135 | 136 | if baseDeployment.spec != self.originalBaseDeployment.spec: 137 | decision = self.shouldDeploy(self.originalBaseDeployment, baseDeployment) 138 | if decision == "canary": 139 | self.deployCanary(baseDeployment) 140 | elif decision == "direct": 141 | self.log("Deploying directly") 142 | self.deployDirect(baseDeployment) 143 | elif decision == "scale": 144 | self.log("Scaling primary to {} instances".format(baseDeployment.spec.replicas)) 145 | self.kube.scaleDeploy(self.baseDeploymentName, 0) 146 | self.kube.scaleDeploy(self.primaryName, baseDeployment.spec.replicas) 147 | self.replicas = baseDeployment.spec.replicas 148 | else: 149 | self.log("ignoring") 150 | self.originalBaseDeployment = self.kube.getDeploy(self.baseDeploymentName) 151 | else: 152 | time.sleep(1) 153 | time.sleep(2) 154 | self.deploying = False 155 | 156 | def shouldDeploy(self, baseDeployment, newDeployment): 157 | # This tries to decide if an observed change to the original deployment should be deployed directly 158 | # or using a progressive rollout (canary) 159 | # No change to the original deployment should be ignored, 160 | # but some path are just k8s versioning and should not be taken into account (ignorePath) 161 | if self.bypass_next_deployment: 162 | self.bypass_next_deployment = False 163 | self.log("Canary deployment bypassed as configured by admin console") 164 | return "direct" 165 | 166 | canaryPath = [ 167 | "root._spec._template._spec._containers*", 168 | "root._spec._template._spec._init_containers*", 169 | ] # support glob matching 170 | ignorePath = [ 171 | "root._metadata._resource_version", 172 | "root._metadata._generation", 173 | "root._metadata._annotations._deployment.*", 174 | "root._status*", 175 | ] 176 | scalePath = "root._spec._replicas" 177 | 178 | contains_scale = False # if scaling the base deployment, report scale on primary and scale down base. 179 | skip = True # a flag set to False whenever a meaningful change is detected 180 | canaryPathRE = [re.compile(fnmatch.translate(cp).replace("[", "\\[").replace("]", "\\]")) for cp in canaryPath] 181 | 182 | ignorePathRE = [re.compile(fnmatch.translate(cp).replace("[", "\\[").replace("]", "\\]")) for cp in ignorePath] 183 | 184 | diff = DeepDiff(baseDeployment, newDeployment) 185 | values_changed = diff["values_changed"] 186 | 187 | if diff.get("type_changes"): 188 | values_changed.update(diff["type_changes"]) 189 | 190 | for key, changes in values_changed.items(): 191 | # decide if observed change should be ignored 192 | ignore = False 193 | for ipathRE in ignorePathRE: 194 | if ipathRE.match(key): 195 | ignore = True 196 | if ignore: 197 | continue 198 | self.log( 199 | "Saw changes to", key, "({} -> {})".format(changes["old_value"], changes["new_value"]), 200 | ) 201 | 202 | if key == scalePath and changes["new_value"] != 0: # og deployment was scaled manually 203 | contains_scale = True 204 | elif key == scalePath and changes["new_value"] == 0: # og deployment was rescaled to 0 by aviary, skip 205 | contains_scale = False 206 | else: 207 | skip = False 208 | 209 | for pathRE in canaryPathRE: 210 | if pathRE.match(key): 211 | return "canary" 212 | if contains_scale and skip: # skip will always be true if kubectl scale was called on the original deployment 213 | return "scale" 214 | return "direct" if not skip else "" 215 | 216 | def prepareDeploy(self, deployment): 217 | deployment.metadata.annotations["aviary-id"] = str(uuid.uuid4()) 218 | return deployment 219 | 220 | def cleanupDeploy(self, deployment): 221 | deployment = copy.deepcopy(deployment) 222 | deployment.metadata.uid = None 223 | deployment.metadata.self_link = None 224 | deployment.metadata.generation = 0 225 | deployment.metadata.creation_timestamp = None 226 | deployment.metadata.resource_version = None 227 | deployment = self.prepareDeploy(deployment) 228 | return deployment 229 | 230 | def deployDirect(self, baseDeployment): 231 | # handle a direct deployment to the primary deployment, without canary 232 | # get primary deployment and put the base.spec into primary.spec 233 | primary = self.kube.getDeploy(self.primaryName) 234 | primary.spec = baseDeployment.spec 235 | 236 | # scale base deploy to 0 (apply stack raise the scale) 237 | self.kube.scaleDeploy(self.baseDeploymentName, 0) 238 | 239 | # set primary replicas number to expected value 240 | primary.spec.replicas = self.replicas 241 | self.kube.deploy(self.prepareDeploy(primary)) 242 | 243 | def deployCanary(self, baseDeployment): 244 | self.deploying = True 245 | # handle a canary deployment 246 | # canaries are scaled up progressively, following the "step" parameter in the configuration 247 | # final promotion of the canary deployment is performed if the "breakpoint" volume of instance is reached 248 | # and if every metric listed under "success" returns something 249 | baseDeployment = copy.deepcopy(baseDeployment) 250 | self.kube.scaleDeploy(self.baseDeploymentName, 0) 251 | self.log("Rolling out canary deployment") 252 | 253 | # get canary object and update spec to latest base deployment 254 | canary = self.kube.getDeploy(self.canaryName) 255 | canary.spec = baseDeployment.spec 256 | self.kube.deploy(self.prepareDeploy(canary)) 257 | 258 | maxInstances = math.ceil(self.replicas * self.config["breakpoint"]) 259 | stepInstances = math.ceil(self.replicas * self.config["step"]) 260 | canaryInstances = stepInstances 261 | failed = False 262 | ts_start = time.time() 263 | self.log(f"Breakpoint set at {maxInstances} instances, going by increments of {stepInstances}") 264 | expected_deploy_time = math.ceil(maxInstances / stepInstances) * ( 265 | self.config["start_delay"] + self.config["max_step_duration"] 266 | ) 267 | expected_deploy_time = str(datetime.timedelta(seconds=expected_deploy_time)) 268 | 269 | self.log(f"Expected deployment time is around {expected_deploy_time}s") 270 | 271 | while canaryInstances <= maxInstances and not failed and not self.abort: 272 | self.log(f"Deploying {stepInstances} instance ... ({canaryInstances}/{self.replicas-canaryInstances})") 273 | self.kube.scaleDeploy(self.canaryName, canaryInstances) 274 | if not self.kube.waitDeploymentReady(self.canaryName, self.config["abort"]): 275 | failed = True 276 | break 277 | self.kube.scaleDeploy(self.primaryName, self.replicas - canaryInstances) 278 | self.kube.waitDeploymentReady(self.primaryName) 279 | self.log("done") 280 | canaryInstances += stepInstances 281 | 282 | time.sleep(self.config["start_delay"]) 283 | 284 | ts_start = time.time() 285 | failures = 0 286 | while time.time() - ts_start < self.config["max_step_duration"]: 287 | if self.abort: 288 | break 289 | if not self.checkCanarySuccess(): 290 | failures += 1 291 | if failures >= self.config["check_max_failures"]: 292 | failed = True 293 | break 294 | time.sleep(self.config["check_success_step_duration"]) 295 | 296 | if self.abort: 297 | self.log(f"Canary deployment was aborted via admin console") 298 | self.abort = False 299 | self.rollbackCanary() 300 | return 301 | 302 | if failed: 303 | self.log(f"Canary deployment failed after {round(time.time() - ts_start)}s, aborting deploy") 304 | self.rollbackCanary() 305 | return 306 | 307 | self.log("Reached breakpoint, canaries were successful. Deploying new primaries ...") 308 | baseDeployment.metadata.name = self.primaryName 309 | self.deployDirect(baseDeployment) 310 | self.kube.scaleDeploy(self.canaryName, 0) 311 | self.kube.waitDeploymentReady(self.primaryName) 312 | self.originalBaseDeployment = self.kube.getDeploy(self.baseDeploymentName) 313 | self.log("done. Safe to exit.") 314 | 315 | def checkCanarySuccess(self): 316 | # checks if canaries instances are successful 317 | # successful means no restarts, and values returned from all PromQL expressions under "success" 318 | if self.kube.restarted(self.canaryName): 319 | self.log("Saw restarts on canary instances") 320 | return False 321 | canaryPods = self.kube.getPodsList(self.canaryName) 322 | for pod in canaryPods: 323 | for expr in self.config["success"]: 324 | queryWithPodName = expr["expr"].replace("<>", pod) 325 | value = self.prom.getLastValue(queryWithPodName) 326 | if value is None: 327 | self.log(queryWithPodName, ":", value) 328 | return False 329 | return True 330 | 331 | def rollbackCanary(self): 332 | # scale primary deploy to base number of replicas and scale down canary 333 | self.kube.scaleDeploy(self.primaryName, self.replicas) 334 | self.kube.scaleDeploy(self.canaryName, 0) 335 | self.kube.waitDeploymentReady(self.primaryName) 336 | self.rollbackBaseDeployment() 337 | self.log("rollback done. Safe to exit.") 338 | 339 | def rollbackBaseDeployment(self): 340 | self.log("Rolling back base deployment from primary deployment") 341 | base = self.kube.getDeploy(self.baseDeploymentName) 342 | primary = self.kube.getDeploy(self.primaryName) 343 | base.spec = primary.spec 344 | base.spec.replicas = 0 345 | # retrieve current primary replicas and rollback modifications to base deployment 346 | # this will allow to reapply modifications later 347 | self.kube.deploy(base) 348 | self.originalBaseDeployment = self.kube.getDeploy(self.baseDeploymentName) 349 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------