Skip to content

Commit

Permalink
docs: add warinig for api server when security mode is enabled
Browse files Browse the repository at this point in the history
  • Loading branch information
aleoli authored and adamjensenbot committed Oct 25, 2023
1 parent c6b63a1 commit d4e973e
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/_static/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,7 @@
font-size: 0.85rem !important;
line-height: unset !important;
}

.mb {
margin-bottom: 1.5rem !important;
}
12 changes: 12 additions & 0 deletions docs/usage/security-modes.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,15 @@ Considering two clusters (C1 and C2) in which the former has started a peering t
```{figure} /_static/images/usage/security-modes/security-modes-schema.drawio.svg
---
align: center
class: mb
---

```

```{figure} /_static/images/usage/security-modes/matrix-full-p2p.drawio.svg
---
align: center
class: mb
---

```
Expand All @@ -71,17 +73,27 @@ Using the same rules and conventions already presented for the previous case (_f
```{figure} /_static/images/usage/security-modes/security-modes-schema.drawio.svg
---
align: center
class: mb
---

```

```{figure} /_static/images/usage/security-modes/matrix-traffic-segregation.drawio.svg
---
align: center
class: mb
---

```

``` {warning} Warning
Currently, when this feature is enabled, your offloaded pods will not be able to reach the local cluster's API Server.
This is due to the fact that the API Server is not exposed as a service, but it is directly reachable through the remapped cluster's IP address.
This limitation will be removed in future.
For the same reason, the [in-band](FeaturesPeeringInBandControlPlane) peer will not work in this mode.
```

## Selection of the security mode

The desired security mode can be selected by setting a **flag** at install time or by setting the proper Helm values.
Expand Down

0 comments on commit d4e973e

Please sign in to comment.