Ocopea is a Kubernetes extension allowing developers to take application copies of their deployments.
Ocopea Kubernetes extension simplifies the development process of complex multi-microservice apps in multi-cluster environments. Untangling the complexity of orchestrating the restoration of production copies for debugging and automated tests are two of the most common tasks our rich API and UI offers.
Learn More
All you'll have to do in order to start using Ocopea is clone this repo under your GOPATH and start playing.
$ cd $GOPATH/src
$ mkdir ocopea
$ cd ocopea
$ git clone https://github.com/ocopea/kubernetes.git
Deploying Ocopea site on your Kubernetes cluster is as simple as running one command. For simplicity, we recommend using kubectl proxy instead of passing API info for Ocopea.
$ kubectl proxy -p 8080
When deploying to an on premises cluster (local deployment), pass the Kubernetes cluster IP as the local-cluster-ip
Use the site-name flag to name the site (e.g. "Durham datacenter");
otherwise, the cluster IP will be used to identify the site.
$ cd deployer
$ go run deployer.go deploy-site -local-cluster-ip={k8s cluster ip} [-site-name={your site name}]
When deploying to a public cloud cluster (e.g. GCE, AWS), use the deployment-type flag with the cloud of choice.
It is recommended to set the site-name flag to match the cluster name in the cloud platform
(e.g. gcloud cluster name).
$ cd deployer
$ go run deployer.go deploy-site -deployment-type=gce -user={...} -password={...} -site-name=europe-west2-c1
The easiest way to explore Ocopea on your laptop is by using minikube.
A minikube deployment is no different than other local clusters.
$ minikube start
$ kubectl proxy -p 8080
$ cd deployer
$ go run deployer.go deploy-site -local-cluster-ip=$(minikube ip)
Once the site has been deployed successfully, the deployer prints the Hub webapp URL.
To login use the default user admin with password nazgul.
Use the -cleanup=true flag if you wish to redeploy to the same site.
The Ocopea site requires a postgres service in order to store it's own metadata. the deploy-site command will deploy
a postgres service within the same kubernetes namespace ocopea site is being deployed. In case you want Ocopea to use
a different postgres instance make sure you have a kubernetes Service in the target namespace for that postgres instance
and use the -custom-pg-service=[customPGServiceName] when running the deploy-site command
Every pull request must pass the full tests of this repository.
- All go code must be formatted with
gofmt - All repository tests must pass. See more information regarding how to run the tests here.