Skip to content

feat(database): add declarative management of foreign servers#8401

Merged
leonardoce merged 26 commits intocloudnative-pg:mainfrom
EdwinaZhu:issue-8063-declarative-support-for-foreign-server
Sep 18, 2025
Merged

feat(database): add declarative management of foreign servers#8401
leonardoce merged 26 commits intocloudnative-pg:mainfrom
EdwinaZhu:issue-8063-declarative-support-for-foreign-server

Conversation

@EdwinaZhu
Copy link
Contributor

@EdwinaZhu EdwinaZhu commented Aug 20, 2025 •
edited by gbartolini
Loading

Add support for managing PostgreSQL Foreign Data Wrappers (FDWs) with foreign servers declaratively via the spec.servers field in the Database custom resource.

This enables Kubernetes-native, privilege-aware lifecycle management of foreign servers without requiring direct SQL execution or superuser privileges.

Supported configuration includes name, ensure, usage grants/revokes, and options. A foreign data wrapper must already exist.

Only foreign servers explicitly listed in spec.servers are reconciled; others remain untouched. Reconciliation uses PostgreSQL’s native CREATE SERVER, ALTER SERVER, and DROP SERVER commands.

Closes #8063

@cnpg-bot cnpg-bot added backport-requested ◀️ This pull request should be backported to all supported releases release-1.25 release-1.26 release-1.27 labels Aug 20, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Aug 20, 2025

❗ By default, the pull request is configured to backport to all release branches.

  • To stop backporting this pr, remove the label: backport-requested ◀️ or add the label 'do not backport'
  • To stop backporting this pr to a certain release branch, remove the specific branch label: release-x.y

@EdwinaZhu EdwinaZhu force-pushed the issue-8063-declarative-support-for-foreign-server branch from e3214cd to 6695674 Compare August 20, 2025 14:53
@EdwinaZhu EdwinaZhu force-pushed the issue-8063-declarative-support-for-foreign-server branch 2 times, most recently from 5d5bad3 to 48afc4c Compare August 27, 2025 08:32
@EdwinaZhu EdwinaZhu force-pushed the issue-8063-declarative-support-for-foreign-server branch from 48afc4c to 64c9170 Compare September 8, 2025 09:38
@EdwinaZhu EdwinaZhu marked this pull request as ready for review September 8, 2025 09:42
@dosubot dosubot bot added the size:XXL This PR changes 1000+ lines, ignoring generated files. label Sep 8, 2025
@EdwinaZhu EdwinaZhu changed the title Draft: declarative management for Foreign Server Feat: Declarative management for Foreign Server Sep 8, 2025
@dosubot dosubot bot added E2E tests E2E tests tickets for easy triage on release process enhancement 🪄 New feature or request labels Sep 8, 2025
@gbartolini gbartolini added do not backport This PR must not be backported - it will be in the next minor release and removed backport-requested ◀️ This pull request should be backported to all supported releases release-1.25 labels Sep 8, 2025
EdwinaZhu and others added 14 commits September 17, 2025 19:17
@EdwinaZhu @mnencia
docs(foreign-server):add the introduction to foreign server function
175a101 
Signed-off-by: YingZhu <yingzhu3@andrew.cmu.edu>
@EdwinaZhu @mnencia
feat(foreign-server): add support for declarative management of usage…
e7f87f4 
… of foreign servers

Signed-off-by: YingZhu <yingzhu3@andrew.cmu.edu>
@EdwinaZhu @mnencia
feat(foreign-server): added test for database webhook and optionsRef(…
7f6f0f6 
…WIP)

Signed-off-by: YingZhu <yingzhu3@andrew.cmu.edu>
@EdwinaZhu @mnencia
feat(foreign-server): remove the WIP optionsRef part
2726b67 
Signed-off-by: YingZhu <yingzhu3@andrew.cmu.edu>
@EdwinaZhu @mnencia
docs: added introduction to the usage field of foreign server
c6e4bec 
Signed-off-by: YingZhu <yingzhu3@andrew.cmu.edu>
@armru @mnencia
chore: nits
2a49f80 
Signed-off-by: Armando Ruocco <armando.ruocco@enterprisedb.com>
@armru @mnencia
refactor(controller,webhook): remove repeated logic
f7310b8 
Signed-off-by: Armando Ruocco <armando.ruocco@enterprisedb.com>
@armru @mnencia
fix: require name in usage
57ad0f5 
Signed-off-by: Armando Ruocco <armando.ruocco@enterprisedb.com>
@gbartolini @mnencia
docs: review
648b79c 
Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
@gbartolini @mnencia
docs: review
3570a77 
Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
@gbartolini @mnencia
docs: review
32e9629 
Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
@gbartolini @mnencia
docs: add operator capability levels
75e546a 
Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
@armru @mnencia
chore: ensure fdw is referenced
39f3c47 
Signed-off-by: Armando Ruocco <armando.ruocco@enterprisedb.com>
@armru @mnencia
test: evaluate the tests errors to ensure they match what we expect
2fbb95f 
Signed-off-by: Armando Ruocco <armando.ruocco@enterprisedb.com>
@mnencia mnencia force-pushed the issue-8063-declarative-support-for-foreign-server branch 2 times, most recently from 9d685ea to 50fb06a Compare September 17, 2025 17:23
@mnencia
Copy link
Member

mnencia commented Sep 17, 2025

/test

@github-actions
Copy link
Contributor

github-actions bot commented Sep 17, 2025

@mnencia, here's the link to the E2E on CNPG workflow run: https://github.com/cloudnative-pg/cloudnative-pg/actions/runs/17805595546

@mnencia mnencia force-pushed the issue-8063-declarative-support-for-foreign-server branch from df73505 to 353d04f Compare September 18, 2025 07:52
@mnencia
chore: review
3686fad 
Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
@mnencia
fix: quote options values
52fa4b6 
Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
@mnencia
fix: fdw oid cannot be casted to regproc
ce4d2e4 
Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
@mnencia
chore: only one style for yaml list indentation
32f9585 
Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
@mnencia
feat(webhook): do not check fdw reference if ensure absent
07792bc 
Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
@mnencia mnencia force-pushed the issue-8063-declarative-support-for-foreign-server branch from 353d04f to 07792bc Compare September 18, 2025 07:57
mnencia
mnencia reviewed Sep 18, 2025
View reviewed changes
@leonardoce leonardoce merged commit 6f759d0 into cloudnative-pg:main Sep 18, 2025
30 checks passed
rossigee pushed a commit to rossigee/cloudnative-pg that referenced this pull request Oct 2, 2025
@EdwinaZhu @armru
@gbartolini @mnencia @rossigee
feat(database): add declarative management of foreign servers (cloudn…
f0780b2 
…ative-pg#8401)

Add support for managing PostgreSQL Foreign Data Wrappers (FDWs) with
foreign servers declaratively via the `spec.servers` field in the
`Database` custom resource.

This enables Kubernetes-native, privilege-aware lifecycle management of
foreign servers without requiring direct SQL execution or superuser
privileges.

Supported configuration includes `name`, `ensure`, `usage`
grants/revokes, and `options`. A foreign data wrapper must already
exist.

Only foreign servers explicitly listed in `spec.servers` are reconciled;
others remain untouched. Reconciliation uses PostgreSQL’s native `CREATE
SERVER`, `ALTER SERVER`, and `DROP SERVER` commands.

Closes cloudnative-pg#8063

Signed-off-by: YingZhu <yingzhu3@andrew.cmu.edu>
Signed-off-by: Armando Ruocco <armando.ruocco@enterprisedb.com>
Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
Co-authored-by: Armando Ruocco <armando.ruocco@enterprisedb.com>
Co-authored-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
Co-authored-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
THE-BRAHMA pushed a commit to THE-BRAHMA/cloudnative-pg that referenced this pull request Oct 30, 2025
@EdwinaZhu @armru
@gbartolini @mnencia @THE-BRAHMA
feat(database): add declarative management of foreign servers (cloudn…
0c09c0a 
…ative-pg#8401)

Add support for managing PostgreSQL Foreign Data Wrappers (FDWs) with
foreign servers declaratively via the `spec.servers` field in the
`Database` custom resource.

This enables Kubernetes-native, privilege-aware lifecycle management of
foreign servers without requiring direct SQL execution or superuser
privileges.

Supported configuration includes `name`, `ensure`, `usage`
grants/revokes, and `options`. A foreign data wrapper must already
exist.

Only foreign servers explicitly listed in `spec.servers` are reconciled;
others remain untouched. Reconciliation uses PostgreSQL’s native `CREATE
SERVER`, `ALTER SERVER`, and `DROP SERVER` commands.

Closes cloudnative-pg#8063

Signed-off-by: YingZhu <yingzhu3@andrew.cmu.edu>
Signed-off-by: Armando Ruocco <armando.ruocco@enterprisedb.com>
Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
Co-authored-by: Armando Ruocco <armando.ruocco@enterprisedb.com>
Co-authored-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
Co-authored-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
Signed-off-by: theBrahma <office.utpal.brahma@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mnencia mnencia mnencia approved these changes

@gbartolini gbartolini gbartolini approved these changes

@leonardoce leonardoce leonardoce approved these changes

@armru armru armru approved these changes

@jsilvela jsilvela Awaiting requested review from jsilvela jsilvela is a code owner

@NiccoloFei NiccoloFei Awaiting requested review from NiccoloFei NiccoloFei is a code owner

@litaocdl litaocdl Awaiting requested review from litaocdl litaocdl is a code owner

Assignees

@mnencia mnencia

@gbartolini gbartolini

@leonardoce leonardoce

@armru armru

@EdwinaZhu EdwinaZhu

Labels

do not backport This PR must not be backported - it will be in the next minor release E2E tests E2E tests tickets for easy triage on release process enhancement 🪄 New feature or request lgtm This PR has been approved by a maintainer ok to merge 👌 This PR can be merged size:XXL This PR changes 1000+ lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Feature]: Declarative support for foreign servers

6 participants

@EdwinaZhu @armru @gbartolini @leonardoce @mnencia @cnpg-bot