Skip to content

[virtual-machine] Set PortList method by default - #996

Merged
Andrei Kvapil (kvaps) merged 1 commit into
mainfrom
port-list-by-default
May 28, 2025
Merged

[virtual-machine] Set PortList method by default#996
Andrei Kvapil (kvaps) merged 1 commit into
mainfrom
port-list-by-default

Conversation

@kvaps

@kvaps Andrei Kvapil (kvaps) commented May 28, 2025

Copy link
Copy Markdown
Member

Signed-off-by: Andrei Kvapil kvapss@gmail.com

Summary by CodeRabbit

  • New Features

    • Updated default traffic passthrough method for virtual machine and VM instance apps to use specific port forwarding instead of whole IP forwarding.
  • Documentation

    • Updated documentation to reflect the new default passthrough method for both virtual machine and VM instance apps.
  • Chores

    • Incremented version numbers for virtual machine and VM instance apps to reflect recent updates.

@coderabbitai

coderabbitai Bot commented May 28, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

This update increments the version numbers for the virtual-machine and vm-instance components and changes their default externalMethod configuration from WholeIP to PortList across documentation, schema, and values files. No structural or control flow changes are introduced.

Changes

Files Change Summary
packages/apps/versions_map Updated version references for virtual-machine (0.9.2→0.10.0) and vm-instance (0.6.1→0.7.0)
packages/apps/virtual-machine/Chart.yaml, packages/apps/vm-instance/Chart.yaml Incremented chart and app version numbers
packages/apps/virtual-machine/README.md, packages/apps/vm-instance/README.md Changed documented default for externalMethod from WholeIP to PortList
packages/apps/virtual-machine/values.schema.json, packages/apps/vm-instance/values.schema.json Changed default for externalMethod in schema from WholeIP to PortList; reversed enum value order
packages/apps/virtual-machine/values.yaml, packages/apps/vm-instance/values.yaml Changed default for externalMethod in values from WholeIP to PortList
packages/apps/virtual-machine/Makefile, packages/apps/vm-instance/Makefile Reordered externalMethod enum values in schema from ["WholeIP", "PortList"] to ["PortList", "WholeIP"]

Possibly related PRs

  • fix version map #776: Also updates version references for virtual-machine and vm-instance in the versions_map, reflecting newer releases.

Suggested reviewers

  • lllamnyp

Poem

In the meadow of code, a hop and a leap,
Versions advance while old defaults sleep.
From WholeIP to PortList, the traffic now flows,
With each little change, our garden grows.
🐇✨
New numbers, new ways—let’s see where it goes!


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (4)
packages/apps/vm-instance/README.md (1)

42-42: Fix verb usage in description
The phrase “to passthrough the traffic” should use the verb form “pass through” instead of the noun “passthrough.”

- specify method to passthrough the traffic to the virtual machine.
+ specify method to pass through the traffic to the virtual machine.
🧰 Tools
🪛 LanguageTool

[grammar] ~42-~42: The word “passthrough” is a noun. The verb is spelled with a white space.
Context: ... externalMethod | specify method to passthrough the traffic to the virtual machine. All...

(NOUN_VERB_CONFUSION)

packages/apps/virtual-machine/README.md (1)

42-42: Fix verb usage in description
The phrase “to passthrough the traffic” should be “to pass through the traffic” to correct the verb usage.

- specify method to passthrough the traffic to the virtual machine.
+ specify method to pass through the traffic to the virtual machine.
🧰 Tools
🪛 LanguageTool

[grammar] ~42-~42: The word “passthrough” is a noun. The verb is spelled with a white space.
Context: ...nalMethod` | specify method to passthrough the traffic to the virtual machine. All...

(NOUN_VERB_CONFUSION)

packages/apps/virtual-machine/values.yaml (1)

4-4: Fix verb usage in comment
In the parameter description, “to passthrough the traffic” should be “to pass through the traffic” to use the correct verb form.

- ## @param externalMethod specify method to passthrough the traffic to the virtual machine. Allowed values: `WholeIP` and `PortList`
+ ## @param externalMethod specify method to pass through the traffic to the virtual machine. Allowed values: `WholeIP` and `PortList`
packages/apps/vm-instance/values.yaml (1)

4-4: Fix verb usage in comment
In the parameter description, change “to passthrough the traffic” to “to pass through the traffic” for correct verb usage.

- ## @param externalMethod specify method to passthrough the traffic to the virtual machine. Allowed values: `WholeIP` and `PortList`
+ ## @param externalMethod specify method to pass through the traffic to the virtual machine. Allowed values: `WholeIP` and `PortList`
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 50932ba and c77e4d4.

📒 Files selected for processing (9)
  • packages/apps/versions_map (2 hunks)
  • packages/apps/virtual-machine/Chart.yaml (1 hunks)
  • packages/apps/virtual-machine/README.md (1 hunks)
  • packages/apps/virtual-machine/values.schema.json (1 hunks)
  • packages/apps/virtual-machine/values.yaml (1 hunks)
  • packages/apps/vm-instance/Chart.yaml (1 hunks)
  • packages/apps/vm-instance/README.md (1 hunks)
  • packages/apps/vm-instance/values.schema.json (1 hunks)
  • packages/apps/vm-instance/values.yaml (1 hunks)
🧰 Additional context used
🪛 LanguageTool
packages/apps/vm-instance/README.md

[grammar] ~42-~42: The word “passthrough” is a noun. The verb is spelled with a white space.
Context: ... externalMethod | specify method to passthrough the traffic to the virtual machine. All...

(NOUN_VERB_CONFUSION)

packages/apps/virtual-machine/README.md

[grammar] ~42-~42: The word “passthrough” is a noun. The verb is spelled with a white space.
Context: ...nalMethod` | specify method to passthrough the traffic to the virtual machine. All...

(NOUN_VERB_CONFUSION)

🔇 Additional comments (12)
packages/apps/virtual-machine/Chart.yaml (2)

20-20: Bump chart version to 0.9.3
The chart version has been correctly incremented from 0.9.2 to 0.9.3 to reflect the new release.


26-26: Bump application version to 0.9.3
The appVersion has been updated in lockstep with the chart version. No additional adjustments required.

packages/apps/vm-instance/README.md (1)

42-42: Update default passthrough method
The default for externalMethod has been changed from WholeIP to PortList in the documentation, aligning with the intended configuration update.

🧰 Tools
🪛 LanguageTool

[grammar] ~42-~42: The word “passthrough” is a noun. The verb is spelled with a white space.
Context: ... externalMethod | specify method to passthrough the traffic to the virtual machine. All...

(NOUN_VERB_CONFUSION)

packages/apps/virtual-machine/README.md (1)

42-42: Update default passthrough method
The documentation’s default for externalMethod has been updated from WholeIP to PortList, consistent with schema and values changes.

🧰 Tools
🪛 LanguageTool

[grammar] ~42-~42: The word “passthrough” is a noun. The verb is spelled with a white space.
Context: ...nalMethod` | specify method to passthrough the traffic to the virtual machine. All...

(NOUN_VERB_CONFUSION)

packages/apps/virtual-machine/values.yaml (1)

7-7: Update default externalMethod value
The default externalMethod has been updated to PortList, aligning with the chart and schema changes.

packages/apps/vm-instance/values.yaml (1)

7-7: Update default externalMethod value
The default externalMethod has been changed to PortList to forward specific ports, consistent with the VM instance schema and documentation.

packages/apps/vm-instance/Chart.yaml (2)

20-20: Approve version bump
The Helm chart version has been correctly incremented to 0.6.2 following semantic versioning.


26-26: Approve appVersion bump
The application version has been updated to 0.6.2 to match the chart version.

packages/apps/vm-instance/values.schema.json (1)

13-13:

Details

✅ Verification successful

Schema default updated to PortList
The externalMethod default value has been correctly changed from "WholeIP" to "PortList". Please verify that the corresponding default in packages/apps/vm-instance/values.yaml is also updated to "PortList" to maintain consistency.

To automate the check, you can run:


🏁 Script executed:

#!/bin/bash
# Verify that values.yaml default for externalMethod matches the schema
rg -n '"externalMethod":' packages/apps/vm-instance/values.yaml

Length of output: 65


🏁 Script executed:

#!/bin/bash
# Search for `externalMethod` in all YAML files under vm-instance to verify the default value
fd -e yaml -e yml packages/apps/vm-instance | xargs rg -n 'externalMethod'

Length of output: 2170


externalMethod default value is consistent
The externalMethod default in packages/apps/vm-instance/values.yaml (line 7) is set to PortList, matching the updated schema. All defaults are in sync—approving these changes.

packages/apps/versions_map (2)

162-162: Approve virtual-machine version mapping update
The virtual-machine component has been updated to version 0.9.3 in the versions map.


173-173: Approve vm-instance version mapping update
The vm-instance component has been updated to version 0.6.2 in the versions map.

packages/apps/virtual-machine/values.schema.json (1)

13-13:

Details

✅ Verification successful

Schema default updated to PortList
The externalMethod default value has been correctly changed from "WholeIP" to "PortList". Please verify that the corresponding default in packages/apps/virtual-machine/values.yaml is also updated to "PortList" to maintain consistency.

To automate the check, you can run:


🏁 Script executed:

#!/bin/bash
# Verify that values.yaml default for externalMethod matches the schema
rg -n '"externalMethod":' packages/apps/virtual-machine/values.yaml

Length of output: 69


To locate the values.yaml file and verify the externalMethod default, let’s first confirm the file’s existence and then search for any occurrences project-wide:


🏁 Script executed:

#!/bin/bash
# 1. List any values.yaml under virtual-machine
find packages/apps/virtual-machine -type f -name "values.yaml"

# 2. If that file exists, search within it for externalMethod
if [ -f packages/apps/virtual-machine/values.yaml ]; then
  echo "Searching in packages/apps/virtual-machine/values.yaml:"
  rg -n 'externalMethod' packages/apps/virtual-machine/values.yaml || echo "– not found"
else
  echo "packages/apps/virtual-machine/values.yaml not present"
fi

# 3. Search the entire repo for externalMethod to catch other locations
echo "Searching across the repo for externalMethod:"
rg -n 'externalMethod' || echo "– none found"

Length of output: 2320


externalMethod default synchronized
Verified that externalMethod in packages/apps/virtual-machine/values.yaml is set to PortList, matching the updated schema. All aligned.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
packages/apps/vm-instance/README.md (1)

42-42: Confirm default change & refine wording. The default value for externalMethod has been correctly updated to PortList, matching the configuration changes. For improved clarity and correct verb usage, consider rephrasing “specify method to passthrough the traffic” to “specify the method to pass traffic through.”

🧰 Tools
🪛 LanguageTool

[grammar] ~42-~42: The word “passthrough” is a noun. The verb is spelled with a white space.
Context: ... externalMethod | specify method to passthrough the traffic to the virtual machine. All...

(NOUN_VERB_CONFUSION)

packages/apps/virtual-machine/README.md (1)

42-42: Update documentation style for externalMethod.

The default has correctly been changed to PortList to match the schema and values updates. To maintain consistency and proper grammar, capitalize the imperative and use “pass through” instead of “passthrough”. For example:

-| `externalMethod`          | specify method to passthrough the traffic to the virtual machine. Allowed values: `WholeIP` and `PortList` | `PortList`   |
+| `externalMethod`          | Specify method to pass traffic through to the virtual machine. Allowed values: `WholeIP` and `PortList` | `PortList`   |
🧰 Tools
🪛 LanguageTool

[grammar] ~42-~42: The word “passthrough” is a noun. The verb is spelled with a white space.
Context: ...nalMethod` | specify method to passthrough the traffic to the virtual machine. All...

(NOUN_VERB_CONFUSION)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c77e4d4 and 8f2eb5c.

📒 Files selected for processing (11)
  • packages/apps/versions_map (3 hunks)
  • packages/apps/virtual-machine/Chart.yaml (1 hunks)
  • packages/apps/virtual-machine/Makefile (1 hunks)
  • packages/apps/virtual-machine/README.md (1 hunks)
  • packages/apps/virtual-machine/values.schema.json (1 hunks)
  • packages/apps/virtual-machine/values.yaml (1 hunks)
  • packages/apps/vm-instance/Chart.yaml (1 hunks)
  • packages/apps/vm-instance/Makefile (1 hunks)
  • packages/apps/vm-instance/README.md (1 hunks)
  • packages/apps/vm-instance/values.schema.json (1 hunks)
  • packages/apps/vm-instance/values.yaml (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • packages/apps/virtual-machine/Makefile
  • packages/apps/virtual-machine/Chart.yaml
🚧 Files skipped from review as they are similar to previous changes (6)
  • packages/apps/vm-instance/values.yaml
  • packages/apps/virtual-machine/values.yaml
  • packages/apps/vm-instance/values.schema.json
  • packages/apps/virtual-machine/values.schema.json
  • packages/apps/versions_map
  • packages/apps/vm-instance/Chart.yaml
🧰 Additional context used
🪛 LanguageTool
packages/apps/virtual-machine/README.md

[grammar] ~42-~42: The word “passthrough” is a noun. The verb is spelled with a white space.
Context: ...nalMethod` | specify method to passthrough the traffic to the virtual machine. All...

(NOUN_VERB_CONFUSION)

packages/apps/vm-instance/README.md

[grammar] ~42-~42: The word “passthrough” is a noun. The verb is spelled with a white space.
Context: ... externalMethod | specify method to passthrough the traffic to the virtual machine. All...

(NOUN_VERB_CONFUSION)

🔇 Additional comments (1)
packages/apps/vm-instance/Makefile (1)

12-12: Reorder externalMethod enum values. The enumeration is correctly updated to ["PortList", "WholeIP"], aligning the schema order with the new default.

Signed-off-by: Andrei Kvapil <kvapss@gmail.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
packages/apps/virtual-machine/README.md (1)

42-42: Fix verb usage and capitalization in the description

The table description should start with a capital letter and use the verb form “pass through” instead of the noun “passthrough.”

Proposed diff:

-| `externalMethod`          | specify method to passthrough the traffic to the virtual machine. Allowed values: `WholeIP` and `PortList` | `PortList`   |
+| `externalMethod`          | Specify method to pass through the traffic to the virtual machine. Allowed values: `WholeIP` and `PortList` | `PortList`   |
🧰 Tools
🪛 LanguageTool

[grammar] ~42-~42: The word “passthrough” is a noun. The verb is spelled with a white space.
Context: ...nalMethod` | specify method to passthrough the traffic to the virtual machine. All...

(NOUN_VERB_CONFUSION)

packages/apps/vm-instance/README.md (1)

42-42: Nit: refine verb in description
In the description cell, consider changing “specify method to passthrough the traffic” to “specify method to pass through the traffic” for grammatical accuracy.

🧰 Tools
🪛 LanguageTool

[grammar] ~42-~42: The word “passthrough” is a noun. The verb is spelled with a white space.
Context: ... externalMethod | specify method to passthrough the traffic to the virtual machine. All...

(NOUN_VERB_CONFUSION)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8f2eb5c and 461f756.

📒 Files selected for processing (11)
  • packages/apps/versions_map (2 hunks)
  • packages/apps/virtual-machine/Chart.yaml (1 hunks)
  • packages/apps/virtual-machine/Makefile (1 hunks)
  • packages/apps/virtual-machine/README.md (1 hunks)
  • packages/apps/virtual-machine/values.schema.json (1 hunks)
  • packages/apps/virtual-machine/values.yaml (1 hunks)
  • packages/apps/vm-instance/Chart.yaml (1 hunks)
  • packages/apps/vm-instance/Makefile (1 hunks)
  • packages/apps/vm-instance/README.md (1 hunks)
  • packages/apps/vm-instance/values.schema.json (1 hunks)
  • packages/apps/vm-instance/values.yaml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (9)
  • packages/apps/virtual-machine/Makefile
  • packages/apps/virtual-machine/Chart.yaml
  • packages/apps/virtual-machine/values.yaml
  • packages/apps/vm-instance/values.yaml
  • packages/apps/vm-instance/Makefile
  • packages/apps/versions_map
  • packages/apps/virtual-machine/values.schema.json
  • packages/apps/vm-instance/values.schema.json
  • packages/apps/vm-instance/Chart.yaml
🧰 Additional context used
🪛 LanguageTool
packages/apps/virtual-machine/README.md

[grammar] ~42-~42: The word “passthrough” is a noun. The verb is spelled with a white space.
Context: ...nalMethod` | specify method to passthrough the traffic to the virtual machine. All...

(NOUN_VERB_CONFUSION)

packages/apps/vm-instance/README.md

[grammar] ~42-~42: The word “passthrough” is a noun. The verb is spelled with a white space.
Context: ... externalMethod | specify method to passthrough the traffic to the virtual machine. All...

(NOUN_VERB_CONFUSION)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Build and Test
🔇 Additional comments (1)
packages/apps/vm-instance/README.md (1)

42-42: Align default externalMethod with configuration changes
The default value for externalMethod has been correctly updated to PortList, matching the schema and values.yaml. This keeps the documentation in sync with the implementation.

🧰 Tools
🪛 LanguageTool

[grammar] ~42-~42: The word “passthrough” is a noun. The verb is spelled with a white space.
Context: ... externalMethod | specify method to passthrough the traffic to the virtual machine. All...

(NOUN_VERB_CONFUSION)

@kvaps
Andrei Kvapil (kvaps) merged commit 99a7754 into main May 28, 2025
@kvaps
Andrei Kvapil (kvaps) deleted the port-list-by-default branch May 28, 2025 11:02
Nick Volynkin (NickVolynkin) added a commit to cozystack/website that referenced this pull request Jun 17, 2025
Specifically, update changes from
- clickhouse:      cozystack/cozystack#1059
- kafka:           cozystack/cozystack#1040
- kubernetes:      cozystack/cozystack#969
- tenant:          cozystack/cozystack#980
- virtual-machine: cozystack/cozystack#996
- vm-instance:     cozystack/cozystack#996

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
Nick Volynkin (NickVolynkin) added a commit to cozystack/website that referenced this pull request Jun 17, 2025
Specifically, update changes from
- clickhouse:      cozystack/cozystack#1059
- kafka:           cozystack/cozystack#1040
- kubernetes:      cozystack/cozystack#969
- tenant:          cozystack/cozystack#980
- virtual-machine: cozystack/cozystack#996
- vm-instance:     cozystack/cozystack#996

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
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.

2 participants