Getting Started with the Developer Plugin
This page is a step-by-step tutorial on how to install and start from scratch with the Gateway Developer Plugin.
When you've successfully completed the following exercises with the reference implementations, you should have a solid understanding of how to set up your own GitOps-oriented developer environments for your Gateway solutions. More importantly, you'll have a solid solution-building foundation for an Ephemeral Gateway.
The following are the main objectives of this getting started guide.
Export a policy from an existing API Gateway
Build a package from the policy
Deploy an API Gateway container with the package
Docker is installed
An existing Gateway license. For information on getting a license see the License Section from the Gateway Container readme.
A running Gateway with a policy to export. You can either use your own existing Gateway or to follow the walkthrough, boot up our demo Container Gateway. To boot up the demo Gateway, fork the Demo Gateway and follow the instructions provided below:
Open up a terminal and go to the
Place an existing Gateway license as
Execute the following commands
$ ./gradlew clean build $ docker-compose up --force-recreate
NOTE: The IP address of this Gateway is https://localhost:18443
Single-Module Developer Repository
To get familiar with working with the Gateway Developer plugin, start with a single-module Gateway solution.
Start by forking the Gateway Developer Skeleton Repository (Single-Module).
Next, follow the instructions in the Getting Started with the Gateway Developer Repository wiki page.
Multi-Module Developer Repository
After getting comfortable with the single-module Gateway solution setup, you may try a multi-module Gateway solution (i.e., uses a multiple folder structure rather than a single folder) with the same developer plugin.
Next, follow the instructions in the Getting Started with the Multiple Module Gateway Developer Repository wiki page.
Ephemeral Gateway Developer Repository (CI/CD Workflow)
For more advanced usages such as integrating the developer plugin with the runtime environment, use the Ephemeral Gateway Developer Repository instead. This repository is a superset of the single-module repository, containing required files and configurations for connectivity to Jenkins.
Fork the Ephemeral Gateway Repository.
Then, follow the instructions in the Getting Started with the Gateway Developer Repository wiki page and then proceed with the next set of instructions in the Getting Started with Runtime wiki page.