From 08d233e4f1deaa6a8fad9ff444f851bc19e5d73a Mon Sep 17 00:00:00 2001 From: Marco Vedovati Date: Fri, 19 Oct 2018 09:57:32 +0200 Subject: [PATCH] install: clean instructions for kata-manager Use a one-line code block for the installation command, and document the dry run option. Fixes: #275 Signed-off-by: Marco Vedovati --- install/installing-with-kata-manager.md | 28 +++++++++++++++++-------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/install/installing-with-kata-manager.md b/install/installing-with-kata-manager.md index 2412b08437..7cea993ad8 100644 --- a/install/installing-with-kata-manager.md +++ b/install/installing-with-kata-manager.md @@ -8,9 +8,15 @@ ## Introduction `kata-manager` automates the Kata Containers installation procedure documented for [these Linux distributions](README.md#supported-distributions). -> Note: +> **Note**: +> - `kata-manager` requires `curl` and `sudo` installed on your system. +> > - Full installation mode is only available for Docker container manager. For other setups, you > can still use `kata-manager` to [install Kata package](#install-kata-packages-only), and then setup your container manager manually. +> +> - You can run `kata-manager` in dry run mode by passing the `-n` flag. Dry run mode allows you to review the +> commands that `kata-manager` would run, without doing any change to your system. + ## Full Installation This command does the following: @@ -18,19 +24,23 @@ This command does the following: 2. Installs Docker 3. Configure Docker to use the Kata OCI runtime by default -``` -$ bash -c "$(curl -fsSL \ -$ https://raw.githubusercontent.com/kata-containers/tests/master/cmd/kata-manager/kata-manager.sh) \ - install-docker-system" +```bash +$ bash -c "$(curl -fsSL https://raw.githubusercontent.com/kata-containers/tests/master/cmd/kata-manager/kata-manager.sh) install-docker-system" ``` + ## Install the Kata packages only Use the following command to only install Kata Containers packages. -``` -$ bash -c "$(curl -fsSL \ -$ https://raw.githubusercontent.com/kata-containers/tests/master/cmd/kata-manager/kata-manager.sh) \ - install-packages" +```bash +$ bash -c "$(curl -fsSL https://raw.githubusercontent.com/kata-containers/tests/master/cmd/kata-manager/kata-manager.sh) install-packages" ``` ## Further Information