diff --git a/doc/source/devref/index.rst b/doc/source/devref/index.rst index 575d4ec4daab..af9d7314028b 100644 --- a/doc/source/devref/index.rst +++ b/doc/source/devref/index.rst @@ -64,6 +64,7 @@ Testing guides :maxdepth: 3 testing/libvirt-numa + testing/serial-console Other Resources --------------- diff --git a/doc/source/devref/testing/serial-console.rst b/doc/source/devref/testing/serial-console.rst new file mode 100644 index 000000000000..d9385966bb82 --- /dev/null +++ b/doc/source/devref/testing/serial-console.rst @@ -0,0 +1,120 @@ + +====================== +Testing Serial Console +====================== + +The main aim of this feature is exposing an interactive web-based +serial consoles through a web-socket proxy. +This page describes how to test it from a devstack environement. + +--------------------------------- +Setting up a devstack environemnt +--------------------------------- + +.. code-block:: bash + + # sudo apt-get install git -y || sudo yum install -y git + # git clone https://git.openstack.org/openstack-dev/devstack + # cd devstack && ./stack.sh + +------------------------------------- +Starting the nova-serialproxy service +------------------------------------- + +. code-block:: bash + + # screen -S stack -X screen -t n-sproxy + # screen -S stack -p n-sproxy -X stuff 'sudo nova-serialproxy\r' + +----------------------------- +Setting up a Nova environemnt +----------------------------- + +The entire configuration is provided in `nova.conf` through the +category `serial_console`. + +.. code-block:: bash + + # cat >> /etc/nova/nova.conf <> client.py < + cirros1 login