InsightsDataGather [config.openshift.io/v1alpha1] - Config APIs | API reference

Specification
API endpoints

Description

InsightsDataGather provides data gather configuration options for the the Insights Operator. Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.

Type

object

Required

spec

Specification

Property Type Description

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`	`ObjectMeta`	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`object`	spec holds user settable values for configuration
`status`	`object`	status holds observed values from the cluster. They may not be overridden.

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

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

spec holds user settable values for configuration

status

object

status holds observed values from the cluster. They may not be overridden.

.spec

Description: spec holds user settable values for configuration
Type: object

Property Type Description

Property	Type	Description
`gatherConfig`	`object`	gatherConfig spec attribute includes all the configuration options related to gathering of the Insights data and its uploading to the ingress.

gatherConfig

object

gatherConfig spec attribute includes all the configuration options related to gathering of the Insights data and its uploading to the ingress.

.spec.gatherConfig

Description: gatherConfig spec attribute includes all the configuration options related to gathering of the Insights data and its uploading to the ingress.
Type: object

Property Type Description

Property	Type	Description
`dataPolicy`	`string`	dataPolicy allows user to enable additional global obfuscation of the IP addresses and base domain in the Insights archive data. Valid values are "None" and "ObfuscateNetworking". When set to None the data is not obfuscated. When set to ObfuscateNetworking the IP addresses and the cluster domain name are obfuscated. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is None.
`disabledGatherers`	`array (string)`	disabledGatherers is a list of gatherers to be excluded from the gathering. All the gatherers can be disabled by providing "all" value. If all the gatherers are disabled, the Insights operator does not gather any data. The particular gatherers IDs can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md. Run the following command to get the names of last active gatherers: "oc get insightsoperators.operator.openshift.io cluster -o json \| jq '.status.gatherStatus.gatherers[].name'" An example of disabling gatherers looks like this: `disabledGatherers: ["clusterconfig/machine_configs", "workloads/workload_info"]`

dataPolicy

string

dataPolicy allows user to enable additional global obfuscation of the IP addresses and base domain in the Insights archive data. Valid values are "None" and "ObfuscateNetworking". When set to None the data is not obfuscated. When set to ObfuscateNetworking the IP addresses and the cluster domain name are obfuscated. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is None.

disabledGatherers

array (string)

disabledGatherers is a list of gatherers to be excluded from the gathering. All the gatherers can be disabled by providing "all" value. If all the gatherers are disabled, the Insights operator does not gather any data. The particular gatherers IDs can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md. Run the following command to get the names of last active gatherers: "oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'" An example of disabling gatherers looks like this: disabledGatherers: ["clusterconfig/machine_configs", "workloads/workload_info"]

.status

Description: status holds observed values from the cluster. They may not be overridden.
Type: object

API endpoints

The following API endpoints are available:

/apis/config.openshift.io/v1alpha1/insightsdatagathers
- DELETE: delete collection of InsightsDataGather
- GET: list objects of kind InsightsDataGather
- POST: create an InsightsDataGather
/apis/config.openshift.io/v1alpha1/insightsdatagathers/{name}
- DELETE: delete an InsightsDataGather
- GET: read the specified InsightsDataGather
- PATCH: partially update the specified InsightsDataGather
- PUT: replace the specified InsightsDataGather
/apis/config.openshift.io/v1alpha1/insightsdatagathers/{name}/status
- GET: read status of the specified InsightsDataGather
- PATCH: partially update status of the specified InsightsDataGather
- PUT: replace status of the specified InsightsDataGather

/apis/config.openshift.io/v1alpha1/insightsdatagathers

HTTP method: DELETE
Description: delete collection of InsightsDataGather

Table 1. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind InsightsDataGather

Table 2. HTTP responses
HTTP code	Reponse body
200 - OK	`InsightsDataGatherList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create an InsightsDataGather

Table 3. Query parameters
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.

Table 4. Body parameters
Parameter	Type	Description
`body`	`InsightsDataGather` schema

Table 5. HTTP responses
HTTP code	Reponse body
200 - OK	`InsightsDataGather` schema
201 - Created	`InsightsDataGather` schema
202 - Accepted	`InsightsDataGather` schema
401 - Unauthorized	Empty

/apis/config.openshift.io/v1alpha1/insightsdatagathers/{name}

Table 6. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the InsightsDataGather

HTTP method: DELETE
Description: delete an InsightsDataGather

Table 7. Query parameters
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

Table 8. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified InsightsDataGather

Table 9. HTTP responses
HTTP code	Reponse body
200 - OK	`InsightsDataGather` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified InsightsDataGather

Table 10. Query parameters
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.

Table 11. HTTP responses
HTTP code	Reponse body
200 - OK	`InsightsDataGather` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified InsightsDataGather

Table 12. Query parameters
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.

Table 13. Body parameters
Parameter	Type	Description
`body`	`InsightsDataGather` schema

Table 14. HTTP responses
HTTP code	Reponse body
200 - OK	`InsightsDataGather` schema
201 - Created	`InsightsDataGather` schema
401 - Unauthorized	Empty

/apis/config.openshift.io/v1alpha1/insightsdatagathers/{name}/status

Table 15. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the InsightsDataGather

HTTP method: GET
Description: read status of the specified InsightsDataGather

Table 16. HTTP responses
HTTP code	Reponse body
200 - OK	`InsightsDataGather` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified InsightsDataGather

Table 17. Query parameters
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.

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`InsightsDataGather` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified InsightsDataGather

Table 19. Query parameters
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.

Table 20. Body parameters
Parameter	Type	Description
`body`	`InsightsDataGather` schema

Table 21. HTTP responses
HTTP code	Reponse body
200 - OK	`InsightsDataGather` schema
201 - Created	`InsightsDataGather` schema
401 - Unauthorized	Empty