Commit Graph

19 Commits

Author SHA1 Message Date
Stephen Finucane 009fd0f35b docs: Remove references to nova-consoleauth
We're going to remove all the code, but first, remove the docs.

Part of blueprint remove-consoleauth

Change-Id: Ie96e18ea7762b93b4116b35d7ebcfcbe53c55527
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-06-17 15:18:31 +01:00
Mohammed Naser 9606c80402 Add 'path' query parameter to console access url
Starting in noVNC v1.1.0, the token query parameter is no longer
forwarded via cookie [1]. We must instead use the 'path' query
parameter to pass the token through to the websocketproxy [2].
This means that if someone deploys noVNC v1.1.0, VNC consoles will
break in nova because the code is relying on the cookie functionality
that v1.1.0 removed.

This modifies the ConsoleAuthToken.access_url property to include the
'path' query parameter as part of the returned access_url that the
client will use to call the console proxy service.

This change is backward compatible with noVNC < v1.1.0. The 'path' query
parameter is a long supported feature in noVNC.

Co-Authored-By: melanie witt <melwittt@gmail.com>

Closes-Bug: #1822676

[1] https://github.com/novnc/noVNC/commit/51f9f0098d306bbc67cc8e02ae547921b6f6585c
[2] https://github.com/novnc/noVNC/pull/1220

Change-Id: I2ddf0f4d768b698e980594dd67206464a9cea37b
2019-06-14 18:01:24 +00:00
Stephen Finucane fbb3b53a3b docs: Fix nits in remote console guide
These were missed in I08991796aaced2abc824f608108c0c786181eb65.

Change-Id: Ibb31d7d8460c6376f42bcb65c94796d5e68f3d9d
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-03-07 17:44:55 +00:00
Stephen Finucane 9cd1fc5794 Address nits on I08991796aaced2abc824f608108c0c786181eb65
- Move deprecated services to the end of the document
- Update incorrect information regarding nova-consoleauth
- Move configuration options that were specified for the wrong service
- Don't give the impression that the serial console is libvirt-only

Change-Id: Ie0fd987a1e5c130b8e31c84910814d5d051f2b31
2018-12-18 11:55:27 +00:00
Zuul af9977c71c Merge "Restore nova-consoleauth to install docs" 2018-12-17 16:36:28 +00:00
melanie witt 983e6ea551 Restore nova-consoleauth to install docs
The installation of the nova-consoleauth service was erroneously
removed from the docs prematurely. The nova-consoleauth service
is still being used in Rocky, with the removal being possible in
Stein.

This should have been fixed as part of change
Ibbdc7c50c312da2acc59dfe64de95a519f87f123 but was missed.

This is also related to the release note update in Rocky
under change Ie637b4871df8b870193b5bc07eece15c03860c06.

Co-Authored-By: Matt Riedemann <mriedem.os@gmail.com>

Closes-Bug: #1793255
Related-Bug: #1798188

Change-Id: Ied268da9e70bd2807c2dfe7a479181fbec52979d
2018-11-28 15:21:55 -05:00
Stephen Finucane 4e6cffe45e Deprecate the nova-xvpvncproxy service
This is a relic that has long since been replaced by the noVNC proxy
service. Start preparing for its removal.

Change-Id: Icb225dec3ad291b751e475bd3703ce0eb30b44db
2018-10-15 10:03:13 +01:00
Stephen Finucane 2764b938b1 doc: Add minimal documentation for MKS consoles
I did know this was a thing but only barely. As with RDP, the
documentation is very minimal but it should contain enough pointers for
anyone playing with this stuff.

Change-Id: I0b62d42eae7c325566ee065dcdc0f73b7223d471
2018-10-15 10:02:28 +01:00
Stephen Finucane c7355aa66d doc: Add minimal documentation for RDP consoles
I didn't even know this was a thing. Call it out...and promptly link to
the Cloudbase documentation, which I don't want to reproduce here for
reasons of expediency.

Change-Id: I4416bf5c5c4e906bcfdeec5a7ae41f747029a292
2018-10-15 10:02:28 +01:00
Stephen Finucane 0e801a9e62 doc: Rewrite the console doc
The link between the various consoles was never well understood (by me,
at least). Clarify this by restructuring the document to highlight the
few differences between these services.

Change-Id: I08991796aaced2abc824f608108c0c786181eb65
2018-10-15 10:02:26 +01:00
melanie witt e91dad3ee9 Deprecate the nova-consoleauth service
Part of blueprint convert-consoles-to-objects

Change-Id: I9bfa89d2d8fe2b5803b4e1478377e13dc3231b1c
2018-05-03 10:02:29 -04:00
Matt Riedemann 7c37aba40b Mention that users need noVNC >= 0.6
Apparently versions below 0.6 don't work with
the nova-novncproxy service.

Change-Id: I9f355f2af7b90022b01ad0bfbe7081d73dcc1416
Closes-Bug: #1752896
2018-04-19 18:00:06 -04:00
Matt Riedemann ed7af4c8f4 Update noVNC deployment docs to mention non-US keymap fix in 1.0.0
noVNC 1.0.0 has the fix for non-US key mappings so this adds a simple
note when installing the novnc package that at least 1.0.0 should be
used for non-US key map support.

Change-Id: Ia1a84c986025f8a46c1062440faa0deb1d2d73a5
Related-Bug: #1682020
2018-02-26 05:55:33 -05:00
Daniel Berrange 7c593dc505 doc: Document TLS security setup for noVNC proxy
The nova noVNC proxy server has gained the ability to use the VeNCrypt
authentication scheme to secure network communications with the compute
node VNC servers.  This documents how to configure the QEMU/KVM compute
nodes and the noVNC proxy server nodes.

Change-Id: If3cea87568efff0874cd8851cabc6770812c545b
Blueprint: websocket-proxy-to-host-security
Co-Authored-By: Stephen Finucane <sfinucan@redhat.com>
2018-01-22 14:48:51 +00:00
Markus Zoeller 19f0acd960 docs: Explain the flow of the "serial console" feature
The serial console feature is a little unknown and it's a little
confusing at first. This change adds a doc to explain this better.

Change-Id: Ia5a336694aec95db29545e31b2c6b364dd825a15
2017-10-18 13:39:57 +00:00
Jenkins b73cd8658b Merge "conf: Rename two VNC options" 2017-09-20 14:27:20 +00:00
Takashi NATSUME 2fce8a1396 Fix the ocata config-reference URLs
Replace the ocata config-reference URLs with
URLs in each project repo.

Change-Id: I48d7c77a6e0eaaf0efe66f848f45ae99007577e1
Closes-Bug: #1715545
2017-09-19 06:38:15 +00:00
Stephen Finucane e5a03e3c54 conf: Rename two VNC options
Make the lives of operators easier by using consistent opt naming for
similar features.

Change-Id: Ic05c2c8364e015f6878b0bc25449216624568ad5
2017-09-04 17:22:16 +01:00
chenxing 575b529118 doc: Import administration guide
Import all docs from openstack-manuals.

Part of bp: doc-migration

Change-Id: I28bb8ce1f4a8653f176a554d2e95b4423c437972
Co-Authored-By: Stephen Finucane <sfinucan@redhat.com>
2017-08-04 07:00:45 -04:00