feat: v1.5.0 - OpenNebula 7.0.x support, smart auto-fill IDs & multi-instance improvements by rafagarciaUMA · Pull Request #25 · 6G-SANDBOX/toolkit-installer

rafagarciaUMA · 2026-02-16T11:50:38Z

Summary

This release introduces support for OpenNebula 7.0.x, smart auto-fill of template/image IDs from marketplace appliances, and multi-instance support using ID-based lookups to prevent naming conflicts.

Changes

Added

Support for OpenNebula 7.0.x.
Smart auto-fill for template_id and image_id variables from marketplace appliances.
VM ID-based functions to prevent naming conflicts with multiple instances.
Unique naming for instantiated services.
Function index and section headers to OpenNebula CLI wrapper.
Component selection prompt readability improvements.

Changed

site_routemanager is now optional.
Enhanced user input handling for list values in site YAML.

Fixed

Handle empty VM/service list in onemarketapp_instantiate.
Multi-instance support with ID-based lookups in installer.
Unpack 4 return values from onemarketapp_instantiate.

Files modified

installer.py — Main installer flow with OpenNebula version selection, ID-based lookups, auto-fill logic
utils/one.py — New _by_id functions, unique naming, empty list handling
utils/file.py — List input handling improvements
scripts/install.sh — Version bump to v1.5.0
pyproject.toml — Version bump to 1.5.0
CHANGELOG.md — v1.5.0 entry
.env — Added APPLIANCE_TOOLKIT_V7_SERVICE_URL

The previous commit added ID-based functions but installer.py still used name-based lookups after service instantiation, causing "Service not found" errors when multiple services share the same name. ## Changes to utils/one.py - Add oneflow_roles_by_id() to get roles by service ID - Add oneflow_roles_vm_names_by_id() to get VM names by service ID - Add oneflow_chown_by_id() to change owner by service ID - Add oneflow_role_info_by_id() to get role details by service ID - Add oneflow_role_vm_name_by_id() to get role VM name by service ID - Add oneflow_custom_attr_value_by_id() to get custom attrs by service ID - Modify oneflow_template_instantiate() to return Tuple[str, int] - Modify onemarketapp_instantiate() to return Tuple[bool, str, Optional[int]] ## Changes to installer.py - Import oneflow_role_vm_name_by_id and oneflow_custom_attr_value_by_id - Capture toolkit_service_id from onemarketapp_instantiate() - Use oneflow_role_vm_name_by_id() for jenkins_vm, minio_vm, tnlcm_vm - Use oneflow_custom_attr_value_by_id() for sites_ansible_token

…rvice state checks

…r one.py

Add ID-based variants for VM operations to handle cases where multiple VMs may have the same name (e.g., Technitium DNS, Route Manager API): New functions in utils/one.py: - onevm_chown_by_id(vm_id, username, group_name) - onevm_id(vm_name) - get VM ID from name - onevm_show_by_id(vm_id) - onevm_ip_by_id(vm_id) - onevm_state_by_id(vm_id) - onevm_user_input_by_id(vm_id, user_input) - onevms_running_with_ids() - returns {name: id} dict Modified onemarketapp_instantiate(): - Now returns Tuple[bool, str, Optional[int], Optional[int]] - Fourth element is VM ID for IMAGE type appliances - Uses onevms_running_with_ids() for VM selection - Internally uses ID-based functions to avoid conflicts Updated installer.py: - Captures VM IDs for Technitium and Route Manager API - Uses onevm_ip_by_id() for DNS and Route Manager endpoints - Uses onevm_user_input_by_id() for Route Manager token This ensures correct VM operations when multiple toolkit installations exist with identically named IMAGE-type appliances.

The onemarketapp_instantiate function was updated to return 4 values (is_instantiated, appliance_name, service_id, vm_id) but the toolkit service instantiation was still expecting only 3 values, causing a "too many values to unpack (expected 3)" error. Updated the unpacking at line 335 to include the fourth value (vm_id) using _ since it's not needed for the toolkit service.

…nction

Prevent crash when user confirms having an instantiated appliance but no running VMs or services exist in OpenNebula. Changes: - Wrap instantiation confirmation in a while loop to allow retry - Add validation before ask_select to check for empty choices - Display warning message and re-prompt when no instances found - Initialize vm_name, service_name, and vms_running_with_ids variables before the loop to prevent undefined variable issues - Fix typo: "Do yo have" -> "Do you have" Previously, answering "Yes" to the instantiation question when no VMs or services existed would crash with "A list of choices needs to be provided" from questionary's ask_select function.

Generate unique service names with username and timestamp when instantiating OpenNebula services via oneflow_template_instantiate(). Format: "{template_name} - {username} - {YYYYMMDD-HHMMSS}" Example: "6G-Sandbox Toolkit 20250915-1622-v1.0.0 - rafag - 20250206-143522" This allows multiple developers to instantiate the same service template while being able to identify and differentiate their instances in the service list.

Add visual header with component name in uppercase, separator lines, and emoji to make components stand out during library iteration.

…ariables Extend the marketplace auto-fill logic to handle components with multiple appliances that use prefixed variable names (e.g., collector_template_id, switch_image_id). The matching algorithm: - Standard variables (template_id, image_id): auto-filled from the only appliance when there's exactly one - Prefixed variables (*_template_id, *_image_id): matched against appliance names by extracting the prefix and searching for it in the appliance name words (case-insensitive, handling hyphens and underscores) This enables components like int_p4_sw to automatically populate their collector_template_id and collector_image_id from the "INT-P4 Collector" appliance, reducing manual input during site configuration.

…nce changelog with multi-instance support and unpack return values

Copilot

Pull request overview

This PR adds support for OpenNebula 7.0.x alongside 6.10.x, introduces smart auto-fill functionality for template and image IDs from marketplace appliances, and improves multi-instance support through ID-based resource lookups. The changes include a comprehensive function index in the OpenNebula CLI wrapper, unique naming for service instances, and enhanced user experience for component selection and data entry.

Changes:

Added OpenNebula 7.0.x version detection and corresponding toolkit service appliance support
Implemented smart auto-fill logic for template_id/image_id variables with support for standard, prefixed, and nested (versioned) variables
Introduced ID-based lookup functions (_by_id suffix pattern) to prevent naming conflicts in multi-instance scenarios
Enhanced user input handling for list values and improved component selection prompts

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
pyproject.toml	Version bump to 1.5.0 and added new authors (has syntax error)
scripts/install.sh	Version bump to v1.5.0
CHANGELOG.md	Added v1.5.0 release notes with comprehensive change documentation
utils/one.py	Added function index, new _by_id functions, unique service naming, SERVICE type ID retrieval, and empty list handling
utils/file.py	Enhanced template_id/image_id detection for prefixed variables, improved list input parsing
installer.py	OpenNebula version selection, smart auto-fill logic for IDs, ID-based function calls, improved error messages and component prompts

Comments suppressed due to low confidence (2)

utils/one.py:1222

While the comment states "Use ID-based functions to avoid conflicts with services of the same name", the code still uses name-based onevm_chown for VMs within the service. If multiple service instances exist, their VMs could potentially have conflicting names. Consider either creating a oneflow_roles_vm_ids_by_id function to retrieve VM IDs directly, or document why VM names are guaranteed to be unique within instantiated services (e.g., if OpenNebula automatically appends service instance IDs to VM names).

    # Use ID-based functions to avoid conflicts with services of the same name
    roles_vm_names = oneflow_roles_vm_names_by_id(oneflow_id=service_id)
    if roles_vm_names:
        for vm_name in roles_vm_names:
            onevm_chown(
                vm_name=vm_name,
                username=username,
                group_name=group_name,
            )

utils/one.py:2928

While the comment states "Use ID-based functions from here to avoid conflicts with services of the same name", the code still uses name-based onevm_chown for VMs within the service roles (line 2924). If multiple service instances exist, their VMs could potentially have conflicting names. Consider using VM IDs from the service role data structure instead of names for consistency with the ID-based approach.

            roles_vm_names = oneflow_roles_vm_names_by_id(oneflow_id=service_id)
            if roles_vm_names:
                for vm_name in roles_vm_names:
                    onevm_chown(
                        vm_name=vm_name,
                        username=username,
                        group_name=group_name,
                    )

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…n auto-fill logic

…ompts

…ormats in site variable prompts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…ble prompts

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

… in site variable prompts

…ter error management

rubenlocru

All good no errors in the deploy

rafagarciaUMA added 12 commits January 20, 2026 11:33

fix: update onemarketapp_instantiate to use ID-based functions for se…

213360b

…rvice state checks

docs: add function index and section headers to OpenNebula CLI wrappe…

3eb337c

…r one.py

fix: enhance user input handling for list values in read_site_yaml fu…

700df4f

…nction

style(installer): improve component selection prompt readability

751ad89

Add visual header with component name in uppercase, separator lines, and emoji to make components stand out during library iteration.

chore: update version to 1.5.0 in pyproject.toml and install.sh; enha…

c9cc3ac

…nce changelog with multi-instance support and unpack return values

feat(installer): enhance debug logging for instantiated service name

b374c6a

rafagarciaUMA requested review from Copilot and rubenlocru February 16, 2026 11:50

Copilot started reviewing on behalf of rafagarciaUMA February 16, 2026 11:51 View session

Merge branch 'main' into test_rafa

9c119e9

Copilot AI reviewed Feb 16, 2026

View reviewed changes

Comment thread installer.py

Comment thread utils/file.py

Comment thread utils/file.py

Comment thread installer.py Outdated

Comment thread pyproject.toml Outdated

Comment thread utils/file.py

Comment thread utils/file.py

Comment thread utils/file.py

rafagarciaUMA and others added 6 commits February 16, 2026 13:13

fix(installer): add clarification comments for template_id handling i…

2ee7ea0

…n auto-fill logic

feat(installer): add validation for numeric input in site variable pr…

9d3b349

…ompts

feat(installer): enhance user input validation for numeric and list f…

b14b300

…ormats in site variable prompts

Update installer.py

5b0e422

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update pyproject.toml

07b67e9

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

feat(file): add validation for comma-separated integers in site varia…

462f3be

…ble prompts

rafagarciaUMA requested a review from Copilot February 16, 2026 12:27

Copilot started reviewing on behalf of rafagarciaUMA February 16, 2026 12:27 View session

Copilot AI reviewed Feb 16, 2026

View reviewed changes

Comment thread utils/file.py

Comment thread utils/one.py Outdated

rafagarciaUMA added 2 commits February 16, 2026 13:36

feat(installer): improve user input validation for integers and lists…

0da631c

… in site variable prompts

fix(one.py): improve exception handling to include SystemExit for bet…

9cb8fcc

…ter error management

rubenlocru reviewed Feb 18, 2026

View reviewed changes

rubenlocru approved these changes Feb 18, 2026

View reviewed changes

rubenlocru merged commit 6ab5186 into main Feb 18, 2026
1 check passed

Navigation Menu

Uh oh!

feat: v1.5.0 - OpenNebula 7.0.x support, smart auto-fill IDs & multi-instance improvements - #25

feat: v1.5.0 - OpenNebula 7.0.x support, smart auto-fill IDs & multi-instance improvements#25
rubenlocru merged 21 commits into
mainfrom
test_rafa

rafagarciaUMA commented Feb 16, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

rubenlocru left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

rafagarciaUMA commented Feb 16, 2026

Summary

Changes

Added

Changed

Fixed

Files modified

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

rubenlocru left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants