1
0

[readme] improve readibility

This commit is contained in:
Simon Cornet 2024-02-06 07:54:13 +01:00
parent a1581e6c4f
commit 0c17911cc4

View File

@ -1,6 +1,6 @@
# ! Disclaimer ! # ! Disclaimer !
This is an example role for how I have setup OpenAppSec on multiple VMs using docker containers. This is an example role for how I have setup OpenAppSec on multiple VMs using docker containers.
It has many things stripped out and is very custom for my needs. It has many many many things stripped out and is very custom for my needs.
Dont copy it and think it will work at all out-of-the-box. It is just here to show how Ansible can be used to deploy the OpenAppSec containers and push the NGINX config per (sub)domain. Dehydrated is used for obtaining valid LetsEncrypt certificates but do require to be kickstarted using already existing certificates. Dont copy it and think it will work at all out-of-the-box. It is just here to show how Ansible can be used to deploy the OpenAppSec containers and push the NGINX config per (sub)domain. Dehydrated is used for obtaining valid LetsEncrypt certificates but do require to be kickstarted using already existing certificates.
@ -8,7 +8,7 @@ Dont copy it and think it will work at all out-of-the-box. It is just here to sh
In my setup we have 2 firewalls (active/passive ha) forwarding incoming tcp connections from a VIP. In my setup we have 2 firewalls (active/passive ha) forwarding incoming tcp connections from a VIP.
Then we have two active/passive ha loadbalancers (based on HAproxy), forwarding only tcp/80 and tcp/443 to any available WAF node based on a simple healthcheck. Then we have two active/passive ha loadbalancers (based on HAproxy), forwarding only tcp/80 and tcp/443 to any available WAF node based on a simple healthcheck.
The WAFs share a NFS mount for storing certificates. This share is also used for the LetsEncrypt http challenge. The WAFs mount a NFS share for storing certificates. This share is also used for the LetsEncrypt http challenge.
Since the load on the WAFs can increase we can easily add more in the furture. Since the load on the WAFs can increase we can easily add more in the furture.
Now here is some OpenAI generated ASCII art based on my architectural description... :) Now here is some OpenAI generated ASCII art based on my architectural description... :)
@ -43,5 +43,5 @@ Now here is some OpenAI generated ASCII art based on my architectural descriptio
# Requirements # Requirements
This Ansible playbook assumes the target hosts are prepared with the following: This Ansible playbook assumes the target hosts are prepared with the following:
- Docker container runtime installed - Docker container runtime installed
- /mnt/certs share mounted - `/mnt/certs`` share is mounted
- Ansible user has passwordless sudo - Ansible user has passwordless sudo