Skip to main content
Version: 3.3

PortworxDiag CRD reference

PortworxDiag is the Schema for the portworxdiags API.

PortworxDiag

FieldDescriptionType
apiVersionAPIVersion 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
string
kindKind 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
string
specPortworxDiagSpec is the spec used to define a portworx diag.object
statusPortworxDiagStatus is the status of a portworx diag.object

spec fields

FieldDescriptionType
spec.portworxConfiguration for diags collection of the main Portworx component.object
spec.portworx.generateCoreGenerates the core dump as well when collecting the node diags. Could be useful
to analyze the current state of the system.
boolean
spec.portworx.nodesNodes for which the diags need to be collected. If a volume selector is
also specified, then both the selectors will be honored and the selected
nodes will be a union of both selectors.
object
spec.portworx.nodes.allSelect all nodes in the Portworx cluster. If set to true, other selectors are ignored.boolean
spec.portworx.nodes.idsIds of the nodes to be selected.array
spec.portworx.nodes.labelsLabels of the nodes to be selected.object
spec.portworx.podDiagsCollects all the pod diags. Used to specify whether Pod diags need to be
collected or not.
boolean
spec.portworx.volumesCollects the diags for the nodes on which the selected volumes are attached.object
spec.portworx.volumes.idsIds of the volumes to be selected.array
spec.portworx.volumes.labelsLabels of the volumes to be selected.object

status fields

FieldDescriptionType
status.clusterUuidUUID of the Portworx cluster. This is useful to find the uploaded diags.string
status.messageOptional message used to give the reason for any failure.string
status.nodesStatus of the diags collection from all the selected nodes.array
status.nodes.messageOptional message used to give the reason for any failure.string
status.nodes.nodeIdID of the node for which the diag status is reported.string
status.nodes.statusOne word status of the diags collection on the node.string
status.phaseOne word status of the entire diags collection job.string
status.podDiagsStatus of the diags collection from all the pods.object
status.podDiags.messageOptional message used to give the reason for any failure.string
status.podDiags.statusOne word status of the pod diags collection.string