Skip to main content

Introduction

This procedure explains how to configure and use Edge View in the Edge Infrastructure Services console. You will enable an Edge View policy on a project, assign that project to your target node, and then launch remote sessions directly from the node and application instance detail pages. Edge View lets you open an SSH terminal to EVE-OS (Edge Virtualization Engine) on a node, or connect to a running application instance via VNC or SSH, all through an encrypted tunnel routed via the Edge Infrastructure Services dispatcher.

Prerequisites

  • You have the SysManager or SysAdmin role in your enterprise. See Manage Roles.
  • At least one node onboarded to Edge Infrastructure Services and in Online run state.
  • A project assigned to the target node.

Enable the Edge View Policy on a Project

The Edge View policy must be enabled on the project assigned to your target node before remote sessions are available. If the policy is already active, skip to Connect to a Node via Remote Console. For step-by-step instructions and a full field reference, see Configure Project Policies — Edge View Policy. At minimum, enable the Edge View Enabled toggle and turn on Access EVE-OS (for node SSH) or Access Edge Applications (for app VNC and SSH).

Connect to a Node via Remote Console

Remote Console opens an SSH terminal to the EVE-OS shell of the node through an Edge View tunnel. Use it for node-level diagnostics, configuration, and troubleshooting.
  1. In the sidebar, click Infrastructure > Fleet > Nodes.
  2. Click the name of the node you want to access.
  3. On the node details page, click the Remote Console button (terminal icon) in the hero bar.
  4. The Remote Access notice dialog appears. Review the warning that actions taken in this session can affect running workloads, data, network state, and device configuration.
  5. Click Continue. Edge Infrastructure Services activates the Edge View session and opens an SSH terminal in a new browser window. If the window does not appear, check that your browser allows popups for this site.
The Remote Console button appears when you have read access to the node and the Edge View policy for the node’s project allows device access. If the button doesn’t appear, the project assigned to this node does not have the Edge View policy enabled, or the Access EVE-OS permission is turned off. Enable the policy in the project settings. Configuration lock and node connectivity don’t hide or disable the button. If the node is offline or configuration locking is enabled, the error appears when you request the session. Note: The session uses a JWT token that expires based on the Maximum Session Duration setting in the Edge View policy. When the token expires, the session ends. Re-click Remote Console to start a new session.

Connect to an Application Instance via Remote Console or SSH Terminal

You can access a running application instance through VNC (graphical console) or SSH (command-line terminal).
  1. In the sidebar, click Infrastructure > Workloads > Applications.
  2. Click the name of the application instance you want to access.
  3. On the application instance details page, use one of the following buttons in the hero bar.

Remote Console (VNC)

The Remote Console button opens a VNC viewer for the application’s graphical console.
  1. Click Remote Console (monitor icon).
  2. Review the Remote Access notice and click Continue. The graphical console opens in a separate browser window, and an in-app session panel appears. If the window does not appear, check that your browser allows popups for this site.
The session panel remains available while the console is open. Minimize it to keep the session running in the background, and restore it later from the background tasks tray. The panel provides the following controls.
  • Open Viewer Again: Reopen the viewer window if you closed it while the session is still active.
  • End Session: Close the viewer and end the remote console session.
Closing the viewer window also ends the session.

SSH Terminal

The SSH Terminal button opens an SSH connection to the application instance.
  1. Click SSH Terminal (terminal icon).
  2. In the SSH Terminal dialog, fill in the following fields.
  3. Select Open Terminal. An SSH terminal session opens in a new browser window. If the window does not appear, check that your browser allows popups for this site.
If the buttons are disabled, check that the project’s Edge View policy has the Access Edge Applications permission enabled.

Open Remote Console (VNC) From a Node

You can start an application’s Remote Console (VNC) session from the node that hosts it, without opening the application instance page first. The action is available both on the node details page and directly from the Nodes list.
  1. In the sidebar, click Infrastructure > Fleet > Nodes.
  2. Open the More actions (...) menu for the node that hosts the application instance. On the Nodes list, use the action menu on the node’s table row or grid card. To start from the node details page instead, click the name of the node first.
  3. Choose Remote Console (VNC).
  4. In the application picker, select the application instance you want to access, then click Continue.
  5. Review the Remote Access notice and click Continue. The session opens the same way as an application instance Remote Console (VNC) session, including the in-app session panel described in the preceding section.
If the node has no application instances, the picker shows a message to that effect instead of a list. This menu item requires the Access Edge Applications permission in the project Edge View policy. That is a different permission from Access EVE-OS, which governs node Remote Console, Troubleshoot, and Collect Logs. Note: The two surfaces hide the menu item differently. The node details page has already loaded the node’s application instances, so it hides Remote Console (VNC) when the node has none. The Nodes list checks only the Edge View policy, so the item can still appear for a node that has no application instances. In that case the picker opens and reports that the node has no application instances.

Use the Troubleshoot CLI

The Troubleshoot CLI opens an interactive Edge View command console in a drawer at the bottom of the browser. Use it to run Edge View diagnostic commands directly on the node, including ping, ls, dmesg, ps, and pub, without leaving the console. Commands run on the node via Edge View and can affect device state, so this access method requires the same Edge View policy prerequisites as Remote Console.
The Troubleshoot CLI is not currently available. The Troubleshoot item is hidden in the console for all users in this release. This section documents the intended behavior and will be updated when the action is restored.
When the action is available, the Troubleshoot item is also hidden if the project assigned to the node does not have Edge View enabled. If you do not see it, verify that the Edge View policy is configured as described in Enable the Edge View Policy on a Project.
  1. On the node detail page, select the More actions (...) menu in the header.
  2. Select Troubleshoot.
  3. Review the notice dialog. It confirms the node name and warns that commands run here can affect running workloads, data, network state, and device configuration.
  4. Select Continue. A CLI drawer opens at the bottom of the page. The drawer header shows Troubleshoot followed by the node name.
  5. Type Edge View commands in the input field and press Enter to run them. For a full list of available commands, see the LF Edge wiki: Edge View Commands.
  6. To copy the session transcript to the clipboard, select the Copy icon in the drawer header.
  7. To save the transcript as a .txt file, select the Export (download) icon in the drawer header.
  8. To close the session, select × in the drawer header. The EdgeView session is cleaned up when the drawer closes.
The drawer can be resized by dragging the handle at the top edge. Every command issued in a Troubleshoot session is logged. A corresponding event appears in the Events log for the node.

Verify the Configuration

After launching a session, verify that it is active:
  1. On the node details page or application instance details page, the Remote Console / SSH Terminal button changes appearance when a session is active.
  2. To end the session, close the terminal or viewer window. For a Remote Console (VNC) session, you can also select End Session in the session panel. The Edge View tunnel is cleaned up when the console session ends.
  3. To confirm the session was logged, go to the node details page and select the View Events button in the page header. An event entry appears for the Edge View session, including the command history.

Next Steps

Edge View and Remote Access Overview

Background on the Edge View security model and policy settings.

Configure Edge View with the CLI

Enable Edge View for projects and nodes using ZCLI commands.

Configure Edge View (Advanced Method)

Use the Docker-based Edge View client script for full diagnostic access, including network monitoring and file inspection commands.