YiannisGkoufas / noobaa-operator

Operator for NooBaa - object data service for hybrid and multi cloud environments :cloud: :wrench:

NooBaa Operator

NooBaa is an object data service for hybrid and multi cloud environments. NooBaa runs on kubernetes, provides an S3 object store service (and Lambda with bucket triggers) to clients both inside and outside the cluster, and uses storage resources from within or outside the cluster, with flexible placement policies to automate data use cases.

About NooBaa

Using the operator as CLI

• Download the compiled operator binary from the releases page

For Mac

brew install noobaa/noobaa/noobaa
# or
wget https://github.com/noobaa/noobaa-operator/releases/download/v2.0.9/noobaa-mac-v2.0.9; mv noobaa-mac-* noobaa; chmod +x noobaa

For Linux

wget https://github.com/noobaa/noobaa-operator/releases/download/v2.0.9/noobaa-linux-v2.0.9; mv noobaa-linux-* noobaa; chmod +x noobaa

• Run: ./noobaa --help for CLI usage
• Install the operator and noobaa with: ./noobaa install The install output includes S3 service endpoint and credentials, as well as web management console address with credentials.
• Getting this information is always available with: ./noobaa status
• Remove NooBaa deployment can be done with: ./noobaa uninstall

Troubleshooting

• The operator is running, but there is no noobaa-core-0 pod

  Make sure that there is a single default storage class with oc get sc. run oc describe sts for more information

• The operator is running, but the noobaa-core-0 is pending

  Verify that there are enough resources. run oc describe pod noobaa-core-0 for more information

Operator Design

CRDs

• NooBaa - The basic CRD to deploy a NooBaa system.
• BackingStore - Connection to cloud or local storage to use in policies.
• BucketClass - Policies applied to a class of buckets.

Applications

• OBC Provisioner - Method to claim a new/existing bucket.

Developing

• Fork and clone the repo: git clone https://github.com/<username>/noobaa-operator

• Use minikube: minikube start

• Use your package manager to install go and python3.

• Install operator-sdk For Mac:

   wget https://github.com/operator-framework/operator-sdk/releases/download/v0.13.0/operator-sdk-v0.13.0-x86_64-apple-darwin
   mv operator-sdk-v0.13.0-x86_64-apple-darwin /usr/local/bin/operator-sdk
   chmod +x /usr/local/bin/operator-sdk
   operator-sdk version
  
  

  For Linux:

    wget https://github.com/operator-framework/operator-sdk/releases/download/v0.13.0/operator-sdk-v0.13.0-x86_64-linux-gnu
    chmod +x operator-sdk-v0.13.0-x86_64-linux-gnu
    sudo mv operator-sdk-v0.13.0-x86_64-linux-gnu /usr/local/bin/operator-sdk
    operator-sdk version    

• Source the devenv into your shell: . devenv.sh
• Build the project: make
• Test with the alias nb that runs the local operator from build/_output/bin (alias created by devenv)
• Install the operator and create the system with: nb install