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
.spec
- Description
- Spec defines the desired state of ResourceInterface
- Type
object
.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
.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
.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
.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
.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
.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
.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
.spec.workspaces[].value.configMap
- Description
- ConfigMap represents a configMap that should populate this workspace.
- Type
object
.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
.spec.workspaces[].value.csi
- Description
- CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
- Type
object- Required
driver
.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
.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
.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
.spec.workspaces[].value.projected
- Description
- Projected represents a projected volume that should populate this workspace.
- Type
object
.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
.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
.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
.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
.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
.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
.spec.workspaces[].value.projected.sources[].downwardAPI
- Description
- downwardAPI information about the downwardAPI data to project
- Type
object
.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
.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
.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
.spec.workspaces[].value.projected.sources[].secret
- Description
- secret information about the secret data to project
- Type
object
.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
.spec.workspaces[].value.projected.sources[].serviceAccountToken
- Description
- serviceAccountToken is information about the serviceAccountToken data to project
- Type
object- Required
path
.spec.workspaces[].value.secret
- Description
- Secret represents a secret that should populate this workspace.
- Type
object
.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
.spec.workspaces[].value.volumeClaimTemplate
- Description
- VolumeClaimTemplate is a template for a claim that will be created in the same namespace.
- Type
object
.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
.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
.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
.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
.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
.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
.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
.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
.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
.spec.workspaces[].workspaceMapping
- Description
- WorkspaceMapping defines the workspace mapping configuration for this workspace.
- Type
object
API Endpoints
The following API endpoints are available:
/apis/connectors.alauda.io/v1alpha1/namespaces/{namespace}/resourceinterfacesDELETE: delete collection of ResourceInterfaceGET: list objects of kind ResourceInterfacePOST: create a new ResourceInterface
/apis/connectors.alauda.io/v1alpha1/namespaces/{namespace}/resourceinterfaces/{name}DELETE: delete the specified ResourceInterfaceGET: read the specified ResourceInterfacePATCH: partially update the specified ResourceInterfacePUT: replace the specified ResourceInterface
/apis/connectors.alauda.io/v1alpha1/namespaces/{namespace}/resourceinterfaces
- HTTP method
DELETE- Description
- delete collection of ResourceInterface
- HTTP responses
- HTTP method
GET- Description
- list objects of kind ResourceInterface
- HTTP responses
- HTTP method
POST- Description
- create a new ResourceInterface
- Query parameters
- Body parameters
- HTTP responses
/apis/connectors.alauda.io/v1alpha1/namespaces/{namespace}/resourceinterfaces/{name}
- HTTP method
DELETE- Description
- delete the specified ResourceInterface
- Query parameters
- HTTP responses
- HTTP method
GET- Description
- read the specified ResourceInterface
- HTTP responses
- HTTP method
PATCH- Description
- partially update the specified ResourceInterface
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace the specified ResourceInterface
- Query parameters
- Body parameters
- HTTP responses