pmcf

Poor mans configuration management

Generates system packages from config blueprint.

supported linux derivates:

• arch linux
• debian
• rpm based systems

generates config packages for:

• systemd
  • networkd
  • timesyncd
  • resolverd
  • journald
• kea
• bind
• mosquitto
• influxdb
• iwd
• chrony
• openldap

API

Table of Contents

• Base
  • mapFromDirections
    • Parameters
  • unionFromDirections
    • Parameters
  • walkDirections
    • Parameters
  • attribute
    • Parameters
  • attributeIterator
    • Parameters
  • getAttributes
    • Parameters
  • property
    • Parameters
  • priority
  • expression
    • Parameters
  • templateContent
    • Parameters
  • isTemplate
  • expand
    • Parameters
• serviceEndpoints
  • Parameters
• PortEndpoint
  • Parameters
  • port
  • socketAddress
• HTTPEndpoint
  • Parameters
  • port
• id
• domainNames
• InitializationContext
  • Parameters
• SkeletonNetworkInterface
  • networkAddresses
    • Parameters
• type
• SystemdJournalRemoteService
  • Properties
  • systemdConfigs
    • Parameters
• SystemdJournalUploadService
  • Properties
  • systemdConfigs
    • Parameters
• NetworkAddress
  • Parameters
  • subnet
  • networkInterface
  • address
• addresses
  • Parameters
• cidrAddresses
  • Parameters
• families
• secretName
• directHosts
• subnetForAddress
  • Parameters
• domainName
  • Parameters
• domainFromDominName
  • Parameters
• sectionLines
  • Parameters
• asArray
  • Parameters
• asIterator
  • Parameters

Base

attributes: as declared in the types properties: use defined values to support attribute value definitions

mapFromDirections

Deliver AggregatedMap of all property Maps.

Parameters

• directions Array<string>
• property string

Returns Map<any, any>

unionFromDirections

Deliver union set of all property values.

Parameters

• directions Array<string>
• property string

Returns Set<any>

walkDirections

Walk the object graph in some directions and deliver seen nodes.

Parameters

• directions Array<string> (optional, default ["this","extends","owner"])

Returns Iterable<Base>

attribute

Parameters

• name string

Returns any

attributeIterator

Retrive attribute values from an object.

Parameters

• filter Function?

Returns Iterable<[string, any]> values

getAttributes

Retrive attribute values from an object.

Parameters

• filter Function? (optional, default filterPublic)

Returns Object values

property

Parameters

• name string

Returns any

priority

Returns number

expression

Parameters

• expression string
• options object

Returns any

templateContent

Parameters

• entryProperties any
• directoryProperties any

Returns AsyncIterable<ContentProvider>

isTemplate

Returns boolean

expand

Parameters

• object any

Returns any

serviceEndpoints

Parameters

• sources any

• options Object? (optional, default {})

  • options.services Function? filter for services
  • options.endpoints Function? filter for endpoints
  • options.select Function? mapper from Endpoint into result
  • options.limit number? upper limit of # result items
  • options.join string? join result(s) into a string

Returns (string | any)

PortEndpoint

Extends BaseEndpoint

Endpoint with an ip port

Parameters

• service
• data

port

Returns number

socketAddress

Returns string

HTTPEndpoint

Extends BaseEndpoint

Endpoint based on http

Parameters

• service Service
• address any
• data object

port

Returns number

id

Returns string

domainNames

Returns Set<string>

InitializationContext

Keeps track of all in flight object creations and loose ends during config initialization.

Parameters

• directory (optional, default "/")

SkeletonNetworkInterface

Extends ServiceOwner

networkAddresses

Parameters

• filter Object (optional, default n=>true)

Returns Iterable<NetworkAddress>

type

Type of the group.

Returns string view | unknown

SystemdJournalRemoteService

Extends CoreService

Properties

• ServerCertificateFile string
• ServerKeyFile string

systemdConfigs

Parameters

• name string

Returns Object

SystemdJournalUploadService

Extends CoreService

Properties

• URL string
• ServerCertificateFile string
• ServerKeyFile string

systemdConfigs

Parameters

• name string

Returns Object

NetworkAddress

Parameters

• networkInterface NetworkInterface
• address (string | Uint8Array | Uint16Array)
• subnet Subnet

subnet

Type: Subnet

networkInterface

Type: NetworkInterface

address

Type: (string | Uint8Array | Uint16Array)

addresses

Parameters

• sources Iterable<(Owner | string)>

• options Object

  • options.aggregate boolean
  • options.filter Object

Returns Iterable<string> addresses

cidrAddresses

Parameters

• networkAddresses Array<NetworkAddress>

Returns Array<string>

families

Returns Set<string>

secretName

Returns string

directHosts

hosts we own direcly.

subnetForAddress

Parameters

• address string

Returns Subnet?

domainName

Appends default domain if name does not already have a domain.

Parameters

• name string
• defaultDomain string?

Returns string

domainFromDominName

Extracts domain name from a name.

Parameters

• domainName string
• defaultDomain string?

Returns (string | undefined)

sectionLines

Parameters

• sectionName string
• values Object

Returns Array<string>

asArray

Parameters

• value any

Returns Array<any>

asIterator

Parameters

• value any

Returns Iterable<any>

install

With npm do:

npm install pmcf