Skip to content

Bus

Key Value
type object
relationship Package -> DeploymentConfig -> Bus
object path $.deployment_config.bus.*
package file path {package-root}/deployment_config/deployment_config.yaml

Fields

Field Type Required Description Constraints Default
protocol Protocol yes String indicating the protocol of the messaging system - -
credentials string | null no An environment variable indicating where elements should look for credentials related to this bus, if any are needed - null
description string | null no A string describing the purpose of this Bus - "Assembly communication bus"
nodes array<string> | null no A list of one or more connection strings to machines/services which can be used for subscribing to - null
topic string | null no A string indicating the subset of messages in this stream that consumers are interested in pattern: "^[a-z0-9]+[a-z0-9-]*[a-z0-9]+$" null
topicPrefix string | null no Prefix to apply to Service name for Sequencer. Prefix followed by a required "-" pattern: "^[a-z0-9]+[a-z0-9-]*[a-z0-9]+-+$" null
uri string | null no A URI describing an endpoint/connection string with which to make requests to a bus - null

Used In

Back to top