Alauda DevOps Pipelines Docs
  • 简体中文

    • TektonPipeline [operator.tekton.dev/v1alpha1]

    描述
    TektonPipeline is the Schema for the tektonpipelines 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

    TektonPipelineSpec defines the desired state of TektonPipeline

    statusobject

    TektonPipelineStatus defines the observed state of TektonPipeline

    .spec

    描述
    TektonPipelineSpec defines the desired state of TektonPipeline
    类型
    object
    必填
    options
    属性类型描述
    await-sidecar-readinessboolean
    bundles-resolver-configobject
    cluster-resolver-configobject
    configobject

    Config holds the configuration for resources created by TektonPipeline

    coschedulestring
    default-affinity-assistant-pod-templatestring
    default-cloud-events-sinkstring
    default-forbidden-envstring
    default-managed-by-label-valuestring
    default-max-matrix-combinations-countstring
    default-pod-templatestring
    default-resolver-typestring
    default-service-accountstring
    default-task-run-workspace-bindingstring
    default-timeout-minutesinteger
    disable-affinity-assistantboolean
    disable-creds-initboolean
    disable-inline-specstring
    embedded-statusstring
    enable-api-fieldsstring
    enable-bundles-resolverboolean
    enable-cel-in-whenexpressionboolean
    enable-cluster-resolverboolean
    enable-custom-tasksboolean
    enable-git-resolverboolean
    enable-hub-resolverboolean
    enable-param-enumboolean
    enable-provenance-in-statusboolean
    enable-step-actionsboolean
    enable-tekton-oci-bundlesboolean

    not in use, see: https://github.com/tektoncd/pipeline/pull/7789 this field is removed from pipeline component keeping here to maintain the API compatibility

    enforce-nonfalsifiabilitystring
    git-resolver-configobject
    hub-resolver-configobject
    keep-pod-on-cancelboolean
    max-result-sizeinteger
    metrics.count.enable-reasonboolean
    metrics.pipelinerun.duration-typestring
    metrics.pipelinerun.levelstring
    metrics.taskrun.duration-typestring
    metrics.taskrun.levelstring
    optionsobject

    options holds additions fields and these fields will be updated on the manifests

    paramsarray

    The params to customize different components of Pipelines

    performanceobject

    PerformanceProperties defines the fields which are configurable to tune the performance of component controller

    require-git-ssh-secret-known-hostsboolean
    results-fromstring
    running-in-environment-with-injected-sidecarsboolean
    scope-when-expressions-to-taskboolean

    ScopeWhenExpressionsToTask is deprecated and never used.

    send-cloudevents-for-runsboolean
    set-security-contextboolean
    targetNamespacestring

    TargetNamespace is where resources will be installed

    trusted-resources-verification-no-match-policystring
    verification-modestring

    .spec.bundles-resolver-config

    类型
    object

    .spec.cluster-resolver-config

    类型
    object

    .spec.config

    描述
    Config holds the configuration for resources created by TektonPipeline
    类型
    object
    属性类型描述
    nodeSelectorobject
    priorityClassNamestring

    PriorityClassName holds the priority class to be set to pod template

    tolerationsarray

    .spec.config.nodeSelector

    类型
    object

    .spec.config.tolerations

    类型
    array

    .spec.config.tolerations[]

    描述
    The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
    类型
    object
    属性类型描述
    effectstring

    Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

    keystring

    Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.

    operatorstring

    Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.

    tolerationSecondsinteger

    TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

    valuestring

    Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

    .spec.git-resolver-config

    类型
    object

    .spec.hub-resolver-config

    类型
    object

    .spec.options

    描述
    options holds additions fields and these fields will be updated on the manifests
    类型
    object
    属性类型描述
    configMapsobject
    deploymentsobject
    disabledboolean
    horizontalPodAutoscalersobject
    statefulSetsobject
    webhookConfigurationOptionsobject

    .spec.options.configMaps

    类型
    object

    .spec.options.deployments

    类型
    object

    .spec.options.horizontalPodAutoscalers

    类型
    object

    .spec.options.statefulSets

    类型
    object

    .spec.options.webhookConfigurationOptions

    类型
    object

    .spec.params

    描述
    The params to customize different components of Pipelines
    类型
    array

    .spec.params[]

    描述
    Param declares an string value to use for the parameter called name.
    类型
    object
    属性类型描述
    namestring
    valuestring

    .spec.performance

    描述
    PerformanceProperties defines the fields which are configurable to tune the performance of component controller
    类型
    object
    必填
    disable-ha
    属性类型描述
    bucketsinteger
    disable-haboolean

    if it is true, disables the HA feature

    kube-api-burstinteger
    kube-api-qpsnumber

    queries per second (QPS) and burst to the master from rest API client actually the number multiplied by 2 https://github.com/pierretasci/pipeline/blob/05d67e427c722a2a57e58328d7097e21429b7524/cmd/controller/main.go#L85-L87 defaults: https://github.com/tektoncd/pipeline/blob/34618964300620dca44d10a595e4af84e9903a55/vendor/k8s.io/client-go/rest/config.go#L45-L46

    replicasinteger
    statefulset-ordinalsboolean

    if is true, enable StatefulsetOrdinals mode

    threads-per-controllerinteger

    The number of workers to use when processing the component controller's work queue

    .status

    描述
    TektonPipelineStatus defines the observed state of TektonPipeline
    类型
    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.

    conditionsarray

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

    extTektonInstallerSetsobject

    The installer sets created for extension components

    observedGenerationinteger

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

    tektonInstallerSetstring

    The current installer set name for TektonPipeline

    versionstring

    The version of the installed release

    .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.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.extTektonInstallerSets

    描述
    The installer sets created for extension components
    类型
    object

    API 端点

    可用的 API 端点如下：

    • /apis/operator.tekton.dev/v1alpha1/namespaces/{namespace}/tektonpipelines
      • DELETE: delete collection of TektonPipeline
      • GET: list objects of kind TektonPipeline
      • POST: create a new TektonPipeline
    • /apis/operator.tekton.dev/v1alpha1/namespaces/{namespace}/tektonpipelines/{name}
      • DELETE: delete the specified TektonPipeline
      • GET: read the specified TektonPipeline
      • PATCH: partially update the specified TektonPipeline
      • PUT: replace the specified TektonPipeline

    /apis/operator.tekton.dev/v1alpha1/namespaces/{namespace}/tektonpipelines

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

    /apis/operator.tekton.dev/v1alpha1/namespaces/{namespace}/tektonpipelines/{name}

    HTTP 方法
    DELETE
    描述
    delete the specified TektonPipeline
    查询参数
    参数类型描述
    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 TektonPipeline
    HTTP 响应
    HTTP 状态码响应体
    200 - OKTektonPipeline schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PATCH
    描述
    partially update the specified TektonPipeline
    查询参数
    参数类型描述
    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 - OKTektonPipeline schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PUT
    描述
    replace the specified TektonPipeline
    查询参数
    参数类型描述
    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.
    请求体参数
    参数类型描述
    bodyTektonPipeline schemaapplication/json formatted
    HTTP 响应
    HTTP 状态码响应体
    200 - OKTektonPipeline schema
    201 - CreatedTektonPipeline schema
    401 - UnauthorizedEmpty