github.com/inspektor-gadget/inspektor-gadget@v0.28.1/docs/crds/traces.gadget.kinvolk.io.md (about)

     1  ---
     2  # Code generated by 'make generate-documentation'. DO NOT EDIT.
     3  # Initial template from
     4  # https://github.com/giantswarm/crd-docs-generator/blob/master/templates/crd.template
     5  # Licensed under the Apache License, Version 2.0
     6  title: Trace CRD schema reference (group gadget.kinvolk.io)
     7  linkTitle: Trace
     8  description: |
     9    Trace is the Schema for the traces API
    10  weight: 100
    11  crd:
    12    name_camelcase: Trace
    13    name_plural: traces
    14    name_singular: trace
    15    group: gadget.kinvolk.io
    16    technical_name: traces.gadget.kinvolk.io
    17    scope: Namespaced
    18    source_repository: github.com/inspektor-gadget/inspektor-gadget
    19    versions:
    20      - v1alpha1
    21    topics:
    22  layout: crd
    23  owner:
    24  aliases:
    25    - /reference/cp-k8s-api/traces.gadget.kinvolk.io/
    26  technical_name: traces.gadget.kinvolk.io
    27  source_repository: github.com/inspektor-gadget/inspektor-gadget
    28  _build:
    29    list: never
    30    publishResources: false
    31    render: never
    32  ---
    33  
    34  # Trace
    35  
    36  
    37  <p class="crd-description">Trace is the Schema for the traces API</p>
    38  <dl class="crd-meta">
    39  <dt class="fullname">Full name:</dt>
    40  <dd class="fullname">traces.gadget.kinvolk.io</dd>
    41  <dt class="groupname">Group:</dt>
    42  <dd class="groupname">gadget.kinvolk.io</dd>
    43  <dt class="singularname">Singular name:</dt>
    44  <dd class="singularname">trace</dd>
    45  <dt class="pluralname">Plural name:</dt>
    46  <dd class="pluralname">traces</dd>
    47  <dt class="scope">Scope:</dt>
    48  <dd class="scope">Namespaced</dd>
    49  <dt class="versions">Versions:</dt>
    50  <dd class="versions"><a class="version" href="#v1alpha1" title="Show schema for version v1alpha1">v1alpha1</a></dd>
    51  </dl>
    52  
    53  
    54  
    55  <div class="crd-schema-version">
    56  <h2 id="v1alpha1">Version v1alpha1</h2>
    57  
    58  
    59  <h3 id="crd-example-v1alpha1">Example CR</h3>
    60  
    61  ```yaml
    62  apiVersion: gadget.kinvolk.io/v1alpha1
    63  kind: Trace
    64  metadata:
    65    name: dns
    66    namespace: gadget
    67  spec:
    68    node: minikube
    69    gadget: dns
    70    filter:
    71      namespace: gadget
    72      podname: etcd-minikube
    73    runMode: Manual
    74    outputMode: Stream
    75  
    76  ```
    77  
    78  
    79  <h3 id="property-details-v1alpha1">Properties</h3>
    80  
    81  
    82  <div class="property depth-0">
    83  <div class="property-header">
    84  <h3 class="property-path" id="v1alpha1-.apiVersion">.apiVersion</h3>
    85  </div>
    86  <div class="property-body">
    87  <div class="property-meta">
    88  <span class="property-type">string</span>
    89  
    90  </div>
    91  
    92  <div class="property-description">
    93  <p>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: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources</a></p>
    94  
    95  </div>
    96  
    97  </div>
    98  </div>
    99  
   100  <div class="property depth-0">
   101  <div class="property-header">
   102  <h3 class="property-path" id="v1alpha1-.kind">.kind</h3>
   103  </div>
   104  <div class="property-body">
   105  <div class="property-meta">
   106  <span class="property-type">string</span>
   107  
   108  </div>
   109  
   110  <div class="property-description">
   111  <p>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: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</a></p>
   112  
   113  </div>
   114  
   115  </div>
   116  </div>
   117  
   118  <div class="property depth-0">
   119  <div class="property-header">
   120  <h3 class="property-path" id="v1alpha1-.metadata">.metadata</h3>
   121  </div>
   122  <div class="property-body">
   123  <div class="property-meta">
   124  <span class="property-type">object</span>
   125  
   126  </div>
   127  
   128  </div>
   129  </div>
   130  
   131  <div class="property depth-0">
   132  <div class="property-header">
   133  <h3 class="property-path" id="v1alpha1-.spec">.spec</h3>
   134  </div>
   135  <div class="property-body">
   136  <div class="property-meta">
   137  <span class="property-type">object</span>
   138  
   139  </div>
   140  
   141  <div class="property-description">
   142  <p>TraceSpec defines the desired state of Trace</p>
   143  
   144  </div>
   145  
   146  </div>
   147  </div>
   148  
   149  <div class="property depth-1">
   150  <div class="property-header">
   151  <h3 class="property-path" id="v1alpha1-.spec.filter">.spec.filter</h3>
   152  </div>
   153  <div class="property-body">
   154  <div class="property-meta">
   155  <span class="property-type">object</span>
   156  
   157  </div>
   158  
   159  <div class="property-description">
   160  <p>Filter is to tell the gadget to filter events based on namespace, pod name, labels or container name</p>
   161  
   162  </div>
   163  
   164  </div>
   165  </div>
   166  
   167  <div class="property depth-2">
   168  <div class="property-header">
   169  <h3 class="property-path" id="v1alpha1-.spec.filter.containerName">.spec.filter.containerName</h3>
   170  </div>
   171  <div class="property-body">
   172  <div class="property-meta">
   173  <span class="property-type">string</span>
   174  
   175  </div>
   176  
   177  <div class="property-description">
   178  <p>ContainerName selects events from containers with this name</p>
   179  
   180  </div>
   181  
   182  </div>
   183  </div>
   184  
   185  <div class="property depth-2">
   186  <div class="property-header">
   187  <h3 class="property-path" id="v1alpha1-.spec.filter.labels">.spec.filter.labels</h3>
   188  </div>
   189  <div class="property-body">
   190  <div class="property-meta">
   191  <span class="property-type">object</span>
   192  
   193  </div>
   194  
   195  <div class="property-description">
   196  <p>Labels selects events from pods with these labels</p>
   197  
   198  </div>
   199  
   200  </div>
   201  </div>
   202  
   203  <div class="property depth-2">
   204  <div class="property-header">
   205  <h3 class="property-path" id="v1alpha1-.spec.filter.namespace">.spec.filter.namespace</h3>
   206  </div>
   207  <div class="property-body">
   208  <div class="property-meta">
   209  <span class="property-type">string</span>
   210  
   211  </div>
   212  
   213  <div class="property-description">
   214  <p>Namespace selects events from this pod namespace</p>
   215  
   216  </div>
   217  
   218  </div>
   219  </div>
   220  
   221  <div class="property depth-2">
   222  <div class="property-header">
   223  <h3 class="property-path" id="v1alpha1-.spec.filter.podname">.spec.filter.podname</h3>
   224  </div>
   225  <div class="property-body">
   226  <div class="property-meta">
   227  <span class="property-type">string</span>
   228  
   229  </div>
   230  
   231  <div class="property-description">
   232  <p>Podname selects events from this pod name</p>
   233  
   234  </div>
   235  
   236  </div>
   237  </div>
   238  
   239  <div class="property depth-1">
   240  <div class="property-header">
   241  <h3 class="property-path" id="v1alpha1-.spec.gadget">.spec.gadget</h3>
   242  </div>
   243  <div class="property-body">
   244  <div class="property-meta">
   245  <span class="property-type">string</span>
   246  
   247  </div>
   248  
   249  <div class="property-description">
   250  <p>Gadget is the name of the gadget such as &ldquo;seccomp&rdquo;</p>
   251  
   252  </div>
   253  
   254  </div>
   255  </div>
   256  
   257  <div class="property depth-1">
   258  <div class="property-header">
   259  <h3 class="property-path" id="v1alpha1-.spec.node">.spec.node</h3>
   260  </div>
   261  <div class="property-body">
   262  <div class="property-meta">
   263  <span class="property-type">string</span>
   264  
   265  </div>
   266  
   267  <div class="property-description">
   268  <p>Node is the name of the node on which this trace should run</p>
   269  
   270  </div>
   271  
   272  </div>
   273  </div>
   274  
   275  <div class="property depth-1">
   276  <div class="property-header">
   277  <h3 class="property-path" id="v1alpha1-.spec.output">.spec.output</h3>
   278  </div>
   279  <div class="property-body">
   280  <div class="property-meta">
   281  <span class="property-type">string</span>
   282  
   283  </div>
   284  
   285  <div class="property-description">
   286  <p>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)</p>
   287  
   288  </div>
   289  
   290  </div>
   291  </div>
   292  
   293  <div class="property depth-1">
   294  <div class="property-header">
   295  <h3 class="property-path" id="v1alpha1-.spec.outputMode">.spec.outputMode</h3>
   296  </div>
   297  <div class="property-body">
   298  <div class="property-meta">
   299  <span class="property-type">string</span>
   300  
   301  </div>
   302  
   303  <div class="property-description">
   304  <p>OutputMode is &ldquo;Status&rdquo;, &ldquo;Stream&rdquo;, &ldquo;File&rdquo; or &ldquo;ExternalResource&rdquo;</p>
   305  
   306  </div>
   307  
   308  </div>
   309  </div>
   310  
   311  <div class="property depth-1">
   312  <div class="property-header">
   313  <h3 class="property-path" id="v1alpha1-.spec.parameters">.spec.parameters</h3>
   314  </div>
   315  <div class="property-body">
   316  <div class="property-meta">
   317  <span class="property-type">object</span>
   318  
   319  </div>
   320  
   321  <div class="property-description">
   322  <p>Parameters contains gadget specific configurations.</p>
   323  
   324  </div>
   325  
   326  </div>
   327  </div>
   328  
   329  <div class="property depth-1">
   330  <div class="property-header">
   331  <h3 class="property-path" id="v1alpha1-.spec.runMode">.spec.runMode</h3>
   332  </div>
   333  <div class="property-body">
   334  <div class="property-meta">
   335  <span class="property-type">string</span>
   336  
   337  </div>
   338  
   339  <div class="property-description">
   340  <p>RunMode is &ldquo;Auto&rdquo; to automatically start the trace as soon as the resource is created, or &ldquo;Manual&rdquo; to be controlled by the &ldquo;gadget.kinvolk.io/operation&rdquo; annotation</p>
   341  
   342  </div>
   343  
   344  </div>
   345  </div>
   346  
   347  <div class="property depth-0">
   348  <div class="property-header">
   349  <h3 class="property-path" id="v1alpha1-.status">.status</h3>
   350  </div>
   351  <div class="property-body">
   352  <div class="property-meta">
   353  <span class="property-type">object</span>
   354  
   355  </div>
   356  
   357  <div class="property-description">
   358  <p>TraceStatus defines the observed state of Trace</p>
   359  
   360  </div>
   361  
   362  </div>
   363  </div>
   364  
   365  <div class="property depth-1">
   366  <div class="property-header">
   367  <h3 class="property-path" id="v1alpha1-.status.operationError">.status.operationError</h3>
   368  </div>
   369  <div class="property-body">
   370  <div class="property-meta">
   371  <span class="property-type">string</span>
   372  
   373  </div>
   374  
   375  <div class="property-description">
   376  <p>OperationError is the error returned by the gadget when applying the annotation gadget.kinvolk.io/operation=</p>
   377  
   378  </div>
   379  
   380  </div>
   381  </div>
   382  
   383  <div class="property depth-1">
   384  <div class="property-header">
   385  <h3 class="property-path" id="v1alpha1-.status.operationWarning">.status.operationWarning</h3>
   386  </div>
   387  <div class="property-body">
   388  <div class="property-meta">
   389  <span class="property-type">string</span>
   390  
   391  </div>
   392  
   393  <div class="property-description">
   394  <p>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.</p>
   395  
   396  </div>
   397  
   398  </div>
   399  </div>
   400  
   401  <div class="property depth-1">
   402  <div class="property-header">
   403  <h3 class="property-path" id="v1alpha1-.status.output">.status.output</h3>
   404  </div>
   405  <div class="property-body">
   406  <div class="property-meta">
   407  <span class="property-type">string</span>
   408  
   409  </div>
   410  
   411  <div class="property-description">
   412  <p>Output is the output of the gadget</p>
   413  
   414  </div>
   415  
   416  </div>
   417  </div>
   418  
   419  <div class="property depth-1">
   420  <div class="property-header">
   421  <h3 class="property-path" id="v1alpha1-.status.state">.status.state</h3>
   422  </div>
   423  <div class="property-body">
   424  <div class="property-meta">
   425  <span class="property-type">string</span>
   426  
   427  </div>
   428  
   429  <div class="property-description">
   430  <p>State is &ldquo;Started&rdquo;, &ldquo;Stopped&rdquo; or &ldquo;Completed&rdquo;</p>
   431  
   432  </div>
   433  
   434  </div>
   435  </div>
   436  
   437  
   438  
   439  
   440  
   441  </div>
   442  
   443  
   444