Files
nova/nova/conf/consoleauth.py
Amit Uniyal 5ecf1d324d enforce remote console shutdown
- Adds a CONF option enforce_session_timeout
- Adds Timer to close connection once token expire
- refactor close_connection functionality
- Fixes existing and adds new unit tests
- Adds release note
- Updates admin guide

Change-Id: I5d7e8faf1d271e9dd98d24e825631246308e7141
2024-02-27 13:23:49 +00:00

57 lines
1.8 KiB
Python

# Copyright (c) 2016 Intel, Inc.
# Copyright (c) 2013 OpenStack Foundation
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from oslo_config import cfg
consoleauth_group = cfg.OptGroup(
name='consoleauth',
title='Console auth options')
consoleauth_opts = [
cfg.IntOpt('token_ttl',
default=600,
min=0,
deprecated_name='console_token_ttl',
deprecated_group='DEFAULT',
help="""
The lifetime of a console auth token (in seconds).
A console auth token is used in authorizing console access for a user.
Once the auth token time to live count has elapsed, the token is
considered expired. Expired tokens are then deleted.
"""),
cfg.BoolOpt(
'enforce_session_timeout',
default=False,
help="""
Enable or disable enforce session timeout for VM console.
This allows operators to enforce a console session timeout.
When set to True, Nova will automatically close the console session
at the server end once token_ttl expires, providing enhanced
control over console session duration.
"""),
]
def register_opts(conf):
conf.register_group(consoleauth_group)
conf.register_opts(consoleauth_opts, group=consoleauth_group)
def list_opts():
return {consoleauth_group: consoleauth_opts}