Skip to content

MGMT-21349: tool description update for vips #75

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.

Sign up for GitHub

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

Closed
zszabo-rh wants to merge 1 commit into from
Closed

MGMT-21349: tool description update for vips #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,10 @@ The MCP server provides the following tools for interacting with the OpenShift A
* `cluster_id`: Cluster ID (string, required)
* `api_vip`: API virtual IP address (string, required)
* `ingress_vip`: Ingress virtual IP address (string, required)

Notes:
* Use only for multi-node clusters with user-managed networking disabled. Single-node clusters and clusters with user-managed networking do not require VIPs.
* Ensure hosts are discovered first (after booting with the Discovery ISO) so that matching subnets are known; attempting to set VIPs earlier can result in errors such as `No suitable matching CIDR found for VIP`.

### Events and Monitoring

Expand Down
4 changes: 4 additions & 0 deletions doc/example_prompts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ Create a new OpenShift cluster.
### `set_cluster_vips`
Configure virtual IP addresses for cluster API and ingress.

Notes:
- Only applicable for multi-node clusters with user-managed networking disabled.
- Run this after hosts have been discovered (post-ISO boot). Attempting it too early may fail due to unknown subnets.

**Example Prompts:**
- "Set the API VIP to 192.168.1.100 and ingress VIP to 192.168.1.101 for my-cluster"
- "Configure cluster my-cluster with API VIP 10.0.0.10 and ingress VIP 10.0.0.11"
Expand Down
7 changes: 7 additions & 0 deletions server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,6 +396,13 @@ async def set_cluster_vips(cluster_id: str, api_vip: str, ingress_vip: str) -> s
for the specified cluster. These VIPs must be available IP addresses within the
cluster's network subnet.

Preconditions:
- Hosts must be discovered for the cluster so that subnets are known. Attempting to
set VIPs before any hosts are discovered typically fails with errors such as
"No suitable matching CIDR found for VIP".
- Only applicable to multi-node clusters with user-managed networking disabled. Single-node
clusters (SNO) and clusters with user-managed networking do not require setting VIPs.

Args:
cluster_id (str): The unique identifier of the cluster to configure.
api_vip (str): The IP address for the cluster API endpoint. This is where
Expand Down