github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-07-17 00:43:36 +00:00
Code Issues Projects Releases Wiki Activity

docs: kata-manager: Update with latest details

Browse Source 
Now that v3.3.0 has been released, simplify
the `kata-manager` documentation.

Fixes: #9227.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
This commit is contained in:
James O. D. Hunt 2024-03-28 16:18:44 +00:00
parent 52fe60c94b
commit 5589e4e291
1 changed files with 21 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
utils/README.md
View File

@ -87,57 +87,33 @@ This means you can switch between hypervisors whenever you wish.
#### List available hypervisors #### List available hypervisors
Run one of the following commands on an installed system. Run the following command on an installed system:
- If you Kata Containers installation includes the `kata-manager.sh` script, run:
```bash ```bash
$ kata-manager -L $ kata-manager -L
``` ```
- If your Kata Containers installation does not include the `kata-manager.sh` script, run:
```bash
$ bash -c "$(curl -fsSL https://raw.githubusercontent.com/kata-containers/kata-containers/main/utils/kata-manager.sh) -L"
```
#### Show the default packaged hypervisor #### Show the default packaged hypervisor
To show the default packaged hypervisor, run one of the following To show the default packaged hypervisor, run the following
commands on an installed system: command on an installed system:
- If you Kata Containers installation includes the `kata-manager.sh` script, run:
```bash ```bash
$ kata-manager -L | grep default $ kata-manager -L | grep default
``` ```
- If your Kata Containers installation does not include the `kata-manager.sh` script, run:
```bash
$ bash -c "$(curl -fsSL https://raw.githubusercontent.com/kata-containers/kata-containers/main/utils/kata-manager.sh) -L | grep default"
```
#### Show the locally configured hypervisor #### Show the locally configured hypervisor
`kata-manager.sh` will create a "local" copy of the packaged Kata configuration `kata-manager.sh` will create a "local" copy of the packaged Kata configuration
file. file.
To show details of the _local_ copy of the configuration files, run To show details of the _local_ copy of the configuration files, run
one of the following on an installed system. the following command on an installed system:
- If you Kata Containers installation includes the `kata-manager.sh` script, run:
```bash ```bash
$ kata-manager -e $ kata-manager -e
``` ```
- If your Kata Containers installation does not include the `kata-manager.sh` script, run:
```bash
$ bash -c "$(curl -fsSL https://raw.githubusercontent.com/kata-containers/kata-containers/main/utils/kata-manager.sh) -e"
```
> **Note:** This command can only be run once Kata has been installed. > **Note:** This command can only be run once Kata has been installed.
> See the [configuration documentation](https://github.com/kata-containers/kata-containers#configuration) > See the [configuration documentation](https://github.com/kata-containers/kata-containers#configuration)
@ -169,36 +145,20 @@ $ bash -c "$(curl -fsSL https://raw.githubusercontent.com/kata-containers/kata-c
To switch the local hypervisor config on an installed system use the To switch the local hypervisor config on an installed system use the
`-S` option. For example, to switch to the Cloud Hypervisor hypervisor, `-S` option. For example, to switch to the Cloud Hypervisor hypervisor,
run one of the following commands on an installed system: run the following command on an installed system:
- If you Kata Containers installation includes the `kata-manager.sh` script, run:
```bash ```bash
$ kata-manager -S clh $ kata-manager -S clh
``` ```
- If your Kata Containers installation does not include the `kata-manager.sh` script, run:
```bash
$ bash -c "$(curl -fsSL https://raw.githubusercontent.com/kata-containers/kata-containers/main/utils/kata-manager.sh) -S clh"
```
> **Note:** See the [List available hypervisors](#list-available-hypervisors) section > **Note:** See the [List available hypervisors](#list-available-hypervisors) section
> for details of how to obtain the list of available hypervisor names. > for details of how to obtain the list of available hypervisor names.
#### Switch to the default packaged hypervisor #### Switch to the default packaged hypervisor
To undo your changes and switch back to the default Kata hypervisor, To undo your changes and switch back to the default Kata hypervisor,
specify the hypervisor name as `default`. For example, run one of the following commands on an installed system: specify the hypervisor name as `default`. For example, run the following command on an installed system:
- If you Kata Containers installation includes the `kata-manager.sh` script, run:
```bash ```bash
$ kata-manager -S default $ kata-manager -S default
``` ```
- If your Kata Containers installation does not include the `kata-manager.sh` script, run:
```bash
$ bash -c "$(curl -fsSL https://raw.githubusercontent.com/kata-containers/kata-containers/main/utils/kata-manager.sh) -S default"
```