-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: update doc for ignition flag usage
it updates the doc to explain how the ignition flag is used. It also adds a new section under contrib where to store an example of configuration and link to the ignition website for more details about specification, mime type and other examples.
- Loading branch information
Luca Stocchi
authored and
Luca Stocchi
committed
Oct 21, 2024
1 parent
95ea6a3
commit acae500
Showing
3 changed files
with
55 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
## Ignition | ||
|
||
Ignition uses a JSON configuration file to define the desired changes. The format of this config is specified in detail [here](https://coreos.github.io/ignition/specs/), and its [MIME type](http://www.iana.org/assignments/media-types/application/vnd.coreos.ignition+json) is registered with IANA. | ||
|
||
`myconfig.json` file provides an example of configuration that adds a new `testuser`, creates a new file to `/etc/myapp` with the content listed in the same `files` section and add a systemd unit drop-in to modify the existing service `systemd-journald` and sets its environment variable SYSTEMD_LOG_LEVEL to debug. | ||
|
||
### Examples | ||
|
||
More examples can be found at https://coreos.github.io/ignition/examples/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
{ | ||
"ignition": { | ||
"version": "3.0.0" | ||
}, | ||
"passwd": { | ||
"users": [ | ||
{ | ||
"name": "testuser", | ||
"sshAuthorizedKeys": [ | ||
"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIO43Z9aRPvvj1zMib/Hh4oWX+MuOPXdFChFMaWfishLj" | ||
] | ||
} | ||
] | ||
}, | ||
"storage": { | ||
"files": [{ | ||
"path": "/etc/someconfig", | ||
"mode": 420, | ||
"contents": { "source": "data:,example%20file%0A" } | ||
}] | ||
}, | ||
"systemd": { | ||
"units": [{ | ||
"name": "systemd-journald.service", | ||
"dropins": [{ | ||
"name": "debug.conf", | ||
"contents": "[Service]\nEnvironment=SYSTEMD_LOG_LEVEL=debug" | ||
}] | ||
}] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters