Skip to content

Conversation

@haosb
Copy link

@haosb haosb commented Oct 31, 2025

Description

Update manual about VM traffic redirect

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.

Changelog entries

section: docs
type: fix
summary: Update manual about VM traffic redirect

Ruslan Usmanov added 2 commits October 31, 2025 15:43
++
Signed-off-by: Ruslan Usmanov <[email protected]>
@haosb haosb requested review from fl64, goganat and z9r5 as code owners October 31, 2025 12:48
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Oct 31, 2025

Reviewer's Guide

Updated VM traffic redirect documentation in English and Russian to clearly explain using the Kubernetes Service resource with selectors, improved the VM and Service examples by adding namespacing and multi-port LoadBalancer configuration, and removed the outdated dynamic service example.

Class diagram for updated VM and Service resource examples

classDiagram
    class VirtualMachine {
      apiVersion: virtualization.deckhouse.io/v1alpha2
      kind: VirtualMachine
      metadata:
        name: frontend-0
        namespace: dev
        labels:
          vm: frontend-0
      spec: ...
    }
    class Service {
      apiVersion: v1
      kind: Service
      metadata:
        name: web-svc
        namespace: dev
      spec:
        type: LoadBalancer
        ports:
          ssh: 2211 -> 22
          http: 80 -> 80
          https: 443 -> 443
        selector:
          vm: frontend-0
    }
    Service "1" --> "1" VirtualMachine
Loading

File-Level Changes

Change Details Files
Clarify VM traffic redirection mechanism
  • Replaced generic forwarding description with explanation of using Service resource and selectors
  • Added a numbered step to create the service
docs/FAQ.md
docs/FAQ.ru.md
Update VirtualMachine manifest example
  • Changed VM name from “web” to “frontend-0”
  • Added namespace field under metadata
  • Updated label from “vm:web” to “vm:frontend-0”
docs/FAQ.md
docs/FAQ.ru.md
Revise Service example to LoadBalancer with multi-port configuration
  • Removed the simple Service example and dynamic label-based routing section
  • Introduced a LoadBalancer-type Service with SSH (2211→22), HTTP (80→80), and HTTPS (443→443) ports
  • Updated service metadata (name “web-svc” and namespace “dev”)
docs/FAQ.md
docs/FAQ.ru.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes - here's some feedback:

  • The numbered list steps all use “1.”; consider renumbering to 1, 2, 3 for clarity and consistency.
  • It may help to briefly note which Service types (ClusterIP, NodePort, LoadBalancer) are supported and when to use each for VM traffic routing.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The numbered list steps all use “1.”; consider renumbering to 1, 2, 3 for clarity and consistency.
- It may help to briefly note which Service types (ClusterIP, NodePort, LoadBalancer) are supported and when to use each for VM traffic routing.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

++
Signed-off-by: Ruslan Usmanov <[email protected]>
@haosb haosb added this to the v1.2.0 milestone Oct 31, 2025
prismagod
prismagod previously approved these changes Nov 5, 2025
Co-authored-by: Vladislav Panfilov <[email protected]>
Signed-off-by: Ruslan Usmanov <[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.

3 participants