APIrator

API Mocks for developers made easy!

Development Instructions

Build

We are using operator-sdk to manage our lifecycle, you should have the operator-sdk installed. On the root folder you can use the following command to build and create the docker image

operator-sdk build apirator/apirator

Deploy

These instructions should be user for development purpose, for production usage we recommend you to use apirator-ops repository that contains our helm installation.

CRD (Custom Resource Definition)

There is a simple custom resource definition that define our main object a Open API Specification object. To install it on kubernetes you should execute the following command

kubectl apply -f <YOUR_GOLANG_PROJECT_FOLDER>/apirator/deploy/crds/apirator.io_apimocks_crd.yaml -n oas

Deployment

You should deploy the files located on /deploy folder. There are files about ServiceAccount, RoleBindings, Roles and deployment.yaml. The apirator is a simple pod that implemented following the operator pattern.

To deploy the apirator you should execute the following command

kubectl apply -f <YOUR_GOLANG_PROJECT_FOLDER>/apirator/deploy/operator.yaml -n oas

References:

You can find more instructions about operator-sdk command line here

License