# Administration Console

This section of the user guide explains what artifacts must be set up and configured within EaaS before you can start creating and managing your environments. It is intended primarily for EaaS administrators.

WARNING

The administration console is available for users with administrative privileges only. For regular users, the console is hidden from the EaaS user interface.

  • Authentication: explains how to create and manage EaaS users and user groups, and how to configure different authentication settings, like LDAP, OneLogin, etc.
  • GitLab Integration: explains how to integrate GitLab with EaaS for enhanced functionality.
  • Repository: explains how to add and manage different repositories, such as Nexus, JFrog, Docker Registry, Docker Hub, and Helm. Adding and managing repositories is a crucial part of the EaaS system since it allows you to set up and use your environments afterward.
  • Email Provider: explains how to configure an outgoing SMTP server to enable EaaS to send different email notifications to its users upon the occurrence of a specific event.
  • Notifications: explains how to specify the conditions under which the EaaS system must inform certain users that a specific event has occurred in the system.
  • Plugins: explains how to install or update the plugins. A plugin is a core part of the EaaS system that contains the business logic of the commands, designates the configurations to be used in a certain type of environment, and defines the UI for the environment configuration.
  • Elasticsearch: explains how to configure Elasticsearch to be used within EaaS for ingesting and analyzing log data of the containers running in a cluster.
  • Licensing: explains how to view and manage your EaaS application license information.

# Authentication

The Authentication block allows you to:

  • Create and manage EaaS users and user groups.
  • Customize and configure Local, LDAP, OneLogin, and GitLab authentication settings.

# Users

This section describes how to manage users in EaaS.

# Create New User

To create a new user, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.
  2. Expand the Authentication block, and select the Users tab.
  3. In the contents panel, click the New user button.
Create New User Procedure
  1. In the Add user form that appears, fill in the following fields:
Add User Form
  • Profile tab:
    • Username: specify the username a user will use to log into EaaS.
    • Email: enter the user’s email address.
    • Password: specify the password a user will use to log into EaaS.
    • Administrator: select the check box, and grant administrative privileges to the user you create. Such privileges allow a user to make changes to important parts of the EaaS system (e.g., configure environments, setup authentication settings, etc.). It is a good way of keeping the system secure and preventing potentially damaging unauthorized changes.
  • Group tab:
    • Select the check box next to the group to which you want to add the user you create.
  1. Click Save.

A new user has been created.

Now, do not forget to grant corresponding permissions to the created user (such as whether the user is able to deploy environments, or apply different environment configurations). For more information, refer to the Environment Setup and Management > Workspace Settings section.

Alternatively, you can add a user to a specific user group (if this has not been done yet), and all the permissions—granted within that user group—will be applied to the created user automatically.

# Edit User

To edit user details, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.
  2. Expand the Authentication block, and select the Users tab.
  3. In the User management table grid that appears, the list of users is displayed. Double-click the user you want to edit.
  4. In the Edit user form that appears, modify the needed fields, and click Save.

TIP

The fields you see in the Edit user form are identical to those available in the Add user form.

Now, the information on a particular user has been updated.

# Remove User

If you are an administrator (i.e., a user with the admin rights), you can remove users that you no longer want to have access to EaaS.

To remove a user, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.
  2. Expand the Authentication block, and select the Users tab.
  3. In the User management table grid that appears, the list of users is displayed. Click the Remove icon next to the user you want to remove.
Remove User Option
  1. In the confirmation dialog box that appears, click Yes to proceed.

Now, the user has been removed.

# Groups

A group is a collection of EaaS users. You can use groups to specify permissions for a collection of users (instead of specifying them for each individual user one by one), which can make those permissions easier to manage for those users.

For example, you could have a group called Administrators, and give that group the types of permissions that administrators typically need (e.g., configure environments, setup authentication settings, etc.). Any user in that group automatically has the permissions that are assigned to the group. If a new user joins EaaS, and should have administrator privileges, you can assign the appropriate permissions by adding the user to that group.

# Create User Group

To create a new user group, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.
  2. Expand the Authentication block, and select the Groups tab.
  3. In the contents panel, click the New group button.
Create User Group Procedure
  1. In the Add group form that appears, fill in the following fields:

    Add Group Form
    • Name (mandatory): enter a unique name for the group you create.
    • Description: enter a brief description of the group.
  2. Click Save.

The user group is now created. You can see the created user group in the Groups management table grid.

TIP

User groups are displayed in alphabetical order. If a user group contains numbers, numbers come first before the letters.

Now, proceed to adding users to it.

# Edit User Group

To edit a user group, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.
  2. Expand the Authentication block, and select the Groups tab.
  3. In the Groups management table grid that appears, the list of user groups is displayed. Double-click the user group you want to edit.
  4. In the Edit group form that appears, modify the needed fields, and click Save.
Edit Group Form

TIP

The fields you see in the Edit group form are identical to those available in the Add Group form.

Now, the information on a particular user group has been updated.

# Remove User Group

If you are an administrator (i.e., a user with the admin rights), you can remove user groups that you no longer need. To do this, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.
  2. Expand the Authentication block, and select the Groups tab.
  3. In the Groups management table grid that appears, the list of user groups is displayed. Click the Remove icon next to the user group you want to remove.
Remove User Group Option
  1. In the confirmation dialog box that appears, click Yes to proceed.

Now, the user group has been removed.

# Add User to Group

Once the corresponding users and user groups have been created, users can be added to the group(s).

Users can be added to several groups simultaneously.

To add users to the group, follow the steps below:

  1. Open the Add User or Edit User form.
  2. Select the Groups tab.
  3. Select the check boxes next to the groups you want to add your users to.
  4. Click Save.
KENV EaaS

Now, once users are added to the group, do not forget to grant them corresponding permissions. For more information, refer to the Environment Setup and Management > Workspace Settings section.

# Remove User from Group

To remove a user from the group, follow the steps below:

  1. Open the Add User or Edit User form.
  2. Select the Groups tab.
  3. Clear the check boxes next to the groups you want to remove your users from.
  4. Click Save.

# General

Before configuring advanced authentication parameters to log into EaaS (such as LDAP, OneLogin, or GitLab), you must configure general authentication settings. To do so, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.

  2. Expand the Authentication block, and select the General tab.

  3. In the contents panel, proceed to the following:

    General Authentication Settings Window
    • Sync user local profile with external: select the check box to allow EaaS sync (i.e., import) users from external identity providers, such as LDAP, OneLogin, or GitLab, to get user account information and validate passwords. From an authorization point of view, these users are indistinguishable from EaaS users created directly via the EaaS user interface.
    • Force local auth for users: enter the names of users, separated by commas, who must sign in to EaaS locally (i.e., using a username and password) before using any other authentication method (like OneLogin or GitLab).
    • Use my default auth provider: when you log into EaaS, an authorization provider checks your credentials to make sure you are an authorized user. To specify a default authorization provider that will check your user data, select the check box. Then expand the Default auth provider drop-down list box, and select an authentication provider you want to use as a default one.
  4. Click Save.

# Local Auth

If a user is supposed to log into the EaaS system locally (i.e., using a username and password), you can configure the following:

  • If the option (button) to log into the EaaS system locally is available on the login page.
  • The text of the login button to be displayed on the login page.

To configure these parameters, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.

  2. Expand the Authentication block, and select the Local auth tab.

  3. In the contents panel, proceed to the following:

    Local Auth Tab
    • Show on login page: select the check box if a button to log into the EaaS system locally must be displayed on the login page.
    • Login button text: enter the login button text you want to be displayed.
  4. Click Save.

# LDAP Auth

You can use a Lightweight Directory Access Protocol (LDAP) authentication server to authenticate users with EaaS.

To configure the LDAP authentication method, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.

  2. Expand the Authentication block, and select the LDAP auth tab.

  3. In the contents panel, proceed to the following:

    LDAP Settings Window

    • Local authentication settings:
      • Show on login page: select the check box if an option (button) to log into the EaaS system using the LDAP authentication method must be displayed on the login page.
      • Login button text: enter the login button text you want to be displayed.
    • LDAP connection settings:
      • LDAP host: enter ldap://127.0.0.1:389.
      • Admin connection DN: enter the LDAP distinguished name for the event broker to use to authenticate itself to the LDAP server.
      • Password for admin DN: enter the password to use with the admin distinguished name to bind to the LDAP server.
      • Base DN: enter dc=maxcrc,dc=com.
      • LDAP search filter: enter uid=.
  4. Click Save.

# OneLogin Auth

OneLogin ensures secure, multi-factor authentication (also known as MFA, 2FA or two-factor authentication, strong authentication) solution that authenticates EaaS users using a variety of factors depending on the user’s content. For example, when you log into EaaS, along with your username and password, you are asked to enter a one-time code sent to your phone to create a strong barrier against unauthorized access.

In addition, OneLogin tracks your movement across locations and devices to leverage machine learning that detects anomalous login activity, such as logins from a new country, malicious IPs, etc. Furthermore, OneLogin learns to trust your consistently used locations so you do not have to use a second factor every time you sign in.

WARNING

To configure the OneLogin authentication method, you must register EaaS with OneLogin.com first.

To configure the OneLogin authentication method, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.

  2. Expand the Authentication block, and select the OneLogin auth tab.

  3. In the contents panel, proceed to the following:

    OneLogin Authenticaion Settings

    • OneLogin authentication settings:
      • Show on login page: select the check box if an option (button) to log into the EaaS system using the OneLogin authentication method must be displayed on the login page.
      • Login button text: enter the login button text you want to be displayed.
    • OneLogin connection settings:
      • Subdomain: enter the name of the subdomain (for example, “kenv”) that is used by EaaS to connect to OneLogin.
      • Client ID: enter an application ID generated by OneLogin upon registering EaaS.
      • Client Secret: enter a secret key generated by OneLogin upon registering EaaS.
  4. Click Save.

# GitLab Auth

If you want EaaS users to log into the system with their GitLab.com accounts, you must configure the GitLab authentication method. To do so, follow the steps below:

WARNING

To configure the GitLab authentication method, you must register EaaS with GitLab.com first.

  1. On the left pane of the EaaS application, select the Settings option.

  2. Expand the Authentication block, and select the GitLab auth tab.

  3. In the contents panel, proceed to the following:

    GitLab Authentication Settings

    • OneLogin authentication settings:
      • Show on login page: select the check box if an option (button) to log into the EaaS system using the GitLab authentication method must be displayed on the login page.
      • Login button text: enter the login button text you want to be displayed.
    • GitLab connection settings:
  4. Click Save.

Now, on the login page, there should be a GitLab login button following the regular sign-in form. Click the icon to begin the authentication process. GitLab.com asks you to sign in and authorize the GitLab application. If everything goes well, you are automatically signed into EaaS.

# GitLab Integration

GitLab can be integrated with EaaS for enhanced functionality.

To do this, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.
  2. Expand the GitLab Integration block, and select the Access Config tab. Here you define access tokens used by EaaS and GitLab to communicate with each other:
    • GitLab Admin User Access Token (for API access purpose): enter an access token for GitLab authentication (i.e., to access GitLab API).
    • EaaS Access Token: enter an access token which you would like to use to access EaaS API from GitLab CI\CD pipelines.
  3. In the left panel, select the Group Mapping tab. Here you define mappings between GitLab and EaaS groups. With the mappings in place, user accounts created and assigned to specific groups in GitLab are automatically added to the appropriate groups in the EaaS system:
    • Allowed GitLab Group: expand the drop-down list box, and select the GitLab group you want to map with the EaaS one. The options in the list become available only after the GitLab and EaaS access tokens are specified. Otherwise, the list box is empty.
    • Map to EaaS Group: expand the drop-down list box, and select the EaaS group of your choice.
  4. Click Save.

# Repository

The Repository block is designed to add and manage different repositories, such as Nexus, JFrog, Docker Registry, Docker Hub, and Helm.

To understand what a repository is, first, you must understand what a plugin and a package are. From a high level of abstraction, plugins are simple files with code needed to perform a specific task. Packages expand that concept and contain many plugins designed to help resolve a larger problem. Repositories, in their turn, store many packages. To sum up, plugins can be treated as a single page of information, packages as folders containing many pages, and, finally, repositories as a filing cabinet.

Adding and managing repositories is a crucial part of the EaaS system since it allows you to set up and use your environments afterward.

# Add Repository

The add a repository, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.

  2. Expand the Repository block and select the repository of your choice (i.e., Nexus, JFrog, Docker Registry, or Docker Hub).

  3. In the contents panel, click the Add repository button.

  4. In the Add repository dialog box that appears, fill in the fields allowing the repository to be defined and queried:

    Add Repository Dialog Box

    • Alias: specify the alias for the repository.
    • URL: specify the URL address to access the repository.
    • Use token auth (available for Docker Registry repositories only): specify the access token for Docker Registry authentication.
    • Username: enter the username to authenticate to the repository.
    • Password: enter the username to authenticate to the repository.
    • Use as source for plugins (available for Docker Registry and Docker Hub repositories only): select the check box in case a repository you add must be used as a source for plugins to be installed in your environments.

WARNING

In case the check box is cleared, you will not be able to install new modules in EaaS.

  1. Click Save.

The added repository appears in the repositories table grid. You can start using it in your environments for a variety of use cases (for example, to install the needed applications from the added repositories in your environments).

# Edit Repository

To update/change the parameters of the previously added repository, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.
  2. Expand the Repository block, and select the repository of your choice (i.e., Nexus, JFrog, Docker Registry, or Docker Hub).
  3. In the contents panel, double-click the repository you want to edit.
  4. In the Edit repository dialog box that appears, modify the needed fields, and click Save. The fields you see in the Edit repository form are identical to those available in the Add repository form.
Edit Repository Form

Now, the repository has been updated.

# Delete Repository

To delete the repository that is no longer needed, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.
  2. Expand the Repository block, and select the repository of your choice (i.e., Nexus, JFrog, Docker Registry, or Docker Hub).
  3. In the contents panel, click the Remove icon Remove Repository Icon next to the repository you want to remove. In the confirmation dialog box that appears, click Yes to proceed.

The repository has been deleted.

# Email Provider

The Email Provider option is designed to configure an outgoing SMTP server to enable EaaS to send different email notifications to its users upon the occurrence of a specific event (for example, when an environment state changes to FAILED, or when the deployment ends, etc.).

SMTP Server Configuration Window

To configure an SMTP server, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.
  2. Expand the Email Provider block, and select the SMTP Server Configuration tab.
  3. In the contents panel, fill in the following fields:
    • SMTP Server Configuration block:
      • Use secure connection: select the check box to use a secure connection protocol and encrypt your email notifications (encrypted emails are not exposed to view).
      • Host: enter a valid hostname or IP address of the outgoing SMTP server to be used for sending email notifications. Typically, this is email-smtp.eu-central-1.amazonaws.com.
      • Port: enter the port number for outgoing mail transport. Enter 25, 465, 587, or leave it empty.
      • Auth Method: expand the drop-down list box, and select the method of your choice to authenticate with the outgoing SMTP server:
        • Basic: select it to authenticate via a basic XOAUTH/XOAUTH2 mechanism.
        • NTLM: select it to authenticate via an NTLM challenge-response mechanism.
      • Username: if your SMTP host requires authentication, specify the username of these authentication credentials here.
      • Password: specify the password associated with the username you have specified above.
      • Default FROM: enter a valid email address from which email notifications are to be sent, such as eaas-noreply@kenv.io.
      • Default ReplyTo: enter a valid email address that your recipients will use to reply to email notifications received. Typically, this is eaas-noreply@kenv.io as well.
    • Configuration test block: in the text field, enter a valid e-mail address, and click Send Email to verify the setup is working correctly. In other words, verify that EaaS can communicate with the SMTP server you have just configured to send e-mail notifications.
  4. Click Save.

The SMTP server has been configured. Now, proceed to the Notifications tab, and specify when the e-mail notifications are to be sent and who must receive them.

# Notifications

The Notifications option is designed to specify the conditions under which the EaaS system must inform certain users that a specific event has occurred in the system (for example, when an environment state changes to FAILED, or when the deployment ends, etc.). To do that, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.

  2. Expand the Notifications block, and select the Email tab.

  3. In the contents panel, configure the following:

    Notifications Dialog Box

    • Enable email notifications: select the check box to send email notifications to certain users—defined in the Recipient List below—in case a specific event occurs.
    • Notify when workspace phase status is changed:
      • Notify when state is NONE: select the check box to send email notifications when a workspace phase status is changed to None.
      • Notify when state is DONE: select the check box to send email notifications when a workspace phase status is changed to Done.
      • Notify when state is PENDING: select the check box to send email notifications when a workspace phase status is changed to Pending.
      • Notify when state is FAILED: select the check box to send email notifications when a workspace phase status is changed to Failed.
      • Notify when state is *RUNNING: select the check box to send email notifications a the workspace phase status is changed to Running.
    • Notify when work on phase is completed: select the check box to send email notifications when a workspace phase is completed.
    • Send connection details when deploy is finished: select the check box to send connection details when the deployment is completed.
    • Recipient List: place a cursor in the List of emails text field, and enter the email addresses of users that are expected to receive email notifications.
  4. Click Save.

# Plugins

The Plugins option is designed to install and manage EaaS plugins that help you extend the functionality of EaaS.

A plugin is an important and integral part of the EaaS system that assists users to define what DevOps tasks can be completed later on. Each plugin contains the business logic of the commands, designates the configurations to be used in a certain type of environment, and defines the UI for the environment configuration.

When a certain plugin is installed, users can use it when creating a new environment. In other words, based on that plugin, users are able to create new environments of a certain type that is defined by the plugin itself.

In addition, by implementing your custom plugin, you are also able to enhance the basic functionality of EaaS. This way, EaaS becomes a very powerful DevOps framework that is able to solve any tasks you need.

In this section you will learn how to:

  • Create a plugin: explains how to create a new custom plugin from scratch based on the Terraform file (this functionality is currently under development. The content will be updated soon).
  • Install a plugin: explains how to install the created plugin.
  • Export a plugin: explains how to retrieve a plugin from the plugin repository and download it in EaaS (this functionality is currently under development. The content will be updated soon).
  • Import a plugin: explains how to import the already existing plugins stored locally and use them in your environments (this functionality is currently under development. The content will be updated soon).
  • Edit a plugin: explains how to update the configuration settings of the existing plugin.

# Install Plugin

By default, the EaaS application is equipped with four plugins allowing you to create AWS EKS clusters, deployment modules, self-service environments, and Terraform deployments. In case the available plugins are not enough for your business purposes, you can install a new plugin of your choice.

Take into account that the plugins to be installed in EaaS are initially stored in the Nexus, JFrog, Docker Registry, Docker Hub, or Helm repositories. This means that before you install the needed plugin, make sure the necessary repository—where the needed plugin is stored—has already been added to EaaS. Otherwise, the plugin cannot be installed.

TIP

In future versions of EaaS, you will also be able to install your custom plugins created and configured directly in EaaS.

To install a plugin, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.

  2. Expand the Plugins block, and select the Plugins Management tab.

    Plugins Management Page

  3. In the contents panel, click the Install icon.

  4. In the Install module form that appears, do the following:

    • Expand the Module drop-down list box, and select the plugin you want to install. It may take a few minutes before the data is loaded from the repository and before the plugins become available for selection.
    • Expand the Version of drop-down list box, and select the version of the plugin you want to install.
  5. Click Install.

TIP

You also have an option to install a plugin manually, i.e., without extracting it from the repository. To do this, in the Docker Image Name field, enter a uniform resource identifier (URI) of the docker image containing the plugin you want to install, for example, eaas-docker.automat-it.io/eaas_module_k8s_countryinfo:v2.o1.

A new plugin has been installed. Now, it is ready to be used in different environments.

# Edit Plugin

EaaS enables you to change plugin parameters if necessary. For example, you can update the default configurations of your plugin, or you can change those parameters that have been initially configured incorrectly.

To edit a plugin, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.
  2. Expand the Plugins block, and select the Plugins Management tab.
  3. In the contents panel, click the wrench icon Edit Plugin Icon next to the plugin you want to edit.
  4. In the Configure Plugin dialog box that appears, make your changes under the Default Configuration, and/or Permissions tabs, and click Save.

# Default Configuration

The Default Configuration tab is designed to set or update the default configuration values of your plugin. Every new environment created on the basis of this plugin will inherit the default settings provided here.

To set or update the default configurations of your plugin, in the left pane, select a group of settings to set/update. Once all parameters are entered, do not forget to click Save to save the changes made.

Configure Plugin Dialog Box

Please note that the fields and options displayed under the Default Configuration tab may vary depending on the plugin you are editing.

TIP

To reset your custom settings and reset the default ones, click the Restore plugin defaults option (the option is unavailable in case no modifications have been applied to your plugin yet).

Now, every new environment, created on the basis of the plugin you have edited, inherits the default settings provided here.

# Permissions

The Permissions tab enables you to:

Plugin Permissions
  • Environments Default Permissions: set default user permissions for newly created environments.
  • Plugin Permissions: enable/disable the plugin. Enabled plugins can be used to create new environments, while disabled plugins cannot be used to create new environments, respectively.
# Environments Default Permissions

By default, when you create a new environment based on a certain plugin, it is given particular default permissions for its users. These permissions include whether users are allowed to deploy environments, whether they are allowed to stop environments, and so on. Via the Environments Default Permissions option, you have the ability to set the default level of access that a user has to a newly created environment:

  1. In the Configure Plugin dialog box, select the Permissions tab. Then click the Environments Default Permissions button.
  2. In the Permissions Editor dialog box that appears, expand the Add drop-down list box, and select one of the following options:
    • User: to define default environment permissions for individual users.
    • Group: to define default environment permissions for several users in a group.
    • System: to define default environment permissions for all EaaS users at once.
    • Owner: to define default permissions for users who have created the environment (i.e., environment owners).
  3. Depending on the option selected at a previous step, do one of the following:
    • If the User option has been selected: in the Add User dialog box that appears, select the user(s) you want to grant the default permissions to, and click Add.
    • If the Group option has been selected: in the Add Groups dialog box that appears, select the group(s) of users you want to grant the default permissions to, and click Add.
    • If the System or Owner option has been selected, skip this step.

TIP

 There are three levels of priorities in EaaS permissions (listed in order of increasing importance), System, User group, and User/Owner. It means that user group settings always override the settings defined for the whole system. Individual user settings/owner settings always override the settings defined for the user group a certain user/owner belongs to.   
  1. The newly added user, group of users, system, or owner appears in the grid.
    Permissions_Editor
  2. Now, double-click the cell next to the action you want to grant access to, and select one of the following options:
    • Allow: the action is allowed.
    • Deny: the action is forbidden.
    • Unset: if the action is not specified (i.e., the Unset option is selected), the system automatically applies the Deny action. However, there are exceptions to this rule: imagine we have a user group that has the Allow action specified, and we have an individual user assigned to this group who has the Unset action specified. In this case, a rule specified for the whole group prevails. In other words, if the permissions are not defined, the permissions of a higher hierarchy level are applied.
  3. Click Apply.

Now, every new environment, created on the basis of the plugin you are editing, inherits user permissions defined here.

The permissions can be changed (customized) later on in a particular environment if needed. For more information, refer to the Environment Setup and Management > Workspace Settings section.

# Plugin Permissions

To create a new environment based on a certain plugin, make sure the plugin is enabled. Otherwise, it cannot be used and selected when a new environment is being created.

To define plugin permissions, i.e., to enable a plugin, follow the steps below:

  1. In the Configure Plugin dialog box, select the Permissions tab. Then click the Plugin Permissions button.
  2. In the Permissions Editor dialog box that appears, expand the Add drop-down list box, and select one of the following options:
    • User: to enable the plugin for individual users.
    • Group: to enable the plugin for several users in a group at once.
    • System: to enable the plugin for all EaaS users.
  3. A certain user, group, or system is added to the table grid. In the Create Environment column, make sure that the check box is selected. Otherwise, the plugin remains disabled.
  4. Click Apply.

Now, if enabled, the plugin can be used as a basis for the creation of new environments.

# Copy Plugin Permissions

The Copy option allows you to copy the already defined permissions from one plugin into another one. This is very helpful as you do not have to define particular permissions from scratch. You simply copy them, make some minor changes if needed, and start using them in the other plugin.

To copy permissions, follow the steps below:

  1. In the Configure Plugin dialog box, select the Permissions tab.
  2. Depending on the permissions you want to copy, click either Environments Default Permissions or Plugin Permissions.
  3. In the Permissions Editor dialog box that appears, select the permissions you want to copy by clicking on them. Then, in the toolbar, click the Copy icon Copy Icon. Alternatively, click the Copy All icon to copy all the permissions available in the grid at once.
    Copy Permissions Dialog Box
  4. Close the Permissions Editor, and go back to the Plugins Management tab. There, in the table grid, double-click the plugin that must have the copied permissions inherited.
  5. In the Configure Plugin dialog box that appears, select the Permissions tab.
  6. Then click either:
    • Environments Default Permissions: in case you are copying the environment defaults.
    • Plugin Permissions: in case you are copying the plugin permissions themselves.
  7. In the Permissions Editor dialog box that appears, place a cursor anywhere in the dialog box and, in the toolbar, click Paste. If the Copy All option has been previously applied, click Replace All instead.
  8. In the Configure Plugin dialog box, click Save.

Now, the permissions have been copied.

# Remove Plugin Permissions

The Remove option allows you to remove the environment defaults defined previously.

To remove the environment default permissions, follow the steps below:

  1. In the Configure Plugin dialog box, select the Permissions tab. Then click the Environments Default Permissions button.
  2. In the Permissions Editor dialog box that appears, click the name of the user, user group, or system which permissions you want to remove.
  3. In the toolbar, click Remove.
  4. The permissions are removed from the table grid. Now, click Apply.
  5. Then in the Configure Plugin dialog box, click Save to save the changes made.

The permissions have been removed.

# Elasticsearch

Elasticsearch is an open-source, distributed RESTful search and analytics engine that can be used within EaaS for ingesting and analyzing log data of the containers running in a cluster. To do this, you must connect to Elasticsearch and specify the connection parameters as described in the Configuration section below.

# Configuration

To configure Elasticsearch, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.
  2. Expand the Elasticsearch block, and select the Configuration tab.
  3. In the contents panel, provide the following parameters to let EaaS connect to Elasticsearch:
    • Use SSL connection: select the check box to encrypt network traffic using SSL.
    • Host: enter an IP address, hostname, special value, or an array of any combination of these to connect to an existing Elasticsearch server.
    • Port: enter a port number to let Elasticsearch listen to external TCP traffic (such as 9200 or 9300).
    • Context: specify the Elasticsearch context path to facilitate running behind a reverse proxy.
    • Username: enter a username to authenticate EaaS to the Elasticsearch server.
    • Password: enter a password to authenticate EaaS to the Elasticsearch server.
  4. Click Save.

Now, once the connection is established, you can proceed to viewing the log data.

# Logs

Logs can help you understand what is happening with your container running in a cluster. They are particularly useful for debugging problems and monitoring cluster activity.

To view the logs, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.
  2. Expand the Elasticsearch block, and select the Logs tab.
  3. In the contents panel, expand the Namespace drop-down list box and select the name of the group storing the container which logs you want to view.
  4. Then expand the Container drop-down list box, and select the name of the needed container.
  5. In the Records count field, specify the number of records you want to have displayed in a table grid at a time. By default, the number is 100.
  6. If needed, click the Refresh button to refresh the table and view the most recent data. To refresh the table grid automatically, turn the Auto Refresh toggle on. By default, the toggle is turned off.
Log Data Displayed

# Licensing

The Licensing block will help you view and manage your EaaS application license information.

# View License Information

To view license details for your EaaS application, follow the steps below:

  1. On the left pane of the EaaS application, select the Settings option.

  2. Select the Licensing tab.

  3. Under the Current license information block you can view your license details:

    Current License Information

    • License Status: this represents the status of your license. The possible options are:
    • Expiration Date: represents the date when your license expires. In case you have a lifetime license, the corresponding label is displayed, LIFETIME LICENSE.
    • Environments Limit: represent the number of environments you can create in EaaS with the current license.

# Add/Update License

You may need to add or update your license if you:

  • Add a new license for a newly installed EaaS application
  • Add a new license when an old license has expired

To add or update a license, follow the steps below:

  1. Log into EaaS under the administrator account.
  2. On the left pane of the EaaS application, select the Settings option.
  3. Select the Licensing tab.
  4. Under the License Upgrade block, click the Upgrade License button.
    License Upgrade Dialog Box
  5. In the License Upgrade dialog box that appears, in the Enter EaaS License Key field, enter the license provided by KENV, and click Apply License Key.

Your license has been added/updated.

TIP

How to get a license key?

EaaS licenses are generated manually by KENV staff based on the installation number that is displayed in the Your Installation Number Is field of the License Upgrade dialog box. Simply copy that number and send it to KENV either via email, or any other method of your choice. Once done, your license key is sent to you by email. Use it to add or update your license.

License Email