GithubHelp home page GithubHelp logo

kubernetes-whatsapp's Introduction

WhatsApp Business API

Introduction

This chart bootstraps a single node or multiconnect WhatsApp Business API deployment on a Kubernetes cluster using the Helm package manager.

Some features available in chart comparing to official manifests:

  • Ingress resource
  • Provides preconfigured database deployment (mysql/postgres)
  • Database upgrades runs on any helm release upgrade (post-upgrade hook)
  • Might be configured to use shared storages (EFS/NFS/Ceph) for media files
  • Cronjob which delete media files by schedule from volume
  • Changes admin password after installation (post-install hook)
  • Web deployment has liveness Probe using WA_API_KEY

Prerequisites

  • Kubernetes 1.9+
  • PV provisioner support in the underlying infrastructure

Installing the Chart

Add repo first:

helm repo add whatsapp https://goodsmileduck.github.io/kubernetes-whatsapp/

To install the chart with the release name whatsapp:

$ helm install whatsapp whatsapp/kubernetes-whatsapp

The command deploys WhatsApp Business API on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.

By default helm deploys multiconnect node deployment.

To deploy single node deployment use file values-single.yaml

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the whatsapp deployment:

$ helm delete --purge whatsapp

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following table lists the configurable parameters of the WhatsApp chart and their default values.

Parameter Description Default
multiconnect Multiconnect mode. Could be MYSQL or PGSQL False
db.engine Database engine MYSQL
db.host Hostname to access database []

TODO

  • Update docs for configuration
  • Add Healthcheck for core/web containers
  • Update volume configuration
  • Add affinitiy support
  • Add tests

kubernetes-whatsapp's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

kubernetes-whatsapp's Issues

Config of scripts.repository is missing

Hi Guy,
What kind of image do you have used here?
image: "{{ .Values.scripts.repository }}:{{ .Values.scripts.tag }}"

It's missing into the value.yaml.

Thanks.

Errors while running Linter's

Please find the exact error.
==> Linting . [INFO] Chart.yaml: icon is recommended [ERROR] templates/: render error in "kubernetes-whatsapp/templates/volumes.yaml": template: kubernetes-whatsapp/templates/volumes.yaml:90:30: executing "kubernetes-whatsapp/templates/volumes.yaml" at <.Values.scripts.repository>: nil pointer evaluating interface {}.repository

Steps to clone the error cloned the repo and ran $helm lint

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.