Code Monkey home page Code Monkey logo

helm-chart's Introduction

Opsdroid Helm Chart

Build Status

Opsdroid is a ChatOps bot framework written in Python. This helm chart allows you to easily install opsdroid on a kubernetes cluster.

Chart Details

This chart will deploy the following:

  • 1 x Opsdroid bot
  • 1 x Rasa NLU instance (optional)

Installing the Chart

Add the opsdroid chart repo:

$ helm repo add opsdroid https://helm.opsdroid.dev/
$ helm repo update

To install the chart with the release name my-bot:

$ helm install --name my-bot opsdroid/opsdroid

Configuration

The following tables list the configurable parameters of the Opsdroid chart and their default values.

Opsdroid

Parameter Description Default
opsdroid.configuration The yaml configuration for opsdroid nil (opsdroid will generate default at runtime)
opsdroid.environment Environment variables for the bot []

Image

Parameter Description Default
opsdroid.image.repository Container image name opsdroid/opsdroid
opsdroid.image.tag Container tag name Latest stable tag
opsdroid.image.imagePullPolicy Container image pull policy IfNotPresent

Service

Parameter Description Default
opsdroid.service.port Port for service to use 8080

Resources

Parameter Description Default
opsdroid.resources.requests.cpu Minimum CPU request nil
opsdroid.resources.limits.cpu Maximum CPU limit nil
opsdroid.resources.requests.memory Minimum memory request nil
opsdroid.resources.limits.memory Maximum memory limit nil

PVC

Parameter Description Default
opsdroid.pvc.enabled Use a Persistent Volume to store opsdroid state false
opsdroid.pvc.annotations Annotations for the Persistent Volume Claim {}
opsdroid.pvc.selector Selector for the Persistent Volume Claim {}
opsdroid.pvc.accessModes Persistent Volume Claim access mode ['ReadWriteOnce']
opsdroid.pvc.storage Persistent Volume Claim size 5Gi
opsdroid.pvc.storageClassName Persistent Volume Claim name nil

Ingress

Parameter Description Default
opsdroid.ingress.enabled Use an Ingress to access opsdroid false
opsdroid.ingress.annotations Opsdroid Ingress annotations {}
opsdroid.ingress.hosts Opsdroid Ingress Hostnames []
opsdroid.ingress.tls Opsdroid Ingress TLS configuration []

Rasa NLU

Parameter Description Default
rasanlu.enabled Use Rasa NLU false
rasanlu.token API key for Rasa NLU to use abc123

Image

Parameter Description Default
rasanlu.image.repository Container image name rasa/rasa_nlu
rasanlu.image.tag Container tag name Latest stable tag
rasanlu.image.imagePullPolicy Container image pull policy IfNotPresent

Service

Parameter Description Default
rasanlu.service.port Port for service to use 5000

Resources

Parameter Description Default
rasanlu.resources.requests.cpu Minimum CPU request nil
rasanlu.resources.limits.cpu Maximum CPU limit nil
rasanlu.resources.requests.memory Minimum memory request nil
rasanlu.resources.limits.memory Maximum memory limit nil

PVC

Parameter Description Default
rasanlu.pvc.enabled Use a Persistent Volume to store opsdroid state false
rasanlu.pvc.annotations Annotations for the Persistent Volume Claim {}
rasanlu.pvc.selector Selector for the Persistent Volume Claim {}
rasanlu.pvc.accessModes Persistent Volume Claim access mode ['ReadWriteOnce']
rasanlu.pvc.storage Persistent Volume Claim size 5Gi
rasanlu.pvc.storageClassName Persistent Volume Claim name nil

Specify each parameter using the --set key=value[,key=value] argument to helm install.

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

$ helm install --name my-release -f values.yaml incubator/opsdroid

Tip: You can use the default values.yaml

Releasing

Releases of the Helm chart are automatically pushed to the gh-pages branch by Travis CI when git tags are created.

Before releasing you may want to ensure the chart is up to date with the latest Docker images and opsdroid versions:

Then to perform a release you need to create and push a new tag.

  • Update the version key in opsdroid/Chart.yaml with the new chart version x.x.x.
  • Add a release commit git commit -a -m "bump version to x.x.x".
  • Create a release on GitHub.
  • Travis CI will automatically build and release to the chart repository.

helm-chart's People

Contributors

abhiky avatar d3n14l avatar github-actions[bot] avatar jacobtomlinson avatar tctovsli avatar

Watchers

 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.