From 493ebc8ca5a17925ae5de2afa1eb1ec8f1c1ce25 Mon Sep 17 00:00:00 2001
From: "James O. D. Hunt" <james.o.hunt@intel.com>
Date: Tue, 15 Feb 2022 14:27:08 +0000
Subject: [PATCH] utils: Update kata manager docs

Update the `kata-manager.sh` README to recommend users view the
available options before running the script.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
---
 utils/README.md | 38 ++++++++++++++++++++++++++++----------
 1 file changed, 28 insertions(+), 10 deletions(-)

diff --git a/utils/README.md b/utils/README.md
index 57e9a879b6..255568a71a 100644
--- a/utils/README.md
+++ b/utils/README.md
@@ -38,18 +38,36 @@ If you still wish to continue, but prefer a manual installation, see
 
 ## Install a minimal Kata Containers system
 
+By default, the script will attempt to install Kata Containers and
+containerd, and then configure containerd to use Kata Containers. However,
+the script provides a number of options to allow you to change its
+behaviour.
+
+> **Note:**
+>
+> Before running the script to install Kata Containers, we recommend
+> that you [review the available options](#show-available-options).
+
+### Show available options
+
+To show the available options without installing anything, run:
+
+```sh
+$ bash -c "$(curl -fsSL https://raw.githubusercontent.com/kata-containers/kata-containers/main/utils/kata-manager.sh) -h"
+```
+
+### To install Kata Containers only
+
+If your system already has containerd installed, to install Kata Containers and only configure containerd, run:
+
+```sh
+$ bash -c "$(curl -fsSL https://raw.githubusercontent.com/kata-containers/kata-containers/main/utils/kata-manager.sh) -o"
+```
+
+### To install Kata Containers and containerd
+
 To install and configure a system with Kata Containers and containerd, run:
 
 ```bash
 $ bash -c "$(curl -fsSL https://raw.githubusercontent.com/kata-containers/kata-containers/main/utils/kata-manager.sh)"
 ```
-
-> **Notes:**
->
-> - The script must be run on a system that does not have Kata Containers or
->   containerd already installed on it.
->
-> - The script accepts up to two parameters which can be used to test
->   pre-release versions (a Kata Containers version, and a containerd
->   version). If either version is unspecified or specified as `""`, the
->   latest official version will be installed.