diff --git a/docs/Documentation-Requirements.md b/docs/Documentation-Requirements.md index bd276d03f1..c1cea47a40 100644 --- a/docs/Documentation-Requirements.md +++ b/docs/Documentation-Requirements.md @@ -25,7 +25,7 @@ All documents must: - Have a `.md` file extension. - Include a TOC (table of contents) at the top of the document with links to 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. - Be linked to from another document in the same repository. diff --git a/docs/design/architecture.md b/docs/design/architecture.md index 622d070b39..516827afa7 100644 --- a/docs/design/architecture.md +++ b/docs/design/architecture.md @@ -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: ``` -$ kata-runtime --kata-show-default-config-paths +$ kata-runtime --show-default-config-paths ``` Most users will not need to modify the configuration file. diff --git a/docs/how-to/how-to-import-kata-logs-with-fluentd.md b/docs/how-to/how-to-import-kata-logs-with-fluentd.md index 926c7345dd..5c8c8c0f8a 100644 --- a/docs/how-to/how-to-import-kata-logs-with-fluentd.md +++ b/docs/how-to/how-to-import-kata-logs-with-fluentd.md @@ -222,7 +222,7 @@ test to check the parsing works. The resulting output from Fluentd is: "_COMM":"kata-runtime", "_EXE":"/opt/kata/bin/kata-runtime", "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", "_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", @@ -281,7 +281,7 @@ own file (rather than into the system journal). ```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 diff --git a/docs/how-to/how-to-use-kata-containers-with-acrn.md b/docs/how-to/how-to-use-kata-containers-with-acrn.md index c6e948c6d8..24aa7c3ab0 100644 --- a/docs/how-to/how-to-use-kata-containers-with-acrn.md +++ b/docs/how-to/how-to-use-kata-containers-with-acrn.md @@ -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) ```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. diff --git a/src/runtime/README.md b/src/runtime/README.md index 02ffb0d8b3..955876c2a4 100644 --- a/src/runtime/README.md +++ b/src/runtime/README.md @@ -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: ```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 -custom configuration file using the `--kata-config` option: +custom configuration file using the `--config` option: ```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