Skip to content

Update docs regarding dataplane deployments #407

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
wants to merge 2 commits into
base: main
Choose a base branch
from
+28 −20
Open

Update docs regarding dataplane deployments #407

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
599df39
Remove rsync sysctl setting in docs
cschwede Nov 5, 2025
a0f546b
Add doc note regarding dataplane deployments
cschwede Nov 5, 2025
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
48 changes: 28 additions & 20 deletions docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,33 @@ continue to run on the controlplane, and all Swift storage services will run on
dataplane nodes. It is recommended to not mix storage on PVs and dataplane
nodes permanently.

> **_NOTE:_** If there are no Swift dataplane nodes configured and `swiftStorage`
> replicas are set to 0 ring building is not possible (because there are no
> nodes/disks until dataplane nodes are defined), and as a result `swiftProxy`
> won't start until the dataplane is created. Therefore it is recommended to
> start Swift proxies after creating the dataplane and set both `swiftProxy` as
> well as `swiftStorage` replicas to 0 when creating the OpenStackControlPlane
> CR, for example:

```
apiVersion: core.openstack.org/v1beta1
kind: OpenStackControlPlane
metadata:
name: openstack-galera-network-isolation
namespace: openstack
spec:
...
swift:
enabled: true
template:
swiftProxy:
replicas: 0
swiftRing:
ringReplicas: 3
swiftStorage:
replicas: 0
```

An `OpenStackDataPlaneDeployment` can use one or more
`OpenStackDataPlaneNodeSet`. Each `OpenStackDataPlaneNodeSet` can use different
disk and configuration settings to allow fine-grained control. Further
Expand All @@ -106,8 +133,7 @@ To deploy and run Swift storage services on dataplane nodes, you need to create
an `OpenStackDataPlaneNodeSet` with the following properties:

1. Included `swift` service
2. Sysctl setting to allow binding on port 873 for unprivileged rsync process
3. List of disks to be used for storage in Swift
2. List of disks to be used for storage in Swift

You also need to enable DNS forwarding to resolve dataplane hostnames within
the controlplane pods. First get the `clusterIP` of the resolver:
Expand Down Expand Up @@ -159,24 +185,6 @@ to the end of the services list, for example:

This runs the required playbooks to configure Swift storage services.

### Add required sysctl setting for rsync

<!-- TODO: this section needs to be removed once this is set by default -->
Rsync is used to replicate data between nodes. It uses port 873 for this, which
is a privileged port by default. However, rsync is running unprivileged within
rootless podman, and thus needs an additional setting to allow binding to port
873.
This setting needs to be added to the `nodeTemplate` section, for example:

```
nodeTemplate:
ansible:
ansibleVars:
edpm_kernel_sysctl_extra_settings:
net.ipv4.ip_unprivileged_port_start:
value: 873
```

### Define disks to be used by Swift on the dataplane nodes

If all nodes use the same type of disks these can be defined once in a global
Expand Down