Add Ssh widget

DEVELOPMENT.md

@@ -141,28 +141,57 @@ script will not be able to install conan for you.)
 
 ## Running Orbit
 
-Like mentioned before, the collector currently only works for Linux. So the following
-only applies there:
+Documentation about how to use Orbit's UI to connect to OrbitService can be found
+[here](documentation/DOCUMENTATION.md#connect-orbit).
 
-1. Start Orbit via 
+Alternatively you can use command line flags to automate the connection setup. This
+is explained in the next sections.
+
+> **Note:** As mentioned before, the collector currently only works for Linux. So
+> Local Profiling as described in the next section only works on Linux.
+
+### Local Profiling
+
+1. Start OrbitService 
+```bash
+sudo ./build_default_relwithdebinfo/bin/OrbitService
+```
+2. Start Orbit with the `--process_name` flag
 ```bash
-./build_default_relwithdebinfo/bin/Orbit
+./build_default_relwithdebinfo/bin/Orbit --process_name="<your process>"
 ```
-2. Start OrbitService by clicking the button `Start OrbitService`. To obtain scheduling
-   information, the collector needs to run as root, hence this will prompt you for a
-	 password (via [pkexec](https://linux.die.net/man/1/pkexec)). Alternatively, you can 
-	 start OrbitService yourself:
+3. Click `Start Session` and continue to the **Main Window**
+
+
+
+### Remote Profiling (SSH connection)
+
+To automate remote profiling, start Orbit with the following flags:
 
 ```bash
-sudo ./build_default_relwithdebinfo/bin/OrbitService # Start the collector
+./build_default_relwithdebinfo/bin/Orbit \
+    --ssh_hostname="<ip address>" \
+    --ssh_port=1234 \ # default 22
+    --ssh_user="<username>" \
+    --ssh_key_path="<path to private key file>" \
+    --ssh_known_host_path="<path to known_hosts file>" \
+    --ssh_target_process="<process name>" \
+    --collector_root_password="<sudo password>"
 ```
 
-The frontend currently has no graphical user interface to connect to a generic
-remote instance. Only Stadia is supported as a special case. 
+This does the following:
+1. Start Orbit on the local machine
+2. Start a SSH connection to the remote machine
+3. Upload OrbitService to the remote machine
+4. Start OrbitService with sudo
+5. Select the target process
+6. Open the **Main Window**
+
+> **Note**: If you omit the `--ssh_target_process` flag, Orbit will start with the
+**Connection Window** prefilled with the other flags.
 
-If you needed remote profiling support you could tunnel the mentioned TCP port through
-a SSH connection to an arbitrary Linux server. There are plans on adding generic
-SSH tunneling support but we can't promise any timeframe for that.
+> **Note**: If you omit the `--collector_root_password` flag, Orbit will assume OrbitService is
+already running and skip steps 3 and 4.
 
 ## Consistent code styling
 

documentation/DOCUMENTATION.md

@@ -14,38 +14,17 @@ have feature requests, consider creating an
 > **Note** Orbit is now mainly a **Linux** profiler. Windows support is
 > experimental and not all features are available on Windows.
 
-## Prerequisites
+## Start Orbit and OrbitService
 
-You need to have `Orbit` and `OrbitService`
-[built](../DEVELOPMENT.md#building-orbit) and
-[running](../DEVELOPMENT.md#building-orbit).
+When starting Orbit, the so-called **Connection Window** (screenshot below) is
+shown. From here, you can start a local or remote profiling session. 
 
-> **Note** For reasonable feature support, `OrbitService` needs to run as
-> **root** (or Administrator on Windows).
+![Connection Window][orbit_connection_window]
 
-> **Note** For remote profiling support you can tunnel the TCP port `44765`
-> through an SSH connection to an arbitrary Linux server.
-
-## Profile your application
-
-In this section, we will go through a capture session showing you how to select
-your target process for profiling, dynamically instrument functions, and record
-a capture. Note that captures are saved automatically.
-
-### Connect Orbit
-
-This section shows you how to select your target process for profiling or load a
-saved capture.
-
-> **Note** Your application must already be running on the target instance.
-
-1. Launch `Orbit` and `OrbitService` as described
-   [here](../DEVELOPMENT.md#building-orbit).
-   Orbit will open the so-called **Connection Window** (screenshot below).
-
-   ![Choose Process in Orbit][orbit_processes]
-2. Select **Local profiling**.
+### Local Profiling
 
+1. Select `Local Profiling`, click `Start OrbitService` and enter your root password
+
    Once the connection gets established, the right pane shows the processes
    running on the target machine. Note that Orbit sorts processes by CPU usage
    and automatically selects the first process in the list.
@@ -55,7 +34,9 @@ saved capture.
    > window. For ease of access, Orbit maintains a list of captures that you
    > saved recently.
 
-3. To confirm the selected process and continue to the main window, click
+   ![Choose Process in Orbit][orbit_processes]
+
+2. To confirm the selected process and continue to the main window, click
    **Start Session** or <kbd>Double-Click</kbd> the process. In the
    **Main Window**, you can see the following:
 
@@ -68,12 +49,42 @@ saved capture.
 
    ![Orbit's main window with processes and modules][orbit_main_window_startup]
 
-4. To return to the startup window and select a different process, or connect
-   to a different instance, click **End Session**.
+3. To return to the **Connection Window** and select a different process, or 
+   connect to a different machine, click **End Session**.
 
    > **Note** If you loaded a capture from file, the right side of the menu bar
    displays the filename of the capture instead of connection details.
 
+### Remote Profiling (SSH)
+
+Orbit supports setting up and using a secure communication channel between the
+locally running UI and OrbitService running on a remote machine. To do that, 
+use the **Connection Window** and
+
+1. Select `Remote Profiling (SSH)`
+
+2. Fill all fields on the left side with the values you want to use for the SSH
+   connection. Orbit only supports file based authentication.
+
+3. Choose either `OrbitService started manually` or 
+  `Start OrbitService with sudo`.
+
+   Pick the former if you manually started OrbitService on the remote machine.
+
+   If you want Orbit to upload and start OrbitService, choose the other option
+   and provide a sudo password.
+
+4. Click `Connect` and wait for Orbit to establish the ssh connection.
+
+5. Continue by selecting your target process and starting the session in the 
+   same way as described [above](#local-profiling)
+
+## Profile your application
+
+In this section, we will go through a capture session. This includes recording
+a capture with callstack sampling, dynamically instrumenting functions and 
+more. Note that captures are saved automatically.
+
 ### Record a capture with callstack sampling
 
 This section shows you how to record a basic capture that samples callstacks in
@@ -835,6 +846,7 @@ we highly recommend that you take a look at the references provided above.
 [linux-proc]: https://man7.org/linux/man-pages/man5/proc.5.html
 [linux-vmstat]: https://man7.org/linux/man-pages/man8/vmstat.8.html
 [linux-cgroup]: https://www.kernel.org/doc/Documentation/cgroup-v1/memory.txt
+[orbit_connection_window]: orbit_connection_window.png
 [orbit_processes]: orbit_processes.png
 [orbit_main_window_default_capture]: orbit_main_window_default_capture.png
 [orbit_main_window_capture]: orbit_main_window_capture.png

src/ClientFlags/ClientFlags.cpp

@@ -12,7 +12,9 @@
 
 ABSL_FLAG(bool, devmode, false, "Enable developer mode in the client's UI");
 
-ABSL_FLAG(bool, nodeploy, false, "Disable automatic deployment of OrbitService");
+ABSL_FLAG(bool, signed_debian_package_deployment, false,
+          "Deploy OrbitService via the signed debian package deployment method. (Use this for "
+          "connecting to a Stadia instance).");
 
 ABSL_FLAG(std::string, collector, "", "Full path of collector to be deployed");
 

src/ClientFlags/include/ClientFlags/ClientFlags.h

@@ -13,7 +13,7 @@
 
 ABSL_DECLARE_FLAG(bool, devmode);
 
-ABSL_DECLARE_FLAG(bool, nodeploy);
+ABSL_DECLARE_FLAG(bool, signed_debian_package_deployment);
 
 ABSL_DECLARE_FLAG(std::string, collector);
 

src/SessionSetup/CMakeLists.txt

@@ -11,6 +11,7 @@ target_sources(
   SessionSetup
   PUBLIC  include/SessionSetup/Connections.h
           include/SessionSetup/ConnectToLocalWidget.h
+          include/SessionSetup/ConnectToSshWidget.h
           include/SessionSetup/ConnectToTargetDialog.h
           include/SessionSetup/DeploymentConfigurations.h
           include/SessionSetup/DoubleClickableLabel.h
@@ -34,6 +35,8 @@ target_sources(
   SessionSetup
   PRIVATE ConnectToLocalWidget.cpp
           ConnectToLocalWidget.ui
+          ConnectToSshWidget.cpp
+          ConnectToSshWidget.ui
           ConnectToTargetDialog.cpp
           ConnectToTargetDialog.ui
           DeploymentConfigurations.cpp