Back to Charts

⚠️ Repo Archive Notice

stable/inbucket/README.md

latest4.0 KB
Original Source

⚠️ Repo Archive Notice

As of Nov 13, 2020, charts in this repo will no longer be updated. For more information, see the Helm Charts Deprecation and Archive Notice, and Update.

Inbucket

Inbucket is an e-mail testing tool.

DEPRECATION NOTICE

This chart is deprecated and no longer supported.

TL;DR;

bash
$ helm install stable/inbucket

Introduction

This chart creates a Inbucket deployment on a Kubernetes cluster using the Helm package manager.

Prerequisites

  • Kubernetes 1.8+ with Beta APIs enabled

Installing the Chart

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

bash
$ helm install --name my-release stable/inbucket

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

Uninstalling the Chart

To uninstall/delete the my-release deployment:

bash
$ helm delete my-release

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 Inbucket chart and their default values.

ParameterDescriptionDefault
image.repositorycontainer image repositoryjhillyerd/inbucket
image.tagcontainer image tagrelease-1.2.0
image.pullPolicycontainer image pull policyIfNotPresent
nodeSelectornode labels for pod assignment{}
podAnnotationsannotations to be added to pods{}
resourcespod resource requests & limits{}
service.annotationsannotations for the service{}
service.clusterIPinternal cluster service IP""
service.externalIPsservice external IP addresses[]
service.loadBalancerIPIP address to assign to load balancer (if supported)""
service.loadBalancerSourceRangeslist of IP CIDRs allowed access to load balancer (if supported)[]
service.typetype of service to createClusterIP
service.node.httphttp port of service. Should be the same you set in INBUCKET_WEB_ADDR""
service.node.smtpsmtp port of service. Should be the same you set in INBUCKET_SMTP_ADDR""
service.node.pop3pop3 port of service. Should be the same you set in INBUCKET_POP3_ADDR""
service.nodePort.httpif service.type is NodePort and this is non-empty, sets the http node port of the service""
service.nodePort.smtpif service.type is NodePort and this is non-empty, sets the smtp node port of the service""
service.nodePort.pop3if service.type is NodePort and this is non-empty, sets the pop3 node port of the service""
ingress.enabledif true, an ingress is createdfalse
ingress.annotationsannotations for the ingress{}
ingress.pathif true, an ingress is created/
ingress.hostsa list of ingress hosts[inbucket.example.com]
ingress.tlsa list of IngressTLS items[]
configThe inbucket config you can use this configurator to adjust you config.set to defaults

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

bash
$ helm install --name my-release \
  --set image.tag=release-1.2.0 \
    stable/inbucket

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

bash
$ helm install --name my-release -f values.yaml stable/inbucket

Limitations

Thanks

This chart was inspired in the Mailhog tool, which is another testing email tool, for more Mailhog.