@kronos-integration/service-systemd

kronos systemd integration

• sync node state to systemd with notify (done)
• propagate config into kronos (done)
• propagate socket activations into kronos (partly)
• start / stop / restart / reload initiated from systemd (partly)
• log into journal (done)

usage

API

Table of Contents

• JournalLogger
  • logEntry
    • Parameters
• FileDescriptor
  • Properties
• credentialsDirectory
• SystemdConfig
  • Properties
  • listeningFileDescriptors
  • loadConfig
• ServiceSystemd
  • Parameters
  • registerService
    • Parameters
  • getCredential
    • Parameters
  • getCredentials
    • Parameters
  • endpoints

JournalLogger

Extends ServiceLogger

Forward logs entries to the journal.

logEntry

Pass to systemd journal.

Parameters

• entry Object

FileDescriptor

Type: Object

Properties

• name string?
• fd number

credentialsDirectory

Type: string

SystemdConfig

Extends ServiceConfig

Provides config from CONFIGURATION_DIRECTORY. Also injects listeningFileDescriptors into the config

Properties

• configurationDirectory string taken from CONFIGURATION_DIRECTORY

listeningFileDescriptors

listeningFileDescriptors as passed in LISTEN_FDS and LISTEN_FDNAMES.

Returns Array<FileDescriptor>

loadConfig

Load config from configuration dir. Additionally pass listeninfFileDescriptions into config.

ServiceSystemd

Extends ServiceProviderMixin(Service, JournalLogger, SystemdConfig)

Kronos bridge to systemd:

• sync node state to systemd with notify
• propagate config into kronos world
• propagate socket activations into kronos (partly)
• start / stop / restart / reload initiated from systemd
• log into journal

Parameters

• config (optional, default {})
• ic

registerService

When in debug mode; every sevice gets the logLevel of the service provider.

Parameters

• service Service

getCredential

Deliver credential as provided by systemd.

Parameters

• key string
• options Object?

Returns Promise<(Uint8Array | string)>

getCredentials

Deliver credentials as provided by systemd.

Parameters

• keys Array<string>
• options Object?

Returns Promise<Array<(Uint8Array | string)>>

endpoints

Definition of the predefined endpoints.

• info in

Returns Object predefined endpoints

install

With npm do:

npm install @kronos-integration/service-systemd

license

BSD-2-Clause