You have installed a recent version of Docker and it is running properly.
For more information:
About the versions of Docker that
CA Live API Creator
supports, see Installation Requirements and Supported Platforms.
About how to install and running Docker (Mac), see the Docker documentation.
To verify your Docker version and verify if Docker is running properly, issue the following command from the command line:
docker info
The output gives you information about your version of Docker.
If you get an error message, do not continue with installing and configuring
CA Live API Creator
to run as a Docker container.
You have decided which port you would like
CA Live API Creator
to run on. This installation assumes that the port is 8080, but you can change it to another port (the port must be greater than 1024 and less than 65535, and it is must not already be in use).
If you are running Docker on Windows and you want to persist the data that Docker generates and you are mapping a volume to make the license file available to the Docker container (you are using the
--volume
option), you have ensured that you have the appropriate permissions on your Windows machine.
For more information about how to run Docker in persistent mode on Windows, see the Docker documentation.
You have reviewed the installation best practices.
For more information about the best practices, see Installation Best Practices.

Non-persistent mode: Running
CA Live API Creator
as a Docker container in non-persistent mode is useful for quick demonstrations and for training. Your API definition and data changes persist until you change or remove the Docker container. If you want to preserve the changes that you make to your API, consider running in persistent mode.
Persistent mode: This deployment method is useful when using
CA Live API Creator
for an extended timeframe and you want to preserve the changes that you make to your API. When you restart the Docker container, your changes are remembered.
Docker Compose cluster: The Docker container for the PostgreSQL authentication token database is linked to the
CA Live API Creator
container that is running in persistent mode.

/usr/local/tomcat

/usr/local/CALiveAPICreator/databases

Start the Docker container using one of the following options:
If you want to access the Docker container by way of

localhost

and publish your host port to your Docker port, run

CA Live API Creator

by issuing the following command, using the

-p

option:

docker 
run \
        -p <HOST_PORT>:<DOCKER_PORT> \
        caliveapicreator/<version>

For more information about the options you can use with the

docker run

command in the Docker CLI, see the Docker CLI reference documentation.

The

docker run

command does not return and shows you the output of the container. This command is helpful for diagnosing problems.

Example:

docker 
run \
        -p 8080:8080 \
        caliveapicreator/5.0.00

If you want to access the Docker container by way of

localhost

, run the container in the background and print the container ID, and publish your host port to your Docker port, run

CA Live API Creator

by issuing the following command, using the

-d

option and the

-p

option:

docker 
run \
        -d \
        -p <HOST_PORT>:<DOCKER_PORT> \
        caliveapicreator/<version>

Example:

docker 
run \
        -d \
        -p 8080:8080 \
        caliveapicreator/5.0.00
You can add other options when you start the Docker container, such as avoiding the End User License Agreement screen and having to accept the End User License Agreement when you first connect to
CA Live API Creator
. For more information about these options, see the "Enable Other Options at Container Startup" section.
Start API Creator by entering the following URL in a browser:
http://localhost:<HOST_PORT>/APICreator 
Example:
http://localhost:8080/APICreator 
(Mac/Linux) If you have not mapped your Docker machine IP to localhost, then use the following URL:
http://<Docker machine IP>:8080/APICreator
Log in to API Creator as the
admin
user.
If the
default
TeamSpace is the only TeamSpace that exists, the system administrator is the initial TeamSpace user. The user name for this user is
admin
. Log in to API Creator as this user. If you have changed the
admin
user password, use that password.

Navigate to the directory that you want to contain your Docker container in persistence mode.

Access the Docker container in non-persistent mode by way of

localhost

by issuing the commands that run the container in the background, that print the container ID, and that publish your host port to your Docker port.

For more information about these commands, see the "Run the Container in Non-Persistent Mode" section.

Extract the sample APIs and databases that the Docker image includes to your local file system so that you can keep any changes that you make to them by issuing the following commands:

docker ps 
docker cp <Docker container ID>:/home/tomcat/CALiveAPICreator.repository . 
docker cp <Docker container ID>:/usr/local/CALiveAPICreator/databases .

The APIs and databases are replicated into the

CALiveAPICreator.repository

and

databases

subdirectories in the current directory. The subdirectories contain the default admin repository and the sample databases.

The following table lists the files and directories that are most relevant in the Docker container:

Path	Description
/usr/local/tomcat	Tomcat runs in this directory, which is a standard installation including the typical subdirectories, such as bin , lib , logs , and webapps . It is common to map the server.xml file in this directory to a local file with different settings.
/home/tomcat/CALiveAPICreator.repository	The APIs are stored in this file, which is your admin repository. To persist your APIs, map this directory to your local file system.
/usr/local/CALiveAPICreator/databases	The Derby managed databases are stored in the databases/ManagedData subdirectory. If you use the built-in managed databases, then any new databases are saved in this directory. This directory also contains the various Derby databases that the Docker installation includes.

Stop the Docker container by issuing the following commands:

docker stop <Docker container ID> 
docker rm <Docker container ID>

Restart the Docker container with the local repository and databases and with the volume mappings by issuing the following commands:

docker run -p 8080:8080 \
  -v /Users/jdoe/CALiveAPICreator.repository:/home/tomcat/CALiveAPICreator.repository \
  -v /Users/jdoe/databases:/usr/local/CALiveAPICreator/databases \
  caliveapicreator/<version>

If you do not want to have the sample APIs pre-installed, point the Docker volumes to a different directory.

Start API Creator by entering the following URL in a browser:

http://localhost:<HOST_PORT>/APICreator 

Example:

http://localhost:8080/APICreator 

(Mac/Linux) If you have not mapped your Docker machine IP to localhost, then use the following URL:

http://<Docker machine IP>:8080/APICreator

Create the
configuration.zip
file from your admin repository (the
teamspaces
and
system
directories).
For more information about these directories, see View your API Definition.
If you plan to have
CA Live API Creator
execute timers or listeners for messaging support that rely on cluster synchronization, you have configured Hazelcast for cluster synchronization strategy. Place the Hazelcast configuration XML file in the same directory as the Docker Compose file.
You can use the
hazelcast.xml
Hazelcast configuration XML file as a sample for the Docker Compose file, and then modify it.
For more information, see Configure Live API Creator to Run as a Cluster.
If you plan to persist your
CA Live API Creator
log messages to the
CA Live API Creator
instances in this cluster, you have created a logger for externalizing logging. Place this file in the same directory as the Docker Compose file.
You can use the
laclogging.xml
file as a sample logging configuration file, and then modify it.
For more information, see External Logging.

Download the sample
docker-compose-example.yml
Docker Compose YAML file for PostgreSQL. This file contains comments that explain what each line does.
If you want to persist your authentication tokens, do one of the following:
Have the YAML file create this database as part of the Docker Compose cluster.

Create a database to persist your authentication tokens. This database can be a Docker container or an accessible database in the host network. Then, open the YAML file and comment out the following lines:

database:
  image: "postgres"
  environment:
    - POSTGRES_PASSWORD=Password1
  ports:
  - "35432:5432"
  volumes:
  - "./init.apikey.sql:/docker-entrypoint-initdb.d/init.sql"
  - "apicreator_databases:/var/lib/postgresql/data"
Open the YAML file, and then add the Docker volumes that you want to share.
You can use the init.apikey.sql SQL file as a sample for the Docker Compose file. Place this file in the same directory as the Docker Compose file.
If you have added nodes in the Docker Compose cluster, add them to the Hazelcast configuration XML file.
Navigate to the directory that you want to contain your Docker container in a Docker Compose cluster by issuing the following command:
$ cd <The directory containing the supporting files and the Docker Compose YAML file>
Run
CA Live API Creator
as a Docker container in a Docker Compose cluster by issuing the following command:
$ docker-compose up
Example:
$ docker-compose -f docker-compose-postgresql.yml up
Enter the URL for the load balancer for the Docker Compose cluster in your browser. For example,
localhost:8087
.

Bypass the extra step at login to accept the CA End User License Agreement (EULA) at container startup.
Change the password for the system administrator user and for the initial API developer at container startup.
Specify an alternate license file at container startup.
Load libraries or overwrite server configuration files.
Specify the memory to be used in the Docker container.
Change heap size for Java and Tomcat in the container.
Specify the time zone in the container.
Options for integrating
CA Live API Creator
with CA API Gateway:
Publish more ports at container startup for integration with CA API Gateway.
Add custom host-to-IP mapping at container startup to use for integration with CA API Gateway.
Configure Tomcat server for mutual authentication at container startup for integration with CA API Gateway.

-e ca_accept_license=ENU

-e LAC_INITIAL_SA_PASSWORD=<MySAPassword>

-e LAC_DEFAULT_LICENSE_FILE=/licenses/MyLicense.txt

--volume=<host directory>:/<Docker container directory> /
-e LAC_DEFAULT_LICENSE_FILE=/licenses/MyLicense.txt

--volume=/Users/jdoe/licensing:/licenses
-e LAC_DEFAULT_LICENSE_FILE=/licenses/MyLicense.txt

-v "<Your host file or library>:<The Docker container file>
"

-v "conf/conf/server.xml:/usr/local/tomcat/conf/server.xml"

-v 
/Users/jdoe/mylibrary.jar:
/usr/local/tomcat/lib/mylibrary.jar

-m <maximum amount of memory>

-m 3g

-e CATALINA_OPTS="-Xmx2048M -Djava.security.egd=file:/dev/./urandom"

-e TZ=<time zone>

-e TZ=GMT

-p <HOST_PORT>:<DOCKER_PORT>

-p 8081:8081

--add-host=<gateway_hostname>:<gateway_hostname_IP>

--add-host=gw92.ca.com:34.203.50.194

-v <Your host file or library>:<The Docker container file>

-v /Users/jdoe/lac/server.xml:/usr/local/tomcat/conf/server.xml

http://localhost:8080/APICreator

tomcat:9.0.8-jre9-slim

Copy any files that you want to add or modify in the standard Docker image, such as a customized

server.xml

configuration file for Tomcat, or a JDBC driver JAR file, to the current directory.

The Docker container includes Tomcat to run

CA Live API Creator

. The Ghostcat vulnerability (CVE-2020-1938) is a vulnerability found in Apache Tomcat's AJP Connector that listens on port 8009. Tomcat treats AJP connections with more trust than connections such as HTTP. AJP connections allow attackers to exploit them to perform actions that are not intended for an untrusted user.

The default

CA Live API Creator

Docker container does not open port 8009. With your own Docker container, avoid the Ghostcat vulnerability by not exposing this port.

For more information about this vulnerability, see CVE-2020-1938 on the Common Vulnerabilities and Exposures (CVE) site.

Create a Docker file that includes these files and installs any other package, for example:

FROM caliveapicreator/5.0.00
MAINTAINER Your name here
COPY server.xml /usr/local/tomcat/conf/
COPY ojdbc8.jar /usr/local/tomcat/lib/
RUN apt-get install libmongodb-java

Create your Docker image by issuing the following command:

docker 
build -t my_lac_docker 

Output similar to the following is expected:

Sending build context to Docker daemon 4.387MB
Step 1/4 : FROM caliveapicreator/5.0.00
 ---> 5c4deff6db45
Step 2/4 : MAINTAINER Your name here
 ---> Using cache
 ---> fcf84e18777e
Step 3/4 : COPY server.xml /usr/local/tomcat/conf/
 ---> Using cache
 ---> 8f3594a7e645
Step 4/4 : COPY ojdbc8.jar /usr/local/tomcat/lib/
 ---> 6bf37ad7dd81
Successfully built 6bf37ad7dd81
Successfully tagged my_lac_docker:latest

Run the Docker image by issuing the following command:

docker 
run -p 8080:8080 my_lac_docker

Verify that API Creator is running by entering the following URL in a browser:

http://localhost:8080/APICreator

List your containers by issuing the following command:
docker 
ps
A result similar to the following is expected:
CONTAINER ID IMAGE                   COMMAND            CREATED        STATUS        PORTS     NAMES
9376d7985de1 caliveapicreator/5.0.00 "catalina.sh run"  5 minutes ago  Up 4 minutes  8080/tcp  lac
Copy the Docker container ID.
Start a shell in the container by issuing the following command:
docker 
exec -it 9376d7985de1 bash
A command prompt appears.

List the Docker containers by issuing the following command:

$ docker 
ps -a

A result similar to the following is expected:

CONTAINER ID    IMAGE                       COMMAND                   CREATED           STATUS           PORTS
547911c7c2cc    caliveapicreator/5.0.00     "StartLiveAPICreator."    7 minutes ago     Up 7 minutes     0.0.0.0:8080->8080/tcp

Complete one of the following options:

To stop the Docker container, issue the following command:

$ docker 
stop <Docker container ID>

To remove the Docker container, issue the following command:

$ docker 
rm <Docker container ID>

List the Docker images by issuing the following command:

$ docker 
images

A response similar to the following is expected:

REPOSITORY             TAG         IMAGE ID        CREATED        SIZE
caliveapicreator/5.0.00   latest      96b2a3d11452    2 days ago     580.4 MB

Remove the image by issuing the following command:

$ docker 
rmi <Docker image ID>