ham-deployable-operator

README

Deployable Operator

Table of Contents generated with DocToc

• What is the Deployable Operator
• Community, discussion, contribution, and support
• Getting Started
  • Prerequisites
  • Quick Start
    • Clone Deployable Operator Repository
    • Build Deployable Operator
    • Install Deployable Operator
    • Uninstall Deployable Operator
  • Troubleshooting
• References

What is the Deployable Operator

The hybridDeployable resource is introduced to handle deployable components running on non-kubernetes platform(s). This operator is intended to work as part of collection of operators for the HybridApplication. See References for additional information.

Community, discussion, contribution and support

Check the CONTRIBUTING Doc for how to contribute to the repo.

---

Getting Started

Prerequisites

• git v2.18+
• Go v1.13.4+
• operator-sdk v0.17.0
• Kubernetes v1.14+
• kubectl v1.14+

Check the Development Doc for how to contribute to the repo.

Quick Start

Clone Deployable Operator Repository

$ mkdir -p "$GOPATH"/src/github.com/hybridapp-io
$ cd "$GOPATH"/src/github.com/hybridapp-io
$ git clone https://github.com/hybridapp-io/ham-deployable-operator.git
$ cd "$GOPATH"/src/github.com/hybridapp-io/ham-deployable-operator

Build Deployable Operator

Build the ham-deployable-operator and push it to a registry. Modify the example below to reference a container reposistory you have access to.

$ operator-sdk build quay.io/<user>/ham-deployable-operator:v0.1.0
$ sed -i 's|REPLACE_IMAGE|quay.io/johndoe/ham-deployable-operator:v0.1.0|g' deploy/operator.yaml
$ docker push quay.io/johndoe/ham-deployable-operator:v0.1.0

Install Deployable Operator

Register the CRD.

$ kubectl create -f deploy/crds

Setup RBAC and deploy.

$ kubectl create -f deploy

Verify ham-deployable-operator is up and running.

$ kubectl get deployment
NAME                        READY   UP-TO-DATE   AVAILABLE   AGE
ham-deployable-operator   1/1     1            1           2m20s

Create the sample CR.

$ kubectl create -f kubectl apply -f examples/simple/simple_deployable_cr.yaml
eployable.core.hybridapp.io/example-deployable created
$kubectl get hdpl
NAME                 AGE
example-deployable   17s

Uninstall Deployable Operator

Remove all resources created.

$ kubectl delete -f deploy
$ kubectl delete -f deploy/crds

Troubleshooting

Please refer to Troubleshooting documentation for further info.

References