# Environment Setup and Management

This section of the user guide explains how to set up, manage, and work with environments:

  • Create Environment: explains how to create an environment or a collection of environments.
  • Edit Environment: explains how to make updates and edits to your environments.
  • Remove Environment: explains how to remove environments that are no longer needed.
  • Environment Setup: explains how to set up an environment.
  • Environment Commands: explains what commands are available within a certain environment and how to apply them.
  • Environment Details: explains how to view environment details, including the environment history, environment status, etc.
  • Scheduler: explains how to trigger the running of different commands in a certain environment at a specific time.
  • Workspace Settings: explains how to define user permissions within a certain environment and how to define the commands that require approval in that environment.

# Create Environment

To create a new environment, follow the steps below:

Option 1

  1. In the welcome wizard, under the Create New block, define the type of the environment you create by clicking either:
    • Create AWS EKS to create a new AWS EKS cluster.
    • Deployment Module to create a new deployment module.
    • Self Service to create a new self-service environment.
    • Terraform deployment to create a new Terraform deployment.
      Welcome Screen
  2. In the dialog box that appears, enter the name of the environment, and then click the Create button.
Create New Dialog Box

Option 2

  1. On the left pane, click the plus sign button Create Tab.
  2. Define the type of the environment you create by selecting either Create AWS EKS, Deployment Module, Self Service, or Terraform deployment.
  3. In the Environment Name field (mandatory), enter the name of the environment you create.
  4. Click Create.
Create New Environment Procedure

# Add environment into existing collection

To add a new environment into the existing collection, follow the steps below:

πŸ’‘ TIP

A collection is a set of several environments that share the same configuration parameters, namely, the same versions of the application modules and the same business logic level parameters.

  1. Log into the EaaS application.
  2. Locate a previously created collection of environments and select it.
  3. In the contents panel, select the Environments tab.
  4. Click the Add button and specify how many environments you want to add.
  5. Click Add.

The new environment(s) appears at the bottom of the grid.

# Edit Environment

At any time, you can make updates and edits to your environments. For example, an environment configuration must be updated, a certain environment in a collection must be removed, an environment name must be changed, a specific task must be scheduled (e.g., deploy an environment at a specific date and time), etc.

To edit an environment, follow the steps below:

  1. Locate an environment you need to edit.
  2. In the contents panel, make your updates by doing one of the following:
    • To update the configuration settings of the environment:
      • Select the Configuration tab, and make your changes (for more information, refer to the Environment Setup section).
        Configuration Settings
    • To trigger automatic running of different commands at a specific time:
      • Select the Scheduler tab, and schedule a specific command as described in the Scheduler section.
        Scheduler Tab
    • To change the environment name:
      • Hover over the environment name, and click the Edit name icon.
        Edit Name Option
      • In the text box that appears, enter a new name for your environment, and click the Tick icon. Or, click the Cancel icon to cancel a name change.
    • To change the environment description:
      • Hover over the environment name, and click the Add comment icon.
        Add Comment Option
      • In the text box that appears, enter a short description for your environment (i.e., add a comment).
      • Click the Tick icon to save the changes made, or click the Cancel icon to cancel your comment.

# Remove Environment

The Remove environment option allows you to delete any existing environments or collections of environments.

# Remove Single Environment/Collection of Environments

To remove one specific environment or a collection of environments, follow the steps below:

  1. Locate an environment or a collection of environments you need to remove.
  2. In the contents panel, on the workspace toolbar, click the More actions icon More Actions Icon.
  3. In the list that appears, select the Remove Environment/Remove Collection option.
  4. In the confirmation dialog box that appears, click Yes to confirm your decision.

Now, the environment/collection of environments has been removed.

# Remove Environment from Collection

To remove a specific environment from a collection, follow the steps below:

  1. Locate the needed collection of environments.
  2. In the contents panel, select the Environments tab.
  3. In the table grid that appears, select the check boxes next to the environments you want to delete.
  4. On the workspace toolbar, click the Remove icon.

Now, the environment has been removed from the collection.

# Environment Setup

Each environment in EaaS has its own configurations. It depends on the initial configuration settings of a plugin based on which an environment has been created. For example, one environment requires that you configure packages and target Kubernetes clusters only. The other environment requires that you configure Kubernetes clusters, provide Helm chart details, and AWS credentials.

Environment Setup Options
Environment Setup Options

This means that the configurations of each environment may vary. It depends on the business logic level parameters of the plugin based on which a specific environment has been created.

Once you have set up your environment, you can use it as a starting point for building your own applications or for your self-service needs without involving the IT team or the DevOps engineers.

# Environment Commands

Each environment in EaaS has many commands to meet your business needs. For example, you can destroy an environment, deploy an environment, stop an environment, start an environment, create a network, etc.

The commands available for each environment may vary. It depends on the business logic level parameters of the environment itself (more precisely, on the parameters of the plugin based on which a specific environment has been created).

To perform a specific command and apply it to your environment, follow the steps below:

  1. Locate an environment you need.
  2. In the contents panel, on the workspace toolbar, click the command you need, for example, Deploy.
    Environment Commands

Now, the command is being performed. In our case, the environment is starting to deploy. In case you want to know what is going on in the back, click the Output Console tab, and review what is happening with your environment right now (for more information on environment details, refer to the Environment Details section).

# Detach Environment

Unlike the other commands that depend on the business logic level parameters of the environment itself, there is a command that is always available for any environment in a collection, namely Detach.

To detach an environment means to remove it from a collection and manage it as a single independent environment.

To detach an environment, follow the steps below:

  1. Locate a previously created collection of environments which environment you want to detach.
  2. In the contents panel, select the Environments tab.
  3. In the table grid that appears, select the check box next to the environment you want to detach, and click the Detach button.
    Detach Environment Option

️❗️ WARNING

You cannot detach several environments at once. You must detach them one by one.

  1. In the Detach Environment from Collection dialog box that appears, update the name of the environment if needed, and click Detach.
    Detach Environment from Collection Dialog Box

An environment has been successfully detached. Click Open Environment to open the detached environment and start working with it. Or, click Close to close the dialog box, and remain in a current collection.

Detach Environment from Collection Dialog Box

# Convert to Collection

At any time, you can convert any existing individual environment into a collection. You may need it, for example, if you want to create several environments of the same configuration and simplify their management.

To convert an environment into a collection, follow the steps below:

  1. Locate an environment you want to convert into a collection.
  2. In the contents panel, on the workspace toolbar, click the More actions icon More Actions Icon.
  3. In the list that appears, select the Convert to Collection option.

An environment has been converted into a collection (i.e., a new collection of environments has been created).

# Convert to Environment

When there is only one environment left in a collection, you may convert it to a single independent environment and manage it separately. To do that, follow the steps below:

  1. Locate a collection of environments which individual environment you want to convert.
  2. In the contents panel, on the workspace toolbar, click the More actions icon More Actions Icon.
  3. In the list that appears, select the Convert to Environment option.

️❗️ WARNING

The option is disabled if more than one environment is available in a collection.

A collection has been converted into a single independent environment. Now, you can start managing it separately.

# Environment Details

Once a specific environment or a collection of environments has been created, you can view its details by navigating to one of the following tabs:

  • Configuration: to view or update the configuration parameters applied to your environment (for more information on the environment configuration, refer to the Environment Setup section).
    Configuration Parameters Applied
  • Artifacts (available for individual environments only): to view the results of the environment plugin work (e.g., server connection details, ARN number details, etc).
Artifacts Tab
  • History: to view the history of all the actions applied to your environment.
  • Approvals Pending: to view the list of actions pending approval (for more information on the approval mechanism, refer to the Approvals Pending section).
Approvals Pending
  • Output Console: to check what is happening with your environment in the background.
Output Console

# History

The History tab represents an audit log designed to monitor user actions. Here you can find out who deployed an environment, when an environment was deployed, and much more.

History Tab

To find the required information faster, filter the log by the date, username, or action name.

History Filtering

To manually refresh the grid and view the most recent data, click the Refresh History icon Refresh Icon.

You can also view the details of a particular command applied to an environment by clicking the Details button Details Button. Then, in the dialog box that appears, view the command details.

Command Details

# Status

Each environment available in EaaS has a list of its statuses, such as Deployed, In Progress, Started, etc. These statuses are the stages of the environment lifecycle that allow you to understand what is going on with your environment right now.

For example, an environment can be in one of the following states:

  • Deploy in progress: the environment is currently being deployed.
  • Deploy failed: the environment has encountered some errors during the deployment.
  • Destroy in progress: the environment is currently being destroyed.
  • Started: the environment has been started.
  • Stopped: the environment has been stopped, and much more.

The status of the environment depends on the command applied to your environment previously.

There are several ways to view an environment status:

  1. Via the Search tab
  2. Via the My Recent tab
  3. From the contents panel
Environment Status

# Scheduler

Scheduler is one of the most practical EaaS features because it can streamline your work with environments. The main idea of this feature is to trigger the running of different commands at a specific time.

To schedule a specific command, follow the steps below:

  1. Locate an environment you need.
  2. In the contents panel, select the Scheduler tab.
  3. In the Add task dialog box that appears, fill in the following fields:
Add Task Dialog Box
  • Is Enabled: turn the toggle on or off to activate or deactivate the trigger.
  • Command Name (mandatory): expand the list and select the command you want to schedule. The commands you see in the list depend on the business logic level parameters of the environment itself. This means that different environments may have different commands to select.
  • Description: enter a short description of the task you are scheduling.
  • Trigger time: specify when the command is expected to be performed:
    • Single: select this radio button to define a one-time trigger. Just enter the date and time you want the command to take place.
    • Weekly: select this radio button to define a weekly trigger. Enter the time and then select the days when you want your command to take place.
  1. Click Save.

The task has been scheduled. It is displayed in the table grid.

Scheduled Task Displayed in the Grid

Now, a specific task’s command will be executed automatically by the system at the time you have just specified.

To remove a task from the scheduler (i.e., to remove a command from being executed), simply click the Delete Task button Delete Task Button located to the right of the table grid. In the confirmation dialog box that appears, click Yes to proceed.

# Workspace Settings

In EaaS, all environments inherit their default settings from a plugin based on which they are created. These settings include whether users are allowed to deploy environments, whether they are allowed to stop environments, and so on.

In case the initial settings of a particular environment must be changed (in other words, if you want to override the initial settings), or in case you simply want to view what settings are defined for your environment, follow the steps below:

  1. Locate an environment the default settings of which you want to view or update.
  2. In the contents panel, on the workspace toolbar, click the More actions icon More Actions Icon.
  3. In the list that appears, select the Workspace Settings option.
  4. In the Workspace Settings dialog box that appears, select the Permissions tab, and view or update the permissions you need. For more information on user permissions, refer to the Environment Default Permissions section.
  5. Or, select the Approvals tab, and define the commands that require approval in your environment. For more information, refer to the Approvals Pending section.