ClusterInput

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/outscale/json-schema/outscale-cluster-input-schema.json",
  "title": "ClusterInput",
  "x-generated": "2026-10-28",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/outscale-oks-openapi.yml#/components/schemas/ClusterInput",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 40,
      "minLength": 1,
      "pattern": "^[a-z][a-z0-9-]*[a-z0-9]$",
      "title": "Cluster Name",
      "description": "Unique cluster name per project, must start with a letter and contain only lowercase letters, numbers, or hyphens"
    },
    "project_id": {
      "type": "string",
      "title": "Project ID",
      "description": "Unique identifier of the project this cluster belongs to"
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "cp_multi_az": {
      "type": "boolean",
      "title": "Control Plane Multi-AZ",
      "description": "Flag to enable multi-availability zone for the control plane"
    },
    "cp_subregions": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Control Plane Subregions",
      "description": "List of subregions where control plane components are deployed",
      "default": []
    },
    "version": {
      "type": "string",
      "title": "Kubernetes Version",
      "description": "Version of Kubernetes to be deployed"
    },
    "admin_lbu": {
      "type": "boolean",
      "title": "Admin LBU",
      "description": "Flag to enable admin load balancer for cluster management",
      "default": false
    },
    "admission_flags": {
      "allOf": [
        {
          "$ref": "#/$defs/AdmissionFlagsInput"
        }
      ],
      "title": "Admission Flags",
      "description": "Configuration for Kubernetes admission controllers",
      "default": {}
    },
    "cidr_pods": {
      "type": "string",
      "title": "Pods CIDR",
      "description": "CIDR block for Kubernetes pods network"
    },
    "cidr_service": {
      "type": "string",
      "title": "Service CIDR",
      "description": "CIDR block for Kubernetes services network"
    },
    "cluster_dns": {
      "type": "string",
      "title": "Cluster DNS",
      "description": "IP address for cluster DNS service"
    },
    "tags": {
      "additionalProperties": {
        "type": "string"
      },
      "type": [
        "object",
        "null"
      ]
    },
    "auto_maintenances": {
      "allOf": [
        {
          "$ref": "#/$defs/AutoMaintenances"
        }
      ],
      "title": "Auto Maintenances",
      "description": "Use 'maintenance_window' instead",
      "deprecated": true
    },
    "maintenance_window": {
      "allOf": [
        {
          "$ref": "#/$defs/Maintenance"
        }
      ],
      "title": "Maintenance Window",
      "description": "Configuration for automated maintenance windows"
    },
    "control_planes": {
      "type": "string",
      "title": "Control Planes",
      "description": "Size of control plane deployment for the cluster",
      "default": "cp.3.masters.small"
    },
    "admin_whitelist": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Admin Whitelist",
      "description": "List of CIDR blocks or IP addresses allowed to access the Kubernetes API"
    },
    "quirks": {
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "disable_api_termination": {
      "type": "boolean",
      "title": "Disable API Termination",
      "description": "Flag to prevent accidental cluster deletion",
      "default": false
    },
    "auth": {
      "allOf": [
        {
          "$ref": "#/$defs/AuthStrategy"
        }
      ],
      "nullable": true
    }
  },
  "type": "object",
  "required": [
    "name",
    "project_id",
    "version",
    "cidr_pods",
    "cidr_service",
    "admin_whitelist"
  ],
  "$defs": {
    "AdmissionFlagsInput": {
      "properties": {
        "disable_admission_plugins": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Disable Admission Plugins",
          "description": "List of Kubernetes admission plugins to disable"
        },
        "enable_admission_plugins": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Enable Admission Plugins",
          "description": "List of Kubernetes admission plugins to enable"
        }
      },
      "type": "object",
      "title": "AdmissionFlagsInput"
    },
    "AuthStrategy": {
      "properties": {
        "oidc": {
          "allOf": [
            {
              "$ref": "#/$defs/OpenIdConnectConfig"
            }
          ],
          "title": "OpenID Connect Authentication",
          "description": "Configuration for authenticating to the cluster using OpenID Connect (OIDC)."
        }
      },
      "type": "object",
      "required": [
        "oidc"
      ],
      "title": "AuthStrategy"
    },
    "AutoMaintenances": {
      "properties": {
        "minor_upgrade_maintenance": {
          "allOf": [
            {
              "$ref": "#/$defs/MaintenanceWindow"
            }
          ],
          "title": "Minor Upgrade Maintenance",
          "description": "Maintenance window configuration for minor Kubernetes upgrades"
        },
        "patch_upgrade_maintenance": {
          "allOf": [
            {
              "$ref": "#/$defs/MaintenanceWindow"
            }
          ],
          "title": "Patch Upgrade Maintenance",
          "description": "Maintenance window configuration for patch Kubernetes upgrades"
        }
      },
      "type": "object",
      "required": [
        "minor_upgrade_maintenance",
        "patch_upgrade_maintenance"
      ],
      "title": "AutoMaintenances"
    },
    "Maintenance": {
      "properties": {
        "duration_hours": {
          "type": "integer",
          "maximum": 23.0,
          "minimum": 0.0,
          "title": "Duration Hours",
          "description": "Duration of the maintenance window in hours"
        },
        "start_hour": {
          "type": "integer",
          "maximum": 23.0,
          "minimum": 0.0,
          "title": "Start Hour",
          "description": "Hour of the day when maintenance window starts (0-23)"
        },
        "week_day": {
          "type": "string",
          "enum": [
            "Mon",
            "Tue",
            "Wed",
            "Thu",
            "Fri",
            "Sat",
            "Sun",
            "string"
          ],
          "title": "Week Day",
          "description": "Day of the week for the maintenance window"
        },
        "tz": {
          "type": "string",
          "title": "Timezone",
          "description": "Timezone for the maintenance window",
          "default": "UTC"
        }
      },
      "type": "object",
      "required": [
        "duration_hours",
        "start_hour",
        "week_day"
      ],
      "title": "Maintenance"
    },
    "MaintenanceWindow": {
      "properties": {
        "enabled": {
          "type": "boolean",
          "title": "Enabled",
          "description": "Flag to enable or disable the maintenance window",
          "default": true
        },
        "duration_hours": {
          "type": "integer",
          "maximum": 23.0,
          "minimum": 0.0,
          "title": "Duration Hours",
          "description": "Duration of the maintenance window in hours",
          "default": 0
        },
        "start_hour": {
          "type": "integer",
          "maximum": 23.0,
          "minimum": 0.0,
          "title": "Start Hour",
          "description": "Hour of the day when maintenance window starts (0-23)",
          "default": 12
        },
        "week_day": {
          "type": "string",
          "enum": [
            "Mon",
            "Tue",
            "Wed",
            "Thu",
            "Fri",
            "Sat",
            "Sun",
            "string"
          ],
          "title": "Week Day",
          "description": "Day of the week for the maintenance window",
          "default": "Tue"
        },
        "tz": {
          "type": "string",
          "title": "Timezone",
          "description": "Timezone for the maintenance window",
          "default": "UTC"
        }
      },
      "type": "object",
      "title": "MaintenanceWindow"
    },
    "OpenIdConnectConfig": {
      "properties": {
        "issuer-url": {
          "type": "string",
          "title": "OIDC Issuer URL",
          "description": "The URL of the provider that allows the API server to discover public signing keys."
        },
        "client-id": {
          "type": "string",
          "title": "OIDC Client ID",
          "description": "The client id that all tokens must be issued for."
        },
        "username-claim": {
          "type": [
            "string",
            "null"
          ]
        },
        "username-prefix": {
          "type": [
            "string",
            "null"
          ]
        },
        "groups-claim": {
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "groups-prefix": {
          "type": [
            "string",
            "null"
          ]
        },
        "required-claim": {
          "additionalProperties": {
            "type": "string"
          },
          "type": [
            "object",
            "null"
          ]
        }
      },
      "type": "object",
      "required": [
        "issuer-url",
        "client-id"
      ],
      "title": "OpenIdConnectConfig"
    }
  }
}