1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
|
# Copyright (c) 2010 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
vnc_group = cfg.OptGroup(
'vnc',
title='VNC options',
help="""
Virtual Network Computer (VNC) can be used to provide remote desktop
console access to instances for tenants and/or administrators.""")
enabled = cfg.BoolOpt(
'enabled',
default=True,
deprecated_group='DEFAULT',
deprecated_name='vnc_enabled',
help="""Enable VNC related features.
Guests will get created with graphical devices to support this. Clients
(for example Horizon) can then establish a VNC connection to the guest.
Possible values:
* True: Enables the feature
* False: Disables the feature
Services which consume this:
* ``nova-compute``
Related options:
* None
""")
keymap = cfg.StrOpt(
'keymap',
default='en-us',
deprecated_group='DEFAULT',
deprecated_name='vnc_keymap',
help="""Keymap for VNC.
The keyboard mapping (keymap) determines which keyboard layout a VNC
session should use by default.
Possible values:
* A keyboard layout which is supported by the underlying hypervisor on
this node. This is usually an 'IETF language tag' (for example
'en-us'). If you use QEMU as hypervisor, you should find the list
of supported keyboard layouts at ``/usr/share/qemu/keymaps``.
Services which consume this:
* ``nova-compute``
Related options:
* None
""")
# TODO(sfinucan): This should be an IPOpt
vncserver_listen = cfg.StrOpt(
'vncserver_listen',
default='127.0.0.1',
deprecated_group='DEFAULT',
help="""
The IP address on which an instance should listen to for incoming VNC
connection requests on this node.
Possible values:
* An IP address
Services which consume this:
* ``nova-compute``
Related options:
* None
""")
# TODO(sfinucan): This should be an IPOpt
vncserver_proxyclient_address = cfg.StrOpt(
'vncserver_proxyclient_address',
default='127.0.0.1',
deprecated_group='DEFAULT',
help="""
Private, internal address of VNC console proxy.
The VNC proxy is an OpenStack component that enables compute service
users to access their instances through VNC clients.
This option sets the private address to which proxy clients, such as
``nova-xvpvncproxy``, should connect to.
Possible values:
* An IP address
Services which consume this:
* ``nova-compute``
Related options:
* None
""")
# TODO(sfinucan): This should be an IPOpt
novncproxy_host = cfg.StrOpt(
'novncproxy_host',
default='0.0.0.0',
deprecated_group='DEFAULT',
help="""
IP address that the noVNC console proxy should bind to.
The VNC proxy is an OpenStack component that enables compute service
users to access their instances through VNC clients. noVNC provides
VNC support through a websocket-based client.
This option sets the private address to which the noVNC console proxy
service should bind to.
Possible values:
* An IP address
Services which consume this:
* ``nova-compute``
Related options:
* novncproxy_port
* novncproxy_base_url
""")
# TODO(sfinucan): This should be a PortOpt
novncproxy_port = cfg.IntOpt(
'novncproxy_port',
default=6080,
min=1,
max=65535,
deprecated_group='DEFAULT',
help="""
Port that the noVNC console proxy should bind to.
The VNC proxy is an OpenStack component that enables compute service
users to access their instances through VNC clients. noVNC provides
VNC support through a websocket-based client.
This option sets the private port to which the noVNC console proxy
service should bind to.
Possible values:
* A port number
Services which consume this:
* ``nova-compute``
Related options:
* novncproxy_host
* novncproxy_base_url
""")
novncproxy_base_url = cfg.StrOpt(
'novncproxy_base_url',
default='http://127.0.0.1:6080/vnc_auto.html',
deprecated_group='DEFAULT',
help="""
Public address of noVNC VNC console proxy.
The VNC proxy is an OpenStack component that enables compute service
users to access their instances through VNC clients. noVNC provides
VNC support through a websocket-based client.
This option sets the public base URL to which client systems will
connect. noVNC clients can use this address to connect to the noVNC
instance and, by extension, the VNC sessions.
Possible values:
* A URL
Services which consume this:
* ``nova-compute``
Related options:
* novncproxy_host
* novncproxy_port
""")
# TODO(sfinucan): This should be an IPOpt
xvpvncproxy_host = cfg.StrOpt(
'xvpvncproxy_host',
default='0.0.0.0',
deprecated_group='DEFAULT',
help="""
IP address that the XVP VNC console proxy should bind to.
The VNC proxy is an OpenStack component that enables compute service
users to access their instances through VNC clients. Xen provides
the Xenserver VNC Proxy, or XVP, as an alternative to the
websocket-based noVNC proxy used by Libvirt. In contrast to noVNC,
XVP clients are Java-based.
This option sets the private address to which the XVP VNC console proxy
service should bind to.
Possible values:
* An IP address
Services which consume this:
* ``nova-compute``
Related options:
* xvpvncproxy_port
* xvpvncproxy_base_url
""")
# TODO(sfinucan): This should be a PortOpt
xvpvncproxy_port = cfg.IntOpt(
'xvpvncproxy_port',
default=6081,
min=1,
max=65535,
deprecated_group='DEFAULT',
help="""
Port that the XVP VNC console proxy should bind to.
The VNC proxy is an OpenStack component that enables compute service
users to access their instances through VNC clients. Xen provides
the Xenserver VNC Proxy, or XVP, as an alternative to the
websocket-based noVNC proxy used by Libvirt. In contrast to noVNC,
XVP clients are Java-based.
This option sets the private port to which the XVP VNC console proxy
service should bind to.
Possible values:
* A port number
Services which consume this:
* ``nova-compute``
Related options:
* xvpvncproxy_host
* xvpvncproxy_base_url
""")
xvpvncproxy_base_url = cfg.StrOpt(
'xvpvncproxy_base_url',
default='http://127.0.0.1:6081/console',
deprecated_group='DEFAULT',
help="""
Public address of XVP VNC console proxy.
The VNC proxy is an OpenStack component that enables compute service
users to access their instances through VNC clients. Xen provides
the Xenserver VNC Proxy, or XVP, as an alternative to the
websocket-based noVNC proxy used by Libvirt. In contrast to noVNC,
XVP clients are Java-based.
This option sets the public base URL to which client systems will
connect. XVP clients can use this address to connect to the XVP
instance and, by extension, the VNC sessions.
Possible values:
* A URL
Services which consume this:
* ``nova-compute``
Related options:
* xvpvncproxy_host
* xvpvncproxy_port
""")
ALL_OPTS = [
enabled,
keymap,
vncserver_listen,
vncserver_proxyclient_address,
novncproxy_host,
novncproxy_port,
novncproxy_base_url,
xvpvncproxy_host,
xvpvncproxy_port,
xvpvncproxy_base_url]
CLI_OPTS = [
novncproxy_host,
novncproxy_port]
def register_opts(conf):
conf.register_group(vnc_group)
conf.register_opts(ALL_OPTS, group=vnc_group)
def register_cli_opts(conf):
conf.register_cli_opts(CLI_OPTS, group=vnc_group)
def list_opts():
return {vnc_group: ALL_OPTS}
|
