Skip to content
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.

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

docs: update docs for v0.15 #620

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Conversation

fl64
Copy link
Member

@fl64 fl64 commented Jan 13, 2025

Description

Updating the documentation on features of version v0.15

Why do we need it, and what problem does it solve?

What is the expected result?

Checklist

  • The code is covered by unit tests.
  • e2e tests passed.
  • Documentation updated according to the changes.
  • Changes were tested in the Kubernetes cluster manually.

@fl64 fl64 force-pushed the docs/module/update-docs-for-v0.15 branch 6 times, most recently from b9dda4b to b215af7 Compare January 13, 2025 13:13
Signed-off-by: Pavel Tishkov <[email protected]>
@fl64 fl64 force-pushed the docs/module/update-docs-for-v0.15 branch from b215af7 to ce1d74a Compare January 13, 2025 13:15
eofff
eofff previously approved these changes Jan 13, 2025
@z9r5 z9r5 requested a review from Lada7878 January 13, 2025 13:30
Signed-off-by: Pavel Tishkov <[email protected]>
Signed-off-by: Pavel Tishkov <[email protected]>
@fl64 fl64 marked this pull request as ready for review January 13, 2025 13:40
fl64 added 4 commits January 13, 2025 16:42
Signed-off-by: Pavel Tishkov <[email protected]>
Signed-off-by: Pavel Tishkov <[email protected]>
Signed-off-by: Pavel Tishkov <[email protected]>
Signed-off-by: Pavel Tishkov <[email protected]>
@fl64 fl64 force-pushed the docs/module/update-docs-for-v0.15 branch from cd061a3 to 1b5ef84 Compare January 13, 2025 13:51
Signed-off-by: Pavel Tishkov <[email protected]>
@fl64 fl64 added this to the v0.15.0 milestone Jan 14, 2025
Signed-off-by: Pavel Tishkov <[email protected]>
hayer969
hayer969 previously approved these changes Jan 14, 2025
# NAME PHASE NODE IPADDRESS AGE
# linux-vm Running virtlab-pt-1 10.66.10.14 79m
```

Мы видим что на данный момент она запущена на узле `virtlab-pt-1`.

Для осуществления миграции виртуальной машины с одного узла на другой, с учетом требований к размещению виртуальной машины используется ресурс `VirtualMachineOperations` (`vmop`) с типом migrate.
Для осуществления миграции виртуальной машины с одного узла на другой, с учетом требований к размещению виртуальной машины используется ресурс `VirtualMachineOperations` (`vmop`) с типом `Evict`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Для осуществления миграции виртуальной машины с одного узла на другой, с учетом требований к размещению виртуальной машины используется ресурс `VirtualMachineOperations` (`vmop`) с типом `Evict`.
Для осуществления миграции виртуальной машины с одного узла на другой, с учетом требований к размещению виртуальной машины используется ресурс `VirtualMachineOperation` (`vmop`) с типом `Evict`.

# NAME PHASE NODE IPADDRESS AGE
# linux-vm Running virtlab-pt-1 10.66.10.14 79m
```

We can see that it is currently running on the `virtlab-pt-1` node.

To migrate a virtual machine from one host to another, taking into account the virtual machine placement requirements, the `VirtualMachineOperations` (`vmop`) resource with the migrate type is used.
To migrate a virtual machine from one host to another, taking into account the virtual machine placement requirements, the `VirtualMachineOperations` (`vmop`) resource with the `Evict` type is used.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To migrate a virtual machine from one host to another, taking into account the virtual machine placement requirements, the `VirtualMachineOperations` (`vmop`) resource with the `Evict` type is used.
To migrate a virtual machine from one host to another, taking into account the virtual machine placement requirements, the `VirtualMachineOperation` (`vmop`) resource with the `Evict` type is used.

Comment on lines 480 to 485
d8 k apply -f - <<EOF
apiVersion: virtualization.deckhouse.io/v1alpha2
kind: VirtualMachineOperation
metadata:
name: migrate-linux-vm-$(date +%s)
name: evict-linux-vm-$(date +%s)
spec:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: use generateName instead of date extrapolation. It will require d8 k create instead of apply.

d8 k create -f - <<EOF
...
metadata:
  generateName: evict-linux-vm-

@@ -98,6 +98,10 @@ Deckhouse Virtualization Platform uses five update channels designed for use in
| Stable | Stable update channel for clusters where active work is finished and mostly operational. Functionality updates to this update channel do not reach this update channel until two weeks after they appear in the release. |
| Rock Solid | The most stable update channel. Suitable for clusters that need a higher level of stability. Feature updates do not reach this channel until one month after they are released. |

{{< alert level="warning" >}}
Attention: Changing the virtual machine “firmware” during a platform version upgrade may result in virtual machines migrating to the new “firmware”.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no definition of the "firmware" in this file.

Comment on lines +96 to +98
ADMIN_GUIDE.md
USER_GUIDE.md
CHARACTERISTICS_DESCRIPTION.md
Copy link
Member

@diafour diafour Jan 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
ADMIN_GUIDE.md
USER_GUIDE.md
CHARACTERISTICS_DESCRIPTION.md
ADMIN_GUIDE.md
USER_GUIDE.md
CHARACTERISTICS_DESCRIPTION.md
INSTALL.md

Fix indent, add INSTALL.md as stated in regex.

Signed-off-by: Lada Lysenko <[email protected]>
Signed-off-by: Lada Lysenko <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants