Skip to content

feat: Add per-instance external access annotations to HA K8s docs #1576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
as51340 wants to merge 1 commit into
base: memgraph-3-10
Choose a base branch
from
+42 −2
Open

feat: Add per-instance external access annotations to HA K8s docs #1576

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 42 additions & 2 deletions pages/clustering/high-availability/setup-ha-cluster-k8s.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,45 @@ Envoy Gateway controller with Memgraph HA cluster, see [Use Memgraph HA chart wi

By default, the chart does **not** expose any external network services.

{<h4 className="custom-header"> Per-instance external access annotations </h4>}

When using `LoadBalancer` or `NodePort` external access, you can set annotations
globally via `externalAccessConfig.dataInstance.annotations` and
`externalAccessConfig.coordinator.annotations`. These apply to every external
Service of that type.

If you need different annotations per instance — for example, to assign unique
DNS hostnames via `external-dns` — use the `externalAccessAnnotations` field on
individual entries in `data[]` or `coordinators[]`. Per-instance annotations are
merged with the global annotations, and **per-instance values take precedence**
when the same key appears in both.

```yaml
externalAccessConfig:
dataInstance:
serviceType: "LoadBalancer"
annotations:
service.beta.kubernetes.io/aws-load-balancer-scheme: "internet-facing"

data:
- id: "0"
externalAccessAnnotations:
external-dns.alpha.kubernetes.io/hostname: "data-0.memgraph.example.com"
args:
- "--management-port=10000"
- "--bolt-port=7687"
- id: "1"
externalAccessAnnotations:
external-dns.alpha.kubernetes.io/hostname: "data-1.memgraph.example.com"
args:
- "--management-port=10000"
- "--bolt-port=7687"
```

In this example, each data instance's external Service gets the shared
`aws-load-balancer-scheme` annotation plus its own unique `external-dns`
hostname.

### Node affinity

Memgraph HA deploys multiple pods, and you can control pod placement with
Expand Down Expand Up @@ -693,9 +732,9 @@ and their default values.
| `storage.logStorageClassName` | The name of the storage class used for storing logs. | `""` |
| `storage.logStorageAccessMode` | Access mode used for log storage. | `ReadWriteOnce` |
| `externalAccess.coordinator.serviceType` | IngressNginx, NodePort, CommonLoadBalancer or LoadBalancer. By default, no external service will be created. | `""` |
| `externalAccess.coordinator.annotations` | Annotations for external services attached to coordinators. | `{}` |
| `externalAccess.coordinator.annotations` | Annotations applied to all coordinators' external services. | `{}` |
| `externalAccess.dataInstance.serviceType` | IngressNginx, NodePort or LoadBalancer. By default, no external service will be created. | `""` |
| `externalAccess.dataInstance.annotations` | Annotations for external services attached to data instances. | `{}` |
| `externalAccess.dataInstance.annotations` | Annotations applied to all data instances' external services. | `{}` |
| `headlessService.enabled` | Specifies whether headless services will be used inside K8s network on all instances. | `false` |
| `ports.boltPort` | Bolt port used on coordinator and data instances. | `7687` |
| `ports.managementPort` | Management port used on coordinator and data instances. | `10000` |
Expand Down Expand Up @@ -767,6 +806,7 @@ following parameters:
| Parameter | Description | Default |
|---------------------------------------------|-----------------------------------------------------------------------------------------------------|-----------------------------------------|
| `id` | ID of the instance | `0` for data, `1` for coordinators |
| `externalAccessAnnotations` | Per-instance annotations for the external access Service, merged with global annotations. | `{}` |
| `args` | List of arguments for the instance | See `args` section |

The `args` section contains a list of arguments for the instance.
Expand Down