Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luizalabs/teresa
Open source tool to deploy apps to Kubernetes clusters
https://github.com/luizalabs/teresa
go hacktoberfest kubernetes paas
Last synced: about 2 months ago
JSON representation
Open source tool to deploy apps to Kubernetes clusters
- Host: GitHub
- URL: https://github.com/luizalabs/teresa
- Owner: luizalabs
- License: other
- Created: 2011-11-28T19:44:45.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2023-02-25T02:14:13.000Z (almost 2 years ago)
- Last Synced: 2024-10-29T16:20:16.052Z (about 2 months ago)
- Topics: go, hacktoberfest, kubernetes, paas
- Language: Go
- Homepage:
- Size: 34.1 MB
- Stars: 556
- Watchers: 27
- Forks: 77
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-made-by-brazilians - teresa
README
# Teresa
[](https://github.com/luizalabs/teresa/releases/latest)
[](/LICENSE.md)
[](https://travis-ci.org/luizalabs/teresa)
[![codecov](https://img.shields.io/codecov/c/github/luizalabs/teresa/master.svg?style=flat-square")](https://codecov.io/gh/luizalabs/teresa)
[](https://goreportcard.com/report/github.com/luizalabs/teresa)
Teresa is an extremely simple platform as a service that runs on top of [Kubernetes](https://github.com/kubernetes/kubernetes).
It uses a client-server model: the client sends high level commands (create application, deploy, etc.) to the server, which translates them to the Kubernetes API.
## Client Installation
### Download (recommended)
This is the best way to get the latest release.
- Access https://github.com/luizalabs/teresa/releases
- Download the latest release for your OS. Eg: `teresa-linux-amd64`
- Rename the download file to `teresa`. Eg: `mv teresa-linux-amd64 teresa`
- Make it an executable. Eg: `chmod +x teresa`
- Move it to the `bin` folder. Eg: `sudo mv teresa /usr/bin`
Then you're good to go :slightly_smiling_face: ! `teresa` should now be available to use on your terminal.
### Homebrew
Run the following in your command-line:
```sh
$ brew tap luizalabs/teresa-cli
$ brew install teresa
```
### Snap
Run the following in your command-line:
```sh
$ sudo snap install teresa-cli
```
## Server Installation
Server requirements:
- Kubernetes cluster (>= 1.9)
- database backend to store users and teams (SQLite or MySQL)
- storage for build artifacts (AWS S3 or minio)
- rsa keys for token signing
- (optional) TLS encryption key and certificate
The recommended installation method uses the [helm](https://github.com/kubernetes/helm) package manager,
for instance to install using S3 and MySQL (recommended):
$ openssl genrsa -out teresa.rsa
$ export TERESA_RSA_PRIVATE=`base64 -w0 teresa.rsa`
$ openssl rsa -in teresa.rsa -pubout > teresa.rsa.pub
$ export TERESA_RSA_PUBLIC=`base64 -w0 teresa.rsa.pub`
$ helm repo add luizalabs http://helm.k8s.magazineluiza.com
$ helm install luizalabs/teresa \
--namespace teresa \
--set rsa.private=$TERESA_RSA_PRIVATE \
--set rsa.public=$TERESA_RSA_PUBLIC \
--set aws.key.access=xxxxxxxx \
--set aws.key.secret=xxxxxxxx \
--set aws.region=us-east-1 \
--set aws.s3.bucket=teresa \
--set db.name=teresa \
--set db.hostname=dbhostname \
--set db.username=teresa \
--set db.password=xxxxxxxx \
--set rbac.enabled=true
Look [here](./helm/README.md) for more information about helm options.
You need to create an admin user to perform [user and team management](./FAQ.md#administration):
$ export POD_NAME=$(kubectl get pods -n teresa -l "app=teresa" -o jsonpath="{.items[0].metadata.name}")
$ kubectl exec $POD_NAME -it -n teresa -- ./teresa-server create-super-user --email [email protected] --password xxxxxxxx
## QuickStart
Read the first sections of the [FAQ](./FAQ.md).