Installation Best Practices

We recommend the following best practices when you are installing 
CA Live API Creator
.
lac42
We recommend the following best practices when you are installing 
CA Live API Creator
:
  • Installing 
    CA Live API Creator
     involves 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 512MB 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 installing 
    CA Live API Creator
     to 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 installing 
    CA Live API Creator
     to 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 installing 
    CA Live API Creator
     to 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.
  • To minimize the round-trip trip time to your databases, install 
    CA Live API Creator
     close 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 running 
    CA Live API Creator
     in your production environment, consider disabling write access to your admin repository to prevent any runtime updates to your API definition by setting the 
    LAC_REPOSITORY_DISABLE
     option.
  • Review the security protocol requirements for the services that you host on 
    CA 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 for 
    CA Live API Creator
     server health using the 
    @heartbeat
     system REST endpoint.
    For more information about this endpoint, see System REST Endpoints.
For a list of all best practices, see Best Practices.