https://github.com/apimatic/apimatic-codegen-operator

RedHat OpenShift Certified Kubernetes Operator for deploying APIMatic CodeGen to Kubernetes and RedHat OpenShift clusters
https://github.com/apimatic/apimatic-codegen-operator

Last synced: 15 days ago
JSON representation

RedHat OpenShift Certified Kubernetes Operator for deploying APIMatic CodeGen to Kubernetes and RedHat OpenShift clusters

• Host: GitHub
• URL: https://github.com/apimatic/apimatic-codegen-operator
• Owner: apimatic
• Created: 2022-05-31T08:23:18.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-07T11:40:44.000Z (about 2 years ago)
• Last Synced: 2024-06-20T21:13:51.084Z (5 months ago)
• Language: Go
• Size: 110 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: licenses/license.txt

Awesome Lists containing this project

README

        
## Table of contents

* [Introduction](#introduction)

* [Features](#features)

* [Working Example](#working-example)

* [Technical Support](#technical-support)

* [Copyrights](#copyrights)

## Introduction

APIMatic CodeGen Operator simplifies the configuration and lifecycle management of the APIMatic CodeGen SDKs, Docs and DX Portal 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 it 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 CodeGen 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).

- 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 cgn codegen-sample --replicas=2

  ```

## Working Example

A complete example using APIMatic CodeGen Operator in your OpenShift environment can be found [here](https://github.com/apimatic/apimatic-codegen-openshift-pipelines-demo).

## 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

© 2022 APIMatic.io