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.

   

3. Navigate to the Credentials section.

   

4. Click on the CREATE CREDENTIAL button.

   

5. 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.

   

3. Navigate to the Node section.

   

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

   

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

   

Create SloopEngine Repository

Generally, a SloopEngine Repository refers to a Git Repository which contains the software source code you want to develop. As of now, SloopEngine only supports Git Repositories.

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

   

2. Go to the specific workspace.

   

3. Navigate to the Repository section.

   

4. Click on the CREATE REPOSITORY button.

   

5. 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.

   

3. Navigate to the Permission section.

   

4. Click on the CREATE PERMISSION button.

   

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

   

After creating a user's permission, it will be visible under the My Permission section of the corresponding user's Workspace. In order to use the SloopEngine IDE, you will need to add your public SSH key to your Git service provider repository.

Here's an overview of the process to add your public key to a Git repository:

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

   

2. Go to the specific workspace.

   

3. Navigate to the My Permission section.

   

4. Copy the public key from the specific permission.

   

5. To add the public key to your account on the Git hosting service, such as GitHub, GitLab or Bitbucket, navigate to your account settings and add the key in a section labeled SSH keys or Deploy keys. The exact steps may vary depending on the hosting service you are using.

Launch SloopEngine IDE

To launch an IDE 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, node, and repository for your work, and will allow you to connect to the IDE and begin software development.

To launch an IDE session:

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

   

2. Go to the specific workspace.

   

3. Navigate to the My Permission section.

   

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

   

5. Enter valid details and click Launch button.

   

This will launch the SloopEngine IDE, which you can then use.