v1OverlordVsphereCloudConfig

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/spectro-cloud/main/json-schema/spectro-cloud-v1-overlord-vsphere-cloud-config-schema.json",
  "title": "v1OverlordVsphereCloudConfig",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/spectro-cloud-overlords-api-openapi.yml#/components/schemas/v1OverlordVsphereCloudConfig",
  "properties": {
    "clusterConfig": {
      "$ref": "#/$defs/v1VsphereOverlordClusterConfigEntity"
    },
    "clusterProfiles": {
      "description": "Cluster profiles pack configuration for private gateway cluster",
      "items": {
        "$ref": "#/$defs/v1SpectroClusterProfileEntity"
      },
      "type": "array"
    },
    "clusterSettings": {
      "$ref": "#/$defs/v1ClusterConfigEntity",
      "description": "clusterSettings is the generic configuration related to a cluster like OS patch, Rbac, Namespace allocation"
    },
    "size": {
      "description": "size of the pool, number of machines",
      "format": "int32",
      "type": "integer"
    }
  },
  "$defs": {
    "v1ClusterConfigEntity": {
      "properties": {
        "clusterMetaAttribute": {
          "description": "ClusterMetaAttribute can be used to set additional cluster metadata information.",
          "type": "string"
        },
        "controlPlaneHealthCheckTimeout": {
          "type": "string"
        },
        "hostClusterConfig": {
          "$ref": "#/$defs/v1HostClusterConfig"
        },
        "hyperShiftConfig": {
          "$ref": "#/$defs/v1HyperShiftConfig"
        },
        "lifecycleConfig": {
          "$ref": "#/$defs/v1LifecycleConfig"
        },
        "location": {
          "$ref": "#/$defs/v1ClusterLocation"
        },
        "machineManagementConfig": {
          "$ref": "#/$defs/v1MachineManagementConfig"
        },
        "resources": {
          "$ref": "#/$defs/v1ClusterResourcesEntity"
        },
        "timezone": {
          "description": "Timezone of a cluster in IANA standard format. It is mandatory field if cluster is deployed through template, else it is optional",
          "type": "string"
        },
        "updateWorkerPoolsInParallel": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "v1ClusterDeploymentType": {
      "description": "Defines the deployment type for HyperShift-enabled clusters.\n- 'hypershift': Indicates a HyperShift management cluster that hosts control planes for other clusters.\n- 'openshift': Indicates an OpenShift cluster whose control plane is hosted on a HyperShift management cluster.",
      "enum": [
        "hypershift",
        "openshift"
      ],
      "type": "string"
    },
    "v1ClusterLocation": {
      "description": "Cluster location information",
      "properties": {
        "countryCode": {
          "description": "country code for cluster location",
          "type": "string"
        },
        "countryName": {
          "description": "country name for cluster location",
          "type": "string"
        },
        "geoLoc": {
          "$ref": "#/$defs/v1GeolocationLatlong"
        },
        "regionCode": {
          "description": "region code for cluster location",
          "type": "string"
        },
        "regionName": {
          "description": "region name for cluster location",
          "type": "string"
        }
      },
      "type": "object"
    },
    "v1ClusterNamespaceResourceAllocation": {
      "description": "Cluster namespace resource allocation",
      "properties": {
        "cpuCores": {
          "type": "number",
          "exclusiveMinimum": 0
        },
        "gpuConfig": {
          "$ref": "#/$defs/v1GpuConfig"
        },
        "memoryMiB": {
          "type": "number",
          "exclusiveMinimum": 0
        }
      }
    },
    "v1ClusterNamespaceResourceInputEntity": {
      "description": "Cluster Namespace resource definition",
      "properties": {
        "metadata": {
          "$ref": "#/$defs/v1ObjectMetaUpdateEntity"
        },
        "spec": {
          "$ref": "#/$defs/v1ClusterNamespaceSpec"
        }
      },
      "type": "object"
    },
    "v1ClusterNamespaceSpec": {
      "description": "Cluster namespace spec",
      "properties": {
        "isRegex": {
          "type": "boolean",
          "x-omitempty": false
        },
        "relatedObject": {
          "$ref": "#/$defs/v1RelatedObject"
        },
        "resourceAllocation": {
          "$ref": "#/$defs/v1ClusterNamespaceResourceAllocation"
        }
      }
    },
    "v1ClusterRbacBinding": {
      "description": "Cluster RBAC binding",
      "properties": {
        "namespace": {
          "type": "string"
        },
        "role": {
          "$ref": "#/$defs/v1ClusterRoleRef"
        },
        "subjects": {
          "items": {
            "$ref": "#/$defs/v1ClusterRbacSubjects"
          },
          "type": "array",
          "uniqueItems": true
        },
        "type": {
          "enum": [
            "RoleBinding",
            "ClusterRoleBinding"
          ],
          "type": "string"
        }
      },
      "type": "object"
    },
    "v1ClusterRbacInputEntity": {
      "description": "Cluster RBAC role binding defintion",
      "properties": {
        "metadata": {
          "$ref": "#/$defs/v1ObjectMetaUpdateEntity"
        },
        "spec": {
          "$ref": "#/$defs/v1ClusterRbacSpec"
        }
      },
      "type": "object"
    },
    "v1ClusterRbacSpec": {
      "description": "Cluster RBAC spec",
      "properties": {
        "bindings": {
          "items": {
            "$ref": "#/$defs/v1ClusterRbacBinding"
          },
          "type": "array",
          "uniqueItems": true
        },
        "isSystem": {
          "default": false,
          "description": "Set to true when the binding is created automatically by the system, rather than manually by the user",
          "type": "boolean"
        },
        "relatedObject": {
          "$ref": "#/$defs/v1RelatedObject"
        }
      },
      "type": "object"
    },
    "v1ClusterRbacSubjects": {
      "description": "Cluster role ref",
      "properties": {
        "name": {
          "type": "string"
        },
        "namespace": {
          "type": "string"
        },
        "type": {
          "enum": [
            "User",
            "Group",
            "ServiceAccount"
          ],
          "type": "string"
        }
      },
      "type": "object"
    },
    "v1ClusterResourcesEntity": {
      "properties": {
        "namespaces": {
          "items": {
            "$ref": "#/$defs/v1ClusterNamespaceResourceInputEntity"
          },
          "type": "array",
          "uniqueItems": true
        },
        "rbacs": {
          "items": {
            "$ref": "#/$defs/v1ClusterRbacInputEntity"
          },
          "type": "array",
          "uniqueItems": true
        }
      },
      "type": "object"
    },
    "v1ClusterRoleRef": {
      "description": "Cluster role ref",
      "properties": {
        "kind": {
          "enum": [
            "Role",
            "ClusterRole"
          ],
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "v1ControlPlaneEndPoint": {
      "properties": {
        "ddnsSearchDomain": {
          "description": "DDNSSearchDomain is the search domain used for resolving IP addresses when the EndpointType is DDNS. This search domain is appended to the generated Hostname to obtain the complete DNS name for the endpoint. If Host is already a DDNS FQDN, DDNSSearchDomain is not required",
          "type": "string"
        },
        "host": {
          "description": "IP or FQDN(External/DDNS)",
          "type": "string"
        },
        "type": {
          "description": "VIP or External",
          "enum": [
            "VIP",
            "External",
            "DDNS"
          ],
          "type": "string"
        }
      },
      "type": "object"
    },
    "v1GeolocationLatlong": {
      "description": "Geolocation Latlong entity",
      "properties": {
        "latitude": {
          "description": "Latitude of a resource",
          "format": "float64",
          "type": "number",
          "x-omitempty": false
        },
        "longitude": {
          "description": "Longitude of a resource",
          "format": "float64",
          "type": "number",
          "x-omitempty": false
        }
      },
      "type": "object"
    },
    "v1GpuConfig": {
      "description": "GPU configuration for resource allocation",
      "properties": {
        "limit": {
          "description": "GPU resource limit",
          "format": "int32",
          "minimum": -1,
          "type": "integer",
          "x-omitempty": false
        },
        "provider": {
          "default": "nvidia",
          "description": "GPU provider (only nvidia is supported currently)",
          "enum": [
            "nvidia"
          ],
          "type": "string"
        }
      }
    },
    "v1HostClusterConfig": {
      "properties": {
        "clusterEndpoint": {
          "$ref": "#/$defs/v1HostClusterEndpoint",
          "description": "host cluster configuration"
        },
        "clusterGroup": {
          "$ref": "#/$defs/v1ObjectReference",
          "description": "cluster group reference"
        },
        "hostCluster": {
          "$ref": "#/$defs/v1ObjectReference",
          "description": "host cluster reference"
        },
        "isHostCluster": {
          "default": false,
          "description": "is enabled as host cluster",
          "type": "boolean",
          "x-omitempty": false
        }
      }
    },
    "v1HostClusterEndpoint": {
      "properties": {
        "config": {
          "$ref": "#/$defs/v1HostClusterEndpointConfig"
        },
        "type": {
          "description": "is enabled as host cluster",
          "enum": [
            "Ingress",
            "LoadBalancer"
          ],
          "type": "string"
        }
      }
    },
    "v1HostClusterEndpointConfig": {
      "properties": {
        "ingressConfig": {
          "$ref": "#/$defs/v1IngressConfig"
        },
        "loadBalancerConfig": {
          "$ref": "#/$defs/v1LoadBalancerConfig"
        }
      }
    },
    "v1HyperShiftConfig": {
      "description": "HyperShiftConfig defines the configuration for HyperShift and OpenShift clusters.\nThis configuration is only applicable to MaaS clusters.\n",
      "properties": {
        "clusterDeploymentType": {
          "$ref": "#/$defs/v1ClusterDeploymentType"
        },
        "hostClusterUid": {
          "description": "The UID of the host HyperShift cluster.\nThis field is required only when clusterDeploymentType is set to 'openshift'.\nMust reference a valid HyperShift cluster.\n",
          "type": "string"
        }
      },
      "type": "object"
    },
    "v1IngressConfig": {
      "description": "Ingress configuration for exposing the virtual cluster's kube-apiserver",
      "properties": {
        "host": {
          "type": "string"
        },
        "port": {
          "format": "int64",
          "type": "integer"
        }
      }
    },
    "v1LifecycleConfig": {
      "properties": {
        "pause": {
          "default": false,
          "description": "enable pause life cycle config",
          "type": "boolean",
          "x-omitempty": false
        }
      }
    },
    "v1LoadBalancerConfig": {
      "description": "Load balancer configuration for exposing the virtual cluster's kube-apiserver",
      "properties": {
        "externalIPs": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "externalTrafficPolicy": {
          "type": "string"
        },
        "loadBalancerSourceRanges": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      }
    },
    "v1MachineManagementConfig": {
      "properties": {
        "osPatchConfig": {
          "$ref": "#/$defs/v1OsPatchConfig",
          "description": "OS patch config contains properties to patch node os with latest security packages. \nIf OsPatchConfig is not provided then node os will not be patched with latest security updates.\nNote: For edge based cluster (like edge-native type) the osPatchConfig is NOT applicable, the values will be ignored.\n"
        }
      },
      "type": "object"
    },
    "v1ManifestRefUpdateEntity": {
      "description": "Manifest update request payload",
      "properties": {
        "content": {
          "description": "Manifest content in yaml",
          "type": "string"
        },
        "name": {
          "description": "Manifest name",
          "type": "string"
        },
        "uid": {
          "description": "Manifest uid",
          "type": "string"
        }
      },
      "required": [
        "name"
      ]
    },
    "v1ObjectMetaUpdateEntity": {
      "description": "ObjectMeta update entity with uid as input",
      "properties": {
        "annotations": {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        "name": {
          "type": "string"
        },
        "uid": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "v1ObjectReference": {
      "description": "ObjectReference contains enough information to let you inspect or modify the referred object.",
      "properties": {
        "kind": {
          "description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
          "type": "string"
        },
        "name": {
          "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
          "type": "string"
        },
        "uid": {
          "description": "UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids",
          "type": "string"
        }
      },
      "type": "object"
    },
    "v1OsPatchConfig": {
      "properties": {
        "onDemandPatchAfter": {
          "$ref": "#/$defs/v1Time",
          "description": "OnDemandPatchAfter is the desired time for one time on-demand patch"
        },
        "patchOnBoot": {
          "description": "PatchOnBoot indicates need to do patch when node first boot up, only once",
          "type": "boolean",
          "x-omitempty": false
        },
        "rebootIfRequired": {
          "description": "Reboot once the OS patch is applied",
          "type": "boolean",
          "x-omitempty": false
        },
        "schedule": {
          "description": "The schedule at which security patches will be applied to OS. Schedule should be in Cron format, see https://en.wikipedia.org/wiki/Cron for more help.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "v1PackType": {
      "default": "spectro",
      "enum": [
        "spectro",
        "helm",
        "manifest",
        "oci"
      ],
      "type": "string"
    },
    "v1PackValuesEntity": {
      "description": "Pack values entity to refer the existing pack for the values override",
      "properties": {
        "manifests": {
          "description": "Pack manifests are additional content as part of the profile",
          "items": {
            "$ref": "#/$defs/v1ManifestRefUpdateEntity"
          },
          "type": "array"
        },
        "name": {
          "description": "Pack name",
          "type": "string"
        },
        "tag": {
          "description": "Pack version tag",
          "type": "string"
        },
        "type": {
          "$ref": "#/$defs/v1PackType"
        },
        "values": {
          "description": "Pack values represents the values.yaml used as input parameters either Params OR Values should be used, not both If both applied at the same time, will only use Values",
          "type": "string"
        }
      },
      "required": [
        "name"
      ],
      "type": "object"
    },
    "v1RelatedObject": {
      "description": "Object for which the resource is related",
      "properties": {
        "kind": {
          "enum": [
            "spectrocluster",
            "machine",
            "cloudconfig",
            "clusterprofile",
            "pack",
            "appprofile",
            "appdeployment",
            "edgehost"
          ],
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "uid": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "v1SpectroClusterProfileEntity": {
      "description": "Cluster profile request payload",
      "properties": {
        "packValues": {
          "description": "Cluster profile packs array",
          "items": {
            "$ref": "#/$defs/v1PackValuesEntity"
          },
          "type": "array",
          "uniqueItems": true
        },
        "replaceWithProfile": {
          "description": "Cluster profile uid to be replaced with new profile",
          "type": "string"
        },
        "uid": {
          "description": "Cluster profile uid",
          "type": "string"
        },
        "variables": {
          "items": {
            "$ref": "#/$defs/v1SpectroClusterVariable"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "v1SpectroClusterVariable": {
      "description": "Variable with value which will be used within the packs of cluster profile",
      "properties": {
        "name": {
          "description": "Variable name",
          "type": "string"
        },
        "value": {
          "description": "Actual value of the variable to be used within the cluster",
          "type": "string"
        }
      },
      "required": [
        "name"
      ],
      "type": "object"
    },
    "v1Time": {
      "description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON.  Wrappers are provided for many of the factory methods that the time package offers.",
      "format": "date-time",
      "type": "string"
    },
    "v1VsphereNetworkConfigEntity": {
      "properties": {
        "networkName": {
          "description": "NetworkName is the name of the network in which VMs are created/located.",
          "type": "string"
        },
        "parentPoolUid": {
          "description": "ParentPoolRef Uid to the ParentPool which allocates IPs for this IPPool",
          "type": "string"
        },
        "staticIp": {
          "description": "support dhcp or static IP, if false, use DHCP",
          "type": "boolean"
        }
      },
      "required": [
        "networkName"
      ],
      "type": "object"
    },
    "v1VsphereOverlordClusterConfigEntity": {
      "properties": {
        "controlPlaneEndpoint": {
          "$ref": "#/$defs/v1ControlPlaneEndPoint",
          "description": "The optional control plane endpoint, which can be an IP or FQDN"
        },
        "ntpServers": {
          "description": "NTPServers is a list of NTP servers to use instead of the machine image's default NTP server list.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "placements": {
          "description": "Placements configuration Placements If defined, will replace default values defined in VsphereClusterConfig Array means one MachinePool can span across multiple vsphere compute cluster",
          "items": {
            "$ref": "#/$defs/v1VspherePlacementConfigEntity"
          },
          "type": "array"
        },
        "sshKeys": {
          "description": "SSHKeys specifies a list of ssh authorized keys for the 'spectro' user",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "staticIp": {
          "description": "whether this cluster should use dhcp or static IP, if false, use DHCP if this is set, then all machinepools should have staticIP with provided IPPool adding this as an additional standalone flag without relating to placement.Nework main reason is to enable more validation for placement.Network.StaticIP which should come together with valid Network.IPPool and Network.Name",
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "v1VspherePlacementConfigEntity": {
      "description": "Both ClusterConfig and MachinePoolConfig will have PlacementConfig MachinePoolconfig.Placements will overwrite values defined in ClusterConfig Currently the convention is: Datacenter / Folder / ImageTemplateFolder / Network should be defined at ClusterConfig Cluster / ResourcePool / Datastore / Network is defined at MachinePool ClusterConfig Network should only indicate use DHCP or not MachinePool Network should contain the actual network and IPPool",
      "properties": {
        "cluster": {
          "description": "Cluster is the computecluster in vsphere",
          "type": "string"
        },
        "datacenter": {
          "description": "Datacenter is the name or inventory path of the datacenter where this machine's VM is created/located.",
          "type": "string"
        },
        "datastore": {
          "description": "Datastore is the datastore in which VMs are created/located.",
          "type": "string"
        },
        "folder": {
          "description": "Folder is the folder in which VMs are created/located.",
          "type": "string"
        },
        "imageTemplateFolder": {
          "description": "ImageTemplateFolder is the folder in which VMs templates are created/located. if empty will use default value spectro-templates",
          "type": "string"
        },
        "network": {
          "$ref": "#/$defs/v1VsphereNetworkConfigEntity",
          "description": "network info"
        },
        "resourcePool": {
          "description": "ResourcePool is the resource pool within the above computecluster Cluster",
          "type": "string"
        },
        "storagePolicyName": {
          "description": "StoragePolicyName of the storage policy to use with this Virtual Machine",
          "type": "string"
        },
        "uid": {
          "description": "UID for this placement",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}