Skip to content

[HorizonDB] Add system-managed pool maintenance information - #10602

Open
Matthew Boentoro (mattboentoro) wants to merge 4 commits into
Azure:mainfrom
mattboentoro:feature/horizondb-system-managed-maintenance
Open

Matthew Boentoro (mattboentoro) wants to merge 4 commits into
Azure:mainfrom
mattboentoro:feature/horizondb-system-managed-maintenance

Conversation

@mattboentoro

@mattboentoro Matthew Boentoro (mattboentoro) commented Nov 18, 2026 •

Copy link
Copy Markdown
Member

🤖 PR Validation — ⚠️ Review suggested

Breaking Changes Suppressions
⚠️ None ⚠️ 1 added
⚠️Azure CLI Extensions Breaking Change Test
⚠️horizondb
rule cmd_name rule_message suggest_message
⚠️ 1011 - SubgroupAdd horizondb cluster pool maintenance-event sub group horizondb cluster pool maintenance-event added

This PR adds warning or check suppressions. Fix the underlying warning where possible and justify each remaining suppression in a code comment or the PR description.

1 added suppression
File Line Kind Code
src/horizondb/azext_horizondb/aaz/latest/horizondb/cluster/pool/maintenance_event/custom.py 36 pylint args_schema.filter._registered = False # pylint: disable=protected-access

This checklist is used to make sure that common guidelines for a pull request are followed.

Related command

az horizondb cluster pool maintenance-event list

az horizondb cluster pool maintenance-event show (hidden)

Summary

  • Add a custom maintenance-event list response matching the portal, without calling the maintenance-event API. Hide inapplicable filtering and pagination options. See custom.py:11-41.
  • Keep maintenance-event show hidden. See _show.py:14-17.
  • Document the maintenance policy and prepare version 1.0.0b10 with release notes. See README.md:189-196, setup.py:17, and HISTORY.rst:6-11.

The informational response is:

Maintenance updates are managed by the system. Currently, HorizonDB supports System-Managed Maintenance Window.

Validation

Commands were run from the repository root using the existing development environment. The wheel build used a temporary $wheelDir.

Command Result
.\env\Scripts\python.exe -m azdev style horizondb Passed: pylint and flake8.
.\env\Scripts\python.exe .\scripts\ci\test_index.py -q Passed: 9 tests total, 2 CI-only checks skipped locally.
.\env\Scripts\python.exe -m azdev test --series azext_horizondb Passed: 57 tests and 122 subtests.
.\env\Scripts\python.exe -m build --wheel --no-isolation --outdir $wheelDir .\src\horizondb Passed: built horizondb-1.0.0b10-py2.py3-none-any.whl. Wheel inspection confirmed the version, matching release notes, and inclusion of the custom maintenance command.
.\env\Scripts\python.exe -m azure.cli horizondb cluster pool maintenance-event list -g example-resource-group --cluster-name example-cluster --pool-name example-pool --output tsv Passed: returned the exact informational response above.

Additional in-process CLI assertions passed with HTTP client creation and network requests blocked: exact JSON/TSV output, quiet output, hidden show in group help, and no filtering/pagination options in list help. All standard output formats also completed successfully. No new live recordings are included because the visible list command does not make a service request.

Review follow-up

Related AAZ model PR: Azure/aaz#1173. Verify generated-model synchronization before merge.

General Guidelines

  • Have you run azdev style horizondb locally? (pip install azdev required)
  • Have you run python scripts/ci/test_index.py -q locally? (pip install azdev required)
  • My extension version conforms to the Extension version schema

For new extensions:

Not applicable: this updates the existing HorizonDB extension.

About Extension Publish

There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update src/index.json automatically.
You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify src/index.json.

🐾 Generated with PAW

Return the portal's system-managed maintenance notice from pool maintenance-event list without issuing an API request. Keep maintenance-event show hidden, document the behavior, and prepare version 1.0.0b10.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: cc5bd08e-335e-4241-8a98-9e6f8ebab442
Copilot AI balanced review requested due to automatic review settings November 18, 2026 18:35
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
There may be pipelines that require an authorized user to comment /azp run to run.

@a0x1ab

Copy link
Copy Markdown
Member

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 2 pipeline(s).

Copilot AI 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.

🟡 Changes recommended

The maintenance-event override lacks offline regression tests, and the missing Azure/aaz model PR leaves generated command and API-version alignment unverified.

2 open issues
What changed in this PR

Adds system-managed maintenance information to the HorizonDB extension through az horizondb cluster pool maintenance-event list, without calling the maintenance-event API.

Changes:

  • Adds an informational list override with filtering and pagination disabled, plus a hidden show command.
  • Updates command-group metadata and custom-command imports.
  • Documents the maintenance policy and prepares release 1.0.0b10.
File Description
src/​horizondb/​setup.py Bumps version to 1.0.0b10.
src/​horizondb/​README.md Documents the maintenance information command.
src/​horizondb/​HISTORY.rst Adds maintenance release notes.
src/​horizondb/​azext_horizondb/​aaz/​latest/​horizondb/​cluster/​private_link_resource/​__init__.py Imports existing custom commands.
src/​horizondb/​azext_horizondb/​aaz/​latest/​horizondb/​cluster/​pool/​maintenance_event/​custom.py Returns maintenance information without service requests.
src/​horizondb/​azext_horizondb/​aaz/​latest/​horizondb/​cluster/​pool/​maintenance_event/​_show.py Adds hidden maintenance-event retrieval.
src/​horizondb/​azext_horizondb/​aaz/​latest/​horizondb/​cluster/​pool/​maintenance_event/​_list.py Adds the generated list command underlying the override.
src/​horizondb/​azext_horizondb/​aaz/​latest/​horizondb/​cluster/​pool/​maintenance_event/​__init__.py Exports generated maintenance commands.
src/​horizondb/​azext_horizondb/​aaz/​latest/​horizondb/​cluster/​pool/​maintenance_event/​__cmd_group.py Registers the maintenance-event group.
src/​horizondb/​azext_horizondb/​aaz/​latest/​horizondb/​cluster/​pool/​__init__.py Imports existing pool customizations.
src/​horizondb/​azext_horizondb/​aaz/​latest/​horizondb/​cluster/​pool/​__cmd_group.py Revises pool help and removes its preview flag.
src/​horizondb/​azext_horizondb/​aaz/​latest/​horizondb/​cluster/​__init__.py Imports cluster and restore customizations.
src/​horizondb/​azext_horizondb/​aaz/​latest/​horizondb/​cluster/​__cmd_group.py Revises cluster help and removes its preview flag.
src/​horizondb/​azext_horizondb/​aaz/​latest/​horizondb/​__cmd_group.py Revises root help and removes its preview flag.
src/​horizondb/​azext_horizondb/​__init__.py Registers the informational list override.

Review effort: Balanced

@nasc17 nasc17 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please review updates that went into files not part of this scope and add a test recording.

Comment thread src/horizondb/HISTORY.rst Resolved
@mattboentoro

Copy link
Copy Markdown
Member Author

Companion AAZ command-model PR: Azure/aaz#1173

Matthew Boentoro and others added 3 commits November 18, 2026 14:59
Ref: Azure#10602 (comment)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: cc5bd08e-335e-4241-8a98-9e6f8ebab442
Restore the original parent summaries and preview flags, remove unrelated custom wildcard imports, and keep new maintenance commands in Preview. Native regeneration against the companion AAZ models matches the command arguments, operations, API versions, and group metadata, excluding the intentional hidden-show override.

Ref: Azure#10602 (comment)
Ref: Azure#10602 (comment)
Ref: Azure#10602 (comment)
Ref: Azure#10602 (comment)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: cc5bd08e-335e-4241-8a98-9e6f8ebab442
Exercise the registered CLI list path with HTTP client creation and network requests blocked. Cover exact JSON/TSV output, hidden filtering/pagination options, and hidden show in group help. No service recording is needed for an offline informational command.

Ref: Azure#10602 (comment)
Ref: Azure#10602 (comment)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: cc5bd08e-335e-4241-8a98-9e6f8ebab442
Matthew Boentoro (mattboentoro) pushed a commit to mattboentoro/aaz that referenced this pull request Nov 18, 2026
Keep the new maintenance commands in Preview and retain the existing HorizonDB, cluster, and pool summaries.

Ref: Azure/azure-cli-extensions#10602 (comment)
Ref: Azure/azure-cli-extensions#10602 (comment)
Ref: Azure/azure-cli-extensions#10602 (comment)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: cc5bd08e-335e-4241-8a98-9e6f8ebab442
@a0x1ab

Copy link
Copy Markdown
Member

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 2 pipeline(s).

is_preview=True,
)
class List(AAZCommand):
"""List maintenance events for a HorizonDB pool. Use the OData $filter query parameter to filter by properties/status with the eq and or operators. For example, properties/status eq 'Planned' or properties/status eq 'InProgress' returns upcoming events.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This description needs to be changes from the AAZ tool. "List maintenance events for a HorizonDB pool."

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.

6 participants