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.
  2. Go to the specific workspace and navigate to the Credentials section.
  3. To create a new Credential, click on the CREATE CREDENTIAL button, enter the required information, and then click the Save button.

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 of your SloopEngine account and navigate to the Credentials section.
  3. Select the Credential you want to synchronize, copy the sync command and run it on the server.

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.
  2. Go to the specific workspace and navigate to the Node section.
  3. To create a new Node, click on the CREATE NODE button, enter the required information, and then click the Save button.

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.
  2. Go to the specific workspace and navigate to the Permission section.
  3. To create a new Permission, click on the CREATE PERMISSION button, enter the required information, and then click the Save button.

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.
  2. Go to the specific workspace and navigate to the My Permission section.
  3. In the Action column, click on the SSH icon for the permission you want to use.
  4. Enter valid details and click Launch button.

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.
  2. Go to the specific workspace and navigate to the My Permission section.
  3. Choose the specific permission and navigate to the Live SSH Sessions section.
  4. To view a specific session, click on the Play button in the Action column.
  5. 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.
  2. Go to the specific workspace and navigate to the My Permission section.
  3. Choose the specific permission and navigate to the Recorded SSH Sessions section.
  4. Click on the Play button in the Action column to playback a specific SSH session.

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