Installation checklist
Follow the checklist to ensure that you have set up Swagger Contract Testing On-Premises properly.
1. Swagger Contract Testing On-Premises license file
The Contract Testing On-Premises version requires a license file to run. You have received this from the SmartBear team during the onboarding process. If not, please contact your Account Manager.
2. Run Docker Compose example
See the Docker Compose example.
3. Choose the domain name for your Swagger Contract Testing On-Premises application
For example: https://pactflow.mycompany.com
You need this for the next step.
4. Configure identity provider
Configure the Swagger Contract Testing On-Premises application in your identity provider. See the Azure Active Directory documentation.
5. Deploy Swagger Contract Testing On-Premises application stack
Configure the Contract Testing On-Premises Docker image to be pulled from Quay.
Use the environment variable templates to create the appropriate deployment configuration artifacts for the Contract Testing On-Premises Docker image (such as a CloudFormation template or a Helm chart).
Ensure the compute resources have the appropriate specifications.
Create a PostgreSQL database.
Set up a Redis cache.
Ensure you configured the network appropriately.
Ensure you forwarded the logs to a log aggregation service.
Ensure you mounted the license file into the running containers.
Ensure you have load-tested the system and that the system can handle your baseline load, and scale with increased demand.
6. Set up database cleaning
Set up database cleaning to ensure optimal PactFlow performance and reliability.
Caution
This step is mandatory.
Skipping the database cleaning can result in a gradual decline in system performance and, eventually, query timeouts and system failure.