About the Gateway Embedded Database

When creating a new gateway database, you have the option of configuring a connection to a MySQL database or using the built-in embedded (non-MySQL) database on the Gateway.
gateway92
When creating a new
Layer7 API Gateway
database, you have the option of configuring a connection to a MySQL database or using the built-in embedded (non-MySQL) database on the Gateway.
The embedded database is designed for environments where it is not possible to have a separate MySQL instance. For example, your security policy may forbid operating MySQL or any other network-accessible SQL database, even on
localhost
.
The embedded database is also ideal for testing or evaluating the Gateway, as it can be set up quickly, without relying on an external database.
Note the following limitations when an embedded database is in effect:
  • Multi-node clustering is not available. The Gateway behaves as a single-node cluster.
  • Service metrics are not persisted to an embedded database (see Gateway Dashboard
    ).
  • The Audit Archiver is not available (see Configure FTP Audit Archiver).
Reverting to MySQL
As required, you may revert to a MySQL database from an embedded database for the Gateway.
The reversion process differs depending on whether you are using an Appliance or Software Gateway.
Appliance Gateways
To change an embedded database to a MySQL database on an appliance Gateway:
  1. Use the migrateOut command in the Gateway Migration Utility to migrate the data out.
  2. Stop the Gateway.
  3. Access the Gateway main menu.
  4. Remove the existing node:
    1. Select option
      2
      (Display
      Layer7 API Gateway
      configuration menu).
    2. Select option
      5
      (Delete the
      Layer7 API Gateway
      ) and respond to the prompts as follows:
      • Delete node:
        yes
      • Delete database:
        no
  5. Create the new MySQL database:
    • Select option
      2
      (Create a new
      Layer7 API Gateway
      database).
      • Database connection:
        yes
  6. Start the Gateway.
  7. Install the license for the Gateway.
  8. Use the migrateIn command to migrate the data back in.
  9. Review the list of migration limitations to see if any apply to you. If so, make the appropriate corrections.
For detailed information about migration, see Gateway Migration.
Software Gateways
To change an embedded database to a MySQL database on a Software Gateway:
  1. Use the migrateOut command in the Gateway Migration Utility to migrate the data out.
  2. Stop the Gateway.
  3. Open a privileged shell and delete the following file:
    /opt/SecureSpan/Gateway/node/default/etc/conf/node.properties
  4. Access the Gateway main menu
  5. Select option
    2
    (Configure the
    Layer7 API Gateway
    ). Follow the steps in the configurator. Make sure you choose to configure a MySQL database.
  6. Start the Gateway.
  7. Install the license for the Gateway.
  8. Use the migrateIn command to migrate the data back in.
  9. Review the list of migration limitations to see if any apply to you. If so, make the appropriate corrections.
For detailed information about migration, see Gateway Migration.