Hermes Mail Sender Operator

Hermes came back from mount olympus and instead of deliverying letters he is now sending emails through a kubernetes cluster.

He is a kubernetes operator that was designed to manage and send emails using the mailersend and mailgun providers.

Architeture and Components

The project was developed using the Kubebuilder operator framework https://kubebuilder.io which speeds up the development process in comparisson to creating everything from scratch.

The email providers were configured using the go sdk libraries that they provide

• https://github.com/mailgun/mailgun-go
• https://github.com/mailersend/mailersend-go

Link to the helm charts repository

• https://github.com/gabrielmuras/hermes-mail-sender-operator-helm-charts

Link to the dockerhub

• https://hub.docker.com/repository/docker/gmuras/hermes-mail-sender-operator/general

Installation

You can install it by the following alternatives

Helm

Add the helm repository

  helm repo add hermes-mail-sender-operator-charts https://gabrielmuras.github.io/hermes-mail-sender-operator-helm-charts

Update

  helm repo update

You can check the available charts

  helm search repo hermes-mail-sender-operator-charts

Install the Operator with the default values or use a custom values that suits your needs

helm install email-operator hermes-mail-sender-operator-charts/hermes-mail-sender-operator

Install the EmailSenderConfig using your values because it doesn't provide a default out of the box default values

helm install <name> hermes-mail-sender-operator-charts/email-sender-config -f <Your-Custom-Yaml>.yaml

Install the EmailSenderConfig using your values because it doesn't provide a default out of the box default values

helm install <name> hermes-mail-sender-operator-charts/email -f <Your-Custom-Yaml>.yaml

Make

Clone this repository and then execute

  make; make manifests; make install; make run

Manifests

Use the manifests present in config/ and apply the contents in those folders:

• config/crds
• config/rbac
• config/manager

The EmailSenderConfigand Emailwill be on the config/samples and also with some examples.

Note that when using the kind secret for the EmailSenderConfig you should pass it in base64 format before the kubectl apply

  echo -n yourApiToken | base64

Default values of operator deployment

name: email-operator
namespace: default
serviceAccount: email-operator
replicas: 1
image: gmuras/hermes-mail-sender-operator:v0.2
resources:
  limits:
    cpu: 800m
    memory: 256Mi
  requests:
    cpu: 800m
    memory: 256Mi

Usage

After the operator is deployed and running you can now apply the EmailSenderConfig kind with your provider informations

• EmailSenderConfig

Helm

name: "name"
apiTokenSecretRef: "secret-name"
senderEmail: "[email protected]"
provider: "mailgun or mailersend"
secret:
  createNew: true
  secretName: "secret-name"
  apiToken: <Token without base64 helm is handling that>

Kubernetes Manifest

---
apiVersion: email.hermes.sender/v1
kind: EmailSenderConfig
metadata:
  name: "name"
spec:
  apiTokenSecretRef: "secret-name"
  senderEmail: "[email protected]"
  provider: "mailgun or mailersend"


---
apiVersion: v1
kind: Secret
metadata:
  name: secret-mailgun
type: Opaque
data:
  apiToken: <Token in base64>

• Email

Helm

name: "email-name"
senderConfigRef: "Desired SenderConfigRef"
recipientEmail: "[email protected]"
subject: "subject"
body: "body"

Kubernetes Manifest

apiVersion: email.hermes.sender/v1
kind: Email
metadata:
  name: "email-name"
spec:
  senderConfigRef: "Desired SenderConfigRef"
  recipientEmail: "[email protected]"
  subject: "subject"
  body: "body"

Then after the email is applied you can run a kubectl get email command and retrieve the informations displayed on the status and in case of failure you can get the error from the status as well

Screenshots