Skip to content

Latest commit

 

History

History
136 lines (94 loc) · 3.83 KB

schema.md

File metadata and controls

136 lines (94 loc) · 3.83 KB
Raw

Data Schema in etcd

Schema version: 3

Schema version is incremented when data format has changed.

All keys are prefixed with a string specified in the sabakan command-line option. This prefix string is denoted as <prefix> in the following.

<prefix>/version

This key contains the schema version. Before version 1.2, sabakan did not have this key.

<prefix>/machines/<serial>

Name Description
serial Serial number of a machine

This type of key holds the information of a machine. The value is formatted in JSON as defined in Machine.

<prefix>/crypts/<serial>/<path>

Name Description
serial Serial number of a machine
path Name of an encrypted disk, in the format shown in /dev/disk/by-path

These keys hold the encryption key of a disk. The value is a raw binary key.

$ etcdctl get /sabakan/crypts/1234abcd/pci-0000:00:1f.2-ata-3 --print-value-only
(This returns a binary key.)

<prefix>/images/coreos

This key holds the index of CoreOS container Linux images. The value is described in boot image management.

<prefix>/images/coreos/deleted

This key holds a list of deleted image IDs as follows:

["123.45.6", "789.0.1", "2018.04.01"]

<prefix>/assets

This key stores the last ID of the asset. Each time an asset is added or updated, the value will be incremented by one.

<prefix>/assets/<NAME>

These keys hold the meta data of an asset. The value is described in asset management.

<prefix>/ignitions/<role>/<id>

These keys store Ignition templates for <role>. <id> should be a version string conforming to Semantic Versioning 2.0.0.

The value of a key is a JSON object as described in api.md.

<prefix>/ipam

This key holds IPAM configurations. The value is IPAMConfig formatted in JSON.

<prefix>/dhcp

This key holds DHCP configurations. The value is DHCPConfig formatted in JSON.

<prefix>/lease-usages/<ip>

Name Description
ip The first IP address of the lease range.

These keys hold lease address usages for a range of IP addresses. The value is a mapping between hardware address and (index, expire) pair where index is the index of the leased IP address in the range and expire is the Go's time.Time when the lease expires.

<prefix>/node-indices/<rack>

Name Description
rack Rack nubmer

This type of key holds assignment of node indices per rack. The value is a list of assigned indices formatted in JSON.

例:

$ etcdctl get "/sabakan/node-indices/0"
[3, 4, 5]

<prefix>/audit/<YYYYMMDD>/<16-digit HEX string>

Each entry of audit log is stored with this type of key. The value is JSON having fields defined in audit log.

  • <YYYYMMDD> is the date of the event.
  • <16-digit HEX string> is the hexadecimal representation of the event revision.

<prefix>/audit

This key stores RFC3339-format timestamp to record the last compaction of audit logs.

<prefix>/kernel-params/coreos

This type of key holds kernel parameters.