Alauda DevOps Connectors Docs

ConnectorsConfig [operator.connectors.alauda.io/v1alpha1]

Description
ConnectorsConfig is the Schema for the connectorsconfig API.
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

ConnectorsConfigSpec defines the desired state of ConnectorsConfig.

statusobject

ConnectorsConfigStatus defines the observed state of ConnectorsConfig.

.spec

Description
ConnectorsConfigSpec defines the desired state of ConnectorsConfig.
Type
object
PropertyTypeDescription
annotationsobject

Annotations overrides annotations for the namespace and its template.

componentsobject

Components maps component name (e.g. "core", "git", "oci") to its config. Component names must match registered ComponentDefinitions. Components not present in the map are enabled with default settings.

installFlagsobject

InstallFlags supplies per-install-flag admin configuration for install-time gating. Map key is a kebab-case install-flag name; value is an arbitrary JSON value whose shape is documented per flag.

Currently registered flag:

pipeline-integration: "<=N" // string, semver constraint on the // ResourceInterface schema-version label. // e.g. "<=2" installs v1 and v2; skips v3+.

Future flags may use other value shapes (boolean toggle, enum string, struct, …); the CRD schema does not constrain inner value structure on purpose so each flag can own its own shape. Per-install-flag transformers (pkg/controllers/transformer/installflags/) parse the JSON value at Transform time; parse failures degrade to the maturity default for that flag (Alpha: skip all matched resources; Beta: install all). GA / Deprecated maturities are locked and ignore admin overrides entirely.

This is NOT a runtime feature flag (see ConnectorsCoreSpec.FeatureFlags for that) — it acts at install/Transform time and decides whether install-time manifests get applied to the cluster, not whether a running binary's code paths are enabled.

Set on ConnectorsConfig.spec to broadcast cluster-wide; set on a per-component CR (e.g. ConnectorsHarbor.spec.installFlags) to override the cluster-wide value on the matching key for THAT component only.

labelsobject

Labels overrides labels for the namespace and its template.

registrystring

Registry overrides the default registry for the workloads. The registry is used to replace the prefix of the image. the image reference format is /:@.

.spec.annotations

Description
Annotations overrides annotations for the namespace and its template.
Type
object

.spec.components

Description
Components maps component name (e.g. "core", "git", "oci") to its config. Component names must match registered ComponentDefinitions. Components not present in the map are enabled with default settings.
Type
object

.spec.installFlags

Description
InstallFlags supplies per-install-flag admin configuration for install-time gating. Map key is a kebab-case install-flag name; value is an arbitrary JSON value whose shape is documented per flag. Currently registered flag: pipeline-integration: "<=N" // string, semver constraint on the // ResourceInterface schema-version label. // e.g. "<=2" installs v1 and v2; skips v3+. Future flags may use other value shapes (boolean toggle, enum string, struct, …); the CRD schema does not constrain inner value structure on purpose so each flag can own its own shape. Per-install-flag transformers (pkg/controllers/transformer/installflags/) parse the JSON value at Transform time; parse failures degrade to the maturity default for that flag (Alpha: skip all matched resources; Beta: install all). GA / Deprecated maturities are locked and ignore admin overrides entirely. This is NOT a runtime feature flag (see ConnectorsCoreSpec.FeatureFlags for that) — it acts at install/Transform time and decides whether install-time manifests get applied to the cluster, not whether a running binary's code paths are enabled. Set on ConnectorsConfig.spec to broadcast cluster-wide; set on a per-component CR (e.g. ConnectorsHarbor.spec.installFlags) to override the cluster-wide value on the matching key for THAT component only.
Type
object

.spec.labels

Description
Labels overrides labels for the namespace and its template.
Type
object

.status

Description
ConnectorsConfigStatus defines the observed state of ConnectorsConfig.
Type
object
PropertyTypeDescription
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.

componentsobject

Components tracks the status of each managed component.

conditionsarray

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

migratedFromobject

MigratedFrom records the migration source when upgrading from standalone CRs. nil if this is a fresh install (no migration occurred).

observedGenerationinteger

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

.status.annotations

Description
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.
Type
object

.status.components

Description
Components tracks the status of each managed component.
Type
object

.status.conditions

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

.status.conditions[]

Description
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
Type
object
Required
statustype
PropertyTypeDescription
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.migratedFrom

Description
MigratedFrom records the migration source when upgrading from standalone CRs. nil if this is a fresh install (no migration occurred).
Type
object
Required
timestamp
PropertyTypeDescription
componentsarray

Components lists which components were migrated and from which namespace. Set once by the bootstrap; never mutated. Use this as the audit record.

pendingCleanuparray

PendingCleanup is the working set of pre-migration standalone CRs the controller still needs to delete. Initially equal to Components; entries are pruned as cleanup converges. Empty list means all leftover standalone CRs have been handled.

timestampstring

Timestamp when the migration was performed.

.status.migratedFrom.components

Description
Components lists which components were migrated and from which namespace. Set once by the bootstrap; never mutated. Use this as the audit record.
Type
array

.status.migratedFrom.components[]

Description
MigratedComponent records the origin of a migrated component.
Type
object
Required
nameoriginalNameoriginalNamespace
PropertyTypeDescription
namestring

Name is the component type (e.g. "core", "git", "oci").

originalNamestring

OriginalName is the original CR name (may differ from deterministic name).

originalNamespacestring

OriginalNamespace is the namespace where the old CR was found.

.status.migratedFrom.pendingCleanup

Description
PendingCleanup is the working set of pre-migration standalone CRs the controller still needs to delete. Initially equal to Components; entries are pruned as cleanup converges. Empty list means all leftover standalone CRs have been handled.
Type
array

.status.migratedFrom.pendingCleanup[]

Description
MigratedComponent records the origin of a migrated component.
Type
object
Required
nameoriginalNameoriginalNamespace
PropertyTypeDescription
namestring

Name is the component type (e.g. "core", "git", "oci").

originalNamestring

OriginalName is the original CR name (may differ from deterministic name).

originalNamespacestring

OriginalNamespace is the namespace where the old CR was found.

API Endpoints

The following API endpoints are available:

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

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

HTTP method
DELETE
Description
delete collection of ConnectorsConfig
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind ConnectorsConfig
HTTP responses
HTTP codeResponse body
200 - OKConnectorsConfigList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new ConnectorsConfig
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
bodyConnectorsConfig schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKConnectorsConfig schema
201 - CreatedConnectorsConfig schema
202 - AcceptedConnectorsConfig schema
401 - UnauthorizedEmpty

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

HTTP method
DELETE
Description
delete the specified ConnectorsConfig
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 ConnectorsConfig
HTTP responses
HTTP codeResponse body
200 - OKConnectorsConfig schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified ConnectorsConfig
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 - OKConnectorsConfig schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified ConnectorsConfig
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
bodyConnectorsConfig schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKConnectorsConfig schema
201 - CreatedConnectorsConfig schema
401 - UnauthorizedEmpty

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

HTTP method
GET
Description
read status of the specified ConnectorsConfig
HTTP responses
HTTP codeResponse body
200 - OKConnectorsConfig schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified ConnectorsConfig
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 - OKConnectorsConfig schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified ConnectorsConfig
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
bodyConnectorsConfig schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKConnectorsConfig schema
201 - CreatedConnectorsConfig schema
401 - UnauthorizedEmpty