Connector [connectors.alauda.io/v1alpha1]

描述
Connector is the Schema for the connectors API
类型
object

规格

属性类型描述
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

ConnectorSpec defines the desired state of Connector

statusobject

ConnectorStatus defines the observed state of Connector

.spec

描述
ConnectorSpec defines the desired state of Connector
类型
object
属性类型描述
addressstring

Address is connector address

addressExtensionsarray

AddressExtensions contains additional addresses that can reuse connector credentials.

authobject

Auth represents authenticate data of current connector

caCertSecretRefobject

CACertSecretRef references a Secret containing PEM-encoded CA certificates for verifying this connector's upstream TLS endpoint. The Secret is resolved from the same namespace as the Connector.

connectorClassNamestring

ConnectorClassName of current connector

generatorsarray

Generators declares child connectors to materialize from this connector. Each entry describes the parameters needed to construct one child Connector. The generator controller reconciles entries into real Connector CRs in the same namespace, with ownerReference and identity labels set automatically.

paramsarray

Params information required for spec

.spec.addressExtensions

描述
AddressExtensions contains additional addresses that can reuse connector credentials.
类型
array

.spec.addressExtensions[]

描述
Param declares an ParamValues to use for the parameter called name.
类型
object
必填
namevalue
属性类型描述
namestring
value

.spec.auth

描述
Auth represents authenticate data of current connector
类型
object
属性类型描述
namestring

Name represent auth name that configured in ConnectorClass.spec.auth.types[].name

paramsarray

Params information required for authentication

secretRefobject

SecretRef secret reference when doing authentication

.spec.auth.params

描述
Params information required for authentication
类型
array

.spec.auth.params[]

描述
Param declares an ParamValues to use for the parameter called name.
类型
object
必填
namevalue
属性类型描述
namestring
value

.spec.auth.secretRef

描述
SecretRef secret reference when doing authentication
类型
object
属性类型描述
apiVersionstring

API version of the referent.

fieldPathstring

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

kindstring

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespacestring

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersionstring

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

.spec.caCertSecretRef

描述
CACertSecretRef references a Secret containing PEM-encoded CA certificates for verifying this connector's upstream TLS endpoint. The Secret is resolved from the same namespace as the Connector.
类型
object
属性类型描述
namestring

Name of the Secret in the same namespace as the Connector.

.spec.generators

描述
Generators declares child connectors to materialize from this connector. Each entry describes the parameters needed to construct one child Connector. The generator controller reconciles entries into real Connector CRs in the same namespace, with ownerReference and identity labels set automatically.
类型
array

.spec.generators[]

描述
ConnectorGenerator declares the parameters needed to materialize one child Connector. Entry fields are flat (no spec: nesting) — BaseConnectorSpec is embedded inline, matching the shape of the parent ConnectorSpec fields directly in YAML.
类型
object
必填
name
属性类型描述
addressstring

Address is connector address

addressExtensionsarray

AddressExtensions contains additional addresses that can reuse connector credentials.

authobject

Auth represents authenticate data of current connector

caCertSecretRefobject

CACertSecretRef references a Secret containing PEM-encoded CA certificates for verifying this connector's upstream TLS endpoint. The Secret is resolved from the same namespace as the Connector.

connectorClassNamestring

ConnectorClassName of current connector

namestring

Name is the entry identity. Used verbatim as the child connector's metadata.name AND stamped on the child's connectors.cpaas.io/generator-entry label value. Must be a valid DNS-1123 LABEL (≤ 63 characters — the K8s label-value bound, tighter than the subdomain limit) and unique within the parent's namespace.

paramsarray

Params information required for spec

.spec.generators[].addressExtensions

描述
AddressExtensions contains additional addresses that can reuse connector credentials.
类型
array

.spec.generators[].addressExtensions[]

描述
Param declares an ParamValues to use for the parameter called name.
类型
object
必填
namevalue
属性类型描述
namestring
value

.spec.generators[].auth

描述
Auth represents authenticate data of current connector
类型
object
属性类型描述
namestring

Name represent auth name that configured in ConnectorClass.spec.auth.types[].name

paramsarray

Params information required for authentication

secretRefobject

SecretRef secret reference when doing authentication

.spec.generators[].auth.params

描述
Params information required for authentication
类型
array

.spec.generators[].auth.params[]

描述
Param declares an ParamValues to use for the parameter called name.
类型
object
必填
namevalue
属性类型描述
namestring
value

.spec.generators[].auth.secretRef

描述
SecretRef secret reference when doing authentication
类型
object
属性类型描述
apiVersionstring

API version of the referent.

fieldPathstring

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

kindstring

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespacestring

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersionstring

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

.spec.generators[].caCertSecretRef

描述
CACertSecretRef references a Secret containing PEM-encoded CA certificates for verifying this connector's upstream TLS endpoint. The Secret is resolved from the same namespace as the Connector.
类型
object
属性类型描述
namestring

Name of the Secret in the same namespace as the Connector.

.spec.generators[].params

描述
Params information required for spec
类型
array

.spec.generators[].params[]

描述
Param declares an ParamValues to use for the parameter called name.
类型
object
必填
namevalue
属性类型描述
namestring
value

.spec.params

描述
Params information required for spec
类型
array

.spec.params[]

描述
Param declares an ParamValues to use for the parameter called name.
类型
object
必填
namevalue
属性类型描述
namestring
value

.status

描述
ConnectorStatus defines the observed state of Connector
类型
object
属性类型描述
annotationsobject

Annotations is additional Status fields for the Resource to save some additional State as well as convey more information to the user. This is roughly akin to Annotations on any k8s resource, just the reconciler conveying richer information outwards.

apiobject

API contains the status information for the connector's api

conditionsarray

Conditions the latest available observations of a resource's current state.

observedGenerationinteger

ObservedGeneration is the 'Generation' of the Service that was last processed by the controller.

proxyobject

Proxy contains the status information for the connector's proxy

.status.annotations

描述
Annotations is additional Status fields for the Resource to save some additional State as well as convey more information to the user. This is roughly akin to Annotations on any k8s resource, just the reconciler conveying richer information outwards.
类型
object

.status.api

描述
API contains the status information for the connector's api
类型
object
属性类型描述
pathstring

Path provides the path for the connector API. it is the path of the connector API. it is used to construct the api path for the connector

.status.conditions

描述
Conditions the latest available observations of a resource's current state.
类型
array

.status.conditions[]

描述
Condition defines a readiness condition for a Knative resource. See: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties
类型
object
必填
statustype
属性类型描述
lastTransitionTimestring

LastTransitionTime is the last time the condition transitioned from one status to another. We use VolatileTime in place of metav1.Time to exclude this from creating equality.Semantic differences (all other things held constant).

messagestring

A human readable message indicating details about the transition.

reasonstring

The reason for the condition's last transition.

severitystring

Severity with which to treat failures of this type of condition. When this is not specified, it defaults to Error.

statusstring

Status of the condition, one of True, False, Unknown.

typestring

Type of condition.

.status.proxy

描述
Proxy contains the status information for the connector's proxy
类型
object
属性类型描述
httpAddressobject

HTTPAddress provides the addressable HTTP endpoint for the connector proxy.

.status.proxy.httpAddress

描述
HTTPAddress provides the addressable HTTP endpoint for the connector proxy.
类型
object
属性类型描述
CACertsstring

CACerts is the Certification Authority (CA) certificates in PEM format according to https://www.rfc-editor.org/rfc/rfc7468.

audiencestring

Audience is the OIDC audience for this address.

namestring

Name is the name of the address.

urlstring

API 端点

可用的 API 端点如下:

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

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

HTTP 方法
DELETE
描述
delete collection of Connector
HTTP 响应
HTTP 状态码响应体
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
list objects of kind Connector
HTTP 响应
HTTP 状态码响应体
200 - OKConnectorList schema
401 - UnauthorizedEmpty
HTTP 方法
POST
描述
create a new Connector
查询参数
参数类型描述
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.
请求体参数
参数类型描述
bodyConnector schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKConnector schema
201 - CreatedConnector schema
202 - AcceptedConnector schema
401 - UnauthorizedEmpty

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

HTTP 方法
DELETE
描述
delete the specified Connector
查询参数
参数类型描述
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 响应
HTTP 状态码响应体
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
read the specified Connector
HTTP 响应
HTTP 状态码响应体
200 - OKConnector schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update the specified Connector
查询参数
参数类型描述
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 响应
HTTP 状态码响应体
200 - OKConnector schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace the specified Connector
查询参数
参数类型描述
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.
请求体参数
参数类型描述
bodyConnector schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKConnector schema
201 - CreatedConnector schema
401 - UnauthorizedEmpty

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

HTTP 方法
GET
描述
read status of the specified Connector
HTTP 响应
HTTP 状态码响应体
200 - OKConnector schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update status of the specified Connector
查询参数
参数类型描述
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 响应
HTTP 状态码响应体
200 - OKConnector schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace status of the specified Connector
查询参数
参数类型描述
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.
请求体参数
参数类型描述
bodyConnector schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKConnector schema
201 - CreatedConnector schema
401 - UnauthorizedEmpty