coreos/container-linux-config-transpiler

Name: container-linux-config-transpiler

Owner: CoreOS

Description: Convert a Container Linux Config into Ignition

Created: 2015-07-15 04:01:43.0

Updated: 2018-05-23 20:33:01.0

Pushed: 2018-05-18 23:44:56.0

Homepage: https://coreos.com/os/docs/latest/configuration.html

Size: 802

Language: Go

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Container Linux Config Transpiler

The Config Transpiler (“ct” for short) is the utility responsible for transforming a human-friendly Container Linux Config into a JSON file. This resulting file can be provided to a Container Linux machine when it first boots to provision the machine.

Documentation

If you're looking to begin writing configs for your Container Linux machines, check out the getting started documentation.

The configuration documentation is a comprehensive resource specifying what options can be in a Container Linux Config.

For a more in-depth view of ct and why it exists, take a look at the Overview document.

Please use the bug tracker to report bugs.

Examples

There are plenty of small, self-contained examples in the documentation.

Installation
macOS homebrew
 install coreos-ct
Prebuilt binaries

The easiest way to get started using ct is to download one of the binaries from the releases page on GitHub.

One can use the following script to download and verify the signature of Config Transpiler:

ecify Config Transpiler version
ER=v0.6.1

ecify Architecture
CH=aarch64 # ARM's 64-bit architecture
=x86_64

ecify OS
=apple-darwin # MacOS
=pc-windows-gnu.exe # Windows
nknown-linux-gnu # Linux

ecify download URL
LOAD_URL=https://github.com/coreos/container-linux-config-transpiler/releases/download

move previous downloads
f /tmp/ct-${CT_VER}-${ARCH}-${OS} /tmp/ct-${CT_VER}-${ARCH}-${OS}.asc /tmp/coreos-app-signing-pubkey.gpg

wnload Config Transpiler binary
 -L ${DOWNLOAD_URL}/${CT_VER}/ct-${CT_VER}-${ARCH}-${OS} -o /tmp/ct-${CT_VER}-${ARCH}-${OS}
d u+x /tmp/ct-${CT_VER}-${ARCH}-${OS}

wnload and import CoreOS application signing GPG key
 https://coreos.com/dist/pubkeys/app-signing-pubkey.gpg -o /tmp/coreos-app-signing-pubkey.gpg
 --import --keyid-format LONG /tmp/coreos-app-signing-pubkey.gpg

wnload and import CoreOS application signing GPG key if it has not already been imported
 -L ${DOWNLOAD_URL}/${CT_VER}/ct-${CT_VER}-${ARCH}-${OS}.asc -o /tmp/ct-${CT_VER}-${ARCH}-${OS}.asc
 --verify /tmp/ct-${CT_VER}-${ARCH}-${OS}.asc /tmp/ct-${CT_VER}-${ARCH}-${OS}
Building from source

To build from source you'll need to have the go compiler installed on your system.

clone --branch v0.8.0 https://github.com/coreos/container-linux-config-transpiler
ontainer-linux-config-transpiler

The ct binary will be placed in ./bin/.

Note: Review releases for new branch versions.

Related projects

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.