zalando / zalando/postgres-operator

Make operator's PG role management observable

Open
#386 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue
Dominant language
Go
Stars
5.2k
Forks
1.1k
Avg merge
2d 16h
Merged PRs (30d)
3

Description

This area is currently a grey zone in a sense that (a) the operator reports very little about roles and (b) roles are not completely managed by the operator (e.g. not deleted).

So we can consider some of the following for debugging/monitoring/user experience purposes:

  1. Add a SQL comment on each created role that contains:
    a. message "Created by the Postgres operator"
    b. time of the last Sync event
    c. a source of the role (Teams API, manifest, infra etc.) and, if applicable, the version of the source
  2. Log at least a generic explicit message that an Update even was triggered by users' modifications. It is possible to deduce that from the new secret's creation, but that's not immediately evident to the end user new to the k8s/operator. The current messages are too generic:

level=info msg=""UPDATE" event has been queued"
level=info msg="update of the cluster started"

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing PostgreSQL role creation and the Sync and Update event paths in the operator. Define which observability improvements are in scope—role comments, source metadata, or explicit user-triggered update logs—and verify that the resulting role information and event messages meet the agreed monitoring needs.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, kubernetes, postgresql
Domain
databases, devops, observability
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.