Frontend system using Apache, allowing to rewrite and proxy URLs like
Frontend system using Caddy, based on apache-frontend software release, allowing to rewrite and proxy URLs like myinstance.myfrontenddomainname.com to real IP/URL of myinstance.
myinstance.myfrontenddomainname.com to real IP/URL of myinstance.
apache_frontend works using the master instance / slave instance design.
Caddy Frontend works using the master instance / slave instance design. It means that a single main instance of Caddy will be used to act as frontend for many slaves.
It means that a single main instance of Apache will be used to act as frontend
for many slaves.
Software type
Software type
=============
=============
Apache frontend is available in 3 software types:
Caddy frontend is available in 4 software types:
* default : The standard way to use the apache frontend configuring everything with a few given parameters
* ``default`` : The standard way to use the Caddy frontend configuring everything with a few given parameters
* custom-personal : This software type allow each slave to edit its apache configuration file
* ``custom-personal`` : This software type allow each slave to edit its Caddy configuration file
* ``default-slave`` : XXX
* ``custom-personal-slave`` : XXX
About frontend replication
About frontend replication
===========================
==========================
Slaves of the root instance are sent as a parameter to requested frontends which will process them. The only difference is that they will then return the would-be published information to the root instance instead of publishing it. The root instance will then do a synthesis and publish the information to its slaves. The replicate instance only use 5 type of parameters for itself and will transmit the rest to requested frontends.
Slaves of the root instance are sent as a parameter to requested frontends which will process them. The only difference is that they will then return the « would-be published information » to the root instance instead of publishing it. The root instance will then do a synthesis and publish the information to its slaves. The replicate instance only use 5 type of parameters for itself and will transmit the rest to requested frontends.
These parameters are :
These parameters are :
* "-frontend-type" : the type to deploy frontends with. (default to 2)
* "-frontend-quantity" : The quantity of frontends to request (default to "default")
* ``-frontend-type`` : the type to deploy frontends with. (default to 2)
* "-frontend-i-state": The state of frontend i
* ``-frontend-quantity`` : The quantity of frontends to request (default to "default")
* "-frontend-config-i-foo": Frontend i will be requested with parameter foo
* ``-frontend-i-state``: The state of frontend i
* "-frontend-software-release-url": Software release to be used for frontends, default to the current software release
* ``-frontend-config-i-foo``: Frontend i will be requested with parameter foo
* "-sla-i-foo" : where "i" is the number of the concerned frontend (between 1 and "-frontend-quantity") and "foo" a sla parameter.
* ``-frontend-software-release-url``: Software release to be used for frontends, default to the current software release
ex:
* ``-sla-i-foo`` : where "i" is the number of the concerned frontend (between 1 and "-frontend-quantity") and "foo" a sla parameter.
will request the third frontend on COMP-1234. All frontends will be of software type "custom-personal". The second frontend will be requested with the state stopped
Important NOTE: The way you ask for slave to a replicate frontend is the same as the one you would use for the software given in "-frontend-quantity". Do not forget to use "replicate" for software type. XXXXX So far it is not possible to do a simple request on a replicate frontend if you do not know the software_guid or other sla-parameter of the master instance. In fact we do not know yet the software type of the "requested" frontends. TO BE IMPLEMENTED
will request the third frontend on COMP-1234. All frontends will be of software type ``custom-personal``. The second frontend will be requested with the state stopped
*Note*: the way slaves are transformed to a parameter avoid modifying more than 3 lines in the frontend logic.
**Important NOTE**: The way you ask for slave to a replicate frontend is the same as the one you would use for the software given in "-frontend-quantity". Do not forget to use "replicate" for software type. XXXXX So far it is not possible to do a simple request on a replicate frontend if you do not know the software_guid or other sla-parameter of the master instance. In fact we do not know yet the software type of the "requested" frontends. TO BE IMPLEMENTED
XXX Should be moved to specific JSON File
XXX Should be moved to specific JSON File
Extra-parameter per frontend with default :
ram-cache-size = 1G
disk-cache-size = 8G
Extra-parameter per frontend with default::
ram-cache-size = 1G
disk-cache-size = 8G
How to deploy a frontend server
How to deploy a frontend server
===============================
===============================
This is to deploy an entire frontend server with a public IPv4.
This is to deploy an entire frontend server with a public IPv4. If you want to use an already deployed frontend to make your service available via ipv4, switch to the "Example" parts.
If you want to use an already deployed frontend to make your service available
via ipv4, switch to the "Example" parts.
First, you will need to request a "master" instance of Caddy Frontend with:
First, you will need to request a "master" instance of Apache Frontend with:
* A ``domain`` parameter where the frontend will be available
* A "domain" parameter where the frontend will be available
* A ``public-ipv4`` parameter to state which public IPv4 will be used
* A "public-ipv4" parameter to state which public IPv4 will be used
Those slave instances will be redirected to the "master" instance,
and you will see on the "master" instance the associated RewriteRules of
all slave instances.
Finally, the slave instance will be accessible from:
Those slave instances will be redirected to the "master" instance, and you will see on the "master" instance the associated proper directives of all slave instances.
https://someidentifier.moulefrite.org.
Finally, the slave instance will be accessible from: https://someidentifier.moulefrite.org.
About SSL
About SSL
=========
=========
Default and custom-personal software type can handle specific ssl for one slave instance.
IMPORTANT: One apache can not serve more than One specific SSL VirtualHost and be compatible with obsolete browser (i.e.: IE8). See http://wiki.apache.org/httpd/NameBasedSSLVHostsWithSNI
``default`` and ``custom-personl`` software type can handle specific ssl for one slave instance.
#How to have custom configuration in frontend server
**IMPORTANT**: One Caddy can not serve more than one specific SSL site and be compatible with obsolete browser (i.e.: IE8). See http://wiki.apache.org/httpd/NameBasedSSLVHostsWithSNI
#The second one is included in the virtualhost of the main apache configuration file.
#
The first one is included in the end of the main apache configuration file.
#SlapOS will jsut create those two files for you, then completely forget them.
The second one is included in the virtualhost of the main apache configuration file.
#
#Note: make sure that the UNIX user of the instance has read access to those
SlapOS will just create those two files for you, then completely forget them.
#files if you edit them.
*Note*: make sure that the UNIX user of the instance has read access to those
files if you edit them.
Instance Parameters
Instance Parameters
===================
===================
...
@@ -107,38 +114,37 @@ Instance Parameters
...
@@ -107,38 +114,37 @@ Instance Parameters
Master Instance Parameters
Master Instance Parameters
--------------------------
--------------------------
The parameters for instances are described at `instance-apache-input-schema.json <instance-apache-input-schema.json>`_.
The parameters for instances are described at `instance-caddy-input-schema.json <instance-caddy-input-schema.json>`_.
Here some additional informations about the parameters listed, below:
Here some additional informations about the parameters listed, below:
domain
domain
~~~~~~
~~~~~~
name of the domain to be used (example: mydomain.com). Subdomains of this
domain will be used for the slave instances (example:
Name of the domain to be used (example: mydomain.com). Sub domains of this domain will be used for the slave instances (example: instance12345.mydomain.com). It is then recommended to add a wild card in DNS for the sub domains of the chosen domain like::
instance12345.mydomain.com). It is then recommended to add a wildcard in DNS
for the subdomains of the chosen domain like::
*.mydomain.com. IN A 123.123.123.123
*.mydomain.com. IN A 123.123.123.123
Using the IP given by the Master Instance.
"domain" is a mandatory Parameter.
Using the IP given by the Master Instance. "domain" is a mandatory Parameter.
public-ipv4
public-ipv4
~~~~~~~~~~~
~~~~~~~~~~~
Public ipv4 of the frontend (the one Apache will be indirectly listening to)
Public ipv4 of the frontend (the one Caddy will be indirectly listening to)
port
port
~~~~
~~~~
Port used by Apache. Optional parameter, defaults to 4443.
Port used by Caddy. Optional parameter, defaults to 4443.
plain_http_port
plain_http_port
~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~
Port used by apache to serve plain http (only used to redirect to https).
Port used by Caddy to serve plain http (only used to redirect to https).
Optional parameter, defaults to 8080.
Optional parameter, defaults to 8080.
Slave Instance Parameters
Slave Instance Parameters
-------------------------
-------------------------
The parameters for instances are described at `instance-slave-apache-input-schema.json <instance-slave-apache-input-schema.json>`_.
The parameters for instances are described at `instance-slave-caddy-input-schema.json <instance-slave-caddy-input-schema.json>`_.
Here some additional informations about the parameters listed, below:
Here some additional informations about the parameters listed, below:
...
@@ -146,65 +152,76 @@ path
...
@@ -146,65 +152,76 @@ path
~~~~
~~~~
Only used if type is "zope".
Only used if type is "zope".
Will append the specified path to the "VirtualHostRoot" of the zope's
Will append the specified path to the "VirtualHostRoot" of the zope's VirtualHostMonster.
VirtualHostMonster.
"path" is an optional parameter, ignored if not specified.
"path" is an optional parameter, ignored if not specified.
Example of value: "/erp5/web_site_module/hosting/"
Example of value: "/erp5/web_site_module/hosting/"
apache_custom_https
apache_custom_https
~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~
Raw apache configuration in python template format (i.e. write "%%" for one "%") for the slave listening to the https port. Its content will be templatified in order to access functionalities such as cache access, ssl certificates... The list is available above.
Raw Caddy configuration in python template format (i.e. write "%%" for one "%") for the slave listening to the https port. Its content will be templatified in order to access functionalities such as cache access, ssl certificates... The list is available above.
NOTE: If you want to use the cache, use the apache option "ProxyPreserveHost On"
apache_custom_http
apache_custom_http
~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~
Raw apache configuration in python template format (i.e. write "%%" for one "%") for the slave listening to the http port. Its content will be templatified in order to access functionalities such as cache access, ssl certificates... The list is available above
Raw Caddy configuration in python template format (i.e. write "%%" for one "%") for the slave listening to the http port. Its content will be templatified in order to access functionalities such as cache access, ssl certificates... The list is available above
NOTE: If you want to use the cache, use the apache option "ProxyPreserveHost On"
url
url
~~~
~~~
Necesarry to activate cache. url of backend to use.
Necessary to activate cache. ``url`` of backend to use.
"url" is an optional parameter.
``url`` is an optional parameter.
Example: http://mybackend.com/myresource
Example: http://mybackend.com/myresource
domain
domain
~~~~~~
~~~~~~
Necesarry to activate cache. The frontend will be accessible from this domain.
"domain" is an optional parameter.
Necessary to activate cache.
The frontend will be accessible from this domain.
``domain`` is an optional parameter.
Example: www.mycustomdomain.com
Example: www.mycustomdomain.com
enable_cache
enable_cache
~~~~~~~~~~~~
~~~~~~~~~~~~
Necesarry to activate cache.
"enable_cache" is an optional parameter.
Necessary to activate cache.
``enable_cache`` is an optional parameter.
ssl_key, ssl_crt, ssl_ca_crt
ssl_key, ssl_crt, ssl_ca_crt
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
SSL certificates of the slave.
SSL certificates of the slave.
They are optional.
They are optional.
Functionalities for apache configuration:
Functionalities for Caddy configuration
In the slave apache configuration you can use parameters that will be replaced during instanciation. They should be entered as python templates parameters ex:" %(parameter)s"
---------------------------------------
* cache_access : url of the cache. Should replace backend url in configuration to use the cache
* error_log : path of the slave error log in order to log in a deferenciated file.
In the slave Caddy configuration you can use parameters that will be replaced during instantiation. They should be entered as python templates parameters ex: ``%(parameter)s``:
* error_log : path of the slave access log in order to log in a deferenciated file.
* ssl_key, ssl_crt, ssl_ca_crt, ssl_crs : path of the certificates given in slave instance parameters
* ``cache_access`` : url of the cache. Should replace backend url in configuration to use the cache
* ``access_log`` : path of the slave error log in order to log in a file.
* ``error_log`` : path of the slave access log in order to log in a file.
* ``ssl_key``, ``ssl_crt``, ``ssl_ca_crt``, ``ssl_crs`` : paths of the certificates given in slave instance parameters
Examples
Examples
========
========
Here are some example of how to make your SlapOS service available through
Here are some example of how to make your SlapOS service available through an already deployed frontend.
an already deployed frontend.
Simple Example (default)
Simple Example (default)
------------------------
------------------------
Request slave frontend instance so that https://[1:2:3:4:5:6:7:8]:1234 will be
Request slave frontend instance so that https://[1:2:3:4:5:6:7:8]:1234 will be
redirected and accessible from the proxy::
redirected and accessible from the proxy::
instance = request(
instance = request(
software_release=apache_frontend,
software_release=caddy_frontend,
software_type="RootSoftwareInstance",
software_type="RootSoftwareInstance",
partition_reference='my frontend',
partition_reference='my frontend',
shared=True,
shared=True,
...
@@ -220,8 +237,9 @@ Zope Example (default)
...
@@ -220,8 +237,9 @@ Zope Example (default)
Request slave frontend instance using a Zope backend so that
Request slave frontend instance using a Zope backend so that
https://[1:2:3:4:5:6:7:8]:1234 will be redirected and accessible from the
https://[1:2:3:4:5:6:7:8]:1234 will be redirected and accessible from the
proxy::
proxy::
instance = request(
instance = request(
software_release=apache_frontend,
software_release=caddy_frontend,
software_type="RootSoftwareInstance",
software_type="RootSoftwareInstance",
partition_reference='my frontend',
partition_reference='my frontend',
shared=True,
shared=True,
...
@@ -239,8 +257,9 @@ Request slave frontend instance using a Zope backend, with Varnish activated,
...
@@ -239,8 +257,9 @@ Request slave frontend instance using a Zope backend, with Varnish activated,
listening to a custom domain and redirecting to /erp5/ so that
listening to a custom domain and redirecting to /erp5/ so that
https://[1:2:3:4:5:6:7:8]:1234/erp5/ will be redirected and accessible from
https://[1:2:3:4:5:6:7:8]:1234/erp5/ will be redirected and accessible from
the proxy::
the proxy::
instance = request(
instance = request(
software_release=apache_frontend,
software_release=caddy_frontend,
software_type="RootSoftwareInstance",
software_type="RootSoftwareInstance",
partition_reference='my frontend',
partition_reference='my frontend',
shared=True,
shared=True,
...
@@ -256,9 +275,10 @@ the proxy::
...
@@ -256,9 +275,10 @@ the proxy::
Simple Example
Simple Example
---------------
---------------
Request slave frontend instance so that https://[1:2:3:4:5:6:7:8]:1234 will be
Request slave frontend instance so that https://[1:2:3:4:5:6:7:8]:1234 will be::
instance = request(
instance = request(
software_release=apache_frontend,
software_release=caddy_frontend,
software_type="RootSoftwareInstance",
software_type="RootSoftwareInstance",
partition_reference='my frontend',
partition_reference='my frontend',
shared=True,
shared=True,
...
@@ -267,44 +287,39 @@ Request slave frontend instance so that https://[1:2:3:4:5:6:7:8]:1234 will be
...
@@ -267,44 +287,39 @@ Request slave frontend instance so that https://[1:2:3:4:5:6:7:8]:1234 will be
Where {public ip} is the public IP of your server, or at least the LAN IP to where your NAT will forward to.
Where ``{public ip}`` is the public IP of your server, or at least the LAN IP to where your NAT will forward to, and ``{listening ip}`` is the private ipv4 (like 10.0.34.123) that the instance is using and sending as connection parameter.
{listening ip} is the private ipv4 (like 10.0.34.123) that the instance is using and sending as connection parameter.
Solution 2 (IPv6 only)
Solution 2 (IPv6 only)
----------------------
----------------------
It is also possible to directly allow the service to listen on 80 and 443 ports using the following command:
It is also possible to directly allow the service to listen on 80 and 443 ports using the following command::
