mirror of
https://github.com/kata-containers/kata-containers.git
synced 2026-04-10 22:12:35 +00:00
7af892f8d8
Add details to the README for `kata-manager` showing how to list available hypervisor configs (packaged and local), and switch between the configurations. Also, update the hypervisors page to show a lot more detail about the hypervisor configurations, including the "short name" used by `kata-manager` for switching hypervisor config. > **Note:** > > These changes only apply to the current default golang runtime. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
205 lines
7.4 KiB
Markdown
205 lines
7.4 KiB
Markdown
# Utilities
|
|
|
|
# Kata Manager
|
|
|
|
> **Notes:**
|
|
>
|
|
> - We recommend users install Kata Containers using
|
|
> [official distribution packages](../docs/install/README.md#official-packages), where available.
|
|
>
|
|
> - These instructions only apply to the current default (golang) Kata runtime.
|
|
> See https://github.com/kata-containers/kata-containers/issues/9060 for further details.
|
|
|
|
The [`kata-manager.sh`](kata-manager.sh) script automatically installs and
|
|
configures Kata Containers and a container manager (such as containerd, Docker and `nerdctl`).
|
|
|
|
By default, the script installs the latest versions of Kata Containers and
|
|
containerd. However, be aware of the following before proceeding:
|
|
|
|
- Packages will **not** be automatically updated
|
|
|
|
Since a package manager is not being used, it is **your** responsibility
|
|
to ensure these packages are kept up-to-date when new versions are released
|
|
to ensure you are using a version that includes the latest security and bug fixes.
|
|
|
|
- Potentially untested versions or version combinations
|
|
|
|
This script installs the *newest* versions of Kata Containers
|
|
and containerd from binary release packages. These versions may
|
|
not have been tested with your distribution version.
|
|
|
|
If you still wish to continue, but prefer a manual installation, see
|
|
[the containerd installation guide](/docs/install/container-manager/containerd/containerd-install.md).
|
|
|
|
## 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.
|
|
|
|
> **Notes:**
|
|
>
|
|
> - Before running the script to install Kata Containers, we recommend
|
|
> that you [review the available options](#show-available-options).
|
|
>
|
|
> - The `kata-manager.sh` script is
|
|
> [now packaged](https://github.com/kata-containers/kata-containers/pull/9091)
|
|
> as part of the Kata Containers release and can be called as either
|
|
> `kata-manager.sh` or simply `kata-manager`. Some of the sections
|
|
> below give two examples of how to run the script: running the
|
|
> local version, and by downloading and running the latest version
|
|
> in the Kata Containers GitHub repository. If your version of Kata
|
|
> Containers includes the `kata-manager.sh` script, you can run
|
|
> either version although we would suggest you use the local version
|
|
> since: (a) it has been tested with the Kata Containers release you
|
|
> are using; and (b) it is simpler to run the command directly.
|
|
|
|
### 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)"
|
|
```
|
|
|
|
### Choose a Hypervisor
|
|
|
|
Kata works with different [hypervisors](../docs/hypervisors.md). When you install a Kata system, the default hypervisor
|
|
will be configured, but all the available hypervisors are installed.
|
|
This means you can switch between hypervisors whenever you wish.
|
|
|
|
#### List available hypervisors
|
|
|
|
Run one of the following commands on an installed system.
|
|
|
|
- If you Kata Containers installation includes the `kata-manager.sh` script, run:
|
|
|
|
```bash
|
|
$ 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
|
|
|
|
To show the default packaged hypervisor, run one of the following
|
|
commands on an installed system:
|
|
|
|
- If you Kata Containers installation includes the `kata-manager.sh` script, run:
|
|
|
|
```bash
|
|
$ 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
|
|
|
|
`kata-manager.sh` will create a "local" copy of the packaged Kata configuration
|
|
file.
|
|
|
|
To show details of the _local_ copy of the configuration files, run
|
|
one of the following on an installed system.
|
|
|
|
- If you Kata Containers installation includes the `kata-manager.sh` script, run:
|
|
|
|
```bash
|
|
$ 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.
|
|
|
|
> See the [configuration documentation](https://github.com/kata-containers/kata-containers#configuration)
|
|
> for further information.
|
|
|
|
#### Switch hypervisor
|
|
|
|
> **Note:**
|
|
>
|
|
> If you create your own local configuration files, you should ensure
|
|
> they are backed up safely before switching hypervisor configuration
|
|
> since the script will overwrite any files that it needs to create in
|
|
> the Kata configuration directory (`/etc/kata-containers/` and
|
|
> sub-directories).
|
|
|
|
##### To install Kata Containers and containerd and configure it for a specific hypervisor
|
|
|
|
To specify that Kata be installed and configured to use a specific
|
|
hypervisor, use the `-H` option. For example, to select Cloud Hypervisor, run:
|
|
|
|
```bash
|
|
$ bash -c "$(curl -fsSL https://raw.githubusercontent.com/kata-containers/kata-containers/main/utils/kata-manager.sh) -H clh"
|
|
```
|
|
|
|
> **Note:** See the [List available hypervisors](#list-available-hypervisors) section
|
|
> for details of how to obtain the list of available hypervisor names.
|
|
|
|
##### To switch the locally installed hypervisor
|
|
|
|
To switch the local hypervisor config on an installed system use the
|
|
`-S` option. For example, to switch to the Cloud Hypervisor hypervisor,
|
|
run one of the following commands on an installed system:
|
|
|
|
- If you Kata Containers installation includes the `kata-manager.sh` script, run:
|
|
|
|
```bash
|
|
$ 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
|
|
> for details of how to obtain the list of available hypervisor names.
|
|
|
|
##### Switch to the default packaged 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:
|
|
|
|
- If you Kata Containers installation includes the `kata-manager.sh` script, run:
|
|
|
|
```bash
|
|
$ 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"
|
|
```
|