InstallPlan [operators.coreos.com/v1alpha1]

Description
InstallPlan defines the installation of a set of operators.
Type
object
Required
metadataspec

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

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

Description
InstallPlanSpec defines a set of Application resources to be installed
Type
object
Required
approvalapprovedclusterServiceVersionNames
PropertyTypeDescription
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

Type
array

.spec.clusterServiceVersionNames[]

Type
string

.status

Description
InstallPlanStatus represents the information about the status of steps required to complete installation. Status may trail the actual state of a system.
Type
object
Required
catalogSourcesphase
PropertyTypeDescription
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

Description
AttenuatedServiceAccountRef references the service account that is used to do scoped operator install.
Type
object
PropertyTypeDescription
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

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

.status.bundleLookups[]

Description
BundleLookup is a request to pull and unpackage the content of a bundle to the cluster.
Type
object
Required
catalogSourceRefidentifierpathreplaces
PropertyTypeDescription
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

Description
CatalogSourceRef is a reference to the CatalogSource the bundle path was resolved from.
Type
object
PropertyTypeDescription
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

Description
Conditions represents the overall state of a BundleLookup.
Type
array

.status.bundleLookups[].conditions[]

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

Type
array

.status.catalogSources[]

Type
string

.status.conditions

Type
array

.status.conditions[]

Description
InstallPlanCondition represents the overall status of the execution of an InstallPlan.
Type
object
PropertyTypeDescription
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

Type
array

.status.plan[]

Description
Step represents the status of an individual step in an InstallPlan.
Type
object
Required
resolvingresourcestatus
PropertyTypeDescription
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

Description
StepResource represents the status of a resource to be tracked by an InstallPlan.
Type
object
Required
groupkindnamesourceNamesourceNamespaceversion
PropertyTypeDescription
groupstring
kindstring
manifeststring
namestring
sourceNamestring
sourceNamespacestring
versionstring

API Endpoints

The following API endpoints are available:

  • /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 method
DELETE
Description
delete collection of InstallPlan
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind InstallPlan
HTTP responses
HTTP codeResponse body
200 - OKInstallPlanList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new InstallPlan
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
bodyInstallPlan schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKInstallPlan schema
201 - CreatedInstallPlan schema
202 - AcceptedInstallPlan schema
401 - UnauthorizedEmpty

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

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

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

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