hybriddeployable-operator

module
v0.0.0-...-2a63d36 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 24, 2020 License: Apache-2.0

README

HybridDeployable Operator

Build GoDoc Go Report Card Code Coverage License Container

Table of Contents generated with DocToc

What is the HybridDeployable 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.15.1
  • Kubernetes v1.14+
  • kubectl v1.14+

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

Quick Start
Clone HybridDeployable Operator Repository
$ mkdir -p "$GOPATH"/src/github.com/IBM
$ cd "$GOPATH"/src/github.com/IBM
$ git clone https://github.com/IBM/hybriddeployable-operator.git
$ cd "$GOPATH"/src/github.com/IBM/hybriddeployable-operator
Build HybridDeployable Operator

Build the hybriddeployable-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>/hybriddeployable-operator:v0.1.0
$ sed -i 's|REPLACE_IMAGE|quay.io/johndoe/hybriddeployable-operator:v0.1.0|g' deploy/operator.yaml
$ docker push quay.io/johndoe/hybriddeployable-operator:v0.1.0
Install HybridDeployable Operator

Register the CRD.

$ kubectl create -f deploy/crds/app.cp4mcm.ibm.com_hybriddeployables_crd.yaml

Setup RBAC and deploy.

$ kubectl create -f deploy/service_account.yaml
$ kubectl create -f deploy/role.yaml
$ kubectl create -f deploy/role_binding.yaml
$ kubectl create -f deploy/operator.yaml

Verify hybriddeployable-operator is up and running.

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

Create the sample CR.

$ kubectl create -f deploy/crds/app.cp4mcm.ibm.com_hybriddeployables_cr.yaml
NAME                        READY   UP-TO-DATE   AVAILABLE   AGE
hybriddeployable-operator   1/1     1            1           2m20s
$ kubectl get hybriddeployables
NAME     AGE
simple   11s
Uninstall HybridDeployable Operator

Remove all resources created.

$ kubectl delete -f deploy
$ kubectl delete -f deploy/crds/app.cp4mcm.ibm.com_hybriddeployables_crd.yaml
Troubleshooting

Please refer to Troubleshooting documentation for further info.

References

Directories

Path Synopsis
cmd
pkg
apis/app
Package app contains app API versions.
Package app contains app API versions.
apis/app/v1alpha1
Package v1alpha1 contains API Schema definitions for the app v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=app.cp4mcm.ibm.com Package v1alpha1 contains API Schema definitions for the app v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=app.cp4mcm.ibm.com
Package v1alpha1 contains API Schema definitions for the app v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=app.cp4mcm.ibm.com Package v1alpha1 contains API Schema definitions for the app v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=app.cp4mcm.ibm.com

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL