You're
viewing Apigee X documentation.
View Apigee Edge documentation.
Manage the Apigee Emulator as described in the following sections. See also Exploring the Apigee Emulator.
Installing the Apigee Emulator
To install the Apigee Emulator:
Expand the Apigee Emulators section in the left pane.
Position your cursor over the Apigee Emulator that you want to install.
Click
.
You are prompted to configure the Apigee Emulator container.
Enter a unique name for the Apigee Emulator container and press Enter.
Enter alphanumeric characters, dashes (-), or underscores (_).Enter a unique numeric value to use as the control port for the Apigee Emulator container and press Enter. The control port defaults to
8080
.
Enter a unique numeric value to use as the traffic port for the Apigee Emulator container and press Enter.
The traffic port defaults to8998
.
The latest image of the Apigee Emulator is installed. After the installation completes, the following message displays, Emulator installed successfully
, and the Apigee Emulator container status changes to Ready.
Adding a container for the Apigee Emulator
To add a container for the Apigee Emulator using the UI:
Expand the Apigee Emulators section in the left pane.
Position your cursor over the Apigee Emulator for which you want to add a container.
Click +. You are prompted to configure the container.
Enter the numeric value to use as the control port for the Apigee Emulator container and press Enter.
The control port must be unique across containers. It defaults to8080
.Enter the numeric value to use as the traffic port for the Apigee Emulator container and press Enter.
The traffic port must be unique across containers. It defaults to8998
.Enter a unique name for the Apigee Emulator container and press Enter. Enter alphanumeric characters, dashes (-), or underscores (_).
The container is added.
Viewing status information for the Apigee Emulator
View status information for the Apigee Emulator as described in the following sections.
Using the UI
To view status information for the Apigee Emulator including its Docker and Runtime information, expand the container in the Apigee Emulators section.
Using the Docker CLI
To view container status information for the Apigee Emulator and its configured ports, run docker ps
in the Terminal tab. The following provides an example of the response:
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 33756b8c5c5b ...apigee-emulator:1.6.1 "/usr/bin…" 10 hours ago Up 10 hours 7000-7001/tcp, 0.0.0.0:8080->8080/tcp... apigee-emulator
Starting the Apigee Emulator
Start the Apigee Emulator as described in the following sections.
Using the UI
To start the Apigee Emulator, position your cursor over the Apigee Emulator container that you want to start and click .
Using the Docker CLI
To start the Apigee Emulator, run docker start apigee-emulator
in the Terminal tab.
The status set to Ready
:
Resetting the Apigee Emulator
Reset the Apigee Emulator to remove all deployments and exported test resources as described in the following sections.
Using the UI
To reset the Apigee Emulator, position your cursor over the Apigee Emulator container in the Apigee Emulators section and click .
Using the Docker CLI
To reset the Apigee Emulator, run docker reset apigee-emulator
in the Terminal tab.
The Apigee Emulator is reset and the status is set to Ready
:
The following information is displayed in the Output tab:
Resetting the Apigee Emulator Reset completed
Restarting the Apigee Emulator
To restart the Apigee Emulator, run docker restart container-name
in the Terminal tab.
For example: docker restart MyContainer
The following provides an example of the response: MyContainer
Updating the Apigee Emulator
If the Apigee Emulator is out of sync with the latest version, you can update your installed version using the UI or Docker CLI, as described in the following sections.
Using the UI
To update the Apigee Emulator, position your cursor over the Apigee Emulator in the Apigee Emulators section and click
.
Using the Docker CLI
To update the Apigee Emulator, run the following Docker commands in the Terminal tab:
* Run docker ps
to obtain the image name.
For example: gcr.io/apigee-release/hybrid/apigee-emulator:1.6.1
* Run docker pull imagename
to update the Apigee Emulator installation image.
For example: docker pull gcr.io/apigee-release/hybrid/apigee-emulator:1.6.1
The Apigee Emulator is updated and the following message is displayed: Emulator version is up to date
Stopping the Apigee Emulator
Stop the Apigee Emulator using the UI or Docker CLI as described in the following sections.
Using the UI
To stop the Apigee Emulator, position your cursor over the Apigee Emulator container in the Apigee Emulators section and click .
Using the Docker CLI
To stop the Apigee Emulator, run docker stop apigee-emulator
in the Terminal tab.
The Apigee Emulator is stopped and the status is changed to Not running
:
Deleting a container for the Apigee Emulator
Delete a container for the Apigee Emulator using the UI or Docker CL as described in the following sections.
Using the UI
To delete the Apigee Emulator, position your cursor over the Apigee Emulator container in the Apigee Emulators section and click .
Using the Docker CLI
To delete a container for the Apigee Emulator, run the following Docker commands in the Terminal tab:
Run
docker stop container
to stop the Apigee Emulator installation image (if it's not already stopped).
For example:docker stop MyContainer
Run
docker rm container
to stop the Apigee Emulator installation image.
For example:docker rm MyContainer
The container is deleted.
Refreshing the Apigee Emulator view
Refresh the Apigee Emulator view to synchronize any recent changes.
To refresh the Apigee Emulator view, position your cursor over the Apigee Emulators title bar and click .