github.com/argoproj/argo-events@v1.9.1/api/event-bus.md (about)

     1  <p>
     2  Packages:
     3  </p>
     4  <ul>
     5  <li>
     6  <a href="#argoproj.io%2fv1alpha1">argoproj.io/v1alpha1</a>
     7  </li>
     8  </ul>
     9  <h2 id="argoproj.io/v1alpha1">
    10  argoproj.io/v1alpha1
    11  </h2>
    12  <p>
    13  <p>
    14  Package v1alpha1 is the v1alpha1 version of the API.
    15  </p>
    16  </p>
    17  Resource Types:
    18  <ul>
    19  </ul>
    20  <h3 id="argoproj.io/v1alpha1.AuthStrategy">
    21  AuthStrategy (<code>string</code> alias)
    22  </p>
    23  </h3>
    24  <p>
    25  (<em>Appears on:</em>
    26  <a href="#argoproj.io/v1alpha1.NATSConfig">NATSConfig</a>,
    27  <a href="#argoproj.io/v1alpha1.NativeStrategy">NativeStrategy</a>)
    28  </p>
    29  <p>
    30  <p>
    31  AuthStrategy is the auth strategy of native nats installaion
    32  </p>
    33  </p>
    34  <h3 id="argoproj.io/v1alpha1.BusConfig">
    35  BusConfig
    36  </h3>
    37  <p>
    38  (<em>Appears on:</em>
    39  <a href="#argoproj.io/v1alpha1.EventBusStatus">EventBusStatus</a>)
    40  </p>
    41  <p>
    42  <p>
    43  BusConfig has the finalized configuration for EventBus
    44  </p>
    45  </p>
    46  <table>
    47  <thead>
    48  <tr>
    49  <th>
    50  Field
    51  </th>
    52  <th>
    53  Description
    54  </th>
    55  </tr>
    56  </thead>
    57  <tbody>
    58  <tr>
    59  <td>
    60  <code>nats</code></br> <em> <a href="#argoproj.io/v1alpha1.NATSConfig">
    61  NATSConfig </a> </em>
    62  </td>
    63  <td>
    64  <em>(Optional)</em>
    65  </td>
    66  </tr>
    67  <tr>
    68  <td>
    69  <code>jetstream</code></br> <em>
    70  <a href="#argoproj.io/v1alpha1.JetStreamConfig"> JetStreamConfig </a>
    71  </em>
    72  </td>
    73  <td>
    74  <em>(Optional)</em>
    75  </td>
    76  </tr>
    77  <tr>
    78  <td>
    79  <code>kafka</code></br> <em> <a href="#argoproj.io/v1alpha1.KafkaBus">
    80  KafkaBus </a> </em>
    81  </td>
    82  <td>
    83  <em>(Optional)</em>
    84  </td>
    85  </tr>
    86  </tbody>
    87  </table>
    88  <h3 id="argoproj.io/v1alpha1.ContainerTemplate">
    89  ContainerTemplate
    90  </h3>
    91  <p>
    92  (<em>Appears on:</em>
    93  <a href="#argoproj.io/v1alpha1.JetStreamBus">JetStreamBus</a>,
    94  <a href="#argoproj.io/v1alpha1.NativeStrategy">NativeStrategy</a>)
    95  </p>
    96  <p>
    97  <p>
    98  ContainerTemplate defines customized spec for a container
    99  </p>
   100  </p>
   101  <table>
   102  <thead>
   103  <tr>
   104  <th>
   105  Field
   106  </th>
   107  <th>
   108  Description
   109  </th>
   110  </tr>
   111  </thead>
   112  <tbody>
   113  <tr>
   114  <td>
   115  <code>resources</code></br> <em>
   116  <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#resourcerequirements-v1-core">
   117  Kubernetes core/v1.ResourceRequirements </a> </em>
   118  </td>
   119  <td>
   120  </td>
   121  </tr>
   122  <tr>
   123  <td>
   124  <code>imagePullPolicy</code></br> <em>
   125  <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#pullpolicy-v1-core">
   126  Kubernetes core/v1.PullPolicy </a> </em>
   127  </td>
   128  <td>
   129  </td>
   130  </tr>
   131  <tr>
   132  <td>
   133  <code>securityContext</code></br> <em>
   134  <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#securitycontext-v1-core">
   135  Kubernetes core/v1.SecurityContext </a> </em>
   136  </td>
   137  <td>
   138  </td>
   139  </tr>
   140  </tbody>
   141  </table>
   142  <h3 id="argoproj.io/v1alpha1.EventBus">
   143  EventBus
   144  </h3>
   145  <p>
   146  <p>
   147  EventBus is the definition of a eventbus resource
   148  </p>
   149  </p>
   150  <table>
   151  <thead>
   152  <tr>
   153  <th>
   154  Field
   155  </th>
   156  <th>
   157  Description
   158  </th>
   159  </tr>
   160  </thead>
   161  <tbody>
   162  <tr>
   163  <td>
   164  <code>metadata</code></br> <em>
   165  <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
   166  Kubernetes meta/v1.ObjectMeta </a> </em>
   167  </td>
   168  <td>
   169  Refer to the Kubernetes API documentation for the fields of the
   170  <code>metadata</code> field.
   171  </td>
   172  </tr>
   173  <tr>
   174  <td>
   175  <code>spec</code></br> <em>
   176  <a href="#argoproj.io/v1alpha1.EventBusSpec"> EventBusSpec </a> </em>
   177  </td>
   178  <td>
   179  <br/> <br/>
   180  <table>
   181  <tr>
   182  <td>
   183  <code>nats</code></br> <em> <a href="#argoproj.io/v1alpha1.NATSBus">
   184  NATSBus </a> </em>
   185  </td>
   186  <td>
   187  <em>(Optional)</em>
   188  <p>
   189  NATS eventbus
   190  </p>
   191  </td>
   192  </tr>
   193  <tr>
   194  <td>
   195  <code>jetstream</code></br> <em>
   196  <a href="#argoproj.io/v1alpha1.JetStreamBus"> JetStreamBus </a> </em>
   197  </td>
   198  <td>
   199  <em>(Optional)</em>
   200  </td>
   201  </tr>
   202  <tr>
   203  <td>
   204  <code>kafka</code></br> <em> <a href="#argoproj.io/v1alpha1.KafkaBus">
   205  KafkaBus </a> </em>
   206  </td>
   207  <td>
   208  <em>(Optional)</em>
   209  <p>
   210  Kafka eventbus
   211  </p>
   212  </td>
   213  </tr>
   214  <tr>
   215  <td>
   216  <code>jetstreamExotic</code></br> <em>
   217  <a href="#argoproj.io/v1alpha1.JetStreamConfig"> JetStreamConfig </a>
   218  </em>
   219  </td>
   220  <td>
   221  <em>(Optional)</em>
   222  <p>
   223  Exotic JetStream
   224  </p>
   225  </td>
   226  </tr>
   227  </table>
   228  </td>
   229  </tr>
   230  <tr>
   231  <td>
   232  <code>status</code></br> <em>
   233  <a href="#argoproj.io/v1alpha1.EventBusStatus"> EventBusStatus </a>
   234  </em>
   235  </td>
   236  <td>
   237  <em>(Optional)</em>
   238  </td>
   239  </tr>
   240  </tbody>
   241  </table>
   242  <h3 id="argoproj.io/v1alpha1.EventBusSpec">
   243  EventBusSpec
   244  </h3>
   245  <p>
   246  (<em>Appears on:</em>
   247  <a href="#argoproj.io/v1alpha1.EventBus">EventBus</a>)
   248  </p>
   249  <p>
   250  <p>
   251  EventBusSpec refers to specification of eventbus resource
   252  </p>
   253  </p>
   254  <table>
   255  <thead>
   256  <tr>
   257  <th>
   258  Field
   259  </th>
   260  <th>
   261  Description
   262  </th>
   263  </tr>
   264  </thead>
   265  <tbody>
   266  <tr>
   267  <td>
   268  <code>nats</code></br> <em> <a href="#argoproj.io/v1alpha1.NATSBus">
   269  NATSBus </a> </em>
   270  </td>
   271  <td>
   272  <em>(Optional)</em>
   273  <p>
   274  NATS eventbus
   275  </p>
   276  </td>
   277  </tr>
   278  <tr>
   279  <td>
   280  <code>jetstream</code></br> <em>
   281  <a href="#argoproj.io/v1alpha1.JetStreamBus"> JetStreamBus </a> </em>
   282  </td>
   283  <td>
   284  <em>(Optional)</em>
   285  </td>
   286  </tr>
   287  <tr>
   288  <td>
   289  <code>kafka</code></br> <em> <a href="#argoproj.io/v1alpha1.KafkaBus">
   290  KafkaBus </a> </em>
   291  </td>
   292  <td>
   293  <em>(Optional)</em>
   294  <p>
   295  Kafka eventbus
   296  </p>
   297  </td>
   298  </tr>
   299  <tr>
   300  <td>
   301  <code>jetstreamExotic</code></br> <em>
   302  <a href="#argoproj.io/v1alpha1.JetStreamConfig"> JetStreamConfig </a>
   303  </em>
   304  </td>
   305  <td>
   306  <em>(Optional)</em>
   307  <p>
   308  Exotic JetStream
   309  </p>
   310  </td>
   311  </tr>
   312  </tbody>
   313  </table>
   314  <h3 id="argoproj.io/v1alpha1.EventBusStatus">
   315  EventBusStatus
   316  </h3>
   317  <p>
   318  (<em>Appears on:</em>
   319  <a href="#argoproj.io/v1alpha1.EventBus">EventBus</a>)
   320  </p>
   321  <p>
   322  <p>
   323  EventBusStatus holds the status of the eventbus resource
   324  </p>
   325  </p>
   326  <table>
   327  <thead>
   328  <tr>
   329  <th>
   330  Field
   331  </th>
   332  <th>
   333  Description
   334  </th>
   335  </tr>
   336  </thead>
   337  <tbody>
   338  <tr>
   339  <td>
   340  <code>Status</code></br> <em>
   341  github.com/argoproj/argo-events/pkg/apis/common.Status </em>
   342  </td>
   343  <td>
   344  <p>
   345  (Members of <code>Status</code> are embedded into this type.)
   346  </p>
   347  </td>
   348  </tr>
   349  <tr>
   350  <td>
   351  <code>config</code></br> <em> <a href="#argoproj.io/v1alpha1.BusConfig">
   352  BusConfig </a> </em>
   353  </td>
   354  <td>
   355  <p>
   356  Config holds the fininalized configuration of EventBus
   357  </p>
   358  </td>
   359  </tr>
   360  </tbody>
   361  </table>
   362  <h3 id="argoproj.io/v1alpha1.JetStreamBus">
   363  JetStreamBus
   364  </h3>
   365  <p>
   366  (<em>Appears on:</em>
   367  <a href="#argoproj.io/v1alpha1.EventBusSpec">EventBusSpec</a>)
   368  </p>
   369  <p>
   370  <p>
   371  JetStreamBus holds the JetStream EventBus information
   372  </p>
   373  </p>
   374  <table>
   375  <thead>
   376  <tr>
   377  <th>
   378  Field
   379  </th>
   380  <th>
   381  Description
   382  </th>
   383  </tr>
   384  </thead>
   385  <tbody>
   386  <tr>
   387  <td>
   388  <code>version</code></br> <em> string </em>
   389  </td>
   390  <td>
   391  <p>
   392  JetStream version, such as “2.7.3”
   393  </p>
   394  </td>
   395  </tr>
   396  <tr>
   397  <td>
   398  <code>replicas</code></br> <em> int32 </em>
   399  </td>
   400  <td>
   401  <p>
   402  JetStream StatefulSet size
   403  </p>
   404  </td>
   405  </tr>
   406  <tr>
   407  <td>
   408  <code>containerTemplate</code></br> <em>
   409  <a href="#argoproj.io/v1alpha1.ContainerTemplate"> ContainerTemplate
   410  </a> </em>
   411  </td>
   412  <td>
   413  <em>(Optional)</em>
   414  <p>
   415  ContainerTemplate contains customized spec for Nats JetStream container
   416  </p>
   417  </td>
   418  </tr>
   419  <tr>
   420  <td>
   421  <code>reloaderContainerTemplate</code></br> <em>
   422  <a href="#argoproj.io/v1alpha1.ContainerTemplate"> ContainerTemplate
   423  </a> </em>
   424  </td>
   425  <td>
   426  <em>(Optional)</em>
   427  <p>
   428  ReloaderContainerTemplate contains customized spec for config reloader
   429  container
   430  </p>
   431  </td>
   432  </tr>
   433  <tr>
   434  <td>
   435  <code>metricsContainerTemplate</code></br> <em>
   436  <a href="#argoproj.io/v1alpha1.ContainerTemplate"> ContainerTemplate
   437  </a> </em>
   438  </td>
   439  <td>
   440  <em>(Optional)</em>
   441  <p>
   442  MetricsContainerTemplate contains customized spec for metrics container
   443  </p>
   444  </td>
   445  </tr>
   446  <tr>
   447  <td>
   448  <code>persistence</code></br> <em>
   449  <a href="#argoproj.io/v1alpha1.PersistenceStrategy"> PersistenceStrategy
   450  </a> </em>
   451  </td>
   452  <td>
   453  <em>(Optional)</em>
   454  </td>
   455  </tr>
   456  <tr>
   457  <td>
   458  <code>metadata</code></br> <em>
   459  github.com/argoproj/argo-events/pkg/apis/common.Metadata </em>
   460  </td>
   461  <td>
   462  <p>
   463  Metadata sets the pods’s metadata, i.e. annotations and labels
   464  </p>
   465  </td>
   466  </tr>
   467  <tr>
   468  <td>
   469  <code>nodeSelector</code></br> <em> map\[string\]string </em>
   470  </td>
   471  <td>
   472  <em>(Optional)</em>
   473  <p>
   474  NodeSelector is a selector which must be true for the pod to fit on a
   475  node. Selector which must match a node’s labels for the pod to be
   476  scheduled on that node. More info:
   477  <a href="https://kubernetes.io/docs/concepts/configuration/assign-pod-node/">https://kubernetes.io/docs/concepts/configuration/assign-pod-node/</a>
   478  </p>
   479  </td>
   480  </tr>
   481  <tr>
   482  <td>
   483  <code>tolerations</code></br> <em>
   484  <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#toleration-v1-core">
   485  \[\]Kubernetes core/v1.Toleration </a> </em>
   486  </td>
   487  <td>
   488  <em>(Optional)</em>
   489  <p>
   490  If specified, the pod’s tolerations.
   491  </p>
   492  </td>
   493  </tr>
   494  <tr>
   495  <td>
   496  <code>securityContext</code></br> <em>
   497  <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podsecuritycontext-v1-core">
   498  Kubernetes core/v1.PodSecurityContext </a> </em>
   499  </td>
   500  <td>
   501  <em>(Optional)</em>
   502  <p>
   503  SecurityContext holds pod-level security attributes and common container
   504  settings. Optional: Defaults to empty. See type description for default
   505  values of each field.
   506  </p>
   507  </td>
   508  </tr>
   509  <tr>
   510  <td>
   511  <code>imagePullSecrets</code></br> <em>
   512  <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#localobjectreference-v1-core">
   513  \[\]Kubernetes core/v1.LocalObjectReference </a> </em>
   514  </td>
   515  <td>
   516  <em>(Optional)</em>
   517  <p>
   518  ImagePullSecrets is an optional list of references to secrets in the
   519  same namespace to use for pulling any of the images used by this
   520  PodSpec. If specified, these secrets will be passed to individual puller
   521  implementations for them to use. For example, in the case of docker,
   522  only DockerConfig type secrets are honored. More info:
   523  <a href="https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod">https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod</a>
   524  </p>
   525  </td>
   526  </tr>
   527  <tr>
   528  <td>
   529  <code>priorityClassName</code></br> <em> string </em>
   530  </td>
   531  <td>
   532  <em>(Optional)</em>
   533  <p>
   534  If specified, indicates the Redis pod’s priority. “system-node-critical”
   535  and “system-cluster-critical” are two special keywords which indicate
   536  the highest priorities with the former being the highest priority. Any
   537  other name must be defined by creating a PriorityClass object with that
   538  name. If not specified, the pod priority will be default or zero if
   539  there is no default. More info:
   540  <a href="https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/">https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/</a>
   541  </p>
   542  </td>
   543  </tr>
   544  <tr>
   545  <td>
   546  <code>priority</code></br> <em> int32 </em>
   547  </td>
   548  <td>
   549  <em>(Optional)</em>
   550  <p>
   551  The priority value. Various system components use this field to find the
   552  priority of the Redis pod. When Priority Admission Controller is
   553  enabled, it prevents users from setting this field. The admission
   554  controller populates this field from PriorityClassName. The higher the
   555  value, the higher the priority. More info:
   556  <a href="https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/">https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/</a>
   557  </p>
   558  </td>
   559  </tr>
   560  <tr>
   561  <td>
   562  <code>affinity</code></br> <em>
   563  <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#affinity-v1-core">
   564  Kubernetes core/v1.Affinity </a> </em>
   565  </td>
   566  <td>
   567  <em>(Optional)</em>
   568  <p>
   569  The pod’s scheduling constraints More info:
   570  <a href="https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/">https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/</a>
   571  </p>
   572  </td>
   573  </tr>
   574  <tr>
   575  <td>
   576  <code>serviceAccountName</code></br> <em> string </em>
   577  </td>
   578  <td>
   579  <em>(Optional)</em>
   580  <p>
   581  ServiceAccountName to apply to the StatefulSet
   582  </p>
   583  </td>
   584  </tr>
   585  <tr>
   586  <td>
   587  <code>settings</code></br> <em> string </em>
   588  </td>
   589  <td>
   590  <em>(Optional)</em>
   591  <p>
   592  JetStream configuration, if not specified, global settings in
   593  controller-config will be used. See
   594  <a href="https://docs.nats.io/running-a-nats-service/configuration#jetstream">https://docs.nats.io/running-a-nats-service/configuration#jetstream</a>.
   595  Only configure “max_memory_store” or “max_file_store”, do not set
   596  “store_dir” as it has been hardcoded.
   597  </p>
   598  </td>
   599  </tr>
   600  <tr>
   601  <td>
   602  <code>startArgs</code></br> <em> \[\]string </em>
   603  </td>
   604  <td>
   605  <em>(Optional)</em>
   606  <p>
   607  Optional arguments to start nats-server. For example, “-D” to enable
   608  debugging output, “-DV” to enable debugging and tracing. Check
   609  <a href="https://docs.nats.io/">https://docs.nats.io/</a> for all the
   610  available arguments.
   611  </p>
   612  </td>
   613  </tr>
   614  <tr>
   615  <td>
   616  <code>streamConfig</code></br> <em> string </em>
   617  </td>
   618  <td>
   619  <em>(Optional)</em>
   620  <p>
   621  Optional configuration for the streams to be created in this JetStream
   622  service, if specified, it will be merged with the default configuration
   623  in controller-config. It accepts a YAML format configuration, available
   624  fields include, “maxBytes”, “maxMsgs”, “maxAge” (e.g. 72h), “replicas”
   625  (1, 3, 5), “duplicates” (e.g. 5m).
   626  </p>
   627  </td>
   628  </tr>
   629  <tr>
   630  <td>
   631  <code>maxPayload</code></br> <em> string </em>
   632  </td>
   633  <td>
   634  <em>(Optional)</em>
   635  <p>
   636  Maximum number of bytes in a message payload, 0 means unlimited.
   637  Defaults to 1MB
   638  </p>
   639  </td>
   640  </tr>
   641  </tbody>
   642  </table>
   643  <h3 id="argoproj.io/v1alpha1.JetStreamConfig">
   644  JetStreamConfig
   645  </h3>
   646  <p>
   647  (<em>Appears on:</em>
   648  <a href="#argoproj.io/v1alpha1.BusConfig">BusConfig</a>,
   649  <a href="#argoproj.io/v1alpha1.EventBusSpec">EventBusSpec</a>)
   650  </p>
   651  <p>
   652  </p>
   653  <table>
   654  <thead>
   655  <tr>
   656  <th>
   657  Field
   658  </th>
   659  <th>
   660  Description
   661  </th>
   662  </tr>
   663  </thead>
   664  <tbody>
   665  <tr>
   666  <td>
   667  <code>url</code></br> <em> string </em>
   668  </td>
   669  <td>
   670  <p>
   671  JetStream (Nats) URL
   672  </p>
   673  </td>
   674  </tr>
   675  <tr>
   676  <td>
   677  <code>accessSecret</code></br> <em>
   678  <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core">
   679  Kubernetes core/v1.SecretKeySelector </a> </em>
   680  </td>
   681  <td>
   682  <em>(Optional)</em>
   683  <p>
   684  Secret for auth
   685  </p>
   686  </td>
   687  </tr>
   688  <tr>
   689  <td>
   690  <code>streamConfig</code></br> <em> string </em>
   691  </td>
   692  <td>
   693  <em>(Optional)</em>
   694  </td>
   695  </tr>
   696  </tbody>
   697  </table>
   698  <h3 id="argoproj.io/v1alpha1.KafkaBus">
   699  KafkaBus
   700  </h3>
   701  <p>
   702  (<em>Appears on:</em>
   703  <a href="#argoproj.io/v1alpha1.BusConfig">BusConfig</a>,
   704  <a href="#argoproj.io/v1alpha1.EventBusSpec">EventBusSpec</a>)
   705  </p>
   706  <p>
   707  <p>
   708  KafkaBus holds the KafkaBus EventBus information
   709  </p>
   710  </p>
   711  <table>
   712  <thead>
   713  <tr>
   714  <th>
   715  Field
   716  </th>
   717  <th>
   718  Description
   719  </th>
   720  </tr>
   721  </thead>
   722  <tbody>
   723  <tr>
   724  <td>
   725  <code>url</code></br> <em> string </em>
   726  </td>
   727  <td>
   728  <p>
   729  URL to kafka cluster, multiple URLs separated by comma
   730  </p>
   731  </td>
   732  </tr>
   733  <tr>
   734  <td>
   735  <code>topic</code></br> <em> string </em>
   736  </td>
   737  <td>
   738  <em>(Optional)</em>
   739  <p>
   740  Topic name, defaults to {namespace_name}-{eventbus_name}
   741  </p>
   742  </td>
   743  </tr>
   744  <tr>
   745  <td>
   746  <code>version</code></br> <em> string </em>
   747  </td>
   748  <td>
   749  <em>(Optional)</em>
   750  <p>
   751  Kafka version, sarama defaults to the oldest supported stable version
   752  </p>
   753  </td>
   754  </tr>
   755  <tr>
   756  <td>
   757  <code>tls</code></br> <em>
   758  github.com/argoproj/argo-events/pkg/apis/common.TLSConfig </em>
   759  </td>
   760  <td>
   761  <em>(Optional)</em>
   762  <p>
   763  TLS configuration for the kafka client.
   764  </p>
   765  </td>
   766  </tr>
   767  <tr>
   768  <td>
   769  <code>sasl</code></br> <em>
   770  github.com/argoproj/argo-events/pkg/apis/common.SASLConfig </em>
   771  </td>
   772  <td>
   773  <em>(Optional)</em>
   774  <p>
   775  SASL configuration for the kafka client
   776  </p>
   777  </td>
   778  </tr>
   779  <tr>
   780  <td>
   781  <code>consumerGroup</code></br> <em>
   782  <a href="#argoproj.io/v1alpha1.KafkaConsumerGroup"> KafkaConsumerGroup
   783  </a> </em>
   784  </td>
   785  <td>
   786  <em>(Optional)</em>
   787  <p>
   788  Consumer group for kafka client
   789  </p>
   790  </td>
   791  </tr>
   792  </tbody>
   793  </table>
   794  <h3 id="argoproj.io/v1alpha1.KafkaConsumerGroup">
   795  KafkaConsumerGroup
   796  </h3>
   797  <p>
   798  (<em>Appears on:</em>
   799  <a href="#argoproj.io/v1alpha1.KafkaBus">KafkaBus</a>)
   800  </p>
   801  <p>
   802  </p>
   803  <table>
   804  <thead>
   805  <tr>
   806  <th>
   807  Field
   808  </th>
   809  <th>
   810  Description
   811  </th>
   812  </tr>
   813  </thead>
   814  <tbody>
   815  <tr>
   816  <td>
   817  <code>groupName</code></br> <em> string </em>
   818  </td>
   819  <td>
   820  <em>(Optional)</em>
   821  <p>
   822  Consumer group name, defaults to {namespace_name}-{sensor_name}
   823  </p>
   824  </td>
   825  </tr>
   826  <tr>
   827  <td>
   828  <code>rebalanceStrategy</code></br> <em> string </em>
   829  </td>
   830  <td>
   831  <em>(Optional)</em>
   832  <p>
   833  Rebalance strategy can be one of: sticky, roundrobin, range. Range is
   834  the default.
   835  </p>
   836  </td>
   837  </tr>
   838  <tr>
   839  <td>
   840  <code>startOldest</code></br> <em> bool </em>
   841  </td>
   842  <td>
   843  <em>(Optional)</em>
   844  <p>
   845  When starting up a new group do we want to start from the oldest event
   846  (true) or the newest event (false), defaults to false
   847  </p>
   848  </td>
   849  </tr>
   850  </tbody>
   851  </table>
   852  <h3 id="argoproj.io/v1alpha1.NATSBus">
   853  NATSBus
   854  </h3>
   855  <p>
   856  (<em>Appears on:</em>
   857  <a href="#argoproj.io/v1alpha1.EventBusSpec">EventBusSpec</a>)
   858  </p>
   859  <p>
   860  <p>
   861  NATSBus holds the NATS eventbus information
   862  </p>
   863  </p>
   864  <table>
   865  <thead>
   866  <tr>
   867  <th>
   868  Field
   869  </th>
   870  <th>
   871  Description
   872  </th>
   873  </tr>
   874  </thead>
   875  <tbody>
   876  <tr>
   877  <td>
   878  <code>native</code></br> <em>
   879  <a href="#argoproj.io/v1alpha1.NativeStrategy"> NativeStrategy </a>
   880  </em>
   881  </td>
   882  <td>
   883  <p>
   884  Native means to bring up a native NATS service
   885  </p>
   886  </td>
   887  </tr>
   888  <tr>
   889  <td>
   890  <code>exotic</code></br> <em>
   891  <a href="#argoproj.io/v1alpha1.NATSConfig"> NATSConfig </a> </em>
   892  </td>
   893  <td>
   894  <p>
   895  Exotic holds an exotic NATS config
   896  </p>
   897  </td>
   898  </tr>
   899  </tbody>
   900  </table>
   901  <h3 id="argoproj.io/v1alpha1.NATSConfig">
   902  NATSConfig
   903  </h3>
   904  <p>
   905  (<em>Appears on:</em>
   906  <a href="#argoproj.io/v1alpha1.BusConfig">BusConfig</a>,
   907  <a href="#argoproj.io/v1alpha1.NATSBus">NATSBus</a>)
   908  </p>
   909  <p>
   910  <p>
   911  NATSConfig holds the config of NATS
   912  </p>
   913  </p>
   914  <table>
   915  <thead>
   916  <tr>
   917  <th>
   918  Field
   919  </th>
   920  <th>
   921  Description
   922  </th>
   923  </tr>
   924  </thead>
   925  <tbody>
   926  <tr>
   927  <td>
   928  <code>url</code></br> <em> string </em>
   929  </td>
   930  <td>
   931  <p>
   932  NATS streaming url
   933  </p>
   934  </td>
   935  </tr>
   936  <tr>
   937  <td>
   938  <code>clusterID</code></br> <em> string </em>
   939  </td>
   940  <td>
   941  <p>
   942  Cluster ID for nats streaming
   943  </p>
   944  </td>
   945  </tr>
   946  <tr>
   947  <td>
   948  <code>auth</code></br> <em>
   949  <a href="#argoproj.io/v1alpha1.AuthStrategy"> AuthStrategy </a> </em>
   950  </td>
   951  <td>
   952  <em>(Optional)</em>
   953  <p>
   954  Auth strategy, default to AuthStrategyNone
   955  </p>
   956  </td>
   957  </tr>
   958  <tr>
   959  <td>
   960  <code>accessSecret</code></br> <em>
   961  <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core">
   962  Kubernetes core/v1.SecretKeySelector </a> </em>
   963  </td>
   964  <td>
   965  <em>(Optional)</em>
   966  <p>
   967  Secret for auth
   968  </p>
   969  </td>
   970  </tr>
   971  </tbody>
   972  </table>
   973  <h3 id="argoproj.io/v1alpha1.NativeStrategy">
   974  NativeStrategy
   975  </h3>
   976  <p>
   977  (<em>Appears on:</em>
   978  <a href="#argoproj.io/v1alpha1.NATSBus">NATSBus</a>)
   979  </p>
   980  <p>
   981  <p>
   982  NativeStrategy indicates to install a native NATS service
   983  </p>
   984  </p>
   985  <table>
   986  <thead>
   987  <tr>
   988  <th>
   989  Field
   990  </th>
   991  <th>
   992  Description
   993  </th>
   994  </tr>
   995  </thead>
   996  <tbody>
   997  <tr>
   998  <td>
   999  <code>replicas</code></br> <em> int32 </em>
  1000  </td>
  1001  <td>
  1002  <p>
  1003  Size is the NATS StatefulSet size
  1004  </p>
  1005  </td>
  1006  </tr>
  1007  <tr>
  1008  <td>
  1009  <code>auth</code></br> <em>
  1010  <a href="#argoproj.io/v1alpha1.AuthStrategy"> AuthStrategy </a> </em>
  1011  </td>
  1012  <td>
  1013  </td>
  1014  </tr>
  1015  <tr>
  1016  <td>
  1017  <code>persistence</code></br> <em>
  1018  <a href="#argoproj.io/v1alpha1.PersistenceStrategy"> PersistenceStrategy
  1019  </a> </em>
  1020  </td>
  1021  <td>
  1022  <em>(Optional)</em>
  1023  </td>
  1024  </tr>
  1025  <tr>
  1026  <td>
  1027  <code>containerTemplate</code></br> <em>
  1028  <a href="#argoproj.io/v1alpha1.ContainerTemplate"> ContainerTemplate
  1029  </a> </em>
  1030  </td>
  1031  <td>
  1032  <em>(Optional)</em>
  1033  <p>
  1034  ContainerTemplate contains customized spec for NATS container
  1035  </p>
  1036  </td>
  1037  </tr>
  1038  <tr>
  1039  <td>
  1040  <code>metricsContainerTemplate</code></br> <em>
  1041  <a href="#argoproj.io/v1alpha1.ContainerTemplate"> ContainerTemplate
  1042  </a> </em>
  1043  </td>
  1044  <td>
  1045  <em>(Optional)</em>
  1046  <p>
  1047  MetricsContainerTemplate contains customized spec for metrics container
  1048  </p>
  1049  </td>
  1050  </tr>
  1051  <tr>
  1052  <td>
  1053  <code>nodeSelector</code></br> <em> map\[string\]string </em>
  1054  </td>
  1055  <td>
  1056  <em>(Optional)</em>
  1057  <p>
  1058  NodeSelector is a selector which must be true for the pod to fit on a
  1059  node. Selector which must match a node’s labels for the pod to be
  1060  scheduled on that node. More info:
  1061  <a href="https://kubernetes.io/docs/concepts/configuration/assign-pod-node/">https://kubernetes.io/docs/concepts/configuration/assign-pod-node/</a>
  1062  </p>
  1063  </td>
  1064  </tr>
  1065  <tr>
  1066  <td>
  1067  <code>tolerations</code></br> <em>
  1068  <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#toleration-v1-core">
  1069  \[\]Kubernetes core/v1.Toleration </a> </em>
  1070  </td>
  1071  <td>
  1072  <em>(Optional)</em>
  1073  <p>
  1074  If specified, the pod’s tolerations.
  1075  </p>
  1076  </td>
  1077  </tr>
  1078  <tr>
  1079  <td>
  1080  <code>metadata</code></br> <em>
  1081  github.com/argoproj/argo-events/pkg/apis/common.Metadata </em>
  1082  </td>
  1083  <td>
  1084  <p>
  1085  Metadata sets the pods’s metadata, i.e. annotations and labels
  1086  </p>
  1087  </td>
  1088  </tr>
  1089  <tr>
  1090  <td>
  1091  <code>securityContext</code></br> <em>
  1092  <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podsecuritycontext-v1-core">
  1093  Kubernetes core/v1.PodSecurityContext </a> </em>
  1094  </td>
  1095  <td>
  1096  <em>(Optional)</em>
  1097  <p>
  1098  SecurityContext holds pod-level security attributes and common container
  1099  settings. Optional: Defaults to empty. See type description for default
  1100  values of each field.
  1101  </p>
  1102  </td>
  1103  </tr>
  1104  <tr>
  1105  <td>
  1106  <code>maxAge</code></br> <em> string </em>
  1107  </td>
  1108  <td>
  1109  <em>(Optional)</em>
  1110  <p>
  1111  Max Age of existing messages, i.e. “72h”, “4h35m”
  1112  </p>
  1113  </td>
  1114  </tr>
  1115  <tr>
  1116  <td>
  1117  <code>imagePullSecrets</code></br> <em>
  1118  <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#localobjectreference-v1-core">
  1119  \[\]Kubernetes core/v1.LocalObjectReference </a> </em>
  1120  </td>
  1121  <td>
  1122  <em>(Optional)</em>
  1123  <p>
  1124  ImagePullSecrets is an optional list of references to secrets in the
  1125  same namespace to use for pulling any of the images used by this
  1126  PodSpec. If specified, these secrets will be passed to individual puller
  1127  implementations for them to use. For example, in the case of docker,
  1128  only DockerConfig type secrets are honored. More info:
  1129  <a href="https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod">https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod</a>
  1130  </p>
  1131  </td>
  1132  </tr>
  1133  <tr>
  1134  <td>
  1135  <code>serviceAccountName</code></br> <em> string </em>
  1136  </td>
  1137  <td>
  1138  <em>(Optional)</em>
  1139  <p>
  1140  ServiceAccountName to apply to NATS StatefulSet
  1141  </p>
  1142  </td>
  1143  </tr>
  1144  <tr>
  1145  <td>
  1146  <code>priorityClassName</code></br> <em> string </em>
  1147  </td>
  1148  <td>
  1149  <em>(Optional)</em>
  1150  <p>
  1151  If specified, indicates the EventSource pod’s priority.
  1152  “system-node-critical” and “system-cluster-critical” are two special
  1153  keywords which indicate the highest priorities with the former being the
  1154  highest priority. Any other name must be defined by creating a
  1155  PriorityClass object with that name. If not specified, the pod priority
  1156  will be default or zero if there is no default. More info:
  1157  <a href="https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/">https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/</a>
  1158  </p>
  1159  </td>
  1160  </tr>
  1161  <tr>
  1162  <td>
  1163  <code>priority</code></br> <em> int32 </em>
  1164  </td>
  1165  <td>
  1166  <em>(Optional)</em>
  1167  <p>
  1168  The priority value. Various system components use this field to find the
  1169  priority of the EventSource pod. When Priority Admission Controller is
  1170  enabled, it prevents users from setting this field. The admission
  1171  controller populates this field from PriorityClassName. The higher the
  1172  value, the higher the priority. More info:
  1173  <a href="https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/">https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/</a>
  1174  </p>
  1175  </td>
  1176  </tr>
  1177  <tr>
  1178  <td>
  1179  <code>affinity</code></br> <em>
  1180  <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#affinity-v1-core">
  1181  Kubernetes core/v1.Affinity </a> </em>
  1182  </td>
  1183  <td>
  1184  <em>(Optional)</em>
  1185  <p>
  1186  The pod’s scheduling constraints More info:
  1187  <a href="https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/">https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/</a>
  1188  </p>
  1189  </td>
  1190  </tr>
  1191  <tr>
  1192  <td>
  1193  <code>maxMsgs</code></br> <em> uint64 </em>
  1194  </td>
  1195  <td>
  1196  <p>
  1197  Maximum number of messages per channel, 0 means unlimited. Defaults to
  1198  1000000
  1199  </p>
  1200  </td>
  1201  </tr>
  1202  <tr>
  1203  <td>
  1204  <code>maxBytes</code></br> <em> string </em>
  1205  </td>
  1206  <td>
  1207  <p>
  1208  Total size of messages per channel, 0 means unlimited. Defaults to 1GB
  1209  </p>
  1210  </td>
  1211  </tr>
  1212  <tr>
  1213  <td>
  1214  <code>maxSubs</code></br> <em> uint64 </em>
  1215  </td>
  1216  <td>
  1217  <p>
  1218  Maximum number of subscriptions per channel, 0 means unlimited. Defaults
  1219  to 1000
  1220  </p>
  1221  </td>
  1222  </tr>
  1223  <tr>
  1224  <td>
  1225  <code>maxPayload</code></br> <em> string </em>
  1226  </td>
  1227  <td>
  1228  <p>
  1229  Maximum number of bytes in a message payload, 0 means unlimited.
  1230  Defaults to 1MB
  1231  </p>
  1232  </td>
  1233  </tr>
  1234  <tr>
  1235  <td>
  1236  <code>raftHeartbeatTimeout</code></br> <em> string </em>
  1237  </td>
  1238  <td>
  1239  <p>
  1240  Specifies the time in follower state without a leader before attempting
  1241  an election, i.e. “72h”, “4h35m”. Defaults to 2s
  1242  </p>
  1243  </td>
  1244  </tr>
  1245  <tr>
  1246  <td>
  1247  <code>raftElectionTimeout</code></br> <em> string </em>
  1248  </td>
  1249  <td>
  1250  <p>
  1251  Specifies the time in candidate state without a leader before attempting
  1252  an election, i.e. “72h”, “4h35m”. Defaults to 2s
  1253  </p>
  1254  </td>
  1255  </tr>
  1256  <tr>
  1257  <td>
  1258  <code>raftLeaseTimeout</code></br> <em> string </em>
  1259  </td>
  1260  <td>
  1261  <p>
  1262  Specifies how long a leader waits without being able to contact a quorum
  1263  of nodes before stepping down as leader, i.e. “72h”, “4h35m”. Defaults
  1264  to 1s
  1265  </p>
  1266  </td>
  1267  </tr>
  1268  <tr>
  1269  <td>
  1270  <code>raftCommitTimeout</code></br> <em> string </em>
  1271  </td>
  1272  <td>
  1273  <p>
  1274  Specifies the time without an Apply() operation before sending an
  1275  heartbeat to ensure timely commit, i.e. “72h”, “4h35m”. Defaults to
  1276  100ms
  1277  </p>
  1278  </td>
  1279  </tr>
  1280  </tbody>
  1281  </table>
  1282  <h3 id="argoproj.io/v1alpha1.PersistenceStrategy">
  1283  PersistenceStrategy
  1284  </h3>
  1285  <p>
  1286  (<em>Appears on:</em>
  1287  <a href="#argoproj.io/v1alpha1.JetStreamBus">JetStreamBus</a>,
  1288  <a href="#argoproj.io/v1alpha1.NativeStrategy">NativeStrategy</a>)
  1289  </p>
  1290  <p>
  1291  <p>
  1292  PersistenceStrategy defines the strategy of persistence
  1293  </p>
  1294  </p>
  1295  <table>
  1296  <thead>
  1297  <tr>
  1298  <th>
  1299  Field
  1300  </th>
  1301  <th>
  1302  Description
  1303  </th>
  1304  </tr>
  1305  </thead>
  1306  <tbody>
  1307  <tr>
  1308  <td>
  1309  <code>storageClassName</code></br> <em> string </em>
  1310  </td>
  1311  <td>
  1312  <em>(Optional)</em>
  1313  <p>
  1314  Name of the StorageClass required by the claim. More info:
  1315  <a href="https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1">https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1</a>
  1316  </p>
  1317  </td>
  1318  </tr>
  1319  <tr>
  1320  <td>
  1321  <code>accessMode</code></br> <em>
  1322  <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#persistentvolumeaccessmode-v1-core">
  1323  Kubernetes core/v1.PersistentVolumeAccessMode </a> </em>
  1324  </td>
  1325  <td>
  1326  <em>(Optional)</em>
  1327  <p>
  1328  Available access modes such as ReadWriteOnce, ReadWriteMany
  1329  <a href="https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes">https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes</a>
  1330  </p>
  1331  </td>
  1332  </tr>
  1333  <tr>
  1334  <td>
  1335  <code>volumeSize</code></br> <em>
  1336  k8s.io/apimachinery/pkg/api/resource.Quantity </em>
  1337  </td>
  1338  <td>
  1339  <p>
  1340  Volume size, e.g. 10Gi
  1341  </p>
  1342  </td>
  1343  </tr>
  1344  </tbody>
  1345  </table>
  1346  <hr/>
  1347  <p>
  1348  <em> Generated with <code>gen-crd-api-reference-docs</code>. </em>
  1349  </p>