github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-06-19 04:04:32 +00:00
Code Issues Projects Releases Wiki Activity

docs: Update documentation with new prefixless config options

Browse Source 
Remove the old config options from the documentation and replace them
with the new form (without the redundant `kata-` prefix).

Signed-off-by: Daniel Knittl-Frank <knittl89+git@googlemail.com>
This commit is contained in:
Daniel Knittl-Frank 2020-10-24 12:36:56 +02:00
parent fdcde7968a
commit 056d742c17
5 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Documentation-Requirements.md
View File

@ -25,7 +25,7 @@ All documents must:
- Have a `.md` file extension. - Have a `.md` file extension.
- Include a TOC (table of contents) at the top of the document with links to - Include a TOC (table of contents) at the top of the document with links to
all heading sections. We recommend using the all heading sections. We recommend using the
[`check-markdown`](https://github.com/kata-containers/tests/tree/master/cmd/check-markdown) [`kata-check-markdown`](https://github.com/kata-containers/tests/tree/master/cmd/check-markdown)
tool to generate the TOC. tool to generate the TOC.
- Be linked to from another document in the same repository. - Be linked to from another document in the same repository.

2
docs/design/architecture.md
View File

@ -137,7 +137,7 @@ The runtime uses a TOML format configuration file called `configuration.toml`. B
The actual configuration file paths can be determined by running: The actual configuration file paths can be determined by running:
``` ```
$ kata-runtime --kata-show-default-config-paths $ kata-runtime --show-default-config-paths
``` ```
Most users will not need to modify the configuration file. Most users will not need to modify the configuration file.

4
docs/how-to/how-to-import-kata-logs-with-fluentd.md
View File

@ -222,7 +222,7 @@ test to check the parsing works. The resulting output from Fluentd is:
"_COMM":"kata-runtime", "_COMM":"kata-runtime",
"_EXE":"/opt/kata/bin/kata-runtime", "_EXE":"/opt/kata/bin/kata-runtime",
"SYSLOG_TIMESTAMP":"Feb 21 10:31:27 ", "SYSLOG_TIMESTAMP":"Feb 21 10:31:27 ",
"_CMDLINE":"/opt/kata/bin/kata-runtime --kata-config /opt/kata/share/defaults/kata-containers/configuration-qemu.toml --root /run/runc state 7cdd31660d8705facdadeb8598d2c0bd008e8142c54e3b3069abd392c8d58997", "_CMDLINE":"/opt/kata/bin/kata-runtime --config /opt/kata/share/defaults/kata-containers/configuration-qemu.toml --root /run/runc state 7cdd31660d8705facdadeb8598d2c0bd008e8142c54e3b3069abd392c8d58997",
"SYSLOG_PID":"14314", "SYSLOG_PID":"14314",
"_PID":"14314", "_PID":"14314",
"MESSAGE":"time=\"2020-02-21T10:31:27.810781647Z\" level=info msg=\"release sandbox\" arch=amd64 command=state container=7cdd31660d8705facdadeb8598d2c0bd008e8142c54e3b3069abd392c8d58997 name=kata-runtime pid=14314 sandbox=1c3e77cad66aa2b6d8cc846f818370f79cb0104c0b840f67d0f502fd6562b68c source=virtcontainers subsystem=sandbox", "MESSAGE":"time=\"2020-02-21T10:31:27.810781647Z\" level=info msg=\"release sandbox\" arch=amd64 command=state container=7cdd31660d8705facdadeb8598d2c0bd008e8142c54e3b3069abd392c8d58997 name=kata-runtime pid=14314 sandbox=1c3e77cad66aa2b6d8cc846f818370f79cb0104c0b840f67d0f502fd6562b68c source=virtcontainers subsystem=sandbox",
@ -281,7 +281,7 @@ own file (rather than into the system journal).
```bash ```bash
#!/bin/bash #!/bin/bash
/opt/kata/bin/kata-runtime --kata-config "/opt/kata/share/defaults/kata-containers/configuration-qemu.toml" --log-format=json --log=/var/log/kata-runtime.log $@ /opt/kata/bin/kata-runtime --config "/opt/kata/share/defaults/kata-containers/configuration-qemu.toml" --log-format=json --log=/var/log/kata-runtime.log $@
``` ```
And then we'll add the Fluentd config section to parse that file. Note, we inform the parser that Kata is And then we'll add the Fluentd config section to parse that file. Note, we inform the parser that Kata is

2
docs/how-to/how-to-use-kata-containers-with-acrn.md
View File

@ -91,7 +91,7 @@ To configure Kata Containers with ACRN, copy the generated `configuration-acrn.t
The following command shows full paths to the `configuration.toml` files that the runtime loads. It will use the first path that exists. (Please make sure the kernel and image paths are set correctly in the `configuration.toml` file) The following command shows full paths to the `configuration.toml` files that the runtime loads. It will use the first path that exists. (Please make sure the kernel and image paths are set correctly in the `configuration.toml` file)
```bash ```bash
$ sudo kata-runtime --kata-show-default-config-paths $ sudo kata-runtime --show-default-config-paths
``` ```
>**Warning:** Please offline CPUs using [this](offline_cpu.sh) script, else VM launches will fail. >**Warning:** Please offline CPUs using [this](offline_cpu.sh) script, else VM launches will fail.

6
src/runtime/README.md
View File

@ -129,14 +129,14 @@ The below command lists the full paths to the configuration files that the
runtime attempts to load. The first path that exists will be used: runtime attempts to load. The first path that exists will be used:
```bash ```bash
$ kata-runtime --kata-show-default-config-paths $ kata-runtime --show-default-config-paths
``` ```
Aside from the built-in locations, it is possible to specify the path to a Aside from the built-in locations, it is possible to specify the path to a
custom configuration file using the `--kata-config` option: custom configuration file using the `--config` option:
```bash ```bash
$ kata-runtime --kata-config=/some/where/configuration.toml ... $ kata-runtime --config=/some/where/configuration.toml ...
``` ```
The runtime will log the full path to the configuration file it is using. See The runtime will log the full path to the configuration file it is using. See