paasta-tools 1.21.3__py3-none-any.whl

paasta_tools/cli/schemas/rollback_schema.json

@@ -0,0 +1,160 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "description": "autorollback config schema",
+    "type": "object",
+    "additionalProperties": false,
+    "$defs": {
+        "PrometheusCondition": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "query": {
+                    "type": "string",
+                    "description": "A PromQL query - should return a single datapoint."
+                },
+                "dry_run": {
+                    "type": "boolean",
+                    "description": "False if this condition should be used to rollback, True if violations should just be logged",
+                    "default": false
+                },
+                "upper_bound": {
+                    "type": [
+                        "number",
+                        "null"
+                    ],
+                    "description": "If the value returned by the query is > this value, the condition is considered to be failing (ignored if null)"
+                },
+                "lower_bound": {
+                    "type": [
+                        "number",
+                        "null"
+                    ],
+                    "description": "If the value returned by the query is < this value, the condition is considered to be failing (ignored if null)"
+                }
+            },
+            "required": [
+                "query"
+            ]
+        },
+        "SignalfxCondition": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "query": {
+                    "type": "string",
+                    "description": "A Signalflow query - should return a single datapoint."
+                },
+                "dry_run": {
+                    "type": "boolean",
+                    "description": "False if this condition should be used to rollback, True if violations should just be logged",
+                    "default": false
+                },
+                "upper_bound": {
+                    "type": [
+                        "number",
+                        "null"
+                    ],
+                    "description": "If the value returned by the query is > this value, the condition is considered to be failing (ignored if null)"
+                },
+                "lower_bound": {
+                    "type": [
+                        "number",
+                        "null"
+                    ],
+                    "description": "If the value returned by the query is < this value, the condition is considered to be failing (ignored if null)"
+                }
+            },
+            "required": [
+                "query"
+            ]
+        },
+        "SplunkCondition": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "query": {
+                    "type": "string",
+                    "description": "A Splunk query - expected to return a single datapoint or multiple results."
+                },
+                "query_type": {
+                    "type": "string",
+                    "description": "If `number`, the value from the datapoint returned by `query` will be compared against upper/lower bounds - otherwise, the number of results will.",
+                    "enum": [
+                        "number",
+                        "results"
+                    ],
+                    "default": "number"
+                },
+                "dry_run": {
+                    "type": "boolean",
+                    "description": "False if this condition should be used to rollback, True if violations should just be logged",
+                    "default": false
+                },
+                "upper_bound": {
+                    "type": [
+                        "number",
+                        "null"
+                    ],
+                    "description": "If the value (or number of results) returned by the query is > this value, the condition is considered to be failing (ignored if null)"
+                },
+                "lower_bound": {
+                    "type": [
+                        "number",
+                        "null"
+                    ],
+                    "description": "If the value (or number of results) returned by the query is < this value, the condition is considered to be failing (ignored if null)"
+                }
+            },
+            "required": [
+                "query"
+            ]
+        }
+    },
+    "properties": {
+        "conditions": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "signalfx": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/SignalfxCondition"
+                    },
+                    "description": "All the SignalFx queries used to detemine whether a rollback should happen during a service deployment"
+                },
+                "prometheus": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/PrometheusCondition"
+                    },
+                    "description": "All the Prometheus queries used to detemine whether a rollback should happen during a service deployment"
+                },
+                "splunk": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/SplunkCondition"
+                    },
+                    "description": "All the Splunk queries used to detemine whether a rollback should happen during a service deployment"
+                }
+            }
+        },
+        "enable_slo_rollback": {
+            "type": "boolean",
+            "default": true,
+            "description": "Whether or not to use the legacy SLO-based autorollback system."
+        },
+        "allowed_failing_queries": {
+            "type": "integer",
+            "default": 0,
+            "description": "How many queries are allowed to be failing before a rollback is initiated."
+        },
+        "rollback_window_s": {
+            "type": "integer",
+            "description": "How long to run queries for (in seconds)"
+        },
+        "check_interval_s": {
+            "type": "integer",
+            "description": "How often to run each query (in seconds)"
+        }
+    }
+}

paasta_tools/cli/schemas/service_schema.json

@@ -0,0 +1,25 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "description": "https://docs.google.com/a/yelp.com/document/d/1ZBg5ykniRU30UXj4YcsKfmmnuegQbtR2VuqCAIGi-50/edit",
+    "type": "object",
+    "properties": {
+        "needs_puppet_help": {
+            "type": "boolean"
+        },
+        "description": {
+            "type": "string"
+        },
+        "git_url": {
+            "type": "string",
+            "pattern": "^git@github.yelpcorp.com:[-a-z]+/[-_a-z0-9]+(\\.git)?$",
+            "$comment": "this is obviously very tied to how we name repos at Yelp"
+        },
+        "external_link": {
+            "type": "string"
+        }
+    },
+    "required": [
+        "description",
+        "external_link"
+    ]
+}

paasta_tools/cli/schemas/smartstack_schema.json

@@ -0,0 +1,322 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "description": "smartstack config schema",
+    "type": "object",
+    "minProperties": 1,
+    "additionalProperties": {
+        "type": "object",
+        "properties": {
+            "proxy_port": {
+                "type": [
+                    "integer",
+                    "null"
+                ],
+                "minimum": 19000,
+                "maximum": 21000
+            },
+            "port": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 65535
+            },
+            "healthcheck_uri": {
+                "type": "string",
+                "pattern": "^/[-_0-9a-zA-Z/\\?&\\.=]*$"
+            },
+            "healthcheck_timeout_s": {
+                "type": "number",
+                "minimum": 0,
+                "maximum": 10
+            },
+            "updown_timeout_s": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 86400000
+            },
+            "healthcheck_mode": {
+                "enum": [
+                    "http",
+                    "https",
+                    "tcp"
+                ]
+            },
+            "healthcheck_port": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 65535
+            },
+            "healthcheck_body_expect": {
+                "type": "string"
+            },
+            "retries": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 10
+            },
+            "allredisp": {
+                "type": "boolean"
+            },
+            "timeout_connect_ms": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 60000
+            },
+            "timeout_server_ms": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 86400000
+            },
+            "idle_timeout": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 86400000
+            },
+            "balance": {
+                "type": "string",
+                "pattern": "^(leastconn|roundrobin)$"
+            },
+            "advertise": {
+                "type": "array",
+                "items": {
+                    "type": "string"
+                }
+            },
+            "discover": {
+                "type": "string"
+            },
+            "extra_advertise": {
+                "type": "object",
+                "additionalProperties": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            },
+            "extra_headers": {
+                "type": "object"
+            },
+            "extra_healthcheck_headers": {
+                "type": "object",
+                "properties": {
+                    "Host": {
+                        "type": "string"
+                    },
+                    "X-ProxiedSSL": {
+                        "type": "string"
+                    },
+                    "X-Source-Id": {
+                        "type": "string"
+                    }
+                },
+                "additionalProperties": {
+                    "type": "string"
+                }
+            },
+            "mode": {
+                "enum": [
+                    "http",
+                    "https",
+                    "tcp"
+                ]
+            },
+            "lb_policy": {
+                "enum": [
+                    "ROUND_ROBIN",
+                    "LEAST_REQUEST",
+                    "RING_HASH",
+                    "RANDOM",
+                    "MAGLEV",
+                    "CLUSTER_PROVIDED"
+                ]
+            },
+            "chaos": {
+                "type": "object",
+                "additionalProperties": {
+                    "ecosystem": {
+                        "type": "object",
+                        "additionalProperties": true
+                    },
+                    "habitat": {
+                        "type": "object",
+                        "additionalProperties": true
+                    },
+                    "host": {
+                        "type": "object",
+                        "additionalProperties": true
+                    },
+                    "runtimeenv": {
+                        "type": "object",
+                        "additionalProperties": true
+                    }
+                }
+            },
+            "proxied_through": {
+                "type": "string"
+            },
+            "fixed_delay": {
+                "type": "object",
+                "additionalProperties": {
+                    "type": "object",
+                    "properties": {
+                        "duration_ms": {
+                            "type": "number",
+                            "minimum": 0,
+                            "maximum": 86400000
+                        },
+                        "percent": {
+                            "type": "integer",
+                            "minimum": 0,
+                            "maximum": 100
+                        }
+                    },
+                    "required": [
+                        "duration_ms",
+                        "percent"
+                    ]
+                }
+            },
+            "is_proxy": {
+                "type": "boolean"
+            },
+            "plugins": {
+                "type": "object",
+                "properties": {
+                    "source_required": {
+                        "type": "object",
+                        "properties": {
+                            "enabled": {
+                                "type": "boolean"
+                            }
+                        },
+                        "required": [
+                            "enabled"
+                        ],
+                        "additionalProperties": false
+                    },
+                    "logging": {
+                        "type": "object",
+                        "properties": {
+                            "enabled": {
+                                "type": "boolean"
+                            },
+                            "sample_rate": {
+                                "type": "number",
+                                "minimum": 0,
+                                "maximum": 1
+                            }
+                        },
+                        "required": [
+                            "enabled"
+                        ],
+                        "additionalProperties": true
+                    }
+                },
+                "additionalProperties": true
+            },
+            "endpoint_timeouts": {
+                "type": "object",
+                "additionalProperties": {
+                    "type": "number",
+                    "minimum": 0
+                }
+            },
+            "allow_websocket_upgrade": {
+                "type": "boolean"
+            },
+            "vip_upgrade": {
+                "type": "string",
+                "description": "The service namespace that this namespace will route to (via Envoy) if a request has the X-Ctx-Vip header."
+            },
+            "monitoring": {
+                "type": "object",
+                "properties": {
+                    "team": {
+                        "type": "string"
+                    },
+                    "slack_channel": {
+                        "type": "string"
+                    },
+                    "project": {
+                        "type": "string"
+                    },
+                    "ticket": {
+                        "type": "boolean"
+                    },
+                    "page": {
+                        "type": "boolean"
+                    },
+                    "page_nonprod": {
+                        "type": "boolean"
+                    },
+                    "error_threshold_ratio": {
+                        "type": "number",
+                        "minimum": 0,
+                        "maximum": 1
+                    },
+                    "minimum_error_rps": {
+                        "type": "number",
+                        "minimum": 0
+                    },
+                    "default_endpoint_alerting": {
+                        "type": "boolean"
+                    },
+                    "endpoint_error_threshold_ratio": {
+                        "type": "number",
+                        "minimum": 0,
+                        "maximum": 1
+                    },
+                    "endpoint_minimum_error_rps": {
+                        "type": "number",
+                        "minimum": 0
+                    },
+                    "endpoints": {
+                        "type": "array",
+                        "items": {
+                            "type": "object",
+                            "properties": {
+                                "name": {
+                                    "type": "string"
+                                },
+                                "error_threshold_ratio": {
+                                    "type": "number",
+                                    "minimum": 0,
+                                    "maximum": 1
+                                },
+                                "minimum_error_rps": {
+                                    "type": "number",
+                                    "minimum": 0
+                                },
+                                "team": {
+                                    "type": "string"
+                                },
+                                "slack_channel": {
+                                    "type": "string"
+                                },
+                                "project": {
+                                    "type": "string"
+                                },
+                                "ticket": {
+                                    "type": "boolean"
+                                },
+                                "page": {
+                                    "type": "boolean"
+                                },
+                                "page_nonprod": {
+                                    "type": "boolean"
+                                }
+                            },
+                            "required": [
+                                "name"
+                            ]
+                        }
+                    }
+                }
+            }
+        },
+        "required": [
+            "proxy_port"
+        ],
+        "additionalProperties": false
+    }
+}