• Русский
  • Connector [resourceinterfaces.alauda.io/v1alpha1]

    Description
    ResourceInterface is the Schema for the resourceinterfaces API ResourceInterface defines a reusable template for creating PipelineIntegrations with specific parameters and outputs. It supports inheritance through the extends field and provides a way to standardize resource definitions across different connector implementations.
    Type
    object

    Specification

    PropertyTypeDescription
    apiVersionstring

    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

    kindstring

    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

    metadataObjectMeta

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    specobject

    Spec defines the desired state of ResourceInterface

    .spec

    Description
    Spec defines the desired state of ResourceInterface
    Type
    object
    PropertyTypeDescription
    attributesarray

    Attributes defines the attributes that will be available when creating PipelineIntegration instances.

    configurationsobject

    Configuration defines the additional configuration for this ResourceInterface, which will be passed to the PipelineIntegration instance as annotations. Each key maps to a configuration entry containing a value and optional metadata.

    paramsarray

    Params defines the parameters required to construct a PipelineIntegration. These parameters will be used when creating PipelineIntegration instances.

    workspacesarray

    Workspaces defines the workspaces that will be available when creating PipelineIntegration instances.

    .spec.attributes

    Description
    Attributes defines the attributes that will be available when creating PipelineIntegration instances.
    Type
    array

    .spec.attributes[]

    Description
    ResourceInterfaceAttributeSpec defines attribute specification for ResourceInterface
    Type
    object
    Required
    name
    PropertyTypeDescription
    annotationsobject

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.

    default

    Default is the value a parameter takes if no input value is supplied.

    dependsOnarray

    DependsOn defines the dependencies of this parameter. it could be the name of other parameters or connectors

    descriptionstring

    Description is a user-facing description of the parameter that may be used to populate a UI.

    enumarray

    Enum declares a set of allowed param input values. If Enum is not set, no input validation is performed for the param.

    expressionstring

    Expression defines a custom expression to compute the value. The expression can access connector and params of current PipelineIntegration.

    namestring

    Name declares the name by which a parameter is referenced.

    parameterizeobject

    Parameterize defines the parameterization configuration for this parameter.

    propertiesobject

    Properties is the JSON Schema properties to support key-value pairs parameter.

    typestring

    Type is the user-specified type of the parameter. The possible types are currently "string", "array" and "object", and "string" is the default.

    .spec.attributes[].annotations

    Description
    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
    Type
    object

    .spec.attributes[].dependsOn

    Description
    DependsOn defines the dependencies of this parameter. it could be the name of other parameters or connectors
    Type
    array

    .spec.attributes[].dependsOn[]

    Type
    string

    .spec.attributes[].enum

    Description
    Enum declares a set of allowed param input values. If Enum is not set, no input validation is performed for the param.
    Type
    array

    .spec.attributes[].enum[]

    Type
    string

    .spec.attributes[].parameterize

    Description
    Parameterize defines the parameterization configuration for this parameter.
    Type
    object
    PropertyTypeDescription
    disableboolean

    Disable indicates whether parameterization is disabled for this parameter/workspace.

    namestring

    Name is the default parameter name when this parameter/workspace is parameterized during PipelineResource construction.

    .spec.attributes[].properties

    Description
    Properties is the JSON Schema properties to support key-value pairs parameter.
    Type
    object

    .spec.configurations

    Description
    Configuration defines the additional configuration for this ResourceInterface, which will be passed to the PipelineIntegration instance as annotations. Each key maps to a configuration entry containing a value and optional metadata.
    Type
    object
    PropertyTypeDescription
    multipleMergeConnectorsobject

    MultipleMergeConnectors defines the configuration for enabling multiple connectors merge in PipelineIntegration. When this configuration is enabled, multiple connectors will be merged when creating PipelineIntegration.

    .spec.configurations.multipleMergeConnectors

    Description
    MultipleMergeConnectors defines the configuration for enabling multiple connectors merge in PipelineIntegration. When this configuration is enabled, multiple connectors will be merged when creating PipelineIntegration.
    Type
    object
    PropertyTypeDescription
    descriptionstring

    Description provides a human-readable description of this configuration entry.

    enabledboolean

    Enabled indicates whether this configuration is enabled.

    .spec.params

    Description
    Params defines the parameters required to construct a PipelineIntegration. These parameters will be used when creating PipelineIntegration instances.
    Type
    array

    .spec.params[]

    Description
    ParamSpec defines arbitrary parameters needed beyond typed inputs (such as resources).
    Type
    object
    Required
    name
    PropertyTypeDescription
    annotationsobject

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.

    default

    Default is the value a parameter takes if no input value is supplied.

    descriptionstring

    Description is a user-facing description of the parameter that may be used to populate a UI.

    enumarray

    Enum declares a set of allowed param input values. If Enum is not set, no input validation is performed for the param.

    namestring

    Name declares the name by which a parameter is referenced.

    propertiesobject

    Properties is the JSON Schema properties to support key-value pairs parameter.

    typestring

    Type is the user-specified type of the parameter. The possible types are currently "string", "array" and "object", and "string" is the default.

    .spec.params[].annotations

    Description
    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
    Type
    object

    .spec.params[].enum

    Description
    Enum declares a set of allowed param input values. If Enum is not set, no input validation is performed for the param.
    Type
    array

    .spec.params[].enum[]

    Type
    string

    .spec.params[].properties

    Description
    Properties is the JSON Schema properties to support key-value pairs parameter.
    Type
    object

    .spec.workspaces

    Description
    Workspaces defines the workspaces that will be available when creating PipelineIntegration instances.
    Type
    array

    .spec.workspaces[]

    Description
    ResourceInterfaceWorkspaceSpec defines a workspace specification for ResourceInterface
    Type
    object
    Required
    name
    PropertyTypeDescription
    annotationsobject

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

    descriptionstring

    Description provides a human-readable description of the workspace.

    namestring

    Name of the workspace.

    valueobject

    Value defines the volume source for this workspace.

    workspaceMappingobject

    WorkspaceMapping defines the workspace mapping configuration for this workspace.

    .spec.workspaces[].annotations

    Description
    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
    Type
    object

    .spec.workspaces[].value

    Description
    Value defines the volume source for this workspace.
    Type
    object
    PropertyTypeDescription
    configMapobject

    ConfigMap represents a configMap that should populate this workspace.

    csiobject

    CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.

    emptyDirobject

    EmptyDir represents a temporary directory that shares a Task's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir Either this OR PersistentVolumeClaim can be used.

    persistentVolumeClaimobject

    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. Either this OR EmptyDir can be used.

    projectedobject

    Projected represents a projected volume that should populate this workspace.

    secretobject

    Secret represents a secret that should populate this workspace.

    subPathstring

    SubPath is optionally a directory on the volume which should be used for this binding (i.e. the volume will be mounted at this sub directory).

    volumeClaimTemplateobject

    VolumeClaimTemplate is a template for a claim that will be created in the same namespace.

    .spec.workspaces[].value.configMap

    Description
    ConfigMap represents a configMap that should populate this workspace.
    Type
    object
    PropertyTypeDescription
    defaultModeinteger

    defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    itemsarray

    items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    optionalboolean

    optional specify whether the ConfigMap or its keys must be defined

    .spec.workspaces[].value.configMap.items

    Description
    items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
    Type
    array

    .spec.workspaces[].value.configMap.items[]

    Description
    Maps a string key to a path within a volume.
    Type
    object
    Required
    keypath
    PropertyTypeDescription
    keystring

    key is the key to project.

    modeinteger

    mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    pathstring

    path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

    .spec.workspaces[].value.csi

    Description
    CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
    Type
    object
    Required
    driver
    PropertyTypeDescription
    driverstring

    driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.

    fsTypestring

    fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.

    nodePublishSecretRefobject

    nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.

    readOnlyboolean

    readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).

    volumeAttributesobject

    volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.

    .spec.workspaces[].value.csi.nodePublishSecretRef

    Description
    nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
    Type
    object
    PropertyTypeDescription
    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    .spec.workspaces[].value.csi.volumeAttributes

    Description
    volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
    Type
    object

    .spec.workspaces[].value.emptyDir

    Description
    EmptyDir represents a temporary directory that shares a Task's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir Either this OR PersistentVolumeClaim can be used.
    Type
    object
    PropertyTypeDescription
    mediumstring

    medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

    sizeLimit

    sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

    .spec.workspaces[].value.persistentVolumeClaim

    Description
    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. Either this OR EmptyDir can be used.
    Type
    object
    Required
    claimName
    PropertyTypeDescription
    claimNamestring

    claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

    readOnlyboolean

    readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

    .spec.workspaces[].value.projected

    Description
    Projected represents a projected volume that should populate this workspace.
    Type
    object
    PropertyTypeDescription
    defaultModeinteger

    defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    sourcesarray

    sources is the list of volume projections. Each entry in this list handles one source.

    .spec.workspaces[].value.projected.sources

    Description
    sources is the list of volume projections. Each entry in this list handles one source.
    Type
    array

    .spec.workspaces[].value.projected.sources[]

    Description
    Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.
    Type
    object
    PropertyTypeDescription
    clusterTrustBundleobject

    ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.

    Alpha, gated by the ClusterTrustBundleProjection feature gate.

    ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.

    Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.

    configMapobject

    configMap information about the configMap data to project

    downwardAPIobject

    downwardAPI information about the downwardAPI data to project

    secretobject

    secret information about the secret data to project

    serviceAccountTokenobject

    serviceAccountToken is information about the serviceAccountToken data to project

    .spec.workspaces[].value.projected.sources[].clusterTrustBundle

    Description
    ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file. Alpha, gated by the ClusterTrustBundleProjection feature gate. ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector. Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.
    Type
    object
    Required
    path
    PropertyTypeDescription
    labelSelectorobject

    Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".

    namestring

    Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.

    optionalboolean

    If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.

    pathstring

    Relative path from the volume root to write the bundle.

    signerNamestring

    Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.

    .spec.workspaces[].value.projected.sources[].clusterTrustBundle.labelSelector

    Description
    Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".
    Type
    object
    PropertyTypeDescription
    matchExpressionsarray

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    matchLabelsobject

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    .spec.workspaces[].value.projected.sources[].clusterTrustBundle.labelSelector.matchExpressions

    Description
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    Type
    array

    .spec.workspaces[].value.projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[]

    Description
    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    key is the label key that the selector applies to.

    operatorstring

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesarray

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

    .spec.workspaces[].value.projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[].values

    Description
    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.workspaces[].value.projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[].values[]

    Type
    string

    .spec.workspaces[].value.projected.sources[].clusterTrustBundle.labelSelector.matchLabels

    Description
    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    Type
    object

    .spec.workspaces[].value.projected.sources[].configMap

    Description
    configMap information about the configMap data to project
    Type
    object
    PropertyTypeDescription
    itemsarray

    items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    optionalboolean

    optional specify whether the ConfigMap or its keys must be defined

    .spec.workspaces[].value.projected.sources[].configMap.items

    Description
    items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
    Type
    array

    .spec.workspaces[].value.projected.sources[].configMap.items[]

    Description
    Maps a string key to a path within a volume.
    Type
    object
    Required
    keypath
    PropertyTypeDescription
    keystring

    key is the key to project.

    modeinteger

    mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    pathstring

    path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

    .spec.workspaces[].value.projected.sources[].downwardAPI

    Description
    downwardAPI information about the downwardAPI data to project
    Type
    object
    PropertyTypeDescription
    itemsarray

    Items is a list of DownwardAPIVolume file

    .spec.workspaces[].value.projected.sources[].downwardAPI.items

    Description
    Items is a list of DownwardAPIVolume file
    Type
    array

    .spec.workspaces[].value.projected.sources[].downwardAPI.items[]

    Description
    DownwardAPIVolumeFile represents information to create the file containing the pod field
    Type
    object
    Required
    path
    PropertyTypeDescription
    fieldRefobject

    Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

    modeinteger

    Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    pathstring

    Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

    resourceFieldRefobject

    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

    .spec.workspaces[].value.projected.sources[].downwardAPI.items[].fieldRef

    Description
    Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
    Type
    object
    Required
    fieldPath
    PropertyTypeDescription
    apiVersionstring

    Version of the schema the FieldPath is written in terms of, defaults to "v1".

    fieldPathstring

    Path of the field to select in the specified API version.

    .spec.workspaces[].value.projected.sources[].downwardAPI.items[].resourceFieldRef

    Description
    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
    Type
    object
    Required
    resource
    PropertyTypeDescription
    containerNamestring

    Container name: required for volumes, optional for env vars

    divisor

    Specifies the output format of the exposed resources, defaults to "1"

    resourcestring

    Required: resource to select

    .spec.workspaces[].value.projected.sources[].secret

    Description
    secret information about the secret data to project
    Type
    object
    PropertyTypeDescription
    itemsarray

    items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

    namestring

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    optionalboolean

    optional field specify whether the Secret or its key must be defined

    .spec.workspaces[].value.projected.sources[].secret.items

    Description
    items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
    Type
    array

    .spec.workspaces[].value.projected.sources[].secret.items[]

    Description
    Maps a string key to a path within a volume.
    Type
    object
    Required
    keypath
    PropertyTypeDescription
    keystring

    key is the key to project.

    modeinteger

    mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    pathstring

    path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

    .spec.workspaces[].value.projected.sources[].serviceAccountToken

    Description
    serviceAccountToken is information about the serviceAccountToken data to project
    Type
    object
    Required
    path
    PropertyTypeDescription
    audiencestring

    audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.

    expirationSecondsinteger

    expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.

    pathstring

    path is the path relative to the mount point of the file to project the token into.

    .spec.workspaces[].value.secret

    Description
    Secret represents a secret that should populate this workspace.
    Type
    object
    PropertyTypeDescription
    defaultModeinteger

    defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    itemsarray

    items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

    optionalboolean

    optional field specify whether the Secret or its keys must be defined

    secretNamestring

    secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

    .spec.workspaces[].value.secret.items

    Description
    items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
    Type
    array

    .spec.workspaces[].value.secret.items[]

    Description
    Maps a string key to a path within a volume.
    Type
    object
    Required
    keypath
    PropertyTypeDescription
    keystring

    key is the key to project.

    modeinteger

    mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    pathstring

    path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

    .spec.workspaces[].value.volumeClaimTemplate

    Description
    VolumeClaimTemplate is a template for a claim that will be created in the same namespace.
    Type
    object
    PropertyTypeDescription
    apiVersionstring

    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

    kindstring

    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

    metadataObjectMeta

    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

    specobject

    spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

    statusobject

    status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

    .spec.workspaces[].value.volumeClaimTemplate.spec

    Description
    spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
    Type
    object
    PropertyTypeDescription
    accessModesarray

    accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

    dataSourceobject

    dataSource field can be used to specify either:

    • An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
    • An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
    dataSourceRefobject

    dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef:

    • While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
    • While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
    • While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
    resourcesobject

    resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

    selectorobject

    selector is a label query over volumes to consider for binding.

    storageClassNamestring

    storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

    volumeAttributesClassNamestring

    volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).

    volumeModestring

    volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

    volumeNamestring

    volumeName is the binding reference to the PersistentVolume backing this claim.

    .spec.workspaces[].value.volumeClaimTemplate.spec.accessModes

    Description
    accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
    Type
    array

    .spec.workspaces[].value.volumeClaimTemplate.spec.accessModes[]

    Type
    string

    .spec.workspaces[].value.volumeClaimTemplate.spec.dataSource

    Description
    dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
    Type
    object
    Required
    kindname
    PropertyTypeDescription
    apiGroupstring

    APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

    kindstring

    Kind is the type of resource being referenced

    namestring

    Name is the name of resource being referenced

    .spec.workspaces[].value.volumeClaimTemplate.spec.dataSourceRef

    Description
    dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
    Type
    object
    Required
    kindname
    PropertyTypeDescription
    apiGroupstring

    APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

    kindstring

    Kind is the type of resource being referenced

    namestring

    Name is the name of resource being referenced

    namespacestring

    Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

    .spec.workspaces[].value.volumeClaimTemplate.spec.resources

    Description
    resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
    Type
    object
    PropertyTypeDescription
    limitsobject

    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    requestsobject

    Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    .spec.workspaces[].value.volumeClaimTemplate.spec.resources.limits

    Description
    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    .spec.workspaces[].value.volumeClaimTemplate.spec.resources.requests

    Description
    Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    Type
    object

    .spec.workspaces[].value.volumeClaimTemplate.spec.selector

    Description
    selector is a label query over volumes to consider for binding.
    Type
    object
    PropertyTypeDescription
    matchExpressionsarray

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    matchLabelsobject

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    .spec.workspaces[].value.volumeClaimTemplate.spec.selector.matchExpressions

    Description
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    Type
    array

    .spec.workspaces[].value.volumeClaimTemplate.spec.selector.matchExpressions[]

    Description
    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
    Type
    object
    Required
    keyoperator
    PropertyTypeDescription
    keystring

    key is the label key that the selector applies to.

    operatorstring

    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

    valuesarray

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

    .spec.workspaces[].value.volumeClaimTemplate.spec.selector.matchExpressions[].values

    Description
    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    Type
    array

    .spec.workspaces[].value.volumeClaimTemplate.spec.selector.matchExpressions[].values[]

    Type
    string

    .spec.workspaces[].value.volumeClaimTemplate.spec.selector.matchLabels

    Description
    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    Type
    object

    .spec.workspaces[].value.volumeClaimTemplate.status

    Description
    status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
    Type
    object
    PropertyTypeDescription
    accessModesarray

    accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

    allocatedResourceStatusesobject

    allocatedResourceStatuses stores status of resource being resized for the given PVC. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used.

    ClaimResourceStatus can be in any of following states: - ControllerResizeInProgress: State set when resize controller starts resizing the volume in control-plane. - ControllerResizeFailed: State set when resize has failed in resize controller with a terminal error. - NodeResizePending: State set when resize controller has finished resizing the volume but further resizing of volume is needed on the node. - NodeResizeInProgress: State set when kubelet starts resizing the volume. - NodeResizeFailed: State set when resizing has failed in kubelet with a terminal error. Transient errors don't set NodeResizeFailed. For example: if expanding a PVC for more capacity - this field can be one of the following states: - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed" When this field is not set, it means that no resize operation is in progress for the given PVC.

    A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC.

    This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.

    allocatedResourcesobject

    allocatedResources tracks the resources allocated to a PVC including its capacity. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used.

    Capacity reported here may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity.

    A controller that receives PVC update with previously unknown resourceName should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC.

    This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.

    capacityobject

    capacity represents the actual resources of the underlying volume.

    conditionsarray

    conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.

    currentVolumeAttributesClassNamestring

    currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim This is a beta field and requires enabling VolumeAttributesClass feature (off by default).

    modifyVolumeStatusobject

    ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. This is a beta field and requires enabling VolumeAttributesClass feature (off by default).

    phasestring

    phase represents the current phase of PersistentVolumeClaim.

    .spec.workspaces[].value.volumeClaimTemplate.status.accessModes

    Description
    accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
    Type
    array

    .spec.workspaces[].value.volumeClaimTemplate.status.accessModes[]

    Type
    string

    .spec.workspaces[].value.volumeClaimTemplate.status.allocatedResourceStatuses

    Description
    allocatedResourceStatuses stores status of resource being resized for the given PVC. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. ClaimResourceStatus can be in any of following states: - ControllerResizeInProgress: State set when resize controller starts resizing the volume in control-plane. - ControllerResizeFailed: State set when resize has failed in resize controller with a terminal error. - NodeResizePending: State set when resize controller has finished resizing the volume but further resizing of volume is needed on the node. - NodeResizeInProgress: State set when kubelet starts resizing the volume. - NodeResizeFailed: State set when resizing has failed in kubelet with a terminal error. Transient errors don't set NodeResizeFailed. For example: if expanding a PVC for more capacity - this field can be one of the following states: - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed" When this field is not set, it means that no resize operation is in progress for the given PVC. A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
    Type
    object

    .spec.workspaces[].value.volumeClaimTemplate.status.allocatedResources

    Description
    allocatedResources tracks the resources allocated to a PVC including its capacity. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. Capacity reported here may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. A controller that receives PVC update with previously unknown resourceName should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
    Type
    object

    .spec.workspaces[].value.volumeClaimTemplate.status.capacity

    Description
    capacity represents the actual resources of the underlying volume.
    Type
    object

    .spec.workspaces[].value.volumeClaimTemplate.status.conditions

    Description
    conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.
    Type
    array

    .spec.workspaces[].value.volumeClaimTemplate.status.conditions[]

    Description
    PersistentVolumeClaimCondition contains details about state of pvc
    Type
    object
    Required
    statustype
    PropertyTypeDescription
    lastProbeTimestring

    lastProbeTime is the time we probed the condition.

    lastTransitionTimestring

    lastTransitionTime is the time the condition transitioned from one status to another.

    messagestring

    message is the human-readable message indicating details about last transition.

    reasonstring

    reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "Resizing" that means the underlying persistent volume is being resized.

    statusstring

    Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=state%20of%20pvc-,conditions.status,-(string)%2C%20required

    typestring

    Type is the type of the condition. More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=set%20to%20%27ResizeStarted%27.-,PersistentVolumeClaimCondition,-contains%20details%20about

    .spec.workspaces[].value.volumeClaimTemplate.status.modifyVolumeStatus

    Description
    ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
    Type
    object
    Required
    status
    PropertyTypeDescription
    statusstring

    status is the status of the ControllerModifyVolume operation. It can be in any of following states:

    • Pending Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as the specified VolumeAttributesClass not existing.
    • InProgress InProgress indicates that the volume is being modified.
    • Infeasible Infeasible indicates that the request has been rejected as invalid by the CSI driver. To resolve the error, a valid VolumeAttributesClass needs to be specified. Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.
    targetVolumeAttributesClassNamestring

    targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled

    .spec.workspaces[].workspaceMapping

    Description
    WorkspaceMapping defines the workspace mapping configuration for this workspace.
    Type
    object
    PropertyTypeDescription
    namestring

    Name is the default parameter name when this workspace is mapped during PipelineIntegration construction.

    API Endpoints

    The following API endpoints are available:

    • /apis/connectors.alauda.io/v1alpha1/namespaces/{namespace}/resourceinterfaces
      • DELETE: delete collection of ResourceInterface
      • GET: list objects of kind ResourceInterface
      • POST: create a new ResourceInterface
    • /apis/connectors.alauda.io/v1alpha1/namespaces/{namespace}/resourceinterfaces/{name}
      • DELETE: delete the specified ResourceInterface
      • GET: read the specified ResourceInterface
      • PATCH: partially update the specified ResourceInterface
      • PUT: replace the specified ResourceInterface

    /apis/connectors.alauda.io/v1alpha1/namespaces/{namespace}/resourceinterfaces

    HTTP method
    DELETE
    Description
    delete collection of ResourceInterface
    HTTP responses
    HTTP codeResponse body
    200 - OKStatus schema
    401 - UnauthorizedEmpty
    HTTP method
    GET
    Description
    list objects of kind ResourceInterface
    HTTP responses
    HTTP codeResponse body
    200 - OKResourceInterfaceList schema
    401 - UnauthorizedEmpty
    HTTP method
    POST
    Description
    create a new ResourceInterface
    Query parameters
    ParameterTypeDescription
    dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
    fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
    Body parameters
    ParameterTypeDescription
    bodyResourceInterface schemaapplication/json formatted
    HTTP responses
    HTTP codeResponse body
    200 - OKResourceInterface schema
    201 - CreatedResourceInterface schema
    202 - AcceptedResourceInterface schema
    401 - UnauthorizedEmpty

    /apis/connectors.alauda.io/v1alpha1/namespaces/{namespace}/resourceinterfaces/{name}

    HTTP method
    DELETE
    Description
    delete the specified ResourceInterface
    Query parameters
    ParameterTypeDescription
    dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
    HTTP responses
    HTTP codeResponse body
    200 - OKStatus schema
    202 - AcceptedStatus schema
    401 - UnauthorizedEmpty
    HTTP method
    GET
    Description
    read the specified ResourceInterface
    HTTP responses
    HTTP codeResponse body
    200 - OKResourceInterface schema
    401 - UnauthorizedEmpty
    HTTP method
    PATCH
    Description
    partially update the specified ResourceInterface
    Query parameters
    ParameterTypeDescription
    dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
    fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
    HTTP responses
    HTTP codeResponse body
    200 - OKResourceInterface schema
    401 - UnauthorizedEmpty
    HTTP method
    PUT
    Description
    replace the specified ResourceInterface
    Query parameters
    ParameterTypeDescription
    dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
    fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
    Body parameters
    ParameterTypeDescription
    bodyResourceInterface schemaapplication/json formatted
    HTTP responses
    HTTP codeResponse body
    200 - OKResourceInterface schema
    201 - CreatedResourceInterface schema
    401 - UnauthorizedEmpty