ConnectorClass [connectors.alauda.io/v1alpha1]
- 描述
- ConnectorClass is the Schema for the connectorclasses API
- 类型
object
规格
.spec
- 描述
- Spec defines the desired state of ConnectorClass
- 类型
object
.spec.address
- 描述
- Address indicates address param constraints for this ConnectorClass of connectors we only support string param type
- 类型
object- 必填
name
.spec.address.annotations
- 描述
- Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
- 类型
object
.spec.address.enum
- 描述
- Enum declares a set of allowed param input values. If Enum is not set, no input validation is performed for the param.
- 类型
array
.spec.address.enum[]
- 类型
string
.spec.address.properties
- 描述
- Properties is the JSON Schema properties to support key-value pairs parameter.
- 类型
object
.spec.addressExtensions
- 描述
- AddressExtensions indicates address extension constraints for this ConnectorClass of connectors. It reuses the same schema as params (name/type/description/default). A param without default is considered required.
- 类型
array
.spec.addressExtensions[]
- 描述
- ParamSpec defines arbitrary parameters needed beyond typed inputs (such as resources).
- 类型
object- 必填
name
.spec.addressExtensions[].annotations
- 描述
- Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
- 类型
object
.spec.addressExtensions[].enum
- 描述
- Enum declares a set of allowed param input values. If Enum is not set, no input validation is performed for the param.
- 类型
array
.spec.addressExtensions[].enum[]
- 类型
string
.spec.addressExtensions[].properties
- 描述
- Properties is the JSON Schema properties to support key-value pairs parameter.
- 类型
object
.spec.api
- 描述
- API defines connectorclass plugin api address and openapi specification `api.ref` can be address of plugin api, it should be a kubernetes svc `api.uri` can be an absolute URL(non-empty scheme and non-empty host) pointing to the target or a relative URI. Relative URIs will be resolved using the base URI retrieved from Ref. `api.CACerts` and `api.audience` is not implemented now
- 类型
object
.spec.api.permissions
- 描述
- Permissions defines the request matching rules for different operations on the connectorclass api
- 类型
object
.spec.api.ref
- 描述
- Ref points to an Addressable.
- 类型
object- 必填
kindname
.spec.auth
- 描述
- Auth indicates authentication constraints for this ConnectorClass of connectors
- 类型
object
.spec.auth.types
- 描述
- Types represent the authentication types supported by connectors of the current connectorclass type When the array length is greater than 1, it means supporting multiple types, and the Connector can choose any one when using.
- 类型
array
.spec.auth.types[]
- 描述
- ConnectorClassAuthType represent the authentication types supported by connectors of the current connectorclass type
- 类型
object- 必填
name
.spec.auth.types[].annotations
- 描述
- Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
- 类型
object
.spec.auth.types[].generator
- 描述
- Generator specifies how to generate authentication data dynamically. Can be used to implement custom authentication logic.
- 类型
object
.spec.auth.types[].params
- 描述
- Params declares the data fields included in this authentication type. For known types, the definition of included params is optional. If not defined, the conventional params will be used.
- 类型
array
.spec.auth.types[].params[]
- 描述
- ParamSpec defines arbitrary parameters needed beyond typed inputs (such as resources).
- 类型
object- 必填
name
.spec.auth.types[].params[].annotations
- 描述
- Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
- 类型
object
.spec.auth.types[].params[].enum
- 描述
- Enum declares a set of allowed param input values. If Enum is not set, no input validation is performed for the param.
- 类型
array
.spec.auth.types[].params[].enum[]
- 类型
string
.spec.auth.types[].params[].properties
- 描述
- Properties is the JSON Schema properties to support key-value pairs parameter.
- 类型
object
.spec.authProbes
- 描述
- AuthProbes defines authentication probe for this ConnectorClass of connectors
- 类型
array
.spec.authProbes[]
- 描述
- ConnectorClassAuthProbe represents network the detection configuration
- 类型
object- 必填
authName
.spec.authProbes[].params
- 描述
- Params declares the data fields included in this probe it will use param value when probe
- 类型
array
.spec.authProbes[].params[]
- 描述
- ParamSpec defines arbitrary parameters needed beyond typed inputs (such as resources).
- 类型
object- 必填
name
.spec.authProbes[].params[].annotations
- 描述
- Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
- 类型
object
.spec.authProbes[].params[].enum
- 描述
- Enum declares a set of allowed param input values. If Enum is not set, no input validation is performed for the param.
- 类型
array
.spec.authProbes[].params[].enum[]
- 类型
string
.spec.authProbes[].params[].properties
- 描述
- Properties is the JSON Schema properties to support key-value pairs parameter.
- 类型
object
.spec.authProbes[].probe
- 描述
- Probe represents current detection configuration
- 类型
object
.spec.authProbes[].probe.api
- 描述
- API defines a network detection probe that uses the ConnectorClass API. The API endpoint for the probe is resolved from the ConnectorClass's `spec.api` configuration. If `spec.api` is not configured or is invalid, no API detection will be performed. The `Path` field within `APIProbeAction` specifies a relative path that is appended to the host of URI resolved from `spec.api` (e.g., `spec.api.uri`).
- 类型
object
.spec.authProbes[].probe.http
- 描述
- Http represents the network detection using the http get method
- 类型
object- 必填
path
.spec.authProbes[].probe.http.httpHeaders
- 描述
- Custom headers to set in the request. HTTP allows repeated headers.
- 类型
array
.spec.authProbes[].probe.http.httpHeaders[]
- 描述
- HTTPHeader describes a custom header to be used in HTTP probes
- 类型
object- 必填
namevalue
.spec.authProbes[].probe.http.response
- 描述
- Response defines the expected response validation rules. If not specified, the probe is considered successful if the request completes without error and returns a 2xx status code.
- 类型
object
.spec.configurations
- 描述
- Configurations defines connectorclass configuration
- 类型
array
.spec.configurations[]
- 描述
- ConnectorClassConfiguration defines connectorclass configuration
- 类型
object
.spec.configurations[].annotations
- 描述
- Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
- 类型
object
.spec.configurations[].data
- 描述
- Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'.
- 类型
object
.spec.configurations[].params
- 描述
- Params declares the parameters this configuration accepts from configuration.params at CSI mount time. Each entry is validated and defaults are applied before template rendering. A param with Default == nil is considered required; mount fails if absent.
- 类型
array
.spec.configurations[].params[]
- 描述
- ParamSpec defines arbitrary parameters needed beyond typed inputs (such as resources).
- 类型
object- 必填
name
.spec.configurations[].params[].annotations
- 描述
- Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
- 类型
object
.spec.configurations[].params[].enum
- 描述
- Enum declares a set of allowed param input values. If Enum is not set, no input validation is performed for the param.
- 类型
array
.spec.configurations[].params[].enum[]
- 类型
string
.spec.configurations[].params[].properties
- 描述
- Properties is the JSON Schema properties to support key-value pairs parameter.
- 类型
object
.spec.livenessProbe
- 描述
- LivenessProbe defines liveness probe for this ConnectorClass of connectors
- 类型
object
.spec.livenessProbe.api
- 描述
- API defines a network detection probe that uses the ConnectorClass API. The API endpoint for the probe is resolved from the ConnectorClass's `spec.api` configuration. If `spec.api` is not configured or is invalid, no API detection will be performed. The `Path` field within `APIProbeAction` specifies a relative path that is appended to the host of URI resolved from `spec.api` (e.g., `spec.api.uri`).
- 类型
object
.spec.livenessProbe.http
- 描述
- Http represents the network detection using the http get method
- 类型
object- 必填
path
.spec.livenessProbe.http.httpHeaders
- 描述
- Custom headers to set in the request. HTTP allows repeated headers.
- 类型
array
.spec.livenessProbe.http.httpHeaders[]
- 描述
- HTTPHeader describes a custom header to be used in HTTP probes
- 类型
object- 必填
namevalue
.spec.livenessProbe.http.response
- 描述
- Response defines the expected response validation rules. If not specified, the probe is considered successful if the request completes without error and returns a 2xx status code.
- 类型
object
.spec.params
- 描述
- Params indicates param constraints for this ConnectorClass of connectors we only support string param type
- 类型
array
.spec.params[]
- 描述
- ParamSpec defines arbitrary parameters needed beyond typed inputs (such as resources).
- 类型
object- 必填
name
.spec.params[].annotations
- 描述
- Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
- 类型
object
.spec.params[].enum
- 描述
- Enum declares a set of allowed param input values. If Enum is not set, no input validation is performed for the param.
- 类型
array
.spec.params[].enum[]
- 类型
string
.spec.params[].properties
- 描述
- Properties is the JSON Schema properties to support key-value pairs parameter.
- 类型
object
.spec.proxy
- 描述
- Proxy defines the proxy configuration for this ConnectorClass. Specifies how network traffic should be routed through a proxy server.
- 类型
object
.spec.proxy.authExtractor
- 描述
- AuthExtractor specifies the method used to extract authentication data from incoming requests. The AuthExtractor is responsible for extracting the token required to perform proxy permission validation.
- 类型
object
.spec.proxy.ref
- 描述
- Ref points to an Addressable.
- 类型
object- 必填
kindname
.status
- 描述
- Status defines the actual state of ConnectorClass
- 类型
object
.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 represents status of connectorclass api it will resolved based on `spec.api` if `spec.api` is empty or invalid, it will not be set if current field is empty, the connectorclass cannot provides any api service.
- 类型
object
.status.api.address
- 描述
- Address is a single Addressable address.
- 类型
object
.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
.status.proxy
- 描述
- Proxy represents status of connectorclass proxy it will resolved based on `spec.proxy` if `spec.proxy` is empty or invalid, it will not be set if current field is empty, the connectorclass cannot provides any proxy service.
- 类型
object
.status.proxy.httpAddress
- 描述
- HttpAddress is a single Addressable address.
- 类型
object
API 端点
可用的 API 端点如下:
/apis/connectors.alauda.io/v1alpha1/connectorclassesDELETE: delete collection of ConnectorClassGET: list objects of kind ConnectorClassPOST: create a new ConnectorClass
/apis/connectors.alauda.io/v1alpha1/connectorclasses/{name}DELETE: delete the specified ConnectorClassGET: read the specified ConnectorClassPATCH: partially update the specified ConnectorClassPUT: replace the specified ConnectorClass
/apis/connectors.alauda.io/v1alpha1/connectorclasses/{name}/statusGET: read status of the specified ConnectorClassPATCH: partially update status of the specified ConnectorClassPUT: replace status of the specified ConnectorClass
/apis/connectors.alauda.io/v1alpha1/connectorclasses
- HTTP 方法
DELETE- 描述
- delete collection of ConnectorClass
- HTTP 响应
- HTTP 方法
GET- 描述
- list objects of kind ConnectorClass
- HTTP 响应
- HTTP 方法
POST- 描述
- create a new ConnectorClass
- 查询参数
- 请求体参数
- HTTP 响应
/apis/connectors.alauda.io/v1alpha1/connectorclasses/{name}
- HTTP 方法
DELETE- 描述
- delete the specified ConnectorClass
- 查询参数
- HTTP 响应
- HTTP 方法
GET- 描述
- read the specified ConnectorClass
- HTTP 响应
- HTTP 方法
PATCH- 描述
- partially update the specified ConnectorClass
- 查询参数
- HTTP 响应
- HTTP 方法
PUT- 描述
- replace the specified ConnectorClass
- 查询参数
- 请求体参数
- HTTP 响应
/apis/connectors.alauda.io/v1alpha1/connectorclasses/{name}/status
- HTTP 方法
GET- 描述
- read status of the specified ConnectorClass
- HTTP 响应
- HTTP 方法
PATCH- 描述
- partially update status of the specified ConnectorClass
- 查询参数
- HTTP 响应
- HTTP 方法
PUT- 描述
- replace status of the specified ConnectorClass
- 查询参数
- 请求体参数
- HTTP 响应