Skip to content

docs: promote Supporting Services to GA and fix mkdocs warnings #375

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

Merged
mmols merged 1 commit into from
May 1, 2026
Merged

docs: promote Supporting Services to GA and fix mkdocs warnings #375

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ dev-down:

.PHONY: dev-reset
dev-reset: dev-down
# remove postgres and supported services
# remove postgres and supporting services
ids=$$(docker service ls -q); \
if [ -n "$$ids" ]; then \
echo "$$ids" \
Expand Down
3 changes: 3 additions & 0 deletions changes/unreleased/Changed-20260501-104640.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
kind: Changed
body: Promote Supporting Services from beta to generally available
time: 2026-05-01T10:46:40.2527-05:00
27 changes: 0 additions & 27 deletions docs/development/running-locally.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,5 @@
# Running the Control Plane locally

- [Running the Control Plane locally](#running-the-control-plane-locally)
Copy link
Copy Markdown
Member

@jason-lynch jason-lynch May 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have to remove this? I think most people will consume this document in their editor or in GitHub rather than our docs site, and I find the TOC really helpful for navigating it.

Copy link
Copy Markdown
Member

@jason-lynch jason-lynch May 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd also be open to removing all of our development docs from the docs site.

Copy link
Copy Markdown
Member Author

@mmols mmols May 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both Github and VS Code have outline views for viewing the table of contents, so it seemed like a consistent experience across all three places to just remove this. Obviously not every editor will have an outline view / markdown navigation features.

I think having the development docs on the docs site is valuable - it promotes the idea of outside contribution.

- [Common prerequisites](#common-prerequisites)
- [Developing the Swarm orchestrator](#developing-the-swarm-orchestrator)
- [Prerequisites](#prerequisites)
- [Configuration](#configuration)
- [Running the Control Plane](#running-the-control-plane)
- [Interact with the Control Plane API](#interact-with-the-control-plane-api)
- [Resetting your Development Environment](#resetting-your-development-environment)
- [Development Workflow](#development-workflow)
- [Rebuilding the `pgedge-control-plane` binary](#rebuilding-the-pgedge-control-plane-binary)
- [Debugging](#debugging)
- [API Documentation](#api-documentation)
- [Optional Development Tools](#optional-development-tools)
- [Restish](#restish)
- [`dev-env.zsh` Script](#dev-envzsh-script)
- [Bruno](#bruno)
- [Bruno's `wait_for_task` Helper](#brunos-wait_for_task-helper)
- [When Should I Add to the Test Scenarios?](#when-should-i-add-to-the-test-scenarios)
- [Developing the SystemD orchestrator](#developing-the-systemd-orchestrator)
- [Prerequisites](#prerequisites-1)
- [`pipx`](#pipx)
- [Circus](#circus)
- [Ansible](#ansible)
- [Lima](#lima)
- [Running the Control Plane](#running-the-control-plane-1)
- [Resetting your Development Environment](#resetting-your-development-environment-1)

## Common prerequisites

- Go >= 1.25
Expand Down
6 changes: 3 additions & 3 deletions docs/development/supported-services.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Adding a Supported Service
# Adding a Supporting Service

This guide explains how to add a new supported service type to the control plane.
This guide explains how to add a new supporting service type to the control plane.
MCP is the reference implementation throughout. All touch points are summarized in
the [checklist](#checklist-adding-a-new-service-type) at the end.

Expand All @@ -15,7 +15,7 @@ the [checklist](#checklist-adding-a-new-service-type) at the end.

## Overview

A supported service is a containerized application deployed alongside a pgEdge
A supporting service is a containerized application deployed alongside a pgEdge
database. Services are declared in `DatabaseSpec.Services`, provisioned after
the database is available, and deleted when the database is deleted.

Expand Down
11 changes: 8 additions & 3 deletions docs/services/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Supporting Services (Beta)
# Supporting Services

The pgEdge Control Plane lets you run services alongside your databases.
A supporting service is an application that attaches to a database,
runs on any host in the cluster, and connects using a database user you
specify with the `connect_as` field. The Control Plane supports the
following service types:
specify with the `connect_as` field.

The Control Plane supports the following service types:

- The [pgEdge Postgres MCP Server](mcp.md) connects AI agents and
LLM-powered applications to your database.
Expand All @@ -15,6 +16,10 @@ following service types:
your PostgreSQL schema, making your data accessible over HTTP without
writing backend code.

> [!NOTE]
> Supporting Services are not yet supported on systemd clusters; support is
> coming in a subsequent release.

## Service Instances

When you add a service to a database, the Control Plane creates one
Expand Down
6 changes: 5 additions & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,12 @@ nav:
- Managing Database Instances: using/database-instances.md
- Deleting a Database: using/delete-db.md
- Migrating a Database: using/migrate-db.md
- Supporting Services (Beta):
- Supporting Services:
- Overview: services/index.md
- Managing Services: services/managing.md
- pgEdge Postgres MCP Server: services/mcp.md
- pgEdge RAG Server: services/rag.md
- PostgREST: services/postgrest.md
- Troubleshooting:
- Recovering a Control Plane Cluster: disaster-recovery/disaster-recovery.md
- API:
Expand All @@ -91,5 +93,7 @@ nav:
- Development:
- Development Process: development/development.md
- Automated End-to-End tests: development/e2e-tests.md
- Cluster Integration Tests: development/cluster-tests.md
- Adding a Supporting Service: development/supported-services.md
- Running Locally: development/running-locally.md
- Control Plane Release Notes: changelog.md