Git Product home page Git Product logo

olm-bundle's Introduction

OLM Bundle

This tool can be used to produce an Operator Lifecycle Manager bundle from a stream of YAMLs. You can additionally add metadata by using a Helm Chart.yaml file.

Example:

helm template <chart> | \
olm-bundle \
  --chart-file-path <chart>/Chart.yaml \
  --extra-resources-dir <folder containing extra YAMLs> \
  --output-dir <where to write the output>

You can use base template for the generated ClusterServiceVersion by having clusterserviceversion.yaml.tmpl in the given output directory. Following is an example:

apiVersion: v1alpha1
kind: ClusterServiceVersion
metadata:
  creationTimestamp: null
spec:
  minKubeVersion: 1.16.0
  maturity: stable
  installModes:
    - supported: false
      type: OwnNamespace
    - supported: false
      type: SingleNamespace
    - supported: false
      type: MultiNamespace
    - supported: true
      type: AllNamespaces

Similarly, you can have annotations.yaml.tmpl in the output directory to have it used as base. Following is an example:

annotations:
  operators.operatorframework.io.bundle.mediatype.v1: "registry+v1"
  operators.operatorframework.io.bundle.manifests.v1: "manifests/"
  operators.operatorframework.io.bundle.metadata.v1: "metadata/"
  operators.operatorframework.io.bundle.package.v1: "test-operator"
  operators.operatorframework.io.bundle.channels.v1: "beta,stable"
  operators.operatorframework.io.bundle.channel.default.v1: "stable"

Tool also supports artifacthub.io/* metadata in Chart.yaml provided as annotations. In case there is a conflict of metadata coming from directory scan and metadata that are explicitly mentioned in Chart.yaml, this can be controlled by using --helm-chart-overrides switch.

olm-bundle's People

Contributors

muvaf avatar k0da avatar hasheddan avatar jkremser avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.