• Created by Unknown User (sureshanaparti) on Nov 18, 2024 2 minute read

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Purpose

This is the functional specification to keep management server in maintenance mode.

Bug Reference

N/A

Branch

main

Introduction


CloudStack currently supports safe shutdown of management server from 4.19.0 release onwards. The management server still holds the agents responsibility when it's ready to shutdown. This proposed feature will migrate the agents to other available management servers in CloudStack, and keep it in maintenance mode.

Document History

AuthorDescriptionDate
Suresh Kumar Anaparti
Added feature specification and designNov 2024

Glossary

  • MS - Management Server

Usecases

This feature should able to:

  1. Allow admin to keep management server in maintenance mode, for any kind of maintenance activity (to update patches, packages, restart, etc).

Feature specification

  1. Add support to keep management server in maintenance mode.

Functionality support

  1. Prepare for maintenance
  2. Cancel maintenance

Test Guidelines

  1. Initiate management server maintenance when some jobs are running and host agents are connected.

Error Handling

  1. All errors at various levels will be logged in management-server.log.

Target Users

  1. CloudStack Admins.

Design description

Update the existing shutdown plugin to support maintenance mode of the management server.

  1. New MS States: PrepareForMaintenance, Maintenance

2.  Agents Migration:

New command for agents migration.

Configuration settings

The configuration settings changes below, are incorporated.

Configuration

Description

Default Value

management.server.maintenance.window

Timeout (in mins) for the management server maintenance

60

API Flow

The update API flow for the management server API calls, and respective state changes.




Assumptions and Limitations

  1. TODO.

API changes

New APIs:

  1. prepareForMaintenance API.
    1. managementserverid 
    2. algorithm - indirect agents lb algorithm.
  2. cancelMaintenance API call.
    1. managementserverid

Existing APIs:

  1. listHosts API - list the hosts managed by the management server.
    1. managementserverid

DB changes

N/A

Hypervisors supported

KVM (Indirect Agents), VMWare, XenServer (Direct Agents)

UI Flow

  • Go to Management Servers section, and the perform action prepare for maintenance.
  • New Tab with "Connected Agents" for the  Management Server.

Upgrade

N/A

Open Items/Questions

N/A

References

[1] Feature: Safely shutdown cloudstack



  • No labels