https://github.com/epinio/epinio
Opinionated platform that runs on Kubernetes, that takes you from App to URL in one step.
https://github.com/epinio/epinio
hacktoberfest kubernetes paas
Last synced: 3 months ago
JSON representation
Opinionated platform that runs on Kubernetes, that takes you from App to URL in one step.
- Host: GitHub
- URL: https://github.com/epinio/epinio
- Owner: epinio
- License: apache-2.0
- Created: 2020-11-09T22:51:28.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2026-03-30T06:06:43.000Z (3 months ago)
- Last Synced: 2026-03-30T08:26:15.198Z (3 months ago)
- Topics: hacktoberfest, kubernetes, paas
- Language: Go
- Homepage: https://epinio.io
- Size: 22.4 MB
- Stars: 585
- Watchers: 22
- Forks: 64
- Open Issues: 60
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Epinio
Opinionated platform that runs on Kubernetes to take you from Code to URL in one step.
[](https://pkg.go.dev/github.com/epinio/epinio/internal/api/v1)
[](https://goreportcard.com/report/github.com/epinio/epinio)
[](https://github.com/epinio/epinio/actions/workflows/main.yml)
[](https://github.com/epinio/epinio/actions/workflows/golangci-lint.yml)
[](https://github.com/epinio/epinio/actions/workflows/aks.yml)
[](https://github.com/epinio/epinio/actions/workflows/eks.yml)
[](https://github.com/epinio/epinio/actions/workflows/gke.yml)
[](https://github.com/epinio/epinio/actions/workflows/rke.yml)
[](https://github.com/epinio/epinio/actions/workflows/rke2-lh-ec2.yml)
[](https://github.com/epinio/epinio/actions/workflows/aks-letsencrypt.yml)
[](https://github.com/epinio/epinio/actions/workflows/gke-letsencrypt.yml)
[](https://github.com/epinio/epinio/actions/workflows/rke-upgrade.yml)
## What problem does Epinio solve?
Epinio makes it easy for developers to develop their applications running in Kubernetes clusters. Easy means:
- No experience with Kubernetes is needed
- No steep learning curve
- Quick local setup with minimal configuration
- Deploying to production the same as deploying in development
[Kubernetes](https://kubernetes.io/) is the standard for container orchestration.
Developers may want to use Kubernetes for its benefits or because their Ops team has chosen it.
In either case, working with Kubernetes can be complex depending on the environment.
It has a steep learning curve and doing it right is a full-time job.
Developers should spend their time working on their applications, not doing operations.
Epinio adds the needed abstractions and tools to allow developers to use Kubernetes as a [PaaS](https://en.wikipedia.org/wiki/Platform_as_a_service).
## Documentation
Documentation is available at [docs.epinio.io](https://docs.epinio.io/).
### Installation
Requires a Kubernetes cluster, an Ingress Controller and a Cert Manager as explained in the [installation](https://docs.epinio.io/installation/install_epinio) documentation.
Once this is in place, and leaving out DNS setup, an installation reduces to:
```
helm repo add epinio https://epinio.github.io/helm-charts
helm repo update
helm install --namespace epinio --create-namespace epinio epinio/epinio \
--set global.domain=mydomain.example.com
```
### CLI installation
Installation of the Epinio CLI is by downloading a binary from the
[release page](https://github.com/epinio/epinio/releases), or usage of `brew`, i.e.
```
brew install epinio
```
There is further documentation [here](https://docs.epinio.io/installation/install_epinio_cli).
### Quick Start Tutorial
Our [QuickStart Tutorial](https://docs.epinio.io/tutorials/quickstart) works through how to create a namespace and push an application.
### Reach Us
- Slack: #epinio on [Rancher Users](https://rancher-users.slack.com/)
- Github: [Discuss](https://github.com/epinio/epinio/discussions/new)
### Contributing
`Epinio` uses [Github Project](https://github.com/epinio/epinio/projects/1) for tracking issues.
Find more information in the [Contribution Guide](./CONTRIBUTING.md).
The [developer documentation](./docs) explains how to build and run Epinio from a git source checkout.
## Features
- **Security**
- TLS secured API server
- Basic Authentication to access the API
- __or__ OIDC-based token
- **Epinio Clients**
- Web UI
- Epinio CLI
- **Apps**
- Push code directly without further tools or steps
- Basic operation of your application once pushed
- Cloud Native Buildpacks build and containerize your code for you
- **Configurations**
- CRUD operations on your configuration. A configuration can be a database, SaaS etc. A configuration can be an external component or can be created using `epinio configuration`.
- Bind configurations to apps.
## Example apps
- Rails: https://github.com/epinio/example-rails
- Java: https://github.com/spring-projects/spring-petclinic/
- Paketo Buildpack example apps: https://github.com/paketo-buildpacks/samples
## License
Copyright (c) 2020-2023 [SUSE, LLC](https://suse.com)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
## Breaking Changes & Migrations
### 1.12 to 1.13
Epinio 1.13 rehomes configurations for the staging workloads to a more standardized format that supports a larger variety of configs. These are no longer configured directly on the Epinio container via ENV variables or through Viper CLI flags but rather read from an in-cluster ConfigMap at staging time.
To summarize, version 1.12 referenced the following ENV variables:
```bash
STAGING_SERVICE_ACCOUNT_NAME
STAGING_RESOURCE_CPU
STAGING_RESOURCE_MEMORY
STAGING_RESOURCE_DISK
```
These ENV variables were configured directly by the Helm Chart in the deployment's `env` section. This is no longer the case as we push in the direction of improving configurability of these staging workloads. These configurations are now more expansive, including resource requests vs. limits, node tolerations, affinity criteria, etc. And as such, the ENV approach to this would become unruly as capabilities grew. Instead, we are conforming more closely to how Kubernetes would structure these configs directly in the Job YAML. These configurations are now read in from chart values into the stage script ConfigMaps. The contents of this ConfigMap, as far as the Epinio Server is concerned, would resemble the following (with examples):
```yaml
serviceAccountName: "epinio-server"
ttlSecondsAfterFinished: 300
resources:
requests:
cpu: "200m"
memory: "1Gi"
# limits:
# cpu: ""
# memory: ""
storage:
cache:
emptyDir: false
size: 1Gi
storageClassName: ""
volumeMode: Filesystem
accessModes:
- ReadWriteOnce
sourceBlobs:
emptyDir: true
# size: 1Gi
# storageClassName: ""
# volumeMode: Filesystem
# accessModes:
# - ReadWriteOnce
nodeSelector: {}
# kubernetes.io/os: linux
affinity: {}
# nodeAffinity:
# requiredDuringSchedulingIgnoredDuringExecution:
# nodeSelectorTerms:
# - matchExpressions:
# - key: kubernetes.io/os
# operator: In
# values:
# - linux
tolerations: []
# - key: "kubernetes.io/os"
# operator: "Equal"
# value: "linux"
# effect: "NoSchedule"
```