Alauda Container Platform
  • 简体中文

    • InstallPlan [operators.coreos.com/v1alpha1]

    描述
    InstallPlan defines the installation of a set of operators.
    类型
    object
    必填
    metadataspec

    规格

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

    InstallPlanSpec defines a set of Application resources to be installed

    statusobject

    InstallPlanStatus represents the information about the status of steps required to complete installation. Status may trail the actual state of a system.

    .spec

    描述
    InstallPlanSpec defines a set of Application resources to be installed
    类型
    object
    必填
    approvalapprovedclusterServiceVersionNames
    属性类型描述
    approvalstring

    Approval is the user approval policy for an InstallPlan. It must be one of "Automatic" or "Manual".

    approvedboolean
    clusterServiceVersionNamesarray
    generationinteger
    sourcestring
    sourceNamespacestring

    .spec.clusterServiceVersionNames

    类型
    array

    .spec.clusterServiceVersionNames[]

    类型
    string

    .status

    描述
    InstallPlanStatus represents the information about the status of steps required to complete installation. Status may trail the actual state of a system.
    类型
    object
    必填
    catalogSourcesphase
    属性类型描述
    attenuatedServiceAccountRefobject

    AttenuatedServiceAccountRef references the service account that is used to do scoped operator install.

    bundleLookupsarray

    BundleLookups is the set of in-progress requests to pull and unpackage bundle content to the cluster.

    catalogSourcesarray
    conditionsarray
    messagestring

    Message is a human-readable message containing detailed information that may be important to understanding why the plan has its current status.

    phasestring

    InstallPlanPhase is the current status of a InstallPlan as a whole.

    planarray
    startTimestring

    StartTime is the time when the controller began applying the resources listed in the plan to the cluster.

    .status.attenuatedServiceAccountRef

    描述
    AttenuatedServiceAccountRef references the service account that is used to do scoped operator install.
    类型
    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. TODO: this design is not final and this field is subject to change in the future.

    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

    .status.bundleLookups

    描述
    BundleLookups is the set of in-progress requests to pull and unpackage bundle content to the cluster.
    类型
    array

    .status.bundleLookups[]

    描述
    BundleLookup is a request to pull and unpackage the content of a bundle to the cluster.
    类型
    object
    必填
    catalogSourceRefidentifierpathreplaces
    属性类型描述
    catalogSourceRefobject

    CatalogSourceRef is a reference to the CatalogSource the bundle path was resolved from.

    conditionsarray

    Conditions represents the overall state of a BundleLookup.

    identifierstring

    Identifier is the catalog-unique name of the operator (the name of the CSV for bundles that contain CSVs)

    pathstring

    Path refers to the location of a bundle to pull. It's typically an image reference.

    propertiesstring

    The effective properties of the unpacked bundle.

    replacesstring

    Replaces is the name of the bundle to replace with the one found at Path.

    .status.bundleLookups[].catalogSourceRef

    描述
    CatalogSourceRef is a reference to the CatalogSource the bundle path was resolved from.
    类型
    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. TODO: this design is not final and this field is subject to change in the future.

    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

    .status.bundleLookups[].conditions

    描述
    Conditions represents the overall state of a BundleLookup.
    类型
    array

    .status.bundleLookups[].conditions[]

    类型
    object
    必填
    statustype
    属性类型描述
    lastTransitionTimestring

    Last time the condition transitioned from one status to another.

    lastUpdateTimestring

    Last time the condition was probed.

    messagestring

    A human readable message indicating details about the transition.

    reasonstring

    The reason for the condition's last transition.

    statusstring

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

    typestring

    Type of condition.

    .status.catalogSources

    类型
    array

    .status.catalogSources[]

    类型
    string

    .status.conditions

    类型
    array

    .status.conditions[]

    描述
    InstallPlanCondition represents the overall status of the execution of an InstallPlan.
    类型
    object
    属性类型描述
    lastTransitionTimestring
    lastUpdateTimestring
    messagestring
    reasonstring

    ConditionReason is a camelcased reason for the state transition.

    statusstring
    typestring

    InstallPlanConditionType describes the state of an InstallPlan at a certain point as a whole.

    .status.plan

    类型
    array

    .status.plan[]

    描述
    Step represents the status of an individual step in an InstallPlan.
    类型
    object
    必填
    resolvingresourcestatus
    属性类型描述
    resolvingstring
    resourceobject

    StepResource represents the status of a resource to be tracked by an InstallPlan.

    statusstring

    StepStatus is the current status of a particular resource an in InstallPlan

    .status.plan[].resource

    描述
    StepResource represents the status of a resource to be tracked by an InstallPlan.
    类型
    object
    必填
    groupkindnamesourceNamesourceNamespaceversion
    属性类型描述
    groupstring
    kindstring
    manifeststring
    namestring
    sourceNamestring
    sourceNamespacestring
    versionstring

    API 端点

    可用的 API 端点如下：

    • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans
      • DELETE: delete collection of InstallPlan
      • GET: list objects of kind InstallPlan
      • POST: create a new InstallPlan
    • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}
      • DELETE: delete the specified InstallPlan
      • GET: read the specified InstallPlan
      • PATCH: partially update the specified InstallPlan
      • PUT: replace the specified InstallPlan
    • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}/status
      • GET: read status of the specified InstallPlan
      • PATCH: partially update status of the specified InstallPlan
      • PUT: replace status of the specified InstallPlan

    /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans

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

    /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}

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

    /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}/status

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