"Ostia" Project main repository

Ostia aims to be an openshift native API Management software.

This is a not supported/official redhat product.

Deployment

• To learn how to deploy openshift locally:

https://github.com/openshift/origin/blob/master/docs/cluster_up_down.md

• Clone the repo:

git clone https://github.com/3scale/ostia.git
cd ostia

• At the cluster scope, create the Custom Resource Definition (requires cluster-admin role):

oc login -u system:admin
oc create -f ostia-operator/deploy/crd.yaml

• Create the RBAC (requires cluster-admin role). Deploy the operator into the namespace where you wish to manage your API:

oc new-project my-hello-api
oc create -f ostia-operator/deploy/rbac.yaml
oc create -f ostia-operator/deploy/operator.yaml

• Within the same namespace as the operator, deploy the example Custom Resource:

oc create -f ostia-operator/deploy/cr.yaml -n my-hello-api

Build

• Prerequisites:

  • Go
  • Go Dep (https://github.com/golang/dep)
  • Operator-SDK (https://github.com/operator-framework/operator-sdk)
  • Docker

• Using homebrew (macOS)

Run brew bundle in the project root to install all dependencies by homebrew.

• Installing Go:

Please refer to the official docs: https://golang.org/doc/install

• Installing Go Dep:

Mac:

brew install dep

Other Platforms:

curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh

• Get the Ostia code

go get github.com/3scale/ostia

• Run dep ensure

cd ${GOPATH}/src/github.com/3scale/ostia/ostia-operator
dep ensure -v

• Install operator-framework from vendored sources

go install ./vendor/github.com/operator-framework/operator-sdk/commands/operator-sdk

Make sure ${GOPATH}/bin is added to your PATH

• Build

make build

• Push

make push

Testing

The ostia-operator project is configured to use circleci and there are a number of integration tests which will run when a pull request is triggered against this repository.

Tests can be run locally but expect a running an accessible OpenShift cluster with an nip.io hostname. Tests must be run by a user with an admin or cluster-admin role.

Run integration tests via make integration which accepts an optional argument:

1. OPENSHIFT_PUBLIC_HOSTNAME. The public hostname for OpenShift cluster. Default 127.0.0.1

At the start pf each test run, existing tests projects are marked for deletion. This can also be done manually by running make clean_integration.

The same tests are run against the circleci build server but because of the executor type required, cannot be executed locally via circleci build.