pve-cloud-schemas 0.0.1__tar.gz

pve_cloud_schemas-0.0.1/PKG-INFO

@@ -0,0 +1,7 @@
+Metadata-Version: 2.4
+Name: pve-cloud-schemas
+Version: 0.0.1
+Author-email: Tobias Huebner <tobias.huebner@vmzberlin.com>
+License-Expression: GPL-3.0-or-later
+Requires-Dist: PyYAML==6.0.2
+Requires-Dist: jsonschema==4.23.0

pve_cloud_schemas-0.0.1/README.md

@@ -0,0 +1,3 @@
+# Python pkg - pve-cloud-schemas
+
+Contains schema definitions for custom ansible inventories and extensions for various core pve cloud playbooks.

pve_cloud_schemas-0.0.1/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pve-cloud-schemas"
+authors = [{ name = "Tobias Huebner", email = "tobias.huebner@vmzberlin.com" }]
+license = "GPL-3.0-or-later"
+license-files = ["LICENSE"]
+dependencies = [
+  "PyYAML==6.0.2",
+  "jsonschema==4.23.0",
+]
+dynamic = ["version"]
+
+[tool.setuptools.dynamic]
+version = {attr = "pve_cloud_schemas._version.__version__"}
+
+[tool.setuptools.package-data]
+"pve_cloud_schemas.definitions" = ["*.yml", "*.yaml"]
+"pve_cloud_schemas.extensions" = ["*.yml", "*.yaml"]
+
+[project.scripts]
+pcval = "pve_cloud_schemas.validate:validate_inventory_file"
+pcval-dump = "pve_cloud_schemas.validate:dump_schemas"

pve_cloud_schemas-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pve_cloud_schemas-0.0.1/src/pve_cloud_schemas/_version.py

@@ -0,0 +1 @@
+__version__ = "0.0.1"

pve_cloud_schemas-0.0.1/src/pve_cloud_schemas/definitions/awx_cloud_inv_schema.yaml

@@ -0,0 +1,39 @@
+type: object
+additionalProperties: false
+title: "AWX Cron Inventory"
+required:
+  - target_pve
+  - plugin
+  - pve_clusters
+properties:
+  target_pve:
+    type: string
+  plugin:
+    type: string
+    description: Id of ansible inventory plugin.
+    enum:
+      - pve.cloud.awx_cloud_inv
+  pve_clusters:
+    type: object
+    description: "Copy of the inventory file located in user home directory ~/.pve-cloud-dyn-inv.yaml, containing all the pve clusters the user has access to via ssh."
+    additionalProperties: false
+    patternProperties:
+      "^.*$":
+        type: object
+        title: "PVE cluster fqdn"
+        additionalProperties: false
+        description: "The identifying cluster domain. Synonymous with target_pve. Will be appended to stack_name(s)."
+        patternProperties:
+          "^.*$":
+            type: object
+            title: "PVE Node Hostname"
+            additionalProperties: false
+            description: "Hostname of a pve host (short)."
+            required:
+              - ansible_user
+              - ansible_host
+            properties:
+              ansible_user:
+                type: string
+              ansible_host:
+                type: string

pve_cloud_schemas-0.0.1/src/pve_cloud_schemas/definitions/kubespray_inv_schema.yaml

@@ -0,0 +1,242 @@
+type: object
+description: "Inventory for deploying k8s clusters via kubespray on PVE."
+title: "K8S Kubespray Inv."
+additionalProperties: false
+required:
+  - target_pve
+  - stack_name
+  - cluster_cert_entries
+  - tcp_proxies
+  - static_includes
+  - qemus
+  - ceph_csi_sc_pools
+  - root_ssh_pub_key
+properties:
+  target_pve:
+    type: string
+    description: "The pve cluster this stack should reside in, defined in ~/.pve-cloud-dyn-inv.yaml via `pvcli connect-cluster`"
+  stack_name:
+    type: string
+    description: "Your stack name, needs to be unique within the cloud domain. Will create its own sub zone."
+  extra_control_plane_sans:
+    type: array
+    description: |
+      Extra sans that kubespray will put in kubeapi generated certificates. Original kubespray variable is named supplementary_addresses_in_ssl_keys, 
+      but is set via kubespray custom inventory. Read kubernetes page in pve cloud docs for more details.
+    items:
+      type: string
+  external_domains:
+    type: array
+    description: "Domains that will be exposed to the public proxies floating ip via haproxy routing rules."
+    items:
+      type: object
+      additionalProperties: false
+      required:
+        - zone
+        - names
+      properties:
+        zone:
+          type: string
+          description: "DNS parent zone, should also be the zone that external records are made under in AWS for example."
+        expose_tld:
+          type: boolean
+          description: "Expose the top level domain itself."
+        names:
+          type: array
+          items:
+            type: string
+            description: "Hostname part (host + zone)"
+  cluster_cert_entries:
+    type: array
+    description: "Content for the clusters certificate. Internal routing is handled by ingress dns!"
+    items:
+      type: object
+      additionalProperties: false
+      required:
+        - zone
+        - names
+      properties:
+        zone:
+          type: string
+          description: "DNS parent zone, should coincide with tld for dns01 challenge."
+        names:
+          type: array
+          items:
+            type: string
+            description: "Hostname part (host + zone)"
+        authoritative_zone:
+          type: boolean
+          description: "Create authoritative zone inside of pve cloud bind dns."
+        apex_zone_san:
+          type: boolean
+          description: "Creates additional SAN for the zone, if you have *.example.com you will also get example.com in your certificate. Defaults to false."
+  tcp_proxies:
+    type: array
+    description: "TCP forwards to this cluster on the pve cluster proxy."
+    items:
+      type: object
+      additionalProperties: false
+      required:
+        - proxy_name
+        - haproxy_port
+        - node_port
+      properties:
+        proxy_name:
+          type: string
+          description: "Name of the proxy port. Should be unique for the stack."
+        haproxy_port:
+          type: number
+          description: "Port on the haproxy frontend that listens."
+        node_port:
+          type: number
+          description: "Port on the nodes, usually via K8S NodePort"
+        proxy_snippet:
+          type: string
+          description: "additional snippet that will be inserted into the haproxy listen block. Can be used for custom logic."
+        external:
+          type: boolean
+          description: "Will bind to the external floating ip aswell."
+  static_includes:
+    type: object
+    additionalProperties: false
+    required:
+      - dhcp_stack
+      - proxy_stack
+      - postgres_stack
+      - bind_stack
+    properties:
+      dhcp_stack:
+        type: string
+        description: "Stack fqdn of dhcp stack where reservations for node ips should be made."
+      proxy_stack:
+        type: string
+        description: "Stack fqdn of haproxy stack where ingress and proxy rules should be configured."
+      postgres_stack:
+        type: string
+        description: "Stack fqdn of postgres stack where state and general configuration of our pve cloud is stored."
+      bind_stack:
+        type: string
+        description: "Stack fqdn of bind servers, where create_bind_zone: true ingress_domain zones will be created."
+      cache_stack:
+        type: string
+        description: "Cache stack to mount nfs for kubespray cache and apt cache. Assumes the cache lxc to have the hostname \"main\"." # todo: implement keepalived cache instead
+  include_stacks:
+    type: array
+    description: "Include other stacks into the ansible inventory, from any PVE cluster you like."
+    items:
+      type: object
+      required:
+        - stack_fqdn
+        - host_group
+      additionalProperties: false
+      properties:
+        stack_fqdn:
+          type: string
+          description: "Target stack fqdn to include (stack name + pve_cloud_domain). Will automatically include it from the right pve cluster."
+        host_group:
+          type: string
+          description: "This is the name of the hosts group of our ansible inventory the included vms will be under."
+        qemu_ansible_user:
+          type: string
+          description: User ansible will use to connect, defaults to admin.
+  qemus:
+    type: array
+    description: "Nodes for the cluster in form of qemu vms."
+    items:
+      type: object
+      additionalProperties: false
+      required:
+        - k8s_roles
+        - disk
+        - parameters
+      properties:
+        hostname:
+          type: string
+          description: "Optional unique hostname for this node, otherwise pet name random name will be generated."
+        vars:
+          type: object
+          description: "Custom variables for this node specifically."
+        k8s_roles:
+          type: array
+          description: "String array of k8s roles (master/worker)"
+        target_host:
+          type: string
+          description: "Pve host to tie this vm to."
+        parameters:
+          type: object
+          description: "In accordance with pve qm cli tool, creation args."
+        network_config:
+          type: string
+          description: "Cinit network config yaml string. Will be the last cfg piece that gets merged into the final cloudinit network config."
+        disk:
+          type: object
+          additionalProperties: false
+          required:
+            - size
+            - pool
+          properties:
+            size:
+              type: string
+              description: "Size of the vms disk."
+              example: 25G
+            options:
+              type: object
+              description: "Mount options"
+            pool:
+              type: string
+              description: "Ceph pool name the vms disk will be created in."
+  ceph_csi_sc_pools:
+    type: array
+    description: "Ceph pools that will be made available to the cluster CSI driver."
+    items:
+      type: object
+      additionalProperties: false
+      required:
+        - name
+        - default
+        - mount_options
+      properties:
+        name:
+          type: string
+          description: "Name of the pool in the ceph of our PVE cluster."
+        default:
+          type: boolean
+          description: "Whether or not the pool is the default storage class."
+        mount_options:
+          type: array
+          description: "String array of mount options that will be set in the storage class and applied to pvs."
+  root_ssh_pub_key:
+    type: string
+    description: trusted root key for the cloud init image.
+  pve_ha_group:
+    type: string
+    description: PVE HA group this vm should be assigned to (optional).
+  qemu_hashed_pw:
+    type: string
+    description: Pw for default user defaults to hashed 'password' for debian cloud init image.
+  qemu_base_parameters:
+    type: object
+    description: Base parameters passed to the proxmox qm cli tool for creating vm
+  qemu_image_url:
+    type: string
+    description: http(s) download link for cloud init image.
+  qemu_keyboard_layout:
+    type: string
+    description: Keyboard layout for cloudinit.
+  qemu_network_config:
+    type: string
+    description: Optional qemu network config as a yaml string that is merged into the cloudinit network config of all qemus.
+  acme_staging:
+    type: boolean
+    description: "If set to true will use acme staging directory for issueing certs."
+  plugin:
+    type: string
+    description: Id of ansible inventory plugin.
+    enum:
+      - pve.cloud.kubespray_inv
+  pve_cloud_pytest:
+    type: object
+    description: Variables object used only in e2e tests.
+  qemu_global_vars:
+    type: object
+    description: "Variables that will be applied to all lxc hosts."

pve_cloud_schemas-0.0.1/src/pve_cloud_schemas/definitions/lxc_inv_schema.yaml

@@ -0,0 +1,105 @@
+type: object
+title: "LXC Inventory"
+description: "Base inventory for creating lxcs for a single stack on PVE."
+additionalProperties: false
+required:
+  - target_pve
+  - stack_name
+  - lxcs
+  - root_ssh_pub_key
+properties:
+  target_pve:
+    type: string
+    description: "Proxmox cluster name + cloud domain, this is where the lxcs will be created."
+  stack_name:
+    type: string
+    description: "Your stack name, needs to be unique within the cloud."
+  static_includes:
+    type: object
+  lxcs:
+    type: array
+    description: "List of lxcs that will be created for the stack."
+    items:
+      type: object
+      required:
+        - parameters
+      properties:
+        hostname:
+          type: string
+          description: "Optional unique hostname for this lxc, otherwise pet name random name will be generated."
+        target_host:
+          type: string
+          description: "Pve host to tie this vm to. This is useful to always deploy specifically on a proxmox host."
+        vars:
+          type: object
+          description: "Custom variables for this lxc specifically. Will be usable in playbooks."
+        parameters:
+          type: object
+          description: "Parameters that will be passed to pve pct cli tool for lxc creation."
+          required:
+            - rootfs
+            - cores
+            - memory
+            - net0
+          properties:
+            rootfs:
+              type: string
+              description: "PVE storage for the container disk."
+            cores:
+              type: integer
+              description: "Number of virtual CPU cores."
+            memory:
+              type: integer
+              description: "Memory in bytes, use POW 2."
+            net0:
+              type: string
+              description: "Configuration for primary network interface."
+              examples:
+                - "name=eth0,bridge=vmbr0,tag=120,firewall=1,ip=dhcp"
+  include_stacks:
+    type: array
+    description: "Include other cloud stacks into the ansible inventory, from any PVE cluster within the cloud you like."
+    items:
+      type: object
+      properties:
+        stack_fqdn:
+          type: string
+          description: "Target stack fqdn to include (stack name + pve_cloud_domain). Will automatically include it from the right pve cluster."
+        host_group:
+          type: string
+          description: "This is the name of the hosts group of our ansible inventory the included vms will be under."
+        qemu_ansible_user:
+          type: string
+          description: "User ansible will use to connect if its a vm, defaults to admin. LXCs are always root."
+  lxc_global_vars:
+    type: object
+    description: "Variables that will be applied to all lxc hosts and are available in playbooks."
+    properties:
+      use_alternate_ssh_port:
+        type: boolean
+        description: "Will use 2222 instead of 22 for ssh."
+      install_prom_systemd_exporter:
+        type: boolean
+        description: "Will install prometheus metrics exporter for systemd. This implements with pve cloud terraform monitoring modules."
+    additionalProperties: true
+  pve_ha_group:
+    type: string
+    description: "When set the stack will be added to the corresponding PVE high availability group."
+  lxc_base_parameters:
+    type: object
+    description: "PVE pct cli parameters that will be used for all lxcs."
+  lxc_os_template:
+    type: string
+    description: "`pveam available --section system` / run `pveam update` for newest, PVE available LXC template (will be downloaded)."
+    example: debian-11-standard_11.7-1_amd64.tar.zst
+  root_ssh_pub_key:
+    type: string
+    description: "Public key that will be installed for the root user of all lxcs in the stack."
+  pve_cloud_pytest:
+    type: object
+    description: Variables object used only in e2e tests.
+  plugin:
+    type: string
+    description: Id of ansible inventory plugin.
+    enum:
+      - pve.cloud.lxc_inv

pve_cloud_schemas-0.0.1/src/pve_cloud_schemas/definitions/pve_cloud_inv_schema.yaml

@@ -0,0 +1,162 @@
+type: object
+title: "Cloud Inventory"
+description: "Definitions for a proxmox cloud."
+additionalProperties: false
+required:
+  - pve_cloud_domain
+  - pve_clusters
+  - pve_vm_subnet
+  - bind_master_ip
+  - bind_slave_ip
+  - bind_arpa_zone_service_lxcs
+  - bind_additional_arpa_zones
+  - bind_zone_admin_email
+  - kea_dhcp_main_ip
+  - kea_dhcp_failover_ip
+  - kea_dhcp_routers
+  - kea_dhcp_pools
+  - kea_dhcp_static_routes
+properties:
+  pve_vm_subnet:
+    type: string
+    description: "Subnet this PVE cluster uses for its VMs."
+  pve_cloud_domain:
+    type: string
+    description: "The overarching domain for the cloud. Will also be used for ddns."
+  pve_clusters:
+    type: object
+    additionalProperties: false
+    description: "Definitions for specific Proxmox clusters that will be part of the cloud. Keys are hostnames."
+    patternProperties:
+      '^.*$':
+        type: object
+        title: "PVE cluster fqdn"
+        additionalProperties: false
+        description: "Fully quantified name for the cluster."
+        required:
+          - pve_unique_cloud_services
+        properties:
+          pve_haproxy_floating_ip:
+            type: string
+            description: "Floating ip of our central cluster HAProxy."
+          pve_haproxy_floating_ip_internal:
+            type: string
+            description: "Floating ip that is exclusively accessible from inside the cloud / location. External forwardings should be made to pve_haproxy_floating_ip."
+          pve_unique_cloud_services:
+            type: array
+            description: "Unique service the cluster provides for its cloud. Unique in the sense that only one cluster may provide each of the services."
+            items:
+              type: string
+              enum:
+                - dns
+                - dhcp
+                - psql-state
+          pve_host_vars:
+            type: object
+            description: "Optional variables that will be specifically set for a pve host. Key is the simple host name."
+            properties:
+              wol_iface:
+                type: string
+                description: "Inteface wol should be enabled using ethtool."
+              tso_gso_fix:
+                type: array
+                description: "Will turn of network optimizations on old network cards, this assures they can run indefinetly. Will only take effect with the e1000_driver_fix playbook."
+              mac_iface_mapping:
+                type: array
+                description: "Map mac addresses to interface names, will be picked up by setup playbooks. This will actually change the interfaces names on the host aswell as try to replace /etc/network/interfaces."
+                items:
+                  type: object
+                  additionalProperties: false
+                  required:
+                    - mac_addr
+                    - iface
+                  properties:
+                    mac_addr:
+                      type: string
+                      description: "Network device mac address."
+                    iface:
+                      type: string
+                      description: "Interface name that will be assigned to the device. Default name will be removed!"
+  bind_master_ip:
+    type: string
+    description: "IP of the primary bind dns for this cluster, will be statically assigned."
+  bind_slave_ip:
+    type: string
+    description: "IP of the slave bind dns for this cluster."
+  bind_arpa_zone_service_lxcs:
+    type: string
+    description: "Arpa zone in which service lxcs with static ips will manuall get their reverse dns entries."
+  bind_additional_arpa_zones:
+    type: array
+    description: "Additional arpa zones which should be created and managed in the dns / dhcp ddns."
+    examples:
+      - "1.168.192.in-addr.arpa"
+  bind_zone_admin_email:
+    type: string
+    description: "Required adminstrator email in bind format for bind zones."
+    examples: 
+      - admin.example.com.
+  bind_forward_zones:
+    type: array
+    description: "Creates zone in bind and delegation ns records to the specified nameservers."
+    items:
+      type: object
+      properties:
+        zone:
+          type: string
+        nameservers:
+          type: array
+          items:
+            type: string
+  kea_dhcp_main_ip:
+    type: string
+    description: "Static assigned ip for the main dhcp server."
+  kea_dhcp_failover_ip:
+    type: string
+    description: "Static ip for slave dhcp server."
+  kea_dhcp_routers:
+    type: string
+    description: "option-data for kea dhcp routers. The default route router that the dhcp will communicate."
+    exaxmples:
+      - "192.168.1.1"
+  kea_dhcp_pools:
+    type: array
+    description: "Address pools that the dhcp allocates from. Has to be within pve_vm_subnet cidr."
+    items:
+      type: string
+      description: "IPV4 Address range in keas format."
+      examples:
+        - "192.168.1.2 - 192.168.1.199"
+  kea_dhcp_static_routes:
+    type: string
+    description: "classless-static-routes for kea option-data. Extra routes you want the dhcp to communicate, for example to a custom VPN gateway."
+    # todo: check if this overwrites the default dhcp router option, document why this was set
+    examples:
+      - "0.0.0.0/0 - 192.168.1.1, 10.0.2.0/24 - 192.168.1.217"
+  kea_dhcp_ceph_frontend_subnet:
+    type: string
+    description: "Optional cidr definition for a seperate dhcp if the ceph frontend resides on a different interface (map it inside the dhcp lxcs to pve0)."
+    examples:
+      -  "10.255.42.0/23"
+  kea_dhcp_ceph_frontend_pool:
+    type: string
+    description: "Pool kea definition for ceph frontend ip allocations, this way monitors can have their static block."
+    examples:
+      - "10.255.42.17 - 10.255.43.254"
+  acme_contact:
+    type: string
+    description: "Email address to use for acme account creation."
+  acme_method:
+    type: string
+    enum:
+      - route53
+      - ionos
+    description: "PVE Cloud included method for solving dns01 challenges."
+  pve_cloud_pytest:
+    type: object
+    description: Variables object used only in e2e tests.
+  plugin:
+    type: string
+    description: "Id of ansible inventory plugin, needs to be set exactly."
+    enum:
+      - pve.cloud.pve_cloud_inv

pve_cloud_schemas-0.0.1/src/pve_cloud_schemas/definitions/pve_inventory_schema.yaml

@@ -0,0 +1,55 @@
+type: object
+description: "Inventory file located in user home directory ~/.pve-inventory.yaml, containing all the pve clusters the user has access to via ssh."
+additionalProperties: false
+properties:
+  # dummy for schema lib
+  plugin:
+    type: string
+    description: "Id of ansible inventory plugin, needs to be set exactly."
+    enum:
+      - pve.cloud.pve_cloud_dyn_inv
+patternProperties:
+  "^.*$": 
+    type: object
+    description: "The overarching pve cloud domain. Contains multiple pve clusters."
+    patternProperties:
+      "^.*$": 
+        type: object
+        additionalProperties: false
+        description: "The identifying pve cluster domain. Synonymous with target_pve."
+        patternProperties:
+          "^.*$":
+            type: object
+            additionalProperties: false
+            description: "Hostname of a pve host (short)."
+            required:
+              - ansible_user
+              - ansible_host
+            properties:
+              ansible_user:
+                type: string
+              ansible_host:
+                type: string
+              vars:
+                type: object
+                properties:
+                  wol_iface:
+                    type: string
+                    description: Inteface wol should be enabled using ethtool.
+                  tso_gso_fix:
+                    type: array
+                    description: Will turn of network optimizations on old network cards, this assures they can run indefinetly.
+                  mac_iface_mapping:
+                    type: array
+                    description: Will setup the pve hosts networkdevices with a fixed name mapped for specified mac addresses.
+                    items:
+                      type: object
+                      additionalProperties: false
+                      required:
+                        - mac_addr
+                        - iface
+                      properties:
+                        mac_addr:
+                          type: string
+                        iface:
+                          type: string

pve_cloud_schemas-0.0.1/src/pve_cloud_schemas/definitions/qemu_inv_schema.yaml

@@ -0,0 +1,91 @@
+title: "VM Inventory"
+type: object
+description: "Inventory for deploying k8s clusters via kubespray on PVE."
+additionalProperties: false
+required:
+  - stack_name
+  - qemus
+  - target_pve
+  - root_ssh_pub_key
+properties:
+  stack_name:
+    type: string
+    description: "Your stack name, needs to be unique within the parent_domain. Will create its own sub zone."
+  target_pve:
+    type: string
+    description: "The pve cluster this stack should reside in, defined in ~/.pve-cloud-dyn-inv.yaml via `pvcli connect-cluster`"
+  qemus:
+    type: array
+    description: "Nodes for the cluster in form of qemu vms."
+    items:
+      type: object
+      properties:
+        parameters:
+          type: object
+          description: "In accordance with pve qm cli tool, creation args."
+        disk:
+          type: object
+          additionalProperties: false
+          required:
+            - size
+            - pool
+          properties:
+            size:
+              type: string
+              description: "Size of the vms disk."
+              example: 25G
+            options:
+              type: object
+              description: "Mount options"
+            pool:
+              type: string
+              description: "Ceph pool name the vms disk will be created in."
+  include_stacks:
+    type: array
+    items:
+      type: object
+      description: "Include other stacks into the ansible inventory, from any PVE cluster you like."
+      properties:
+        stack_fqdn:
+          type: string
+          description: "Target stack fqdn to include (stack name + pve_cloud_domain)" # todo: same replace as lxc inv
+        host_group:
+          type: string
+          description: "This is the name of the hosts group of our ansible inventory the included vms will be under."
+        qemu_ansible_user:
+          type: string
+          description: User ansible will use to connect, defaults to admin.
+  static_includes:
+    type: object
+  root_ssh_pub_key:
+    type: string
+    description: "Ssh key for qemu_default_user"
+  pve_ha_group:
+    type: string
+    description: "PVE HA Group this qemu instance should be assigned to."
+  qemu_default_user:
+    type: string
+    description: "User for cinit."
+  qemu_hashed_pw:
+    type: string
+    description: "The hashed password that will be passed to cloudinit. Use `mkpasswd --method=SHA-512` with the fitting method for your cinit image."
+  qemu_base_parameters:
+    type: object
+    description: "Parameters from qm create proxmox cli tool that will be passed to all created qemus."
+  qemu_image_url:
+    type: string
+    description: "http(s) download link to the cinit image you want to use."
+  qemu_keyboard_layout:
+    type: string
+    description: "The keyboard layout, can be and of de, en ...."
+  qemu_global_vars:
+    type: object
+    description: "Variables that will be applied to all lxc hosts"
+  pve_cloud_pytest:
+    type: object
+    description: Variables object used only in e2e tests.
+  plugin:
+    type: string
+    description: Id of ansible inventory plugin
+    enum:
+      - pve.cloud.qemu_inv

pve_cloud_schemas-0.0.1/src/pve_cloud_schemas/definitions/test_env_schema.yaml

@@ -0,0 +1,127 @@
+type: object
+description: "Config / Inventory file for pve cloud e2e tests. Schema is merely a merge from the main schemas of the pve_cloud collection."
+additionalProperties: false
+required:
+  - pve_test_hosts
+  - pve_test_cloud_domain
+  - pve_test_deployments_domain
+  - pve_test_cluster_name
+  - pve_test_disk_storage_id
+  - pve_test_ceph_csi_storage_id
+  - pve_test_service_lxcs_nameserver
+  - pve_test_service_lxcs_gateway
+  - pve_test_ssh_pub_key
+  - pve_test_cloud_inv
+  - pve_test_cloud_inv_cluster
+properties:
+  # dummy for schema lib
+  plugin:
+    type: string
+    description: "Id of ansible inventory plugin, needs to be set exactly."
+    enum:
+      - pve.cloud.pve_cloud_test_env
+  pve_test_hosts:
+    type: object
+    additionalProperties: false
+    patternProperties:
+      "^.*$": 
+        type: object
+        title: "PVE Host name"
+        additionalProperties: false
+        required:
+          - ansible_user
+          - ansible_host
+        properties:
+          ansible_user:
+            type: string
+          ansible_host:
+            type: string
+  pve_test_cloud_domain:
+    type: string
+  pve_test_deployments_domain:
+    type: string
+  pve_test_cluster_name:
+    type: string
+  pve_test_disk_storage_id:
+    type: string
+  pve_test_ceph_csi_storage_id:
+    type: string
+  pve_test_service_lxcs_nameserver:
+    type: string
+  pve_slop_firewall_ip:
+    type: string
+  pve_test_service_lxcs_gateway:
+    type: string
+  pve_test_ssh_pub_key:
+    type: string
+  pve_test_cloud_inv:
+    type: object
+    additionalProperties: false
+    required:
+      - pve_vm_subnet
+      - bind_master_ip
+      - bind_slave_ip
+      - bind_arpa_zone_service_lxcs
+      - bind_additional_arpa_zones
+      - bind_zone_admin_email
+      - kea_dhcp_main_ip
+      - kea_dhcp_failover_ip
+      - kea_dhcp_routers
+      - kea_dhcp_pools
+      - kea_dhcp_static_routes
+    properties:
+      pve_vm_subnet:
+        type: string
+      bind_master_ip:
+        type: string
+      bind_slave_ip:
+        type: string
+      bind_arpa_zone_service_lxcs:
+        type: string
+      bind_additional_arpa_zones:
+        type: array
+        items:
+          type: string
+      bind_zone_admin_email:
+        type: string
+      bind_forward_zones:
+        type: array
+        items:
+          type: object
+          properties:
+            zone:
+              type: string
+            nameservers:
+              type: array
+              items:
+                type: string
+      kea_dhcp_main_ip:
+        type: string
+      kea_dhcp_failover_ip:
+        type: string
+      kea_dhcp_routers:
+        type: string
+      kea_dhcp_pools:
+        type: array
+        items:
+          type: string
+      kea_dhcp_static_routes:
+        type: string
+  pve_test_host_vars:
+    patternProperties:
+      "^.*$": 
+        type: object
+        title: "PVE Host name"
+  pve_test_cloud_inv_cluster:
+    type: object
+    additionalProperties: False
+    required:
+      - pve_haproxy_floating_ip
+      - pve_haproxy_floating_ip_internal
+    properties:
+      pve_haproxy_floating_ip:
+        type: string
+      pve_haproxy_floating_ip_internal:
+        type: string
+  pve_test_tf_parameters:
+    type: object

pve_cloud_schemas-0.0.1/src/pve_cloud_schemas/extensions/setup_bind_schema_ext.yaml

@@ -0,0 +1,17 @@
+properties:
+  plugin:
+    type: string
+    description: Id of ansible inventory plugin.
+    enum:
+      - pve.cloud.lxc_inv # merge key
+  lxcs:
+    items:
+      required:
+        - vars
+      properties:
+        vars:
+          required:
+            - bind_master
+          properties:
+            bind_master:
+              type: boolean

pve_cloud_schemas-0.0.1/src/pve_cloud_schemas/extensions/setup_ceph_kea_schema_ext.yaml

@@ -0,0 +1,31 @@
+title: "Schema ext setup_ceph_kea playbook"
+properties:
+  plugin:
+    type: string
+    description: Id of ansible inventory plugin.
+    enum:
+      - pve.cloud.lxc_inv
+  lxcs:
+    items:
+      required:
+        - vars
+      properties:
+        parameters:
+          properties:
+            net0:
+              pattern: "\\bname=pve\\b"
+            net1:
+              pattern: "\\bname=cephfe\\b"
+        vars:
+          required:
+            - kea_dhcp_ceph_frontend_subnet
+            - kea_dhcp_ceph_frontend_pool
+          properties:
+            kea_dhcp_ceph_frontend_subnet:
+              type: string
+              description: "Optional definition for a seperate dhcp if the ceph frontend resides on a different interface (map it inside the dhcp lxcs to pve0)."
+            kea_dhcp_ceph_frontend_pool:
+              type: string
+              description: "Pool for ceph frontend ip allocations, this way monitors can have their static block."
+              examples:
+                - "10.255.22.17 - 10.255.23.254"

pve_cloud_schemas-0.0.1/src/pve_cloud_schemas/extensions/setup_haproxy_schema_ext.yaml

@@ -0,0 +1,28 @@
+required:
+  - static_includes
+properties:
+  plugin:
+    type: string
+    description: Id of ansible inventory plugin.
+    enum:
+      - pve.cloud.lxc_inv
+  static_includes:
+    additionalProperties: false
+    required:
+      - postgres_stack
+    properties:
+      postgres_stack:
+        type: string
+        description: Stack fqdn for postgres patroni stack.
+  lxcs:
+    items:
+      required:
+        - vars
+      properties:
+        vars:
+          required:
+            - keepalived_master
+          properties:
+            keepalived_master:
+              description: One LXC should have this set to true the other to false.
+              type: boolean

pve_cloud_schemas-0.0.1/src/pve_cloud_schemas/extensions/setup_kea_schema_ext.yaml

@@ -0,0 +1,23 @@
+title: "Schema ext setup_kea playbook"
+properties:
+  plugin:
+    type: string
+    description: Id of ansible inventory plugin.
+    enum:
+      - pve.cloud.lxc_inv
+  lxcs:
+    items:
+      required:
+        - vars
+      properties:
+        parameters:
+          properties:
+            net0:
+              pattern: "\\bname=pve\\b"
+        vars:
+          required:
+            - kea_dhcp_main
+          properties:
+            kea_dhcp_main:
+              description: "Determines the lxc that will be the dhcp master instance. One lxc should be set to true, the other to false."
+              type: boolean

pve_cloud_schemas-0.0.1/src/pve_cloud_schemas/validate.py

@@ -0,0 +1,102 @@
+import os
+import sys
+import jsonschema
+from importlib.resources import files
+import yaml
+from pathlib import Path
+import shutil
+import copy
+
+
+def recursive_merge(dict1, dict2):
+    result = copy.deepcopy(dict1)
+
+    for key, value in dict2.items():
+        if key in result:
+            if isinstance(result[key], dict) and isinstance(value, dict):
+                result[key] = recursive_merge(result[key], value)
+
+            elif isinstance(result[key], list) and isinstance(value, list):
+                # merge lists uniquely while keeping order
+                seen = set()
+                new_list = []
+                for item in result[key] + value:
+                    if item not in seen:
+                        seen.add(item)
+                        new_list.append(item)
+                result[key] = new_list
+
+            else:
+                result[key] = copy.deepcopy(value)
+        else:
+            result[key] = copy.deepcopy(value)
+
+    return result
+
+
+# this method gets called indirectly via the pve_cloud ansible collection
+# if there is a pve.cloud collection playbook is passed in the system args
+# we can load a schema extension aswell
+def validate_inventory(inventory):
+    # load base schema
+    base_schema_name = inventory["plugin"].removeprefix("pve.cloud.")
+
+    with (files("pve_cloud_schemas.definitions") / f"{base_schema_name}_schema.yaml").open("r") as f:
+        schema = yaml.safe_load(f)
+
+    called_pve_cloud_playbook = None
+    for arg in sys.argv:
+        if arg.startswith("pve.cloud."):
+            called_pve_cloud_playbook = arg.split('.')[-1].removeprefix("pve.cloud.")
+
+    if called_pve_cloud_playbook:
+        # playbook call look for schema extension
+        extension_file = files("pve_cloud_schemas.extensions") / f"{called_pve_cloud_playbook}_schema_ext.yaml"
+
+        if extension_file.is_file(): # schema extension exists
+            with extension_file.open("r") as f:
+                schema_ext = yaml.safe_load(f)
+
+            # merge with base schema 
+            schema = recursive_merge(schema, schema_ext)
+
+    
+    jsonschema.validate(instance=inventory, schema=schema)
+
+
+
+def validate_inventory_file():
+    with open(sys.argv[1], "r") as f:
+        inventory = yaml.safe_load(f)
+    
+    validate_inventory(inventory)
+
+
+def dump_schemas():
+    dump_po = Path(sys.argv[1])
+    dump_po.mkdir(parents=True, exist_ok=True)
+
+    schemas = files("pve_cloud_schemas.definitions")
+    for schema in schemas.iterdir():
+        with schema.open("rb") as src, (dump_po / schema.name).open("wb") as dest:
+            shutil.copyfileobj(src, dest)
+
+    # map schemas to their plugin id
+    schema_map = {}
+
+    for schema in schemas.iterdir():
+        with schema.open("r") as f:
+            schema_loaded = yaml.safe_load(f)
+        
+        schema_map[schema_loaded["properties"]["plugin"]["enum"][0]] = schema_loaded
+
+    # load schema extensions, merge and dump
+    for schema_ext in files("pve_cloud_schemas.extensions").iterdir():
+        with schema_ext.open("r") as f:
+            schema_ext_loaded = yaml.safe_load(f)
+        
+        schema_merged = recursive_merge(schema_map[schema_ext_loaded["properties"]["plugin"]["enum"][0]], schema_ext_loaded)
+
+        # write it
+        with (dump_po / schema_ext.name).open("w") as f:
+            yaml.dump(schema_merged, f, sort_keys=False, indent=2)

pve_cloud_schemas-0.0.1/src/pve_cloud_schemas.egg-info/PKG-INFO

@@ -0,0 +1,7 @@
+Metadata-Version: 2.4
+Name: pve-cloud-schemas
+Version: 0.0.1
+Author-email: Tobias Huebner <tobias.huebner@vmzberlin.com>
+License-Expression: GPL-3.0-or-later
+Requires-Dist: PyYAML==6.0.2
+Requires-Dist: jsonschema==4.23.0

pve_cloud_schemas-0.0.1/src/pve_cloud_schemas.egg-info/SOURCES.txt

@@ -0,0 +1,21 @@
+README.md
+pyproject.toml
+src/pve_cloud_schemas/_version.py
+src/pve_cloud_schemas/validate.py
+src/pve_cloud_schemas.egg-info/PKG-INFO
+src/pve_cloud_schemas.egg-info/SOURCES.txt
+src/pve_cloud_schemas.egg-info/dependency_links.txt
+src/pve_cloud_schemas.egg-info/entry_points.txt
+src/pve_cloud_schemas.egg-info/requires.txt
+src/pve_cloud_schemas.egg-info/top_level.txt
+src/pve_cloud_schemas/definitions/awx_cloud_inv_schema.yaml
+src/pve_cloud_schemas/definitions/kubespray_inv_schema.yaml
+src/pve_cloud_schemas/definitions/lxc_inv_schema.yaml
+src/pve_cloud_schemas/definitions/pve_cloud_inv_schema.yaml
+src/pve_cloud_schemas/definitions/pve_inventory_schema.yaml
+src/pve_cloud_schemas/definitions/qemu_inv_schema.yaml
+src/pve_cloud_schemas/definitions/test_env_schema.yaml
+src/pve_cloud_schemas/extensions/setup_bind_schema_ext.yaml
+src/pve_cloud_schemas/extensions/setup_ceph_kea_schema_ext.yaml
+src/pve_cloud_schemas/extensions/setup_haproxy_schema_ext.yaml
+src/pve_cloud_schemas/extensions/setup_kea_schema_ext.yaml

pve_cloud_schemas-0.0.1/src/pve_cloud_schemas.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pve_cloud_schemas-0.0.1/src/pve_cloud_schemas.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+pcval = pve_cloud_schemas.validate:validate_inventory_file
+pcval-dump = pve_cloud_schemas.validate:dump_schemas

pve_cloud_schemas-0.0.1/src/pve_cloud_schemas.egg-info/requires.txt

@@ -0,0 +1,2 @@
+PyYAML==6.0.2
+jsonschema==4.23.0

pve_cloud_schemas-0.0.1/src/pve_cloud_schemas.egg-info/top_level.txt

@@ -0,0 +1 @@
+pve_cloud_schemas