Mailu/docs/kubernetes/index.rst

Kubernetes setup
================

Please note that Kubernetes setup is not yet well supported or documented, all
tests currently run on Docker Compose. The configuration has not yet been updated
to work properly with ngin authentication proxy.

Prepare the environment
-----------------------

The resource configurations in this folder assume that you have `Kubernetes Ingress`_
set up for your cluster. If you are not using the `NGINX Ingress Controller for Kubernetes`_,
please ensure that the configuration specified in the file matches your set up.

.. _`Kubernetes Ingress`: https://kubernetes.io/docs/concepts/services-networking/ingress/
.. _`NGINX Ingress Controller for Kubernetes`: https://github.com/kubernetes/ingress/tree/master/controllers/nginx

Setup the Kubernetes service
----------------------------

Using the resource configurations is simple:

1. ``kubectl apply -f kubernetes-nginx-ingress-controller.yaml`` to configure an ingress controller with the proper settings. (If you have one set up already you may need to port the configuration to your own ingress).
2. ``kubectl apply -f kubernetes-mailu.yaml`` to create the resources required to run Mailu.

Based on the configuration, your Mailu instance should be available at ``mail.<hostname>.tld/admin`` (note that visiting just ``mail.<hostname>.tld`` will likely result in a 404.
Fix the rst syntax for most documentation 2017-11-02 21:05:12 +02:00			`Kubernetes setup`
			`================`

Update the kubernetes docs and warn about incompatibility with version 1.5 2017-11-05 17:58:44 +02:00			`Please note that Kubernetes setup is not yet well supported or documented, all`
			`tests currently run on Docker Compose. The configuration has not yet been updated`
			`to work properly with ngin authentication proxy.`

Fix the rst syntax for most documentation 2017-11-02 21:05:12 +02:00			`Prepare the environment`
			`-----------------------`

			The resource configurations in this folder assume that you have `Kubernetes Ingress`_
			set up for your cluster. If you are not using the `NGINX Ingress Controller for Kubernetes`_,
			`please ensure that the configuration specified in the file matches your set up.`

			.. _`Kubernetes Ingress`: https://kubernetes.io/docs/concepts/services-networking/ingress/
			.. _`NGINX Ingress Controller for Kubernetes`: https://github.com/kubernetes/ingress/tree/master/controllers/nginx

			`Setup the Kubernetes service`
			`----------------------------`

			`Using the resource configurations is simple:`

			1. ``kubectl apply -f kubernetes-nginx-ingress-controller.yaml`` to configure an ingress controller with the proper settings. (If you have one set up already you may need to port the configuration to your own ingress).
			2. ``kubectl apply -f kubernetes-mailu.yaml`` to create the resources required to run Mailu.

			Based on the configuration, your Mailu instance should be available at ``mail.<hostname>.tld/admin`` (note that visiting just ``mail.<hostname>.tld`` will likely result in a 404.