Skip to content
This repository has been archived by the owner on Apr 3, 2022. It is now read-only.

Latest commit

 

History

History
867 lines (867 loc) · 15.3 KB

event-bus.md

File metadata and controls

867 lines (867 loc) · 15.3 KB
Raw

Packages:

argoproj.io/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

AuthStrategy (string alias)

(Appears on: NATSConfig, NativeStrategy)

AuthStrategy is the auth strategy of native nats installaion

BusConfig

(Appears on: EventBusStatus)

BusConfig has the finalized configuration for EventBus

Field Description
nats
NATSConfig

Condition

(Appears on: Status)

Condition contains details about resource state

Field Description
type
ConditionType

Condition type.

status
Kubernetes core/v1.ConditionStatus

Condition status, True, False or Unknown.

lastTransitionTime
Kubernetes meta/v1.Time 		(Optional)

Last time the condition transitioned from one status to another.

reason
string 		(Optional)

Unique, this should be a short, machine understandable string that gives the reason for condition’s last transition. For example, “ImageNotFound”

message
string 		(Optional)

Human-readable message indicating details about last transition.

ConditionType (string alias)

(Appears on: Condition)

ConditionType is a valid value of Condition.Type

ContainerTemplate

(Appears on: NativeStrategy)

ContainerTemplate defines customized spec for a container

Field Description
resources
Kubernetes core/v1.ResourceRequirements

EventBus

EventBus is the definition of a eventbus resource

Field Description
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
EventBusSpec

nats
NATSBus

NATS eventbus

status
EventBusStatus 		(Optional)

EventBusSpec

(Appears on: EventBus)

EventBusSpec refers to specification of eventbus resource

Field Description
nats
NATSBus

NATS eventbus

EventBusStatus

(Appears on: EventBus)

EventBusStatus holds the status of the eventbus resource

Field Description
Status
Status

(Members of Status are embedded into this type.)

config
BusConfig

Config holds the fininalized configuration of EventBus

Metadata

(Appears on: NativeStrategy)

Metadata holds the annotations and labels of an event source pod

Field Description
annotations
map\[string\]string
labels
map\[string\]string

NATSBus

(Appears on: EventBusSpec)

NATSBus holds the NATS eventbus information

Field Description
native
NativeStrategy

Native means to bring up a native NATS service

exotic
NATSConfig

Exotic holds an exotic NATS config

NATSConfig

(Appears on: BusConfig, NATSBus)

NATSConfig holds the config of NATS

Field Description
url
string

NATS streaming url

clusterID
string

Cluster ID for nats streaming

auth
AuthStrategy 		(Optional)

Auth strategy, default to AuthStrategyNone

accessSecret
Kubernetes core/v1.SecretKeySelector 		(Optional)

Secret for auth

NativeStrategy

(Appears on: NATSBus)

NativeStrategy indicates to install a native NATS service

Field Description
replicas
int32

Size is the NATS StatefulSet size

auth
AuthStrategy
antiAffinity
bool

Deprecated, use Affinity instead, will be removed in v1.5

persistence
PersistenceStrategy 		(Optional)
containerTemplate
ContainerTemplate 		(Optional)

ContainerTemplate contains customized spec for NATS container

metricsContainerTemplate
ContainerTemplate 		(Optional)

MetricsContainerTemplate contains customized spec for metrics container

nodeSelector
map\[string\]string 		(Optional)

NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

tolerations
\[\]Kubernetes core/v1.Toleration 		(Optional)

If specified, the pod’s tolerations.

metadata
Metadata

Metadata sets the pods’s metadata, i.e. annotations and labels

securityContext
Kubernetes core/v1.PodSecurityContext 		(Optional)

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

maxAge
string 		(Optional)

Max Age of existing messages, i.e. “72h”, “4h35m”

imagePullSecrets
\[\]Kubernetes core/v1.LocalObjectReference 		(Optional)

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images\#specifying-imagepullsecrets-on-a-pod

serviceAccountName
string 		(Optional)

ServiceAccountName to apply to NATS StatefulSet

priorityClassName
string 		(Optional)

If specified, indicates the EventSource pod’s priority. “system-node-critical” and “system-cluster-critical” are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. More info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/

priority
int32 		(Optional)

The priority value. Various system components use this field to find the priority of the EventSource pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. More info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/

affinity
Kubernetes core/v1.Affinity 		(Optional)

The pod’s scheduling constraints More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/

maxMsgs
uint64

Maximum number of messages per channel, 0 means unlimited. Defaults to 1000000

maxBytes
string

Total size of messages per channel, 0 means unlimited. Defaults to 1GB

PersistenceStrategy

(Appears on: NativeStrategy)

PersistenceStrategy defines the strategy of persistence

Field Description
storageClassName
string 		(Optional)

Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes\#class-1

accessMode
Kubernetes core/v1.PersistentVolumeAccessMode 		(Optional)

Available access modes such as ReadWriteOnce, ReadWriteMany https://kubernetes.io/docs/concepts/storage/persistent-volumes/\#access-modes

volumeSize
k8s.io/apimachinery/pkg/api/resource.Quantity

Volume size, e.g. 10Gi

Status

(Appears on: EventBusStatus)

Status is a common structure which can be used for Status field.

Field Description
conditions
\[\]Condition 		(Optional)

Conditions are the latest available observations of a resource’s current state.

Generated with gen-crd-api-reference-docs.