cloudfall 0.2.0__py3-none-any.whl

cloudfall/__init__.py

@@ -0,0 +1,19 @@
+"""Cloudfall platform SDK."""
+
+from cloudfall.domain import ResourceDocument, ResourceId, ResourceKind
+from cloudfall.inventory import PlatformInventory
+from cloudfall.operations import FleetOperations, UtcTimestamp, build_operations_view
+from cloudfall.validation import ConfigValidationError, ValidatedConfig, validate_config
+
+__all__ = [
+    "ConfigValidationError",
+    "FleetOperations",
+    "PlatformInventory",
+    "ResourceDocument",
+    "ResourceId",
+    "ResourceKind",
+    "UtcTimestamp",
+    "ValidatedConfig",
+    "build_operations_view",
+    "validate_config",
+]

cloudfall/__main__.py

@@ -0,0 +1,5 @@
+"""Allow ``python -m cloudfall`` at the system boundary."""
+
+from cloudfall.cli import run
+
+run()

cloudfall/_bundled/schemas/v1/alert-rule.schema.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://cloudfall.internal/schemas/v1/alert-rule.schema.json",
+  "title": "Cloudfall alert rule",
+  "x-cloudfall-kind": "AlertRule",
+  "type": "object",
+  "properties": {
+    "apiVersion": {
+      "$ref": "common.schema.json#/$defs/apiVersion"
+    },
+    "kind": {
+      "const": "AlertRule"
+    },
+    "metadata": {
+      "$ref": "common.schema.json#/$defs/metadata"
+    },
+    "spec": {
+      "type": "object",
+      "properties": {
+        "environment": {
+          "$ref": "common.schema.json#/$defs/resourceId"
+        },
+        "expr": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 1000,
+          "pattern": "^[^\\u0000-\\u001f\\u007f]+$"
+        },
+        "for": {
+          "type": "string",
+          "pattern": "^[0-9]{1,5}[smh]$"
+        },
+        "severity": {
+          "enum": [
+            "warning",
+            "critical"
+          ]
+        },
+        "summary": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 200,
+          "pattern": "^[^\\u0000-\\u001f\\u007f]+$"
+        }
+      },
+      "required": [
+        "environment",
+        "expr",
+        "for",
+        "severity",
+        "summary"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "apiVersion",
+    "kind",
+    "metadata",
+    "spec"
+  ],
+  "additionalProperties": false
+}

cloudfall/_bundled/schemas/v1/application.schema.json

@@ -0,0 +1,60 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://cloudfall.internal/schemas/v1/application.schema.json",
+  "title": "Cloudfall application",
+  "x-cloudfall-kind": "Application",
+  "type": "object",
+  "properties": {
+    "apiVersion": {
+      "$ref": "common.schema.json#/$defs/apiVersion"
+    },
+    "kind": {
+      "const": "Application"
+    },
+    "metadata": {
+      "$ref": "common.schema.json#/$defs/metadata"
+    },
+    "spec": {
+      "type": "object",
+      "properties": {
+        "linuxUser": {
+          "$ref": "common.schema.json#/$defs/linuxUser"
+        },
+        "approval": {
+          "enum": [
+            "automatic",
+            "manual"
+          ]
+        },
+        "components": {
+          "type": "array",
+          "items": {
+            "$ref": "common.schema.json#/$defs/resourceId"
+          },
+          "minItems": 1,
+          "uniqueItems": true
+        },
+        "secretRefs": {
+          "type": "array",
+          "items": {
+            "$ref": "common.schema.json#/$defs/secretReference"
+          },
+          "uniqueItems": true
+        }
+      },
+      "required": [
+        "linuxUser",
+        "approval",
+        "components"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "apiVersion",
+    "kind",
+    "metadata",
+    "spec"
+  ],
+  "additionalProperties": false
+}

cloudfall/_bundled/schemas/v1/artifact.schema.json

@@ -0,0 +1,71 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://cloudfall.internal/schemas/v1/artifact.schema.json",
+  "title": "Cloudfall release artifact metadata",
+  "type": "object",
+  "properties": {
+    "apiVersion": {
+      "$ref": "common.schema.json#/$defs/apiVersion"
+    },
+    "kind": {
+      "const": "Artifact"
+    },
+    "metadata": {
+      "$ref": "common.schema.json#/$defs/metadata"
+    },
+    "spec": {
+      "type": "object",
+      "properties": {
+        "component": {
+          "$ref": "common.schema.json#/$defs/resourceId"
+        },
+        "release": {
+          "type": "string",
+          "pattern": "^[0-9]{8}T[0-9]{6}Z-[0-9a-f]{7,40}$"
+        },
+        "gitRef": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 200
+        },
+        "gitCommit": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{40}$"
+        },
+        "builtAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "archive": {
+          "type": "string",
+          "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*\\.tar\\.gz$"
+        },
+        "archiveSha256": {
+          "$ref": "common.schema.json#/$defs/sha256"
+        },
+        "sizeBytes": {
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "required": [
+        "component",
+        "release",
+        "gitRef",
+        "gitCommit",
+        "builtAt",
+        "archive",
+        "archiveSha256",
+        "sizeBytes"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "apiVersion",
+    "kind",
+    "metadata",
+    "spec"
+  ],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,58 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://cloudfall.internal/schemas/v1/backup-receipt.schema.json",
+  "title": "Cloudfall backup operation receipt",
+  "type": "object",
+  "properties": {
+    "apiVersion": {
+      "$ref": "common.schema.json#/$defs/apiVersion"
+    },
+    "kind": {
+      "const": "BackupReceipt"
+    },
+    "metadata": {
+      "$ref": "common.schema.json#/$defs/metadata"
+    },
+    "spec": {
+      "type": "object",
+      "properties": {
+        "service": {
+          "$ref": "common.schema.json#/$defs/resourceId"
+        },
+        "server": {
+          "$ref": "common.schema.json#/$defs/resourceId"
+        },
+        "action": {
+          "enum": [
+            "backup",
+            "restore-check"
+          ]
+        },
+        "executedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "summary": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2000
+        }
+      },
+      "required": [
+        "service",
+        "server",
+        "action",
+        "executedAt",
+        "summary"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "apiVersion",
+    "kind",
+    "metadata",
+    "spec"
+  ],
+  "additionalProperties": false
+}

cloudfall/_bundled/schemas/v1/common.schema.json

@@ -0,0 +1,115 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://cloudfall.internal/schemas/v1/common.schema.json",
+  "title": "Cloudfall common definitions",
+  "$defs": {
+    "apiVersion": {
+      "const": "cloudfall/v1"
+    },
+    "resourceId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 63,
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
+    },
+    "metadata": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/resourceId"
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 500
+        }
+      },
+      "required": [
+        "id"
+      ],
+      "additionalProperties": false
+    },
+    "linuxUser": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 32,
+      "pattern": "^[a-z_][a-z0-9_-]*$"
+    },
+    "packageName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 200,
+      "pattern": "^[a-z0-9][a-z0-9+.-]*$"
+    },
+    "serviceName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255,
+      "pattern": "^[A-Za-z0-9@_.:-]+\\.service$"
+    },
+    "systemdUnitName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255,
+      "pattern": "^[A-Za-z0-9@_.:-]+\\.(?:service|timer)$"
+    },
+    "networkPort": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 65535
+    },
+    "networkProtocol": {
+      "enum": [
+        "tcp",
+        "udp"
+      ]
+    },
+    "fileMode": {
+      "type": "string",
+      "pattern": "^0[0-7]{3}$"
+    },
+    "sha256": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    },
+    "absolutePath": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^/(?:[^/\\u0000]+/?)*$",
+      "not": {
+        "anyOf": [
+          {
+            "pattern": "(?:^|/)\\.\\.(?:/|$)"
+          },
+          {
+            "pattern": "//"
+          }
+        ]
+      }
+    },
+    "secretReference": {
+      "type": "object",
+      "properties": {
+        "scope": {
+          "enum": [
+            "platform",
+            "application",
+            "component"
+          ]
+        },
+        "environment": {
+          "$ref": "#/$defs/resourceId"
+        },
+        "path": {
+          "$ref": "#/$defs/absolutePath"
+        }
+      },
+      "required": [
+        "scope",
+        "environment",
+        "path"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

cloudfall/_bundled/schemas/v1/component.schema.json

@@ -0,0 +1,234 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://cloudfall.internal/schemas/v1/component.schema.json",
+  "title": "Cloudfall component",
+  "x-cloudfall-kind": "Component",
+  "type": "object",
+  "properties": {
+    "apiVersion": {
+      "$ref": "common.schema.json#/$defs/apiVersion"
+    },
+    "kind": {
+      "const": "Component"
+    },
+    "metadata": {
+      "$ref": "common.schema.json#/$defs/metadata"
+    },
+    "spec": {
+      "type": "object",
+      "properties": {
+        "application": {
+          "$ref": "common.schema.json#/$defs/resourceId"
+        },
+        "repository": {
+          "type": "object",
+          "properties": {
+            "url": {
+              "type": "string",
+              "format": "uri",
+              "pattern": "^(?:https|ssh|file)://"
+            },
+            "subdirectory": {
+              "type": "string",
+              "minLength": 1,
+              "pattern": "^(?!/)(?!.*(?:^|/)\\.\\.(?:/|$)).+$"
+            }
+          },
+          "required": [
+            "url"
+          ],
+          "additionalProperties": false
+        },
+        "runtime": {
+          "type": "object",
+          "properties": {
+            "type": {
+              "enum": [
+                "python",
+                "node",
+                "pm2"
+              ]
+            },
+            "version": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 30
+            },
+            "packageManager": {
+              "enum": [
+                "uv",
+                "npm",
+                "pnpm",
+                "yarn"
+              ]
+            }
+          },
+          "required": [
+            "type",
+            "version",
+            "packageManager"
+          ],
+          "additionalProperties": false
+        },
+        "deployment": {
+          "type": "object",
+          "properties": {
+            "strategy": {
+              "const": "artifact-symlink"
+            },
+            "servers": {
+              "type": "array",
+              "items": {
+                "$ref": "common.schema.json#/$defs/resourceId"
+              },
+              "minItems": 1,
+              "uniqueItems": true
+            },
+            "installRoot": {
+              "$ref": "common.schema.json#/$defs/absolutePath"
+            },
+            "retainUntilCleanup": {
+              "const": true
+            }
+          },
+          "required": [
+            "strategy",
+            "servers",
+            "installRoot",
+            "retainUntilCleanup"
+          ],
+          "additionalProperties": false
+        },
+        "service": {
+          "type": "object",
+          "properties": {
+            "manager": {
+              "const": "systemd"
+            },
+            "name": {
+              "$ref": "common.schema.json#/$defs/resourceId"
+            },
+            "command": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "minLength": 1
+              },
+              "minItems": 1
+            }
+          },
+          "required": [
+            "manager",
+            "name",
+            "command"
+          ],
+          "additionalProperties": false
+        },
+        "healthCheck": {
+          "oneOf": [
+            {
+              "type": "object",
+              "properties": {
+                "type": {
+                  "const": "http"
+                },
+                "scheme": {
+                  "enum": [
+                    "http",
+                    "https"
+                  ]
+                },
+                "port": {
+                  "type": "integer",
+                  "minimum": 1,
+                  "maximum": 65535
+                },
+                "path": {
+                  "type": "string",
+                  "pattern": "^/"
+                },
+                "expectedStatuses": {
+                  "type": "array",
+                  "items": {
+                    "type": "integer",
+                    "minimum": 100,
+                    "maximum": 599
+                  },
+                  "minItems": 1,
+                  "uniqueItems": true
+                },
+                "timeoutSeconds": {
+                  "type": "integer",
+                  "minimum": 1,
+                  "maximum": 300
+                },
+                "attempts": {
+                  "type": "integer",
+                  "minimum": 1,
+                  "maximum": 20
+                }
+              },
+              "required": [
+                "type",
+                "scheme",
+                "port",
+                "path",
+                "expectedStatuses",
+                "timeoutSeconds",
+                "attempts"
+              ],
+              "additionalProperties": false
+            },
+            {
+              "type": "object",
+              "properties": {
+                "type": {
+                  "const": "none"
+                }
+              },
+              "required": [
+                "type"
+              ],
+              "additionalProperties": false
+            }
+          ]
+        },
+        "environment": {
+          "type": "object",
+          "minProperties": 1,
+          "patternProperties": {
+            "^[A-Za-z_][A-Za-z0-9_]*$": {
+              "type": "string",
+              "maxLength": 1000,
+              "pattern": "^[^\\u0000-\\u001f\\u007f]*$"
+            }
+          },
+          "additionalProperties": false
+        },
+        "secretRefs": {
+          "type": "array",
+          "items": {
+            "$ref": "common.schema.json#/$defs/secretReference"
+          },
+          "uniqueItems": true
+        }
+      },
+      "required": [
+        "application",
+        "repository",
+        "runtime",
+        "deployment",
+        "service",
+        "healthCheck"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "apiVersion",
+    "kind",
+    "metadata",
+    "spec"
+  ],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,53 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://cloudfall.internal/schemas/v1/deployment-receipt.schema.json",
+  "title": "Cloudfall domain deployment receipt",
+  "type": "object",
+  "properties": {
+    "apiVersion": {
+      "$ref": "common.schema.json#/$defs/apiVersion"
+    },
+    "kind": {
+      "const": "DeploymentReceipt"
+    },
+    "metadata": {
+      "$ref": "common.schema.json#/$defs/metadata"
+    },
+    "spec": {
+      "type": "object",
+      "properties": {
+        "domain": {
+          "$ref": "common.schema.json#/$defs/resourceId"
+        },
+        "server": {
+          "$ref": "common.schema.json#/$defs/resourceId"
+        },
+        "deployedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "configurationPath": {
+          "$ref": "common.schema.json#/$defs/absolutePath"
+        },
+        "configurationSha256": {
+          "$ref": "common.schema.json#/$defs/sha256"
+        }
+      },
+      "required": [
+        "domain",
+        "server",
+        "deployedAt",
+        "configurationPath",
+        "configurationSha256"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "apiVersion",
+    "kind",
+    "metadata",
+    "spec"
+  ],
+  "additionalProperties": false
+}