commands

Documentation

Overview

Package commands implements the commands for the ttn-lw-stack binary.

Index

• Variables
• func NewComponentDeviceRegistryRedis(conf Config, name string) *redis.Client
• func NewNetworkServerApplicationUplinkQueueRedis(conf Config) *redis.Client
• func NewNetworkServerDeviceRegistryRedis(conf Config) *redis.Client
• func NewNetworkServerDownlinkTaskRedis(conf Config) *redis.Client
• type Config

Variables

var DefaultConfig = Config{
	ServiceBase: shared.DefaultServiceBase,
	IS:          shared_identityserver.DefaultIdentityServerConfig,
	GS:          shared_gatewayserver.DefaultGatewayServerConfig,
	NS:          shared_networkserver.DefaultNetworkServerConfig,
	AS:          shared_applicationserver.DefaultApplicationServerConfig,
	JS:          shared_joinserver.DefaultJoinServerConfig,
	Console:     shared_console.DefaultConsoleConfig,
	GCS:         shared_gatewayconfigurationserver.DefaultGatewayConfigurationServerConfig,
	DTC:         shared_devicetemplateconverter.DefaultDeviceTemplateConverterConfig,
	QRG:         shared_qrcodegenerator.DefaultQRCodeGeneratorConfig,
	PBA:         shared_packetbrokeragent.DefaultPacketBrokerAgentConfig,
	DR:          shared_devicerepository.DefaultDeviceRepositoryConfig,

	OutputFormat: "json",
}

DefaultConfig contains the default config for the ttn-lw-stack binary.

var (

	// Root command is the entrypoint of the program
	Root = &cobra.Command{
		Use:           name,
		SilenceErrors: true,
		SilenceUsage:  true,
		Short:         "The Things Stack for LoRaWAN",
		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {

			err := mgr.ReadInConfig()
			if err != nil {
				return err
			}

			if err = mgr.Unmarshal(config); err != nil {
				return err
			}

			if err := shared.InitializeFallbacks(&config.ServiceBase); err != nil {
				return err
			}

			logger, err = shared.InitializeLogger(&config.Log)
			if err != nil {
				return err
			}

			logger.Use(logobservability.New())

			if config.Sentry.DSN != "" {
				opts := sentry.ClientOptions{
					Dsn:         config.Sentry.DSN,
					Release:     pkgversion.String(),
					Environment: config.Sentry.Environment,
				}
				if hostname, err := os.Hostname(); err == nil {
					opts.ServerName = hostname
				}
				err = sentry.Init(opts)
				if err != nil {
					return err
				}
				logger.Use(logsentry.New())
			}

			ctx = log.NewContext(ctx, logger)

			versionUpdate = make(chan pkgversion.Update)
			if config.SkipVersionCheck {
				close(versionUpdate)
			} else {
				go func(ctx context.Context) {
					defer close(versionUpdate)
					update, err := pkgversion.CheckUpdate(ctx)
					if err != nil {
						log.FromContext(ctx).WithError(err).Warn("Failed to check version update")
					} else if update != nil {
						versionUpdate <- *update
					} else {
						log.FromContext(ctx).Debug("No new version available")
					}
				}(ctx)
			}

			return nil
		},
		PersistentPostRunE: func(cmd *cobra.Command, args []string) error {
			select {
			case <-ctx.Done():
			case <-time.After(versionCheckTimeout):
				logger.Warn("Version check timed out")
			case versionUpdate, ok := <-versionUpdate:
				if ok {
					pkgversion.LogUpdate(ctx, &versionUpdate)
				}
			}
			return nil
		},
	}
)

Functions

func NewComponentDeviceRegistryRedis

func NewComponentDeviceRegistryRedis(conf Config, name string) *redis.Client

func NewNetworkServerApplicationUplinkQueueRedis

func NewNetworkServerApplicationUplinkQueueRedis(conf Config) *redis.Client

func NewNetworkServerDeviceRegistryRedis

func NewNetworkServerDeviceRegistryRedis(conf Config) *redis.Client

func NewNetworkServerDownlinkTaskRedis

func NewNetworkServerDownlinkTaskRedis(conf Config) *redis.Client

Types

type Config

type Config struct {
	conf.ServiceBase `name:",squash"`
	IS               identityserver.Config             `name:"is"`
	GS               gatewayserver.Config              `name:"gs"`
	NS               networkserver.Config              `name:"ns"`
	AS               applicationserver.Config          `name:"as"`
	JS               joinserver.Config                 `name:"js"`
	Console          console.Config                    `name:"console"`
	GCS              gatewayconfigurationserver.Config `name:"gcs"`
	DTC              devicetemplateconverter.Config    `name:"dtc"`
	QRG              qrcodegenerator.Config            `name:"qrg"`
	PBA              packetbrokeragent.Config          `name:"pba"`
	DR               devicerepository.Config           `name:"dr"`
	OutputFormat     string                            `name:"output-format" yaml:"output-format" description:"Output format"`
}

Config for the ttn-lw-stack binary.