AMPLIFY Runtime Services Getting Started

Amplify Runtime Services is deprecated and will be discontinued effective September 1, 2022.

Introduction

AMPLIFY Runtime Services (ARS) is Axway's Container as a Service (CaaS) solution. It uses the AMPLIFY Cloud Services command-line interface, called acs for short, for creating and administering applications in the AMPLIFY Runtime Services environment. As part of the Axway's AMPLIFY platform, it also leverages the AMPLIFY or Axway CLI to handle installing the acs CLI tool.

Supported Configurations

AMPLIFY Runtime Services supports these component versions:

  • Node: All active versions as specified here.
  • Docker: All Docker released versions.

Installation

To get started, install the prerequisite applications, which are Node.js, the AMPLIFY or Axway CLI, the AMPLIFY Cloud Services (ACS) CLI, and Docker.  

To install Node.js, the AMPLIFY or Axway cli, the AMPLIFY Cloud Services (acs) cli, and Docker

  1. Node.js: Download and install Node.js from https://nodejs.org/en/#download. Note that AMPLIFY Runtime Services has been tested with all currently active Node versions.
  2. Docker: Install Docker from https://docs.docker.com/get-docker/ .  
  3. AMPLIFY or Axway CLI: From a console window, type the following command to install the Amplify or Axway CLI. Refer to the Amplify CLI documentation or the Axway CLI documentation for more details.

    The AMPLIFY CLI and "amplify" commands are for CLI versions 1.5.0 and earlier. Starting in version 2.0.0, the AMPLIFY CLI has been renamed to the Axway CLI. Refer to the Axway CLI and "axway" commands for CLI versions 2.0.0 and later.

    ### Axway CLI v2.0.0 and later
    [sudo] npm install --global axway
     
    ### AMPLIFY CLI v1.5.0 and earlier
    [sudo] npm install --global @axway/amplify-cli

    When using Windows, you can omit the [sudo] portion of the command.

  4. AMPLIFY Cloud Service (acs) CLI: If you have an existing AMPLIFY Cloud Services (acs) cli installed, execute the following command to uninstall the ACS CLI to ensure the latest version.

    [sudo] npm uninstall -g acs

    You can omit the [sudo] portion of the command when using Windows.

  5. Type the following command to install the acs cli.

    ### Axway CLI v2.0.0 and later
    axway pm install acs
     
    ### AMPLIFY CLI v1.5.0 and earlier
    amplify pm install acs
  6. Type the following command to login to AMPLIFY Runtime Services. 

    ### Axway CLI v2.0.0 and later
    axway auth login
     
    ### AMPLIFY CLI v1.5.0 and earlier
    amplify auth login


    With the amplify auth login command, your default browser should open up and prompt you to enter your AMPLIFY credentials to log into the AMPLIFY platform.  

  7. Once you have successfully logged in to your AMPLIFY account, type the following command to show you the currently logged-in user and organizations to which you belong.

    ### Axway CLI v2.0.0 and later
    axway acs whoami
     
    ### AMPLIFY CLI v1.5.0 and earlier
    amplify acs whoami

When you have completed the above steps, you now have the prerequisite applications installed to use AMPLIFY Runtime Services (ARS).

AMPLIFY Runtime Services Command-Line Interface Reference

This page includes getting started with the AMPLIFY Runtime Services Command-Line Interface commands. For more details about each of the ARS cli commands in the instructions below, refer to the AMPLIFY Runtime Services Command-Line Interface Reference

Creating and Publishing an Application from Source Code or Docker Image

After completing your initial installation, you are now ready to publish your first AMPLIFY Runtime Services (ARS) application.

When publishing your ARS application, you have the following options:

  • Publish an application from source code
  • Publish an application from a Docker image
  • Leverage API Builder

For the purposes of this guide, we will cover the publishing your ARS application from Source Code and Docker Image. The API Builder publication is covered in details in Deploy an API Builder application to AMPLIFY Runtime Services.

To create your ARS application, use the following commands.

  1. Type one of the following commands to create a new app from source code or a Docker image. You can find more details on how to create new apps in the new command reference section.

    ### Axway CLI v2.0.0 and later
    axway acs new [application name]
     
    ### AMPLIFY CLI v1.5.0 and earlier
    amplify acs new [application name]
    ### Axway CLI v2.0.0 and later
    axway acs new --type image [application name]
     
    ### AMPLIFY CLI v1.5.0 and earlier
    amplify acs new --type image [application name]
  2. Type the following command to publish your application. You can find more details for the publish command in the reference section.

    ### Axway CLI v2.0.0 and later
    axway acs publish [application name]
     
    ### AMPLIFY CLI v1.5.0 and earlier
    amplify acs publish [application name]

Monitoring Your Application

Now that you have created and published your application, you can use the following commands to take advantage of the additional features that ARS has to offer.

Follow the steps in this section to monitor your published application. 

  1. Type the following command to list the details of your application. Refer to the list command reference section for details.

    ### Axway CLI v2.0.0 and later
    axway acs list [application name]
     
    ### AMPLIFY CLI v1.5.0 and earlier
    amplify acs list [application name]


  2. Type the following command to list the application's log messages within a specific period. By default, a maximum of 100 log messages is returned at a time. Refer to the loglist command reference section for details.

    ### Axway CLI v2.0.0 and later
    axway acs loglist [options] [appname]
     
    ### AMPLIFY CLI v1.5.0 and earlier
    amplify acs loglist [options] [appname]
  3. Type the following command to review the application's accesslog. Refer to the accesslog command reference section for details.

    ### Axway CLI v2.0.0 and later
    axway acs accesslog [options] [appname]
     
    ### AMPLIFY CLI v1.5.0 and earlier
    amplify acs accesslog [options] [appname]
  4. Type the following command if you want to know more about resource consumption. You can use the usage command to check resource usage within a specific period. By default, a maximum of 100 log entries is returned at a time. Refer to the usage command reference section for details.

    ### Axway CLI v2.0.0 and later
    axway acs usage [options] [appname]
     
    ### AMPLIFY CLI v1.5.0 and earlier
    amplify acs usage [options] [appname]

Those are some examples on how you can monitor your application. Refer to the command reference section for additional monitoring commands.

Configuring Domain and Certifications

After publishing and monitoring your application, you can configure your domains and certifications.

  1. Type the following command if you want the application accessible by a custom domain as an alias for the application's  cloud.appcelerator.com URL. Refer to the domain command in the reference section for details. 

    ### Axway CLI v2.0.0 and later
    axway acs domain [ options ] [ appname ]
     
    ### AMPLIFY CLI v1.5.0 and earlier
    amplify acs domain [ options ] [ appname ]
  2. Type the following command to enable you to manage custom SSL certificates to accommodate HTTPS access. Refer to the crt command in the reference section for details.

    ### Axway CLI v2.0.0 and later
    axway acs crt [options] [appname]
     
    ### AMPLIFY CLI v1.5.0 and earlier
    amplify acs crt [options] [appname]

Refer to the command reference section for additional domain and certification configuration commands.

Configuring Applications and Container Variables

You also have the option to configure your applications and container variables. 

  1. Type the following command to configure environment variables and the number of cloud servers for the application to use (auto-scaling). Refer to the config command reference section for details. 

    ### Axway CLI v2.0.0 and later
    ### Environment variables
    axway acs config [--set <key>=<value>] [--unset <key>] [--env] [appname]
    
    ### Auto-scaling
    axway acs config [--autoscaleup true|false] [--autoscaledown true|false] [--minsize N] [--maxsize N] [--maxqueuedrequests N] [--usagenotice true|false] [appname]
     
    ### AMPLIFY CLI v1.5.0 and earlier
    ### Environment variables
    amplify acs config [--set <key>=<value>] [--unset <key>] [--env] [appname]
     
    ### Auto-scaling
    amplify acs config [--autoscaleup true|false] [--autoscaledown true|false] [--minsize N] [--maxsize N] [--maxqueuedrequests N] [--usagenotice true|false] [appname]
  2. Type the following command to configure the server container size of the application. If your application is already published after changing the container size, you will need to republish the application. Refer to the server command and publish command reference section for details. 

    ### Axway CLI v2.0.0 and later
    axway acs server [options] [appname]
     
    ### AMPLIFY CLI v1.5.0 and earlier
    amplify acs server [options] [appname]

Refer to the command reference section for additional configuration commands.

Application Tuning and Optimization

This section includes commands to use for application tuning and optimization.

  1. Type the following command to download the app source file with a specified app name and version. If no app name is provided, specify the app directory with either dir or -d. The currently deployed app version will be downloaded if no app version option is provided. Refer to the download command reference section for details. 

    ### Axway CLI v2.0.0 and later
    axway acs download [options] [appname]
     
    ### AMPLIFY CLI v1.5.0 and earlier
    amplify acs download [options] [appname]
  2. Type the following command to restart an AMPLIFY Runtime Services application without having to use the amplify acs publish --force command. Refer to the restart command reference section for details.

    This command will restart all servers associated with your app.

    ### Axway CLI v2.0.0 and later
    axway acs restart [options] [appname]
     
    ### AMPLIFY CLI v1.5.0 and earlier
    amplify acs restart [options] [appname]
Refer to the command reference section for additional tuning and optimization commands.


Related Links