Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apimatic/apimatic-kubernetes-operator
APIMatic API CodeGen operator for Kubernetes
https://github.com/apimatic/apimatic-kubernetes-operator
Last synced: 15 days ago
JSON representation
APIMatic API CodeGen operator for Kubernetes
- Host: GitHub
- URL: https://github.com/apimatic/apimatic-kubernetes-operator
- Owner: apimatic
- Created: 2021-08-10T07:28:22.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-08-27T09:47:50.000Z (about 3 years ago)
- Last Synced: 2024-06-21T16:54:18.156Z (5 months ago)
- Language: Go
- Size: 178 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Table of contents
* [Introduction](#introduction)
* [Features](#features)
* [Running the Sample](#running-the-sample)
* [Prerequisites](#prerequisites)
* [Steps for Direct Deployment](#steps-for-direct-deployment)
* [Steps for OLM Deployment](#steps-for-olm-deployment)
* [Technical Support](#technical-support)
* [Copyrights](#copyrights)
## Introduction
APIMatic Operator simplifies the configuration and lifecycle management of the APIMatic code and docs generation solution on different Kubernetes distributions and OpenShift. The Operator encapsulates key operational knowledge on how to configure and upgrade the APIMatic CodeGen application, making it easy to get up and running.
More information about the underlying APIMatic CodeGen API that is exposed
by this operator can be found [here](https://apimatic-core-v3-docs.netlify.app/#/http/getting-started/overview-apimatic-core).
## Features
APIMatic Operator provides the following features:
- Deploys the APIMatic CodeGen Web API service within the Kubernetes or OpenShift cluster.
- Exposes the APIMatic CodeGen API external to the cluster, using Service type as [NodePort](https://kubernetes.io/docs/concepts/services-networking/service/#nodeport), [LoadBalancer](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer) or [ExternalName](https://kubernetes.io/docs/concepts/services-networking/service/#externalname).
- For exposing the service through an ingress resource, create an Ingress resource in the namespace of your APIMatic CR and set owned APIMatic service created by the operator as a backed service. More information can be found [here](https://kubernetes.io/docs/concepts/services-networking/ingress/).
- Manual horizontal scaling of pods.
```sh
kubectl scale apm apimatic-sample--replicas=2
```
## Running the Sample
### Prerequisites
Please contact APIMatic at [[email protected]](mailto:[email protected]) to register with the APIMatic CodeGen Docker Hub registry and acquire a valid license to run the APIMatic CodeGen API.
Further prerequisites for running the sample include:
- [go](https://golang.org/) v1.16.*
- [git](https://git-scm.com/)
- [make](https://www.gnu.org/software/make/)
- [Operator SDK](https://sdk.operatorframework.io/docs/overview/)
- A running Kubernetes cluster with [kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) on client. For testing purposes, you can use [Minikube](https://minikube.sigs.k8s.io/docs/) or [kind](https://kind.sigs.k8s.io/)
- For checking the service created by the APIMatic operator on-prem, you can use [MetalLB](https://metallb.org/)
### Steps for Direct Deployment
To run the sample for checking the APIMatic operator:
- Clone the APIMatic repository into your working directory using the following command:
```sh
git clone https://github.com/apimatic/apimatic-kubernetes-operator.git
```
- Run `make deploy` to set up the APIMatic operator resources. This will deploy the '`apimatic-system`' namespace as well as the CRD and the RBAC manifests.
- Create a secret named '`apimaticimagesecret`' to allow pulling the APIMatic CodeGen image using the Docker Hub username registered with APIMatic. If you have not done so, please contact [email protected] for the steps required.
```sh
kubectl create secret docker-registry apimaticimagesecret --docker-server=https://index.docker.io/v1/ --docker-username= --docker-password= --docker-email=
```
- Create a [configmap](https://kubernetes.io/docs/concepts/configuration/configmap/) resource named '`apimaticlicense`' that will serve as the volume storing the APIMatic license. An example of this is given below which will create the ConfigMap using the *License.lic* file located at */usr/local/apimatic/license/*
```sh
kubectl create configmap apimaticlicense --from-file /usr/local/apimatic/license/License.lic
```
- This will deploy a ConfigMap resource with the following definition:
```sh
apiVersion: v1
data:
License.lic: \"\"
kind: ConfigMap
metadata:
name: apimaticlicense
namespace: default
```
- Now run the sample using the following command:
```sh
kubectl apply -f config/samples/apicodegen_v1beta1_apimatic.yaml
```
- You will now see a new [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) with replica count of 3 and [Service](https://kubernetes.io/docs/concepts/services-networking/service/) of type `NodePort` created, both named ***apimatic-sample***. Accessing http://localhost:32000 from your browser (or using curl from within the Minikube or Kind cluster, if using that) should now show the APIMatic Titan page.
- You can now use the exposed APIMatic CodeGen API to generate API SDKs and Docs using [curl](https://curl.se/), [Postman](https://www.postman.com/) or your own custom Web application that consumes the APIMatic CodeGen API service.
- Once done, you can remove the APIMatic resources using the following command:
```sh
make undeploy
```
### Steps for OLM Deployment
The following steps can be used to utilize [Operator LifeCycle Manager (OLM)](https://olm.operatorframework.io/docs/) to deploy the operator and run the sample. The steps are as follows:
- If not already done so, clone the APIMatic repository into your working directory:
```sh
git clone https://github.com/apimatic/apimatic-kubernetes-operator.git
```
- [Install OLM in your Kubernetes cluster](https://olm.operatorframework.io/docs/getting-started/#installing-olm-in-your-cluster).
- Run the following script to install the resources required by OLM to deploy the APIMatic operator in the Kubernetes cluster within the `apimatic-system` namespace. Information about the different resources required can be found using the steps given [here](https://olm.operatorframework.io/docs/tasks/).
```sh
kubectl apply -f olm/manifests.yaml
```
- This should spin up the `ClusterServiceVersion` of the operator in the `apimatic-system` namespace, following which the operator pod will spin up. To ensure the that the operator installed successfully, check for the `ClusterServiceVersion` and the operator deployment in the namespace it was installed in.
```sh
kubectl get csv -n apimatic-system
kubectl get deployment -n apimatic-system
```
- Create a secret named `apimaticimagesecret` to allow pulling the APIMatic CodeGen image using the Docker Hub username registered with APIMatic. If you have not done so, please contact [email protected] for the steps required.
```sh
kubectl create secret docker-registry apimaticimagesecret --docker-server=https://index.docker.io/v1/ --docker-username= --docker-password= --docker-email=
```
- Create a [configmap](https://kubernetes.io/docs/concepts/configuration/configmap/) resource named `apimaticlicense` that will serve as the volume storing the APIMatic license. An example of this is given below which will create the ConfigMap using the *License.lic* file located at */usr/local/apimatic/license/*
```sh
kubectl create configmap apimaticlicense --from-file /usr/local/apimatic/license/License.lic
```
- This will deploy a ConfigMap resource with the following definition:
```sh
apiVersion: v1
data:
License.lic: \"\"
kind: ConfigMap
metadata:
name: apimaticlicense
namespace: default
```
- Now run the sample using the following command:
```sh
kubectl apply -f config/samples/apicodegen_v1beta1_apimatic.yaml
```
- You will now see a new [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) with replica count of 3 and [Service](https://kubernetes.io/docs/concepts/services-networking/service/) of type `NodePort` created, both named ***apimatic-sample***. Accessing http://localhost:32000 from your browser (or using curl from within the Minikube or Kind cluster, if using that) should now show the APIMatic Titan page.
- You can now use the exposed APIMatic CodeGen API to generate API SDKs and Docs using [curl](https://curl.se/), [Postman](https://www.postman.com/) or your own custom Web application that consumes the APIMatic CodeGen API service.
- Once done, you can remove the APIMatic operator resources using the follow script:
```sh
kubectl delete -f olm/manifests.yaml
```
## Technical Support
- To request additional features in the future, or if you notice any discrepancy regarding this document, please drop an email to [[email protected]](mailto:[email protected]).
### Copyrights
© 2021 APIMatic.io