// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="config-samples-operator-openshift-io-v1"]
= Config [samples.operator.openshift.io/v1]
:toc: macro
:toc-title:

toc::[]


Description::
+
--
Config contains the configuration and detailed condition status for the Samples Operator.

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
--

Type::
  `object`

Required::
  - `metadata`
  - `spec`


== Specification

[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiVersion`
| `string`
| 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

| `kind`
| `string`
| 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

| `metadata`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

| `spec`
| `object`
| ConfigSpec contains the desired configuration and state for the Samples Operator, controlling
various behavior around the imagestreams and templates it creates/updates in the
openshift namespace.

| `status`
| `object`
| ConfigStatus contains the actual configuration in effect, as well as various details
that describe the state of the Samples Operator.

|===
=== .spec
Description::
+
--
ConfigSpec contains the desired configuration and state for the Samples Operator, controlling
various behavior around the imagestreams and templates it creates/updates in the
openshift namespace.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `architectures`
| `array (string)`
| architectures determine which hardware architecture(s) to install, where x86_64, ppc64le, and s390x are the only
supported choices currently.

| `managementState`
| `string`
| managementState is top level on/off type of switch for all operators.
When "Managed", this operator processes config and manipulates the samples accordingly.
When "Unmanaged", this operator ignores any updates to the resources it watches.
When "Removed", it reacts that same wasy as it does if the Config object
is deleted, meaning any ImageStreams or Templates it manages (i.e. it honors the skipped
lists) and the registry secret are deleted, along with the ConfigMap in the operator's
namespace that represents the last config used to manipulate the samples,

| `samplesRegistry`
| `string`
| samplesRegistry allows for the specification of which registry is accessed
by the ImageStreams for their image content.  Defaults on the content in https://github.com/openshift/library
that are pulled into this github repository, but based on our pulling only ocp content it typically
defaults to registry.redhat.io.

| `skippedHelmCharts`
| `array (string)`
| skippedHelmCharts specifies names of helm charts that should NOT be
managed. Admins can use this to allow them to delete content
they don’t want. They will still have to MANUALLY DELETE the
content but the operator will not recreate(or update) anything
listed here. Few examples of the name of helmcharts which can be skipped are
'redhat-redhat-perl-imagestreams','redhat-redhat-nodejs-imagestreams','redhat-nginx-imagestreams',
'redhat-redhat-ruby-imagestreams','redhat-redhat-python-imagestreams','redhat-redhat-php-imagestreams',
'redhat-httpd-imagestreams','redhat-redhat-dotnet-imagestreams'. Rest of the names can be obtained from
openshift console --> helmcharts -->installed helmcharts. This will display the list of all the
12 helmcharts(of imagestreams)being installed by Samples Operator. The skippedHelmCharts must be a
valid Kubernetes resource name. May contain only lowercase alphanumeric characters, hyphens and periods,
and each period separated segment must begin and end with an alphanumeric character. It must be non-empty
and at most 253 characters in length

| `skippedImagestreams`
| `array (string)`
| skippedImagestreams specifies names of image streams that should NOT be
created/updated.  Admins can use this to allow them to delete content
they don’t want.  They will still have to manually delete the
content but the operator will not recreate(or update) anything
listed here.

| `skippedTemplates`
| `array (string)`
| skippedTemplates specifies names of templates that should NOT be
created/updated.  Admins can use this to allow them to delete content
they don’t want.  They will still have to manually delete the
content but the operator will not recreate(or update) anything
listed here.

|===
=== .status
Description::
+
--
ConfigStatus contains the actual configuration in effect, as well as various details
that describe the state of the Samples Operator.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `architectures`
| `array (string)`
| architectures determine which hardware architecture(s) to install, where x86_64 and ppc64le are the
supported choices.

| `conditions`
| `array`
| conditions represents the available maintenance status of the sample
imagestreams and templates.

| `conditions[]`
| `object`
| ConfigCondition captures various conditions of the Config
as entries are processed.

| `managementState`
| `string`
| managementState reflects the current operational status of the on/off switch for
the operator.  This operator compares the ManagementState as part of determining that we are turning
the operator back on (i.e. "Managed") when it was previously "Unmanaged".

| `samplesRegistry`
| `string`
| samplesRegistry allows for the specification of which registry is accessed
by the ImageStreams for their image content.  Defaults on the content in https://github.com/openshift/library
that are pulled into this github repository, but based on our pulling only ocp content it typically
defaults to registry.redhat.io.

| `skippedImagestreams`
| `array (string)`
| skippedImagestreams specifies names of image streams that should NOT be
created/updated.  Admins can use this to allow them to delete content
they don’t want.  They will still have to manually delete the
content but the operator will not recreate(or update) anything
listed here.

| `skippedTemplates`
| `array (string)`
| skippedTemplates specifies names of templates that should NOT be
created/updated.  Admins can use this to allow them to delete content
they don’t want.  They will still have to manually delete the
content but the operator will not recreate(or update) anything
listed here.

| `version`
| `string`
| version is the value of the operator's payload based version indicator when it was last successfully processed

|===
=== .status.conditions
Description::
+
--
conditions represents the available maintenance status of the sample
imagestreams and templates.
--

Type::
  `array`




=== .status.conditions[]
Description::
+
--
ConfigCondition captures various conditions of the Config
as entries are processed.
--

Type::
  `object`

Required::
  - `status`
  - `type`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `lastTransitionTime`
| `string`
| lastTransitionTime is the last time the condition transitioned from one status to another.

| `lastUpdateTime`
| `string`
| lastUpdateTime is the last time this condition was updated.

| `message`
| `string`
| message is a human readable message indicating details about the transition.

| `reason`
| `string`
| reason is what caused the condition's last transition.

| `status`
| `string`
| status of the condition, one of True, False, Unknown.

| `type`
| `string`
| type of condition.

|===

== API endpoints

The following API endpoints are available:

* `/apis/samples.operator.openshift.io/v1/configs`
- `DELETE`: delete collection of Config
- `GET`: list objects of kind Config
- `POST`: create a Config
* `/apis/samples.operator.openshift.io/v1/configs/{name}`
- `DELETE`: delete a Config
- `GET`: read the specified Config
- `PATCH`: partially update the specified Config
- `PUT`: replace the specified Config
* `/apis/samples.operator.openshift.io/v1/configs/{name}/status`
- `GET`: read status of the specified Config
- `PATCH`: partially update status of the specified Config
- `PUT`: replace status of the specified Config


=== /apis/samples.operator.openshift.io/v1/configs



HTTP method::
  `DELETE`

Description::
  delete collection of Config




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `GET`

Description::
  list objects of kind Config




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-openshift-operator-samples-v1-ConfigList[`ConfigList`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `POST`

Description::
  create a Config


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When 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
| `fieldValidation`
| `string`
| fieldValidation 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
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema
| 201 - Created
| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema
| 202 - Accepted
| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/samples.operator.openshift.io/v1/configs/{name}

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the Config
|===


HTTP method::
  `DELETE`

Description::
  delete a Config


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When 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
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `GET`

Description::
  read the specified Config




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PATCH`

Description::
  partially update the specified Config


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When 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
| `fieldValidation`
| `string`
| fieldValidation 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
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace the specified Config


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When 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
| `fieldValidation`
| `string`
| fieldValidation 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
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema
| 201 - Created
| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/samples.operator.openshift.io/v1/configs/{name}/status

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the Config
|===


HTTP method::
  `GET`

Description::
  read status of the specified Config




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PATCH`

Description::
  partially update status of the specified Config


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When 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
| `fieldValidation`
| `string`
| fieldValidation 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
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace status of the specified Config


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When 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
| `fieldValidation`
| `string`
| fieldValidation 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
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema
| 201 - Created
| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema
| 401 - Unauthorized
| Empty
|===


