Manual Development

Owned by Antoine Hage (Unlicensed)
Last updated: Nov 07, 2018
4 min read

Overview

An environment is a network of interconnected servers with access to the same set of settings and resources such as registry, databases, network, infrastructure ...

The development environment offers the needed tools to develop, test and debug applications and programs.

Applications are broken down to several components where each component is developed and tested by a team of engineers using their machines. Once a component is completed, it is merged with other components and both are tested again.

At this stage, the development and testing is happening in a development environment and having the right set of tools ensures speed and quality.


The Remote Development Environment is suitable for development purposes and considered as a starting point for engineers as it helps them build, test and troubleshoot APIs on their local or any remote machine.

SOAJS Console offers multiple tools for this type of environments that also assist engineers in managing all the needed configuration when building applications.

SOAJS allows you to can create multiple development environments for different engineering teams working on different products and provides you with all the tools you need to manage, orchestrate and operate in these environments.




Features & Benefits

The development environment offers many features that engineers require when building microservices and daemons and testing them on their machines.

It orchestrates and facilitates the management of all needed configuration via a ready to use User interface ( SOAJS Console ) such as Registry & security configuration and resources and database management.

This environment does not use any Container technology as its infrastructure, it requires the engineer to manually set the needed environment variables then start/stop/restart all microservices and daemons himself.

The features of a Development Environment are classified under 4 products that all together form the SOAJS Suite:

API Lifecycle Management

Multi-Cloud Orchestration

IT Ops Automation

Release Management
N/A




Creating and Operating in a Development Environment

The following elaborate how an engineer can create, deploy and operate in a Development Environment with reference to the features SOAJS offers in its suite and key benefits that highlights how SOAJS helps engineers ensure quality and boosts their development speed.

DevelopmentKey Features


  1. Learn how to create a new microservice or how to use SOAJS to modernize existing systems written in any language
  2. Install and Login to SOAJS Console
  3. Use the API Builder to Create a Microservice & Download the Source Code
  4. Link and Activate your Microservice and visualize it in the API Catalog
  • Build standardized Rest Layers and ensure smooth integration between microservices as well as bridging to 3rd party systems
  • Gain access to the source code and full control of API behavior
  • Focus on the business logic, SOAJS takes care of the rest!
  • Integrate with GIT providers with a click of a button
  • Use the API Catalog, visualize and modify the settings of your microservices
Infrastructure


  1. Create a new Development Environment 
    1. Start with a Blank Environment
  2. Connect with a Cloud Provider & Create Virtual Machine Layers 
  3. Extend the Default Environment Registry and create Custom Entries that your microservice require
  • Avoid deployment protocols, procedure or infra setup overhead, use SOAJS wizards, provision and standardize faster
  • Create Dynamic Custom configuration for your code, share it and secure it with other components
  • Connect with multiple cloud providers, setup and deploy your infrastructure with a click of a button
Deployment




  1. Deploy the Resources your microservices needs to communicate within Virtual Machine Layers
  2. Create the Databases that your microservice will use on top deployed resources
  3. Download the Profile from Cloud & Deployments 
  4. Start the microservices & visualize them under Cloud & Deployments 
    1. API Gateway 
      1. Open your Terminal 
        1. Download the API Gateway 
        2. Set the needed environment variables
        3. Start the SOAJS API Gateway 
    2. Your Microservice
      1. Open another Terminal
        1. Navigate to the directory where your microservice resides
        2. Set the needed environment variables
        3. Start your microservice
  • Deploy the API Gateway and leverage the full capability of cloud awareness, multitenancy, productization and more
  • Build, Tweak & Optimize your code ensuring ultimate performance before deploying it in production mode
  • Deploy resources on demand and connect your code to them
  • Avoid writing hardcoded connection configuration in your code and use SOAJS Console for Database & Resources Management
Management & IT Ops


  1. Upgrade your Microservice and leverage Productization and Multitenancy
    1. Create and configure Productized ACL Packages
    2. Create and configure Tenants and Security Keys
  2. Reload & Apply the configuration on your microservice
  • Transform your code to become multitenant and reuse it with different products
  • Full  Control over security protocols and in multiple environments
  • Modify and reload configuration at will with ZERO downtime!
Testing & Simulation


  1. Test your microservice using the API Simulator
  2. Modify your code and restart your microservice in the terminal ( Manually )
  • Visualize and test the behavior of your code in multiple environments and using different tenant configuration
  • Ensure API quality and performance