docs(chore): Presentation - Wrap content with scope border

Stylistic choice, could be reverted. This was done to better visually scope the boundary of content tabs, as it's less obvious where they actually end when they're not within an admonition block.

This commit only adds the `!!! quote ""` lines with associated md comment above them, everything else is just indentation.
This commit is contained in:
polarathene 2024-03-10 22:21:03 +13:00
parent e270525176
commit 9c713d6225
1 changed files with 626 additions and 620 deletions

View File

@ -20,7 +20,10 @@ This article describes how to deploy DMS to Kubernetes. We highly recommend ever
When you do not want to or you cannot use Helm, below is a simple starting point for writing your YAML manifests.
=== "`ConfigMap`"
<!-- This empty quote block is purely for a visual border -->
!!! quote ""
=== "`ConfigMap`"
Provide the basic configuration via environment variables with a `ConfigMap`. Note that this is just an example configuration; tune the `ConfigMap` to your needs.
@ -85,7 +88,7 @@ When you do not want to or you cannot use Helm, below is a simple starting point
[Kustomize][kustomize] can be a useful tool as it supports creating a `ConfigMap` from multiple files.
=== "`PersistentVolumeClaim`"
=== "`PersistentVolumeClaim`"
To persist data externally from the DMS container, configure a `PersistentVolumeClaim` (PVC). Make sure you have a storage system (like Longhorn, Rook, etc.) and that you choose the correct `storageClassName` (according to your storage system).
@ -106,7 +109,7 @@ When you do not want to or you cannot use Helm, below is a simple starting point
storage: 25Gi
```
=== "`Service`"
=== "`Service`"
A [`Service`][Kubernetes-network-service] is required for getting the traffic to the pod itself. It configures a load balancer with the ports you'll need.
@ -151,7 +154,7 @@ When you do not want to or you cannot use Helm, below is a simple starting point
protocol: TCP
```
=== "Certificates"
=== "Certificates"
In this example, we use [`cert-manager`][cert-manager] to supply RSA certificates. You can also supply RSA certificates as fallback certificates, which DMS supports out of the box with `SSL_ALT_CERT_PATH` and `SSL_ALT_KEY_PATH`, and provide ECDSA as the proper certificates.
@ -180,7 +183,7 @@ When you do not want to or you cannot use Helm, below is a simple starting point
You will need to have [`cert-manager`][cert-manager] configured. Especially the issue will need to be configured. Since we do not know how you want or need your certificates to be supplied, we do not provide more configuration here. The documentation for [`cert-manager`][cert-manager] is excellent.
=== "Sensitive Data"
=== "Sensitive Data"
!!! attention "Sensitive Data"
@ -188,7 +191,7 @@ When you do not want to or you cannot use Helm, below is a simple starting point
The [TLS docs page][docs-tls] provides guidance when it comes to certificates and transport layer security. Always provide sensitive information via `Secrets`.
=== "`Deployment`"
=== "`Deployment`"
The `Deployment` config is the most complex component.
@ -346,7 +349,10 @@ The more difficult part with Kubernetes is to expose a deployed DMS instance to
The major problem with exposing DMS to the outside world in Kubernetes is to [preserve the real client IP][Kubernetes-service-source-ip]. The real client IP is required by DMS for performing IP-based DNS and spam checks.
=== "Configure IP Manually"
<!-- This empty quote block is purely for a visual border -->
!!! quote ""
=== "Configure IP Manually"
???+ abstract "Advantages / Disadvantages"
@ -433,7 +439,7 @@ The major problem with exposing DMS to the outside world in Kubernetes is to [pr
ipAddressPools: [ mailserver ]
```
=== "Host network"
=== "Host network"
???+ abstract "Advantages / Disadvantages"
@ -480,7 +486,7 @@ The major problem with exposing DMS to the outside world in Kubernetes is to [pr
# ...
```
=== "Using the PROXY Protocol"
=== "Using the PROXY Protocol"
???+ abstract "Advantages / Disadvantages"