cloudfall 0.2.0__py3-none-any.whl

cloudfall/_bundled/schemas/v1/operator-policy.schema.json

@@ -0,0 +1,97 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://cloudfall.internal/schemas/v1/operator-policy.schema.json",
+  "title": "Cloudfall operator autonomy policy",
+  "x-cloudfall-kind": "OperatorPolicy",
+  "type": "object",
+  "properties": {
+    "apiVersion": {
+      "$ref": "common.schema.json#/$defs/apiVersion"
+    },
+    "kind": {
+      "const": "OperatorPolicy"
+    },
+    "metadata": {
+      "$ref": "common.schema.json#/$defs/metadata"
+    },
+    "spec": {
+      "type": "object",
+      "properties": {
+        "environment": {
+          "$ref": "common.schema.json#/$defs/resourceId"
+        },
+        "autonomy": {
+          "type": "object",
+          "properties": {
+            "operations": {
+              "type": "array",
+              "minItems": 1,
+              "uniqueItems": true,
+              "items": {
+                "type": "object",
+                "properties": {
+                  "kind": {
+                    "enum": [
+                      "converge-services",
+                      "converge-baseline"
+                    ]
+                  },
+                  "requiredVerifiedRuns": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 1000
+                  }
+                },
+                "required": [
+                  "kind",
+                  "requiredVerifiedRuns"
+                ],
+                "additionalProperties": false
+              }
+            },
+            "maxAutonomousPerHour": {
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 100
+            },
+            "quietHours": {
+              "type": "object",
+              "properties": {
+                "start": {
+                  "type": "string",
+                  "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
+                },
+                "end": {
+                  "type": "string",
+                  "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
+                }
+              },
+              "required": [
+                "start",
+                "end"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "operations",
+            "maxAutonomousPerHour"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "environment",
+        "autonomy"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "apiVersion",
+    "kind",
+    "metadata",
+    "spec"
+  ],
+  "additionalProperties": false
+}

cloudfall/_bundled/schemas/v1/operator-proposal.schema.json

@@ -0,0 +1,253 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://cloudfall.internal/schemas/v1/operator-proposal.schema.json",
+  "title": "Cloudfall operator proposal receipt",
+  "type": "object",
+  "properties": {
+    "apiVersion": {
+      "$ref": "common.schema.json#/$defs/apiVersion"
+    },
+    "kind": {
+      "const": "OperatorProposal"
+    },
+    "metadata": {
+      "$ref": "common.schema.json#/$defs/metadata"
+    },
+    "spec": {
+      "type": "object",
+      "properties": {
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "status": {
+          "enum": [
+            "proposed",
+            "executed",
+            "verified",
+            "failed"
+          ]
+        },
+        "trigger": {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "enum": [
+                "alert",
+                "drift"
+              ]
+            },
+            "fingerprint": {
+              "type": "string",
+              "pattern": "^[a-f0-9]{16}$"
+            },
+            "alert": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 200
+                },
+                "cloudfallRule": {
+                  "$ref": "common.schema.json#/$defs/resourceId"
+                },
+                "severity": {
+                  "enum": [
+                    "warning",
+                    "critical"
+                  ]
+                },
+                "environment": {
+                  "$ref": "common.schema.json#/$defs/resourceId"
+                },
+                "server": {
+                  "$ref": "common.schema.json#/$defs/resourceId"
+                },
+                "service": {
+                  "$ref": "common.schema.json#/$defs/resourceId"
+                },
+                "activeAt": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 64
+                }
+              },
+              "required": [
+                "name",
+                "cloudfallRule",
+                "severity",
+                "environment",
+                "server",
+                "service",
+                "activeAt"
+              ],
+              "additionalProperties": false
+            },
+            "drift": {
+              "type": "object",
+              "properties": {
+                "server": {
+                  "$ref": "common.schema.json#/$defs/resourceId"
+                },
+                "checks": {
+                  "type": "array",
+                  "items": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 200
+                  },
+                  "minItems": 1
+                }
+              },
+              "required": [
+                "server",
+                "checks"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "kind",
+            "fingerprint"
+          ],
+          "oneOf": [
+            {
+              "required": [
+                "alert"
+              ]
+            },
+            {
+              "required": [
+                "drift"
+              ]
+            }
+          ],
+          "additionalProperties": false
+        },
+        "diagnosis": {
+          "type": "object",
+          "properties": {
+            "summary": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 1000
+            },
+            "evidence": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 500
+              },
+              "minItems": 1
+            }
+          },
+          "required": [
+            "summary",
+            "evidence"
+          ],
+          "additionalProperties": false
+        },
+        "operation": {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "enum": [
+                "converge-services",
+                "converge-baseline"
+              ]
+            },
+            "server": {
+              "$ref": "common.schema.json#/$defs/resourceId"
+            },
+            "service": {
+              "$ref": "common.schema.json#/$defs/resourceId"
+            },
+            "command": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 500
+              },
+              "minItems": 1
+            }
+          },
+          "required": [
+            "kind",
+            "server",
+            "command"
+          ],
+          "additionalProperties": false
+        },
+        "approval": {
+          "type": "object",
+          "properties": {
+            "mode": {
+              "enum": [
+                "human",
+                "autonomous"
+              ]
+            },
+            "policy": {
+              "$ref": "common.schema.json#/$defs/resourceId"
+            }
+          },
+          "required": [
+            "mode"
+          ],
+          "additionalProperties": false
+        },
+        "outcome": {
+          "type": "object",
+          "properties": {
+            "executedAt": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "verifiedAt": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "result": {
+              "enum": [
+                "verified",
+                "failed"
+              ]
+            },
+            "detail": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 1000
+            }
+          },
+          "required": [
+            "executedAt",
+            "verifiedAt",
+            "result",
+            "detail"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "createdAt",
+        "status",
+        "trigger",
+        "diagnosis",
+        "operation"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "apiVersion",
+    "kind",
+    "metadata",
+    "spec"
+  ],
+  "additionalProperties": false
+}

cloudfall/_bundled/schemas/v1/release-receipt.schema.json

@@ -0,0 +1,66 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://cloudfall.internal/schemas/v1/release-receipt.schema.json",
+  "title": "Cloudfall component release receipt",
+  "type": "object",
+  "properties": {
+    "apiVersion": {
+      "$ref": "common.schema.json#/$defs/apiVersion"
+    },
+    "kind": {
+      "const": "ReleaseReceipt"
+    },
+    "metadata": {
+      "$ref": "common.schema.json#/$defs/metadata"
+    },
+    "spec": {
+      "type": "object",
+      "properties": {
+        "component": {
+          "$ref": "common.schema.json#/$defs/resourceId"
+        },
+        "server": {
+          "$ref": "common.schema.json#/$defs/resourceId"
+        },
+        "release": {
+          "type": "string",
+          "pattern": "^[0-9]{8}T[0-9]{6}Z-[0-9a-f]{7,40}$"
+        },
+        "artifactSha256": {
+          "$ref": "common.schema.json#/$defs/sha256"
+        },
+        "deployedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "previousRelease": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "pattern": "^[0-9]{8}T[0-9]{6}Z-[0-9a-f]{7,40}$"
+        },
+        "healthCheckPassed": {
+          "const": true
+        }
+      },
+      "required": [
+        "component",
+        "server",
+        "release",
+        "artifactSha256",
+        "deployedAt",
+        "previousRelease",
+        "healthCheckPassed"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "apiVersion",
+    "kind",
+    "metadata",
+    "spec"
+  ],
+  "additionalProperties": false
+}

cloudfall/_bundled/schemas/v1/server-type.schema.json

@@ -0,0 +1,289 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://cloudfall.internal/schemas/v1/server-type.schema.json",
+  "title": "Cloudfall server type",
+  "x-cloudfall-kind": "ServerType",
+  "type": "object",
+  "properties": {
+    "apiVersion": {
+      "$ref": "common.schema.json#/$defs/apiVersion"
+    },
+    "kind": {
+      "const": "ServerType"
+    },
+    "metadata": {
+      "$ref": "common.schema.json#/$defs/metadata"
+    },
+    "spec": {
+      "type": "object",
+      "properties": {
+        "os": {
+          "type": "object",
+          "properties": {
+            "distribution": {
+              "const": "Debian"
+            },
+            "versions": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "pattern": "^[0-9]+$"
+              },
+              "minItems": 1,
+              "uniqueItems": true
+            },
+            "serviceManager": {
+              "const": "systemd"
+            }
+          },
+          "required": [
+            "distribution",
+            "versions",
+            "serviceManager"
+          ],
+          "additionalProperties": false
+        },
+        "storage": {
+          "type": "object",
+          "properties": {
+            "softwareRaid": {
+              "type": "object",
+              "properties": {
+                "level": {
+                  "enum": [
+                    "raid0",
+                    "raid1",
+                    "raid5",
+                    "raid6",
+                    "raid10"
+                  ]
+                },
+                "minimumActiveDevices": {
+                  "type": "integer",
+                  "minimum": 1
+                },
+                "minimumUsableBytes": {
+                  "type": "integer",
+                  "minimum": 1
+                }
+              },
+              "required": [
+                "level",
+                "minimumActiveDevices",
+                "minimumUsableBytes"
+              ],
+              "additionalProperties": false
+            },
+            "mounts": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "path": {
+                    "$ref": "common.schema.json#/$defs/absolutePath"
+                  },
+                  "filesystem": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 30
+                  },
+                  "minimumBytes": {
+                    "type": "integer",
+                    "minimum": 1
+                  }
+                },
+                "required": [
+                  "path",
+                  "filesystem",
+                  "minimumBytes"
+                ],
+                "additionalProperties": false
+              },
+              "uniqueItems": true
+            }
+          },
+          "required": [
+            "mounts"
+          ],
+          "additionalProperties": false
+        },
+        "packages": {
+          "type": "object",
+          "properties": {
+            "required": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "$ref": "common.schema.json#/$defs/packageName"
+                  },
+                  "version": {
+                    "type": "string",
+                    "minLength": 1
+                  }
+                },
+                "required": [
+                  "name"
+                ],
+                "additionalProperties": false
+              },
+              "uniqueItems": true
+            },
+            "forbidden": {
+              "type": "array",
+              "items": {
+                "$ref": "common.schema.json#/$defs/packageName"
+              },
+              "uniqueItems": true
+            }
+          },
+          "required": [
+            "required",
+            "forbidden"
+          ],
+          "additionalProperties": false
+        },
+        "firewall": {
+          "type": "object",
+          "properties": {
+            "policy": {
+              "const": "default-deny"
+            },
+            "allowedInbound": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "port": {
+                    "$ref": "common.schema.json#/$defs/networkPort"
+                  },
+                  "protocol": {
+                    "$ref": "common.schema.json#/$defs/networkProtocol"
+                  },
+                  "description": {
+                    "type": "string",
+                    "pattern": "^[A-Za-z0-9][A-Za-z0-9 ._-]{0,199}$"
+                  }
+                },
+                "required": [
+                  "port",
+                  "protocol"
+                ],
+                "additionalProperties": false
+              },
+              "uniqueItems": true
+            }
+          },
+          "required": [
+            "policy",
+            "allowedInbound"
+          ],
+          "additionalProperties": false
+        },
+        "services": {
+          "type": "object",
+          "properties": {
+            "required": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "$ref": "common.schema.json#/$defs/systemdUnitName"
+                  },
+                  "state": {
+                    "enum": [
+                      "running",
+                      "stopped"
+                    ]
+                  },
+                  "status": {
+                    "enum": [
+                      "enabled",
+                      "disabled",
+                      "static",
+                      "indirect"
+                    ]
+                  }
+                },
+                "required": [
+                  "name",
+                  "state",
+                  "status"
+                ],
+                "additionalProperties": false
+              },
+              "uniqueItems": true
+            }
+          },
+          "required": [
+            "required"
+          ],
+          "additionalProperties": false
+        },
+        "configuration": {
+          "type": "object",
+          "properties": {
+            "files": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "path": {
+                    "$ref": "common.schema.json#/$defs/absolutePath"
+                  },
+                  "capture": {
+                    "enum": [
+                      "metadata",
+                      "hash"
+                    ]
+                  },
+                  "owner": {
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "group": {
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "mode": {
+                    "$ref": "common.schema.json#/$defs/fileMode"
+                  },
+                  "sha256": {
+                    "$ref": "common.schema.json#/$defs/sha256"
+                  }
+                },
+                "required": [
+                  "path",
+                  "capture"
+                ],
+                "additionalProperties": false
+              },
+              "uniqueItems": true
+            }
+          },
+          "required": [
+            "files"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "os",
+        "storage",
+        "packages",
+        "services",
+        "configuration"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "apiVersion",
+    "kind",
+    "metadata",
+    "spec"
+  ],
+  "additionalProperties": false
+}