Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/AxaFrance/dailyclean

Save The planet by auto turn off your pods on kubernetes
https://github.com/AxaFrance/dailyclean

guildevopen

Last synced: 4 months ago
JSON representation

Save The planet by auto turn off your pods on kubernetes

Host: GitHub
URL: https://github.com/AxaFrance/dailyclean
Owner: AxaFrance
License: mit
Created: 2021-12-02T14:12:09.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-03-06T15:38:48.000Z (9 months ago)
Last Synced: 2024-06-22T10:40:16.589Z (6 months ago)
Topics: guildevopen
Language: Java
Homepage:
Size: 8.16 MB
Stars: 93
Watchers: 6
Forks: 7
Open Issues: 15
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # DailyClean

![workflow](https://github.com/AxaGuilDEv/dailyclean/actions/workflows/dailyclean-docker-images.yml/badge.svg) [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=AxaGuilDEv_dailyclean&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=AxaGuilDEv_dailyclean) [![Docker API](https://img.shields.io/docker/pulls/axaguildev/dailyclean-api.svg)](https://hub.docker.com/r/axaguildev/dailyclean-api/builds) [![Docker JOB](https://img.shields.io/docker/pulls/axaguildev/dailyclean-job.svg)](https://hub.docker.com/r/axaguildev/dailyclean-job/builds)

![DailyClean](./dailyclean.gif "DailyClean")

- [About](#about)

- [Getting Started](#getting-started)

- [How Does It Work](#how-does-it-work)

- [Contribute](#contribute)

- [Authors](#authors)

## About

Daily clean is all you to turn on or off automatically or manually all your pods your kubernetes namespace.

Save the planet with DailyClean.

Daily clean only use kubernetes native API.

![DailyClean Automation](./dailyclean-configuration.png "DailyClean Automation")

## Getting Started

To test dailyclean on your local machine by using kubernetes with Docker Desktop, please use these commands:

```bash

git clone https://github.com/AxaGuilDEv/dailyclean.git

cd dailyclean/demo

kubectl create namespace license-preproduction

kubectl config set-context --current --namespace=license-preproduction

# Create a custom service account

kubectl apply -f dailyclean-serviceaccount.yml

# Install dailyclean for the dailyclean service account

kubectl apply -f deployment-dailyclean.yml

# Install three instances of kubernetes-bootcamp

kubectl apply -f deployment-others.yml

# Install MySql

kubectl apply -f deployment-mysql.yml

```

Now, open your favorite browser and enter the url of dailyclean-api service : http://localhost:30001

Enjoy dailyclean !!!!

## How Does It Work

- Daily clean use native kubernetes API, it works with any kubernetes projects. 

DailyClean is a pod that have to be install in your namespace. 

It create cron job that start or stop your pods. 

- API is in native GraalVM so it is lightweight.

- User interface is in React/Javascript.

you can use specific labels to configure DailyClean in your Kubernetes scripts:

```yaml

metadata:

  name: my-api

  labels:

    # if false, dailyclean will not stop this pod for deployment

    axa.com/dailyclean: 'false' 

    # WARNING: default value is true for DEPLOYMENT and false for STATEFULTSET

```

```yaml

metadata:

  name: fibonacci1

  labels:

    # if true, dailyclean web UI will consider this pod as a function

    axa.com/function: 'true' 

```

## Contribute

- [How to run the solution and to contribute](./CONTRIBUTING.md)

- [Please respect our code of conduct](./CODE_OF_CONDUCT.md)

## Authors

The awesome team :

- __[Thomas Lemarchand](https://github.com/tlemarchand)__ : Conception, Architecture, Dailyclean job developer

- __[Pierre-Henri Gache](https://github.com/phgache)__ : Architecture, CI/CD Pipelines

- __[Guillaume Thomas](https://github.com/guillaume-thomas)__ : API developer

- __[Guillaume Chervet](https://github.com/guillaume-chervet)__: Frontend developer, CI/CD Pipelines

- Charles Herriau: Developer of the statefulset management feature