PodNetworkConnectivityCheck [controlplane.operator.openshift.io/v1alpha1]

Description

PodNetworkConnectivityCheck 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
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 defines the source and target of the connectivity check
status	object	status contains the observed status of the connectivity check

.spec

Description

spec defines the source and target of the connectivity check

Type

`object`

Required

• sourcePod
• targetEndpoint

Property	Type	Description
sourcePod	string	sourcePod names the pod from which the condition will be checked
targetEndpoint	string	EndpointAddress to check. A TCP address of the form host:port. Note that if host is a DNS name, then the check would fail if the DNS name cannot be resolved. Specify an IP address for host to bypass DNS name lookup.
tlsClientCert	object	TLSClientCert, if specified, references a kubernetes.io/tls type secret with 'tls.crt' and 'tls.key' entries containing an optional TLS client certificate and key to be used when checking endpoints that require a client certificate in order to gracefully preform the scan without causing excessive logging in the endpoint process. The secret must exist in the same namespace as this resource.

.spec.tlsClientCert

Description

TLSClientCert, if specified, references a kubernetes.io/tls type secret with 'tls.crt' and 'tls.key' entries containing an optional TLS client certificate and key to be used when checking endpoints that require a client certificate in order to gracefully preform the scan without causing excessive logging in the endpoint process. The secret must exist in the same namespace as this resource.

Type

`object`

Required

• name

Property	Type	Description
name	string	name is the metadata.name of the referenced secret

.status

Description

status contains the observed status of the connectivity check

Type

`object`

Property	Type	Description
conditions	array	conditions summarize the status of the check
conditions[]	object	PodNetworkConnectivityCheckCondition represents the overall status of the pod network connectivity.
failures	array	failures contains logs of unsuccessful check actions
failures[]	object	LogEntry records events
outages	array	outages contains logs of time periods of outages
outages[]	object	OutageEntry records time period of an outage
successes	array	successes contains logs successful check actions
successes[]	object	LogEntry records events

.status.conditions

Description

conditions summarize the status of the check

Type

`array`

.status.conditions[]

Description

PodNetworkConnectivityCheckCondition represents the overall status of the pod network connectivity.

Type

`object`

Required

• status
• type

Property	Type	Description
lastTransitionTime	``	Last time the condition transitioned from one status to another.
message	string	message indicating details about last transition in a human readable format.
reason	string	reason for the condition’s last status transition in a machine readable format.
status	string	status of the condition
type	string	type of the condition

.status.failures

Description

failures contains logs of unsuccessful check actions

Type

`array`

.status.failures[]

Description

LogEntry records events

Type

`object`

Required

• success

Property	Type	Description
latency	``	latency records how long the action mentioned in the entry took.
message	string	message explaining status in a human readable format.
reason	string	reason for status in a machine readable format.
success	boolean	success indicates if the log entry indicates a success or failure.
time	``	Start time of check action.

.status.outages

Description

outages contains logs of time periods of outages

Type

`array`

.status.outages[]

Description

OutageEntry records time period of an outage

Type

`object`

Property	Type	Description
end	``	end of outage detected
endLogs	array	endLogs contains log entries related to the end of this outage. Should contain the success entry that resolved the outage and possibly a few of the failure log entries that preceded it.
endLogs[]	object	LogEntry records events
message	string	message summarizes outage details in a human readable format.
start	``	start of outage detected
startLogs	array	startLogs contains log entries related to the start of this outage. Should contain the original failure, any entries where the failure mode changed.
startLogs[]	object	LogEntry records events

.status.outages[].endLogs

Description

endLogs contains log entries related to the end of this outage. Should contain the success entry that resolved the outage and possibly a few of the failure log entries that preceded it.

Type

`array`

.status.outages[].endLogs[]

Description

LogEntry records events

Type

`object`

Required

• success

Property	Type	Description
latency	``	latency records how long the action mentioned in the entry took.
message	string	message explaining status in a human readable format.
reason	string	reason for status in a machine readable format.
success	boolean	success indicates if the log entry indicates a success or failure.
time	``	Start time of check action.

.status.outages[].startLogs

Description

startLogs contains log entries related to the start of this outage. Should contain the original failure, any entries where the failure mode changed.

Type

`array`

.status.outages[].startLogs[]

Description

LogEntry records events

Type

`object`

Required

• success

Property	Type	Description
latency	``	latency records how long the action mentioned in the entry took.
message	string	message explaining status in a human readable format.
reason	string	reason for status in a machine readable format.
success	boolean	success indicates if the log entry indicates a success or failure.
time	``	Start time of check action.

.status.successes

Description

successes contains logs successful check actions

Type

`array`

.status.successes[]

Description

LogEntry records events

Type

`object`

Required

• success

Property	Type	Description
latency	``	latency records how long the action mentioned in the entry took.
message	string	message explaining status in a human readable format.
reason	string	reason for status in a machine readable format.
success	boolean	success indicates if the log entry indicates a success or failure.
time	``	Start time of check action.

API endpoints

The following API endpoints are available:

• /apis/controlplane.operator.openshift.io/v1alpha1/podnetworkconnectivitychecks
  • GET: list objects of kind PodNetworkConnectivityCheck
• /apis/controlplane.operator.openshift.io/v1alpha1/namespaces/{namespace}/podnetworkconnectivitychecks
  • DELETE: delete collection of PodNetworkConnectivityCheck
  • GET: list objects of kind PodNetworkConnectivityCheck
  • POST: create a PodNetworkConnectivityCheck
• /apis/controlplane.operator.openshift.io/v1alpha1/namespaces/{namespace}/podnetworkconnectivitychecks/{name}
  • DELETE: delete a PodNetworkConnectivityCheck
  • GET: read the specified PodNetworkConnectivityCheck
  • PATCH: partially update the specified PodNetworkConnectivityCheck
  • PUT: replace the specified PodNetworkConnectivityCheck
• /apis/controlplane.operator.openshift.io/v1alpha1/namespaces/{namespace}/podnetworkconnectivitychecks/{name}/status
  • GET: read status of the specified PodNetworkConnectivityCheck
  • PATCH: partially update status of the specified PodNetworkConnectivityCheck
  • PUT: replace status of the specified PodNetworkConnectivityCheck

/apis/controlplane.operator.openshift.io/v1alpha1/podnetworkconnectivitychecks

HTTP method

`GET`

Description

list objects of kind PodNetworkConnectivityCheck

HTTP responses

HTTP code	Reponse body
200 - OK	PodNetworkConnectivityCheckList schema
401 - Unauthorized	Empty

/apis/controlplane.operator.openshift.io/v1alpha1/namespaces/{namespace}/podnetworkconnectivitychecks

HTTP method

`DELETE`

Description

delete collection of PodNetworkConnectivityCheck

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

list objects of kind PodNetworkConnectivityCheck

HTTP responses

HTTP code	Reponse body
200 - OK	PodNetworkConnectivityCheckList schema
401 - Unauthorized	Empty

HTTP method

`POST`

Description

create a PodNetworkConnectivityCheck

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.

Body parameters

Parameter	Type	Description
body	PodNetworkConnectivityCheck schema

HTTP responses

HTTP code	Reponse body
200 - OK	PodNetworkConnectivityCheck schema
201 - Created	PodNetworkConnectivityCheck schema
202 - Accepted	PodNetworkConnectivityCheck schema
401 - Unauthorized	Empty

/apis/controlplane.operator.openshift.io/v1alpha1/namespaces/{namespace}/podnetworkconnectivitychecks/{name}

Global path parameters

Parameter	Type	Description
name	string	name of the PodNetworkConnectivityCheck

HTTP method

`DELETE`

Description

delete a PodNetworkConnectivityCheck

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

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
202 - Accepted	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

read the specified PodNetworkConnectivityCheck

HTTP responses

HTTP code	Reponse body
200 - OK	PodNetworkConnectivityCheck schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update the specified PodNetworkConnectivityCheck

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.

HTTP responses

HTTP code	Reponse body
200 - OK	PodNetworkConnectivityCheck schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace the specified PodNetworkConnectivityCheck

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.

Body parameters

Parameter	Type	Description
body	PodNetworkConnectivityCheck schema

HTTP responses

HTTP code	Reponse body
200 - OK	PodNetworkConnectivityCheck schema
201 - Created	PodNetworkConnectivityCheck schema
401 - Unauthorized	Empty

/apis/controlplane.operator.openshift.io/v1alpha1/namespaces/{namespace}/podnetworkconnectivitychecks/{name}/status

Global path parameters

Parameter	Type	Description
name	string	name of the PodNetworkConnectivityCheck

HTTP method

`GET`

Description

read status of the specified PodNetworkConnectivityCheck

HTTP responses

HTTP code	Reponse body
200 - OK	PodNetworkConnectivityCheck schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update status of the specified PodNetworkConnectivityCheck

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.

HTTP responses

HTTP code	Reponse body
200 - OK	PodNetworkConnectivityCheck schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace status of the specified PodNetworkConnectivityCheck

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.

Body parameters

Parameter	Type	Description
body	PodNetworkConnectivityCheck schema

HTTP responses

HTTP code	Reponse body
200 - OK	PodNetworkConnectivityCheck schema
201 - Created	PodNetworkConnectivityCheck schema
401 - Unauthorized	Empty