Skip to content

docs: update docs due 1.9.0 #2284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
prismagod wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

docs: update docs due 1.9.0 #2284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ed2b8ff
docs: add alert about NetworkPolicy restrictions for VM node access
prismagod Apr 27, 2026
d224f4e
docs: update maximum possible number of cores in CPU topology
prismagod Apr 27, 2026
a1d6286
docs: update Ubuntu version
prismagod Apr 29, 2026
2814223
docs: add docs about memory hotplug
prismagod May 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions docs/ADMIN_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ In this example, let's create a cluster image.
apiVersion: virtualization.deckhouse.io/v1alpha2
kind: ClusterVirtualImage
metadata:
name: ubuntu-22-04
name: ubuntu-24-04
spec:
# Source for creating an image.
dataSource:
Expand All @@ -305,17 +305,17 @@ In this example, let's create a cluster image.
1. To verify that the ClusterVirtualImage has been created, run the following command:

```bash
d8 k get clustervirtualimage ubuntu-22-04
d8 k get clustervirtualimage ubuntu-24-04

# A short version of the command.
d8 k get cvi ubuntu-22-04
d8 k get cvi ubuntu-24-04
```

In the output, you should see information about the resource:

```console
NAME PHASE CDROM PROGRESS AGE
ubuntu-22-04 Ready false 100% 23h
ubuntu-24-04 Ready false 100% 23h
```

Once created, the ClusterVirtualImage resource can be in one of the following states (phases):
Expand All @@ -335,27 +335,27 @@ Diagnosing problems with a resource is done by analyzing the information in the
You can trace the image creation process by adding the `-w` key to the command used for verification of the created resource:

```bash
d8 k get cvi ubuntu-22-04 -w
d8 k get cvi ubuntu-24-04 -w
```

Example output:

```console
NAME PHASE CDROM PROGRESS AGE
ubuntu-22-04 Provisioning false 4s
ubuntu-22-04 Provisioning false 0.0% 4s
ubuntu-22-04 Provisioning false 28.2% 6s
ubuntu-22-04 Provisioning false 66.5% 8s
ubuntu-22-04 Provisioning false 100.0% 10s
ubuntu-22-04 Provisioning false 100.0% 16s
ubuntu-22-04 Ready false 100% 18s
ubuntu-24-04 Provisioning false 4s
ubuntu-24-04 Provisioning false 0.0% 4s
ubuntu-24-04 Provisioning false 28.2% 6s
ubuntu-24-04 Provisioning false 66.5% 8s
ubuntu-24-04 Provisioning false 100.0% 10s
ubuntu-24-04 Provisioning false 100.0% 16s
ubuntu-24-04 Ready false 100% 18s
```

You can get additional information about the downloaded image from the description of the ClusterVirtualImage resource.
To check on the description, run the following command:

```bash
d8 k describe cvi ubuntu-22-04
d8 k describe cvi ubuntu-24-04
```

How to create an image from an HTTP server in the web interface:
Expand All @@ -374,28 +374,28 @@ An image stored in a container registry has a certain format. Let's look at an e
1. First, download the image locally:

```bash
curl -L https://cloud-images.ubuntu.com/minimal/releases/jammy/release/ubuntu-22.04-minimal-cloudimg-amd64.img -o ubuntu2204.img
curl -L https://cloud-images.ubuntu.com/minimal/releases/noble/release/ubuntu-24.04-minimal-cloudimg-amd64.img -o ubuntu2404.img
```

1. Next, create a `Dockerfile` with the following contents:

```Dockerfile
FROM scratch
COPY ubuntu2204.img /disk/ubuntu2204.img
COPY ubuntu2404.img /disk/ubuntu2404.img
```

1. Build the image and upload it to the container registry. The example below uses `docker.io` as the container registry. You would need to have a service account and a configured environment to run it.

```bash
docker build -t docker.io/<username>/ubuntu2204:latest
docker build -t docker.io/<username>/ubuntu2404:latest
```

Where `username` is the username specified when registering at `docker.io`.

1. Upload the created image to the container registry:

```bash
docker push docker.io/<username>/ubuntu2204:latest
docker push docker.io/<username>/ubuntu2404:latest
```

1. To use this image, create a resource as an example:
Expand All @@ -405,12 +405,12 @@ An image stored in a container registry has a certain format. Let's look at an e
apiVersion: virtualization.deckhouse.io/v1alpha2
kind: ClusterVirtualImage
metadata:
name: ubuntu-2204
name: ubuntu-2404
spec:
dataSource:
type: ContainerImage
containerImage:
image: docker.io/<username>/ubuntu2204:latest
image: docker.io/<username>/ubuntu2404:latest
EOF
```

Expand Down Expand Up @@ -536,7 +536,7 @@ Images eligible for cleanup:
KIND NAMESPACE NAME
ClusterVirtualImage debian-12
VirtualDisk default debian-10-root
VirtualImage default ubuntu-2204
VirtualImage default ubuntu-2404
```

## Virtual machine classes
Expand Down
40 changes: 20 additions & 20 deletions docs/ADMIN_GUIDE.ru.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ spec:
apiVersion: virtualization.deckhouse.io/v1alpha2
kind: ClusterVirtualImage
metadata:
name: ubuntu-22-04
name: ubuntu-24-04
spec:
# Источник для создания образа.
dataSource:
Expand All @@ -307,17 +307,17 @@ spec:
1. Проверьте результат создания ресурса ClusterVirtualImage, выполнив следующую команду:

```bash
d8 k get clustervirtualimage ubuntu-22-04
d8 k get clustervirtualimage ubuntu-24-04

# Короткий вариант команды.
d8 k get cvi ubuntu-22-04
d8 k get cvi ubuntu-24-04
```

В результате будет выведена информация о ресурсе:

```console
NAME PHASE CDROM PROGRESS AGE
ubuntu-22-04 Ready false 100% 23h
ubuntu-24-04 Ready false 100% 23h
```

После создания ресурс ClusterVirtualImage может находиться в одном из следующих состояний (фаз):
Expand All @@ -337,27 +337,27 @@ spec:
Чтобы отследить процесс создания образа, добавьте ключ `-w` к команде проверки результата создания ресурса:

```bash
d8 k get cvi ubuntu-22-04 -w
d8 k get cvi ubuntu-24-04 -w
```

Пример вывода:

```console
NAME PHASE CDROM PROGRESS AGE
ubuntu-22-04 Provisioning false 4s
ubuntu-22-04 Provisioning false 0.0% 4s
ubuntu-22-04 Provisioning false 28.2% 6s
ubuntu-22-04 Provisioning false 66.5% 8s
ubuntu-22-04 Provisioning false 100.0% 10s
ubuntu-22-04 Provisioning false 100.0% 16s
ubuntu-22-04 Ready false 100% 18s
ubuntu-24-04 Provisioning false 4s
ubuntu-24-04 Provisioning false 0.0% 4s
ubuntu-24-04 Provisioning false 28.2% 6s
ubuntu-24-04 Provisioning false 66.5% 8s
ubuntu-24-04 Provisioning false 100.0% 10s
ubuntu-24-04 Provisioning false 100.0% 16s
ubuntu-24-04 Ready false 100% 18s
```

В описании ресурса ClusterVirtualImage можно получить дополнительную информацию о скачанном образе.
Для этого выполните следующую команду:

```bash
d8 k describe cvi ubuntu-22-04
d8 k describe cvi ubuntu-24-04
```

Как создать образ с HTTP-сервера в веб-интерфейсе:
Expand All @@ -376,28 +376,28 @@ d8 k describe cvi ubuntu-22-04
1. Для начала загрузите образ локально:

```bash
curl -L https://cloud-images.ubuntu.com/minimal/releases/jammy/release/ubuntu-22.04-minimal-cloudimg-amd64.img -o ubuntu2204.img
curl -L https://cloud-images.ubuntu.com/minimal/releases/noble/release/ubuntu-24.04-minimal-cloudimg-amd64.img -o ubuntu2404.img
```

1. Далее создайте `Dockerfile` со следующим содержимым:

```Dockerfile
FROM scratch
COPY ubuntu2204.img /disk/ubuntu2204.img
COPY ubuntu2404.img /disk/ubuntu2404.img
```

1. Соберите образ и загрузите его в реестр контейнеров. В качестве реестра контейнеров в примере ниже использован `docker.io`. Для выполнения вам необходимо иметь учётную запись сервиса и настроенное окружение.

```bash
docker build -t docker.io/<username>/ubuntu2204:latest
docker build -t docker.io/<username>/ubuntu2404:latest
```

где `<username>` — имя пользователя, указанное при регистрации в `docker.io`.

1. Загрузите созданный образ в реестр контейнеров:

```bash
docker push docker.io/<username>/ubuntu2204:latest
docker push docker.io/<username>/ubuntu2404:latest
```

1. Чтобы использовать этот образ, создайте в качестве примера ресурс:
Expand All @@ -407,12 +407,12 @@ d8 k describe cvi ubuntu-22-04
apiVersion: virtualization.deckhouse.io/v1alpha2
kind: ClusterVirtualImage
metadata:
name: ubuntu-2204
name: ubuntu-2404
spec:
dataSource:
type: ContainerImage
containerImage:
image: docker.io/<username>/ubuntu2204:latest
image: docker.io/<username>/ubuntu2404:latest
EOF
```

Expand Down Expand Up @@ -539,7 +539,7 @@ Images eligible for cleanup:
KIND NAMESPACE NAME
ClusterVirtualImage debian-12
VirtualDisk default debian-10-root
VirtualImage default ubuntu-2204
VirtualImage default ubuntu-2404
```

## Классы виртуальных машин
Expand Down
Loading
Loading