Skip to content

Commit

Permalink
Update the project description
Browse files Browse the repository at this point in the history
  • Loading branch information
@azlyth
azlyth committed Jun 4, 2024
1 parent 7cb3db3 commit 46b442e
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,11 @@

# Snorlax · [![Build Docker image](https://github.com/moonbeam-nyc/snorlax/actions/workflows/build-docker-image.yaml/badge.svg)](https://github.com/moonbeam-nyc/snorlax/actions/workflows/build-docker-image.yaml)

Snorlax is a Kubernetes operator that wakes and sleeps a set of Kubernetes deployments on a schedule.
**Snorlax** is a Kubernetes operator that wakes and sleeps a specified set of Kubernetes deployments on a schedule.

If you specify ingresses, they are updated to serve a wake proxy which serves a "sleeping" splash page and wakes the deployments up.
You can also specify ingresses which will be updated to point to a **wake proxy** when asleep. This **serves a "sleeping" splash page and wakes the deployments up**.
Once the deployments are ready, the ingresses are restored and the splash page will auto-refresh.

You create `SleepSchedule` resources to define the schedule for deployments (and optionally their respective ingresses).


## Why Snorlax?

Expand Down

0 comments on commit 46b442e

Please sign in to comment.