Chimp is the front facing component for our cloud solution. This project currently contains chimp's server (chimp-server) and our CLI (chimp).
The project is still in active development and we could introduce breaking changes. The master branch is still to be considered as "stable" and most breaking changes will be developed in short lived branches. NOTE: In the kurrent version, the kubernetes support is not working.
To build the source you need to have Go installed. You can install it in any way you like, we strongly suggest you to use version 1.5.X as this is our current target. Feel free to use any other version and report any possible bug.
You then need to configure Go:
#configure GOPATH
mkdir $HOME/go
export GOPATH=$HOME/go
export PATH=$PATH:$GOPATH/bin
Please remember that the exported variables will only be available for your current session. Add them to your bashrc/zshrc if you want to make them persistent.
The source code of this repository must be put in the $GOPATH/src folder.
This can be done with the following commands:
mkdir -p $GOPATH/src/github.com/zalando-techmonkeys/
cd $GOPATH/src/github.com/zalando-techmonkeys/
git clone REPO_URL
cd chimp
Install godep for dependency management.
#install godep if you don't have it
go get github.com/tools/godep
#install required dependencies
godep restore
#install to $GOBIN
godep go install github.com/zalando-techmonkeys/chimp/...
#for tagging the build, both server and cli:
godep go install -ldflags "-X main.Buildstamp=`date -u '+%Y-%m-%d_%I:%M:%S%p'` -X main.Githash=`git rev-parse HEAD`" github.com/zalando-techmonkeys/chimp/...
To choose a backend (marathon is the only one supported), put a yaml configuration file named config.yaml into: /etc/chimp-server/ or $HOME/.config/chimp-server/. The endpoint of the chosen backend system is also specified in the config.yaml file. Please refer to the example for the supported options.
Once chimp is installed, the API server can be simply run as:
# run service
chimp -logtostderr -debug
The cli allows you to do four operations:
- LOGIN: used to get a valid OAuth2 token
- CREATE: used to deploy an application
- DELETE: used to stop a running application
- INFO: used to get info for a particular application
- LIST: to list all the apps running on the cluster
- SCALE: to scale the application to a number of instances
Install godep for dependency management.
#install godep if you don't have it
go get github.com/tools/godep
#install required dependencies
godep restore
#install to $GOBIN
godep go install github.com/zalando-techmonkeys/chimp/...
#for tagging the build, both server and cli:
godep go install -ldflags "-X main.Buildstamp=`date -u '+%Y-%m-%d_%I:%M:%S%p'` -X main.Githash=`git rev-parse HEAD`" github.com/zalando-techmonkeys/chimp/...
To setup the chimp cli put a yaml configuration file named config.yaml into: /etc/chimp/ or $HOME/.config/chimp/ In docs/configurations/chimp/config.yaml you can find an example of such a file where you can set the server and the port to be used to communicate with chimp's server. Please note that command arguments to chimp command line will override the configuration set in the config.yaml file.
Be sure to use the right parameters that can be checked with chimp --help.
You can use chimp login to obtain a valid token for the built-in OAuth2 support. Please note that this is not required if the server is not configured to use OAuth2.
#this will ask your for your password
chimp login USERNAME
Please populate the svcport with the port you want to expose for your application and the name for the name of your app. Names must be exclusive for now.
# example params --url=pierone.stups.zalan.do/cat/cat-hello-aws:0.0.1 --name=test
chimp create YOURAPPNAME YOUR_PIERONE_URL --port=YOUR_PORT --cpu=NUM_CORES --memory=MEMORY --http-only --reqserver=localhost --reqport=8080
Create also supports a --file option that allow you to pass the parameters in a yaml file. The option require you to provide the full path for the file.
The following is an example file:
---
name: cat-2
imageURL: pierone.stups.zalan.do/cat/cat-hello-aws:0.0.1
replicas: 7
ports:
- 8080
labels:
k: v
k1: v1
env:
k: v
k2: v2
CPULimit: 3
MemoryLimit: 3000
force: true
chimp delete YOUR_APP_NAME
chimp info YOUR_APP_NAME
Lists all the applications for your team (when OAuth2 is on). It has a --all option that can be used to get the full list of every application
chimp list
chimp scale YOUR_APP_NAME NUMBER_OF_REPLICAS
- Issues: Just create issues on github
- Enhancements/Bugfixes: Pull requests are welcome
- get in contact: [email protected]
- see MAINTAINERS file.
See LICENSE file.