Skip to content

Commit

Permalink
Update the README
Browse files Browse the repository at this point in the history
  • Loading branch information
azlyth committed May 30, 2024
1 parent 9e66ecb commit 574d393
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ helm-install-local:
--namespace snorlax

helm-install-remote:
helm repo add moonbeam-nyc https://moonbeam-nyc.github.io/helm-charts
helm repo add moonbeam https://moonbeam-nyc.github.io/helm-charts
helm repo update
helm install snorlax moonbeam-nyc/snorlax \
helm install snorlax moonbeam/snorlax \
--create-namespace \
--namespace snorlax

Expand Down Expand Up @@ -134,4 +134,4 @@ operator-bundle-push:
cd operator && make bundle-push BUNDLE_IMG=$(BUNDLE_IMG)

operator-bundle-deploy:
cd operator && operator-sdk run bundle $(BUNDLE_IMG)
cd operator && operator-sdk run bundle $(BUNDLE_IMG)
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

# 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 which wakes and sleeps another Kubernetes deployment on a schedule.
Snorlax is a Kubernetes operator which wakes and sleeps a Kubernetes deployment on a schedule.

And if a request is received when the deployment is sleeping, a cute sleeping Snorlax page is
served and the Kubernetes deployment is woken up. Once the service is ready, the page will auto-refresh.
Expand Down Expand Up @@ -81,7 +81,7 @@ hours each night and on weekends, that means they'll sleep ~55% of the month.
- create a Minikube cluster
- install the latest Helm release of `snorlax`
- deploy a dummy deployment, service, ingress, and sleep schedule
- In another terminal, run `minikube tunnel` to proxy `localhost` to your Minikube cluster ingress service.
- starts the minikube tunel to proxy `localhost` to your Minikube cluster ingress service (you'll need to enter your password)
- Go to [http://localhost](http://localhost) to see either the sleeping page or the dummy deployment (depending on the time of day).

You can also then try updating the sleep schedule with `kubectl edit sleepschedule dummy`.
Expand Down Expand Up @@ -111,6 +111,6 @@ make operator-run

Wondering how to best use Snorlax? Have questions or ideas for new features?

I'd love to hear, and maybe even build it! Reach out to me at:
I'd love to hear, and maybe even build them! Reach out to me at:
<img src="./proxy/static/readme-email-address.png" alt="Contact" width="300">
Binary file modified proxy/static/readme-email-address.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 574d393

Please sign in to comment.