Commit 92d819f

committed

Add usage and links to README

1 parent 3a5ebe8 commit 92d819fCopy full SHA for 92d819f

File tree

1 file changed

+34

-1

lines changed

README.md

1 file changed

+34

-1

lines changed

`‎README.md‎`

Lines changed: 34 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ $ cp container-linux-config.yml.example container-linux-config.yml`
`12`	`12`
`13`	`13`	`## Installing ct`
`14`	`14`
`15`		-CoreOS Container Linux is moving away from the cloud-config file format and over to the container linux config and ignition formats. Ignition files use json and are transcompiled from a container linux config yaml file. The `ct` tool is used to do this and the Makefile includes some onvenient targets to install, update and delete this tool for linux hosts. Requires root to install the binary into /usr/local/bin. If you already have ct installed you can skip these steps.
	`15`	+CoreOS Container Linux is moving away from the cloud-config file format and over to the [container linux config](https://coreos.com/os/docs/latest/configuration.html) and [ignition](https://coreos.com/ignition/docs/latest/what-is-ignition.html) formats. Ignition files use JSON and are transcompiled from a container linux config YAML file. The [ct](https://github.com/coreos/container-linux-config-transpiler/) tool is used to do this and the Makefile includes some convenient targets to install, update, and delete this tool for linux hosts. Requires root to install the binary into /usr/local/bin. If you already have ct installed you can skip these steps.
`16`	`16`
`17`	`17`	`Install:`
`18`	`18`	```
`@@ -29,5 +29,38 @@ Delete:`
`29`	`29`	`$ make ct-clean`
`30`	`30`	```
`31`	`31`
	`32`	`+# Usage`
	`33`	`+Populate your [container linux config](https://coreos.com/os/docs/latest/configuration.html) YAML file with all configuration you want apply in the installed image.`
	`34`	`+`
	`35`	`+## With Makefile`
	`36`	`+`
	`37`	`+### Makefile variables`
	`38`	+```make
	`39`	`+PACKER_CMD ?= packer`
	`40`	`+RELEASE ?= alpha`
	`41`	`+DIGEST_URL ?= https://$(RELEASE).release.core-os.net/amd64-usr/current/coreos_production_iso_image.iso.DIGESTS`
	`42`	`+CONFIG ?= container-linux-config.yml`
	`43`	`+DISK_SIZE ?= 40000`
	`44`	`+MEMORY ?= 1024M`
	`45`	`+BOOT_WAIT ?= 45s`
	`46`	+```
	`47`	`+### Basic example using defaults`
	`48`	+```
	`49`	`+$ make container-linux`
	`50`	+```
	`51`	`+### Building the alpha release`
	`52`	+```
	`53`	`+$ make container-linux RELEASE=alpha`
	`54`	+```
	`55`	`+### Other make targets`
	`56`	`+Delete builds:`
	`57`	+```
	`58`	`+$ make clean`
	`59`	+```
	`60`	`+Delete the packer cache (making packer download the latest iso image on next build):`
	`61`	+```
	`62`	`+$ make cache-clean`
	`63`	+```
	`64`	`+`
`32`	`65`	`# License`
`33`	`66`	`See LICENSE file.`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 92d819f

File tree

1 file changed

1 file changed

`‎README.md‎`

0 commit comments