Create SloopEngine Credential

SloopEngine Credential is a sensitive data used to authenticate SSH connections to your nodes (servers/containers). By default, SloopEngine encrypts and stores your credentials. You can either add an existing SSH key pair or auto-generate new SSH key pair while creating SloopEngine Credential. Please read the SloopEngine Credential documentation to know more.

  1. Access your SloopEngine account dashboard and navigate to the Workspaces section.

    Screenshot of workspaces menu option highlighted in the account menu.

  2. Go to the specific workspace.

    Highlighted specific workspace view option in the workspaces.

  3. Navigate to the Credentials section.

    Screenshot of credentials menu option highlighted in the workspace menu.

  4. Click on the CREATE CREDENTIAL button.

    Highlighted create credential button on the credentials page.

  5. Enter the required information, and then click the Save button.

    Screenshot of credential creation form with valid information.

We recommand allowing SloopEngine to automatically generate an SSH key pair when adding a new Credential.

Sync Credentials using SloopEngine CLI

The SloopEngine CLI synchronizes Credentials from your SloopEngine account to your servers. To complete this process, please follow the instructions provided.

  1. Connect to your server via SSH (using the host terminal) and install the SloopEngine CLI on it.
  2. Go to the specific workspace.

    Highlighted specific workspace view option in the workspaces.

  3. Navigate to the Credentials section.

    Screenshot of credentials menu option highlighted in the workspace menu.

  4. Select the Credential you want to synchronize, copy the sync command and run it on the server.

    Screenshot of copying SloopEngine CLI sync command.

The sync command has a similar structure to the one shown below:


              $ sudo sloopengine credential sync --workspace-id 23 --id 54
              

Create SloopEngine Node

A SloopEngine Node can be a physical host, virtual machine, or container that can be accessed via an FQDN-based hostname or IP address. It can be referenced while creating a permission.

  1. Access your SloopEngine account dashboard and navigate to the Workspaces section.

    Screenshot of workspaces menu option highlighted in the account menu.

  2. Go to the specific workspace.

    Highlighted specific workspace view option in the workspaces.

  3. Navigate to the Node section.

    Screenshot of nodes menu option highlighted in the workspace menu.

  4. To create a new Node, click on the CREATE NODE button.

    Highlighted create node button on the nodes page.

  5. Enter the required information, and then click the Save button.

    Screenshot of node creation form with valid information.

Create SloopEngine Permission

A SloopEngine Permission is an authorization granted to a user that allows the user to access specific credentials, nodes, and repositories. This permission can be used to launch both an SSH session and an IDE session.

  1. Access your SloopEngine account dashboard and navigate to the Workspaces section.

    Screenshot of workspaces menu option highlighted in the account menu.

  2. Go to the specific workspace.

    Highlighted specific workspace view option in the workspaces.

  3. Navigate to the Permission section.

    Screenshot of permissions menu option highlighted in the workspace menu.

  4. Click on the CREATE PERMISSION button.

    Screenshot of create permission button highlighted in the permissions page.

  5. Enter the required information, and then click the Save button.

    Screenshot of the permission creation form with valid information.

Launch SloopEngine SSH Session

To launch an SSH session on the SloopEngine platform, you must first have a permission that has been created for you by a manager. This permission will grant you access to the necessary credential and node for your work, and will allow you to connect to the server via SSH and begin your tasks.

To launch an SSH Session:

  1. Access your SloopEngine account dashboard and navigate to the Workspaces section.

    Screenshot of workspaces menu option highlighted in the account menu.

  2. Go to the specific workspace.

    Highlighted specific workspace view option in the workspaces.

  3. Navigate to the My Permission section.

    Screenshot of mypermissions menu option highlighted in the workspace menu.

  4. In the Action column, click on the SSH icon for the permission you want to use.

    Screenshot of create SSH session button highlighted in the mypermissions page.

  5. Enter valid details and click Launch button.

    Screenshot of the SSH session creation form with valid information.

Log & Audit SloopEngine SSH Session

SloopEngine Log & Audit feature makes it easy to log and audit SSH connections to your servers. By enabling the SSH logging and auditing feature, you can keep track of all the connections established by your team members

Monitor SloopEngine Live SSH Session

SloopEngine's Log & Audit feature allows managers and leads to keep track and examine the activity of an ongoing SSH session. This feature is useful for ensuring compliance with company policies and standards, as well as for monitoring the usage of the platform.

To monitor the Live SSH session on the SloopEngine platform:

  1. Access your SloopEngine account dashboard and navigate to the Workspaces section.

    Screenshot of workspaces menu option highlighted in the account menu.

  2. Go to the specific workspace.

    Highlighted specific workspace view option in the workspaces.

  3. Navigate to the Permission section.

    Screenshot of permissions menu option highlighted in the workspace menu.

  4. Click on the desired permission ID.

    Screenshot of view permission highlighted in the permissions page.

  5. Navigate to the Live SSH Session section.

    Screenshot of live SSH sessions menu option highlighted in the permissions menu.

  6. To view a specific session, click on the Play button in the Action column.

  7. Click on the Play button in the Action column to audit a specific live SSH session.

Playback SloopEngine SSH Session Recording

Managers and Leads have the capability to play back the SSH sessions launched by users. This feature enables them to monitor the activity of the user's SSH session, collect metrics such as launch time, duration, etc., and ensure that the work being performed is in compliance with company policies and standards.

To log and audit an SSH session on the SloopEngine platform:

  1. Access your SloopEngine account dashboard and navigate to the Workspaces section.

    Screenshot of workspaces menu option highlighted in the account menu.

  2. Go to the specific workspace.

    Highlighted specific workspace view option in the workspaces.

  3. Navigate to the Permission section.

    Screenshot of permissions menu option highlighted in the workspace menu.

  4. Click on the desired permission ID.

    Screenshot of view permission highlighted in the permissions page.

  5. Navigate to the Recorded SSH Session section.

    Screenshot of recorded SSH sessions menu option highlighted in the permissions menu.

  6. Click on the Play button in the Action column to playback a specific SSH session.

    Screenshot of the list of recorded SSH sessions, with the play button highlighted for one of the sessions.

By adhering to these steps, you can easily monitor and review SSH sessions for a specific permission on SloopEngine.