Trace

Trace is the Schema for the traces API

Full name:

traces.gadget.kinvolk.io

Group:

gadget.kinvolk.io

Singular name:

trace

Plural name:

traces

Scope:

Namespaced

Versions:

v1alpha1

Version v1alpha1

Example CR

apiVersion: gadget.kinvolk.io/v1alpha1
kind: Trace
metadata:
  name: dns
  namespace: gadget
spec:
  node: minikube
  gadget: dns
  filter:
    namespace: gadget
    podname: etcd-minikube
  runMode: Manual
  outputMode: Stream

Properties

.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

object

.spec

object

TraceSpec defines the desired state of Trace

.spec.filter

object

Filter is to tell the gadget to filter events based on namespace, pod name, labels or container name

.spec.filter.containerName

string

ContainerName selects events from containers with this name

.spec.filter.labels

object

Labels selects events from pods with these labels

.spec.filter.namespace

string

Namespace selects events from this pod namespace

.spec.filter.podname

string

Podname selects events from this pod name

.spec.gadget

string

Gadget is the name of the gadget such as “seccomp”

.spec.node

string

Node is the name of the node on which this trace should run

.spec.output

string

Output allows a gadget to output the results in the specified location. * With OutputMode=Status|Stream, Output is unused * With OutputMode=File, Output specifies the file path * With OutputMode=ExternalResource, Output specifies the external resource (such as seccompprofiles.security-profiles-operator.x-k8s.io for the seccomp gadget)

.spec.outputMode

string

OutputMode is “Status”, “Stream”, “File” or “ExternalResource”

.spec.parameters

object

Parameters contains gadget specific configurations.

.spec.runMode

string

RunMode is “Auto” to automatically start the trace as soon as the resource is created, or “Manual” to be controlled by the “gadget.kinvolk.io/operation” annotation

.status

object

TraceStatus defines the observed state of Trace

.status.operationError

string

OperationError is the error returned by the gadget when applying the annotation gadget.kinvolk.io/operation=

.status.operationWarning

string

OperationWarning is returned by the gadget to notify about a malfunction when applying the annotation gadget.kinvolk.io/operation=. Unlike the OperationError that represents a fatal error, the OperationWarning could be ignored according to the context.

.status.output

string

Output is the output of the gadget

.status.state

string

State is “Started”, “Stopped” or “Completed”