Deployments

On the Deployments page, you can deploy a build in a specific environment and manage running deployments.

On this page, you can:

  • Deploy a build;
  • Enable auto-scaling for a deployment;
  • Start, stop, or delete a deployed build;
  • View logs of a certain deployed build;
  • Check the deployment status (starting, started, stopping, stopped, updating, deleting);
  • Update Edifecs products used within deployments with zero downtime;
  • Search for and filter your deployments;
  • View detailed information on a selected deployment (endpoints, routes, services, number of incoming requests, CPU and memory usage, number of replicas, and the deployed build version).
  1. On the Deployments page, click Deploy Build.
  2. In the Deploy Build dialog, from the drop-down list in the Environment field, select an environment or start typing the name to find the required environment. Note that only the environments with the status Ready are available to choose from.
  3. Under Build, select a build you want to deploy. This associates the build with the environment. Keep in mind that you can run the same build in several environments.
  4. Specify the version of the build you need.
  5. Add Operational Users by clicking . In User, select users from the drop-down list or type in their names, and then click Assign. These users will be authorized to interact with this deployment (access endpoints, send and receive data from/to this deployment).
  6. Next to Variables that are propagated to profiles, click to add a name-value pair.
    1. In the dialog that appears, enter the name that describes the type of the variable, and then click Add.
    2. In the value field, enter a value for this variable and click Apply. To remove a variable, click next to the value field.
  7. Review the list of profiles available in the build under Profiles. The profiles' names are pulled up automatically based on the selected build.
  8. For each available profile, in Replicas, specify the maximum allowed number of profile instances.
  9. Limit the CPU and memory consumption.
  10. Enable auto-scaling if you want the Compute service to scale your deployment automatically based on the limits you specified earlier. Auto-scaling helps you ensure that your deployments have adequate capacity to cater to the current traffic demand, allowing you to scale your deployments up or down by adding and removing profile instances when the deployment reaches the limit of the memory or CPU usage. For example, when your memory consumption reaches the specified maximum threshold, then a replica is added (but no more than the number of replicas specified in Replicas) to scale your deployment up. When your memory usage reaches the minimum threshold, a replica is removed to scale your deployment down.
  11. Click Deploy.

All the created deployments will be available on this page. Switch between environments and builds by selecting the required environment and build on the top-left of the page.

In the list of deployments, the following details are available for each profile:

  • The profile status;
  • The number of profile instances;
  • The profile name;
  • The path to the profile package archive location in the Cloud Repository;
  • The build version;
  • The system CPU usage;
  • The memory (RAM) usage;
  • The number of input and output requests.

To view more details on a particular profile in a deployment, expand the required profile from the list. The following profile information is available:

Field Description
HTTP Service

The automatically generated path to an HTTP service endpoint that you can use to submit your files through RESTful API (RESTful web service).

The path includes the route name and does not change when you deploy other build versions or redeploy the build within the same environment. If you deploy the build in another environment, a new path is generated.

Note The HTTP service is available for profiles that contain RESTful components.

Each endpoint has two URLs, internal and external. The internal endpoint does not require any credentials to pass authorization, is not publicly available, and can only be used for communication between profiles.
#

The number of instances.
Path

The path to the folder with routes or services.
Routes/Services

The list of routes and services that the profile contains.
Received/In Process/Processed/Failed/Exceptions

The number of data files with a specific status for each route.
Total

The total number of data files with a specific status from all the routes in a profile.

Profiles within deployments can be filtered by their statuses and searched by name.

To start a profile:

  1. On the Deployments page, select the deployment you want to start.
  2. Click the menu icon on the right and click Start.

To update Edifecs products used in the deployment:

  1. On the Deployments page, select the deployment.
  2. Click the menu icon on the right and then click Update. If this option is disabled, the Edifecs products within the deployment are all up-to-date.
  3. Review the list of available updates and click Update to initiate the procedure.

    Note You have an option to roll back to the previous deployment state if the upgrade is not completed successfully.

 

To remove a deployment:

  1. On the Deployments page, select the environment and the build deployed in this environment.
  2. If the profiles of this deployment are running, click on the right of the profile.
  3. Click Stop and click OK to stop the profile.
  4. When the profiles have the status Stopped, click Delete Deployment on the top right of the page.
  5. Click OK to remove the deployment with all its profiles.