https://github.com/trendyol/kubernetes-operator-api

The Kubernetes API is a sample Kubernetes operator API using the Java Kubernetes Client. The API is designed for master-worker deployment to satisfy the requirements.
https://github.com/trendyol/kubernetes-operator-api

hexagonal-architecture java11 kubernetes kubernetes-client kubernetes-operator lombok rest-api spring-boot strategy-pattern swagger

Last synced: about 1 month ago
JSON representation

The Kubernetes API is a sample Kubernetes operator API using the Java Kubernetes Client. The API is designed for master-worker deployment to satisfy the requirements.

• Host: GitHub
• URL: https://github.com/trendyol/kubernetes-operator-api
• Owner: Trendyol
• License: mit
• Created: 2022-10-31T10:17:55.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-17T13:45:58.000Z (over 1 year ago)
• Last Synced: 2024-09-30T14:04:47.205Z (about 2 months ago)
• Topics: hexagonal-architecture, java11, kubernetes, kubernetes-client, kubernetes-operator, lombok, rest-api, spring-boot, strategy-pattern, swagger
• Language: Java
• Homepage:
• Size: 57.6 KB
• Stars: 16
• Watchers: 12
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Kubernetes Operator Api

The Kubernetes API is a sample Kubernetes operator API using the Java Kubernetes Client.


The API is designed for master-worker deployment to satisfy the requirements.

## Overview 

* The CI/CD tool we used before this API started to not be enough. 


  The reasons why it is not enough are: 

    - Deployments take too long to create, scale, and terminate.

    - In synchronous requests, some of the scenarios' statuses were pending or failed.

    - The pending scenarios could not be retried.

    - Rollbacks could not be performed automatically.

    - Since there was a strict structure to the deployment process, we could not do the business development at any stage.

  By using this API, above problems have been solved. You can use this API for such requirements. 


* In the resources folder of our application we have: 


  master-deployment.yaml, worker-deployment.yaml, master-service.yaml, master-service-ui.yaml   


  You must customize these files to suit you. This pattern __ was used in file reading operations. Let's not overlook it. 


  Note that you must use all four of these deployment yaml's. 


* The strategy pattern has been used so that the project can work with more than one data center. 


  You must define the data center strategy you want to use. After that, it will be enough to send it in the data_center field. 


The following are the flows that we have implemented in this project.

### Create deployment flow

      - Deploy master

      - Roll out status

      - Deploy worker

      - Roll out status

      - Create service

      - Create service ui 

      - Print pod status 

      - Retrieve service list

      - Print service status

### Scale deployment flow

      - Scale deployment

      - Roll out status

### Terminate deployment flow

      - Delete master deployment

      - Delete worker deployment

      - Delete master service

      - Delete master ui service

---

##### Tech Stack

- Java 11

- Spring Boot

- Kubernetes Client

##### Requirements

For building and running the application, you need:

- [JDK 11](https://www.oracle.com/java/technologies/javase-jdk11-downloads.html)

- [Maven](https://maven.apache.org)

- [Lombok](https://projectlombok.org/)

##### Build & Run

```

  mvn clean install 

  mvn --projects kubernetes-operator-api spring-boot:run

```

##### Port

```

  http://localhost:1234

```

##### License

Distributed under the MIT License. See [LICENSE](LICENSE) for more information.