Installation Best Practices
The following are best practices when you are installing
Layer7 Live API Creator.
We recommend the following best practices when you are installing
Layer7 Live API Creator:
- InstallingLayer7 Live API Creatorinvolves installing API Server. When installing API Server to run as an on-premise service or as a cloud-based service, we recommend:
- As many CPUs as required for peak load. API Server takes advantage of all available CPUs.
- A minimum of 512 MB of heap and a maximum of 4 to 8 GB per Java container. If you have extra RAM, consider using several Java containers.For more information about heap size configuration, see Installation Requirements and Supported Platforms.
- A few GB of available disk space for log files.
- When installingLayer7 Live API Creatorto run as an on-premise service, work with your infrastructure teams to secure the application server according to the vendor's best practices, in particular:
- Reset default passwords.
- Remove unnecessary example applications.
- Close unnecessary open ports.
- When installingLayer7 Live API Creatorto run as a cloud-based service, minimize the server exposure to any vulnerabilities within the environment by setting up the appropriate security groups. For example, if you are installingLayer7 Live API Creatorto run as a cloud-based service in an Amazon Web Services (AWS) Elastic Beanstalk environment, follow the best practices that are outlined in the AWS documentation.
- Minimize the round-trip trip time to your databases by installingLayer7 Live API Creatorclose to the database. Ideally, the ping time between API Server and the database server should be less than one millisecond. You can test the ping time using API Creator.For more information about how to test the connection to your database, see Database Connectivity.
- When runningLayer7 Live API Creatorin a production environment:
- Consider preventing API Server from writing to disk the changes that you make to the admin repository by adding theLAC_REPOSITORY_DISABLEoption when you start API Server and setting it tofalse.
- Minimize in-memory usage and optimize your server performance by completing the following:
- Turn off in-memory logging at the API Server level by adding theLAC_USE_IN_MEMORY_LOGGINGoption when you start API Server and setting it tofalse. By default,Layer7 Live API Creatordetermines whether to display the in-memory logs based on the API level setting for displaying in-memory logs (theEnable In-Memory Logscheckbox on the Settings tab) (the value for this option istrue).
- Configure external logging. For more information about how to configure external logging, see External Logging.
- Review the security protocol requirements for the services that you host onLayer7 Live API Creator. Minimize your services' exposure to security vulnerabilities.For more information about how to minimize exposure to these vulnerabilities, see Restrict the Use of Cryptographic Algorithms and Protocols.
- Configure monitoring services forLayer7 Live API Creatorserver health using the@heartbeatsystem REST endpoint.For more information about this endpoint, see System REST Endpoints.