task_v1alpha1.json

{
  "description": "Task is the Schema for the Task API.",
  "properties": {
    "apiVersion": {
      "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
      "type": "string"
    },
    "kind": {
      "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "description": "TaskSpec defines the desired state of Task.",
      "properties": {
        "connection": {
          "description": "Connection represents the Machine connectivity information.",
          "properties": {
            "authSecretRef": {
              "description": "AuthSecretRef is the SecretReference that contains authentication information of the Machine. The Secret must contain username and password keys.",
              "properties": {
                "name": {
                  "description": "name is unique within a namespace to reference a secret resource.",
                  "type": "string"
                },
                "namespace": {
                  "description": "namespace defines the space within which the secret name must be unique.",
                  "type": "string"
                }
              },
              "type": "object",
              "additionalProperties": false
            },
            "host": {
              "description": "Host is the host IP address or hostname of the Machine.",
              "minLength": 1,
              "type": "string"
            },
            "insecureTLS": {
              "description": "InsecureTLS specifies trusted TLS connections.",
              "type": "boolean"
            },
            "port": {
              "default": 623,
              "description": "Port is the port number for connecting with the Machine.",
              "type": "integer"
            }
          },
          "required": [
            "authSecretRef",
            "host",
            "insecureTLS",
            "port"
          ],
          "type": "object",
          "additionalProperties": false
        },
        "task": {
          "description": "Task defines the specific action to be performed.",
          "maxProperties": 1,
          "properties": {
            "oneTimeBootDeviceAction": {
              "description": "OneTimeBootDeviceAction represents a baseboard management one time set boot device operation.",
              "properties": {
                "device": {
                  "description": "Devices represents the boot devices, in order for setting one time boot. Currently only the first device in the slice is used to set one time boot.",
                  "items": {
                    "description": "BootDevice represents boot device of the Machine.",
                    "type": "string"
                  },
                  "type": "array"
                },
                "efiBoot": {
                  "description": "EFIBoot instructs the machine to use EFI boot.",
                  "type": "boolean"
                }
              },
              "required": [
                "device"
              ],
              "type": "object",
              "additionalProperties": false
            },
            "powerAction": {
              "description": "PowerAction represents a baseboard management power operation.",
              "enum": [
                "on",
                "off",
                "soft",
                "status",
                "cycle",
                "reset"
              ],
              "type": "string"
            },
            "virtualMediaAction": {
              "description": "VirtualMediaAction represents a baseboard management virtual media insert/eject.",
              "properties": {
                "kind": {
                  "type": "string"
                },
                "mediaURL": {
                  "description": "mediaURL represents the URL of the image to be inserted into the virtual media, or empty to eject media.",
                  "type": "string"
                }
              },
              "required": [
                "kind"
              ],
              "type": "object",
              "additionalProperties": false
            }
          },
          "type": "object",
          "additionalProperties": false
        }
      },
      "required": [
        "task"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "description": "TaskStatus defines the observed state of Task",
      "properties": {
        "completionTime": {
          "description": "CompletionTime represents time when the task was completed. The completion time is only set when the task finishes successfully.",
          "format": "date-time",
          "type": "string"
        },
        "conditions": {
          "description": "Conditions represents the latest available observations of an object's current state.",
          "items": {
            "properties": {
              "message": {
                "description": "Message represents human readable message indicating details about last transition.",
                "type": "string"
              },
              "status": {
                "description": "Status is the status of the Task condition. Can be True or False.",
                "type": "string"
              },
              "type": {
                "description": "Type of the Task condition.",
                "type": "string"
              }
            },
            "required": [
              "status",
              "type"
            ],
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "startTime": {
          "description": "StartTime represents time when the Task started processing.",
          "format": "date-time",
          "type": "string"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  },
  "type": "object"
}