Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed remote nomenclature and service name (infra) #804

Merged
merged 2 commits into from
Nov 2, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions docs/tutorial/using-checkbox/remote.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,21 @@ Run the following command:

.. code-block:: none

systemctl status snap.checkbox.service.service
systemctl status snap.checkbox.agent.service

You should see something like this:

.. code-block:: none

● snap.checkbox.service.service - Service for snap application checkbox.service
● snap.checkbox.agent.service - Service for snap application checkbox.service
Loaded: loaded (/etc/systemd/system/snap.checkbox.service.service; enabled; vendor preset: enabled)
Active: active (running) since Fri 2023-07-21 13:38:48 CST; 1h 29min ago
Main PID: 1411 (python3)
Tasks: 1 (limit: 19014)
Memory: 69.7M
CPU: 2.537s
CGroup: /system.slice/snap.checkbox.service.service
└─1411 python3 /snap/checkbox22/current/bin/checkbox-cli service
CGroup: /system.slice/snap.checkbox.agent.service
└─1411 python3 /snap/checkbox22/current/bin/checkbox-cli run-agent

Jul 21 13:38:48 coltrane systemd[1]: Started Service for snap application checkbox.service.
(...)
Expand All @@ -46,14 +46,14 @@ For the sake of this tutorial, let's stop this service for the moment:

.. code-block:: none

sudo systemctl stop snap.checkbox.service.service
sudo systemctl stop snap.checkbox.agent.service

Now, open two terminal windows using ``Ctrl+Alt+T``. In the first one,
start the Checkbox agent:

.. code-block:: none

sudo checkbox.checkbox-cli agent
sudo checkbox.checkbox-cli run-agent

In the second one, run Checkbox as a controller to connect to the agent:

Expand Down Expand Up @@ -107,11 +107,11 @@ restart the Checkbox agent service with:

.. code-block:: none

sudo systemctl start snap.checkbox.service.service
sudo systemctl start snap.checkbox.agent.service

If you have another device running Ubuntu, you can try to install Checkbox on
it, then connect to it using your own computer with the ``checkbox.checkbox-cli
remote x.x.x.x`` command, replacing ``x.x.x.x`` by the IP address of the
control x.x.x.x`` command, replacing ``x.x.x.x`` by the IP address of the
other device.

Launchers in remote mode
Expand All @@ -123,7 +123,7 @@ local mode. If you still have the launcher file you created in the

.. code-block:: none

checkbox.checkbox-cli remote 127.0.0.1 mylauncher
checkbox.checkbox-cli control 127.0.0.1 mylauncher

This will start a remote test session with the configuration defined in
your launcher.
Expand All @@ -136,7 +136,7 @@ of them is the interrupt screen. Run Checkbox remote:

.. code-block:: none

checkbox.checkbox-cli remote 127.0.0.1
checkbox.checkbox-cli control 127.0.0.1

Select the "Checkbox Base Tutorial" test plan, leave all the jobs selected,
and press ``T`` to start the testing session.
Expand Down Expand Up @@ -169,23 +169,23 @@ see the Checkbox agent Systemd service is not running anymore:

.. code-block:: none

systemctl is-active snap.checkbox.service.service
systemctl is-active snap.checkbox.agent.service
inactive

If you try reconnecting to the agent, the controller will wait 5 minutes
for the agent to be reactivated, after what it will time out:

.. code-block:: none

checkbox.checkbox-cli remote 127.0.0.1
checkbox.checkbox-cli control 127.0.0.1
.....
Connection timed out.

Restart the agent by typing:

.. code-block:: none

sudo systemctl start snap.checkbox.service.service
sudo systemctl start snap.checkbox.agent.service

Wrapping up
===========
Expand Down
Loading