Add pgaccess feature by jhrv · Pull Request #526 · nais/api

jhrv · 2026-09-17T12:27:43Z

This pull request introduces support for personal Postgres access management via the API, including new authorizations, RBAC rules, GraphQL mutations and queries, and comprehensive integration tests. The changes ensure that users can request, retrieve, and audit personal Postgres access securely, with fine-grained authorization checks and proper activity logging.

API and Authorization Enhancements:

Added a new postgres:access:read authorization, granting team members and owners permission to read personal Postgres access status and credentials. This is enforced via a new CanReadPostgresAccess function and corresponding database migration. [1] [2]
Updated RBAC rules to allow get and create verbs for the postgresaccesses resource in the nais.io API group, enabling the necessary Kubernetes permissions for managing Postgres access. [1] [2]

GraphQL API Additions:

Introduced the createPostgresAccess mutation and postgresAccessConnection and postgresAccess queries, along with their input types and resolvers, to support creation and retrieval of personal Postgres access and connection credentials. [1] [2] [3] [4] [5]
Extended the activity log GraphQL resolvers to support new activity log entry types for personal Postgres access creation and connection retrieval.

Integration Tests and Fixtures:

Added comprehensive integration tests in create_postgres_access.lua to cover authorization, error cases (such as unknown/unavailable instances), successful access creation, credential retrieval, and auditing.
Introduced Kubernetes resource fixtures for various Postgres access scenarios (ready, expired, pending, missing secret) and Postgres cluster states (ready, progressing) to support the integration tests. [1] [2] [3] [4] [5] [6] [7]

These changes collectively enable secure and auditable management of personal Postgres access for team members via the API.

References:
[1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18]

Copilot

🟡 Changes recommended

The status query has unresolved authorization behavior and requires additional integration coverage.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Adds secure, auditable personal Postgres access management through GraphQL, authorization, RBAC, persistence, and integration tests.

Changes:

Adds access creation, status, and credential retrieval.
Adds authorization, auditing, migration, and Kubernetes RBAC support.
Adds models, resolvers, generated schema code, tests, and fixtures.

File summaries

File	Summary
`internal/persistence/postgres/queries.go`	Access creation and retrieval logic
`internal/persistence/postgres/queries_test.go`	Unit tests for access handling
`internal/persistence/postgres/node.go`	Node identification support
`internal/persistence/postgres/models.go`	Access models and validation
`internal/persistence/postgres/activitylog.go`	Access audit transformations
`internal/graph/schema/postgres.graphqls`	GraphQL schema additions
`internal/graph/postgres.resolvers.go`	GraphQL resolvers
`internal/graph/gengql/schema.generated.go`	Generated schema execution code
`internal/graph/gengql/root_.generated.go`	Generated resolver metadata
`internal/graph/gengql/activitylog.generated.go`	Generated activity-log support
`internal/database/migrations/0075_add_postgres_access_read_authorization.sql`	Read authorization migration
`internal/auth/authz/queries.go`	Postgres access authorization checks
`integration_tests/k8s_resources/create_postgres_access/dev/someteamname/secret_ready_access_credentials.yaml`	Ready credential fixture
`integration_tests/k8s_resources/create_postgres_access/dev/someteamname/postgres_progressing.yaml`	Progressing instance fixture
`integration_tests/k8s_resources/create_postgres_access/dev/someteamname/postgres_foobar.yaml`	Available instance fixture
`integration_tests/k8s_resources/create_postgres_access/dev/someteamname/postgres_access_ready.yaml`	Ready access fixture
`integration_tests/k8s_resources/create_postgres_access/dev/someteamname/postgres_access_pending-access.yaml`	Pending access fixture
`integration_tests/k8s_resources/create_postgres_access/dev/someteamname/postgres_access_missing-secret-access.yaml`	Missing-secret fixture
`integration_tests/k8s_resources/create_postgres_access/dev/someteamname/postgres_access_expired-access.yaml`	Expired access fixture
`integration_tests/create_postgres_access.lua`	Integration coverage for access flows
`charts/console-backend-rbac/templates/rbac.yaml`	Kubernetes RBAC permissions

Review details

Files not reviewed (2)

internal/graph/gengql/activitylog.generated.go: Generated file
internal/graph/gengql/schema.generated.go: Generated file

Suppressed comments (15)

internal/graph/schema/postgres.graphqls:266

The newly added activity-log schema types/data type are missing the required public descriptions (and the data fields are undocumented). Add descriptions for the type and each field before exposing this schema.

type PostgresPersonalAccessCreatedActivityLogEntryData {
	username: String!
	expiresAt: Time!
	reason: String!

internal/graph/schema/postgres.graphqls:338

The new CreatePostgresAccessPayload type and its fields are missing the required public descriptions. Add developer-facing descriptions before exposing this payload in the schema.

type CreatePostgresAccessPayload {
	"Name of the newly created PostgresAccess resource."
	name: String!
	"Server-controlled expiry for this personal access."
	expiresAt: Time!

internal/graph/schema/postgres.graphqls:345

The new input type and its fields are largely undocumented; only reason has a description. Add descriptions for the input and every field, including the access-level and client-key semantics.

input CreatePostgresAccessInput {
	postgresInstance: String!
	teamSlug: Slug!
	environmentName: String!
	accessLevel: PostgresAccessLevel!

internal/graph/schema/postgres.graphqls:354

The new PostgresAccessLevel enum and all of its values lack descriptions. Add developer-facing descriptions for the enum and each value.

enum PostgresAccessLevel {
	READ
	READWRITE
	READWRITECREATE

internal/graph/schema/postgres.graphqls:412

The new PostgresAccess type and its id/name fields omit the required descriptions. Add a type description and explain these fields in the public schema.

type PostgresAccess implements Node {
	id: ID!
	name: String!

internal/graph/schema/postgres.graphqls:435

The new PostgresAccessState enum and all values lack descriptions. Add developer-facing descriptions for the enum and each state.

enum PostgresAccessState {
	PENDING
	READY
	FAILED
	EXPIRED

internal/graph/schema/postgres.graphqls:450

The new connection input type and its fields are missing public descriptions. Add descriptions for the type and each input field.

input PostgresAccessConnectionInput {
	name: String!
	teamSlug: Slug!
	environmentName: String!

internal/graph/schema/postgres.graphqls:457

The new connection payload type and its fields are missing public descriptions. Add descriptions for the type and each returned field, especially the sensitive credential fields.

type PostgresAccessConnectionPayload {
	password: String!
	caCertificate: String!
	serverName: String!
	tunnel: PostgresAccessConnectionTunnel!

internal/graph/schema/postgres.graphqls:463

The new connection tunnel type and both fields are missing public descriptions. Add descriptions explaining the endpoint and gateway key.

type PostgresAccessConnectionTunnel {
	endpoint: String!
	gatewayPublicKey: String!
}

internal/graph/schema/postgres.graphqls:438

The new PostgresAccessTunnel type itself lacks a description even though its fields are documented. Add a developer-facing type description.

type PostgresAccessTunnel {

internal/graph/schema/postgres.graphqls:273

The new personal-access-connection activity-log type and its fields are all missing public descriptions. Add descriptions for the type and every field.

type PostgresPersonalAccessConnectionActivityLogEntry implements ActivityLogEntry & Node {
	id: ID!
	actor: String!
	createdAt: Time!
	message: String!

internal/graph/schema/postgres.graphqls:451

The connection input and the response types below are public schema additions but have no descriptions on their types or fields. Add developer-facing descriptions for the input, payload, tunnel, and every field before publishing them.

input PostgresAccessConnectionInput {
	name: String!
	teamSlug: Slug!
	environmentName: String!
}

internal/graph/schema/postgres.graphqls:457

The connection payload and tunnel types expose credentials and connection metadata without GraphQL descriptions. Document the types and each field, particularly password and caCertificate, so consumers understand the sensitivity and purpose of these values.

type PostgresAccessConnectionPayload {
	password: String!
	caCertificate: String!
	serverName: String!
	tunnel: PostgresAccessConnectionTunnel!

internal/persistence/postgres/queries.go:156

CanReadPostgresAccess grants this operation to team members, but this additional owner check rejects every non-owner with PostgresAccess not found. That makes the new read authorization ineffective for the status query and conflicts with the migration's Team member role; keep the owner-only check for credentials if intended, but allow authorized team members to read status.

	actor := authz.ActorFromContext(ctx)
	if actor == nil || access.Username != actor.User.Identity() {
		return nil, apierror.Errorf("PostgresAccess %q not found", name)
	}

internal/persistence/postgres/queries.go:128

The new public status query/Node lookup is not exercised by the added integration tests; they cover only connection retrieval and helper functions. Add an integration test for postgresAccess (including pending/expired state mapping and a different-owner request) because this path contains the ownership and status exposure checks.

func GetPostgresAccessByIdent(ctx context.Context, id ident.Ident) (*PostgresAccess, error) {
	teamSlug, environmentName, name, err := parseAccessIdent(id)
	if err != nil {
		return nil, err
	}

	return GetPostgresAccess(ctx, name, teamSlug, environmentName)

Files reviewed: 25/28 changed files
Comments generated: 2
Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Copilot

Copilot review overview

🟡 Changes recommended

One or more issues must be addressed before approval.

Review effort: Lite
Findings: 2 · 2

Open (4)

Expose Postgres access through graph resource nodes · New
Guard status queries with read authorization · New
Document PostgresInstance state and labels · New
Reuse one fake client across resource groups · New

Resolved since last review (2)

The new postgresAccess query has no integration test. Please cover its authorization boundary and…
The new personal-access-created activity-log type lacks a type description. Add a concise…

…hanges

Copilot

Copilot review overview

🟡 Changes recommended

Critical database migration and missing-package blockers remain, along with API compatibility and GraphQL behavior issues.

Review effort: Lite
Findings: 2 · 1

Open (3)

Add migration for github_actor_claims column and view · New
Fix missing GitHub middleware package import · New
Preserve ZALANDO_POSTGRES as deprecated enum alias · New

Resolved since last review (4)

Guard status queries with read authorization
Expose Postgres access through graph resource nodes
Reuse one fake client across resource groups
Document PostgresInstance state and labels

+		data,
+		github_actor_claims


 	"github.com/coreos/go-oidc/v3/oidc"
 	"github.com/google/uuid"
 	"github.com/nais/api/internal/auth/authz"
+	"github.com/nais/api/internal/auth/middleware/github"


  DATABASE_TYPE_UNSPECIFIED = 0;
  CLOUD_SQL = 1;
-  ZALANDO_POSTGRES = 2;
+  NAIS_POSTGRES = 2;


… test

thokra-nav

En del @deprecated kommentarer, sikkert fler som jeg ikke har sett. Men hvis det er sikkert at cli, console og andre ikke bruker det, så er det greit å slette nå. Samme med kommentarene til copilot over

thokra-nav

Så tilfeldigvis på rbac, og kom over dette

thokra-nav

Ser at vi gjør get på en del ressurser via getAccessResource uten informer, er det fordi vi har hemmeligheter i de?

jhrv · 2026-09-29T19:13:31Z

@thokra-nav tror vi da har fiksa det vi snakket om.

fjerne kobling mot relayaccess etc, alt går via postgresaccess
instance -> branch

thokra-nav · 2026-09-30T09:19:59Z

+	if !reflect.DeepEqual(wantSpec, spec) {
+		t.Errorf("spec = %#v, want %#v", spec, wantSpec)
+	}


Bruke go-cmp i stedet for reflect.DeepEqual? Synes den gir en tydeligere diff når noe er galt

thokra-nav · 2026-09-30T09:23:04Z

+	access, err := getPostgresAccessResource(ctx, input.Name, input.TeamSlug, input.EnvironmentName)
 	if err != nil {
-		return err
+		return nil, err
 	}


Skulle vi konvertert til pgrator typen her? Så slepper vi å bruke unstructured.Nested... for å hente data, og alle if err != nil hver gang.

accessUnstructured, err := getPostgresAccessResource(ctx, input.Name, input.TeamSlug, input.EnvironmentName) if err != nil { return nil, err } access, err := kubernetes.ToConcrete[nais_io_v1.PostgresAccess](o) if err != nil { return nil, false }

Branches are now addressed as (postgres, branch) with names local to the Postgres. PostgresBranch objects get a deterministic, hashed metadata.name derived by pgrator, which the API verifies on every lookup. - GraphQL: add Postgres.branch(name)/branches, make Postgres.activeBranch a PostgresBranch, remove TeamEnvironment.postgresBranch(name) - createPostgresAccess and deletePostgresBranch take postgres + branch - Show postgres/branch in search; branch IDs are keyed on (postgres, branch) - Use typed nais_io_v1 resources and go-cmp per review - Pin pgrator/pkg/api to 3ab0adf and merge origin/main

feat: pgaccess

4d61408

jhrv requested a review from a team as a code owner September 17, 2026 12:27

nais-team-app Bot added the graphql-review-required label Sep 17, 2026

jhrv commented Sep 17, 2026

View reviewed changes

fix: add reason

7faef84

jhrv requested a lite review from Copilot September 17, 2026 13:01

Copilot started reviewing on behalf of jhrv September 17, 2026 13:01

View session

refactor(postgres): address personal access review comments

ff4b3d6

Copilot AI reviewed Sep 17, 2026

View reviewed changes

Comment thread internal/graph/postgres.resolvers.go Outdated

Comment thread internal/graph/schema/postgres.graphqls

jhrv added 4 commits September 17, 2026 15:48

fix review comments

9ddc6f0

fix: specify usage on different pg access commands

8da0ee7

fix stuff based on feedback

8d30c01

Align Postgres API with Postgres and PostgresInstance CRDs

bb6bcbe

jhrv requested a lite review from Copilot September 29, 2026 04:53

Copilot started reviewing on behalf of jhrv September 29, 2026 04:54

View session

Copilot AI reviewed Sep 29, 2026

View reviewed changes

Comment thread internal/graph/schema/postgres.graphqls Outdated

Comment thread internal/persistence/postgres/queries.go

Comment thread internal/graph/schema/postgres.graphqls Outdated

Comment thread internal/kubernetes/fake/postgres_fixtures_test.go

Align Postgres access GraphQL with API conventions and resolve main c…

f889bfa

…hanges

jhrv requested a lite review from Copilot September 29, 2026 05:43

Copilot started reviewing on behalf of jhrv September 29, 2026 05:44

View session

Copilot AI reviewed Sep 29, 2026

View reviewed changes

jhrv added 4 commits September 29, 2026 08:11

Consolidate PostgresAccess integration fixtures and add access level

060cae6

Merge origin/main into pgaccess

7a057c3

Fix Postgres integration test expectations

8775a90

Limit Postgres GraphQL descriptions to changed API and fix validation…

8556f4e

… test

thokra-nav reviewed Sep 29, 2026

View reviewed changes

Comment thread internal/graph/schema/postgres.graphqls

Comment thread internal/graph/schema/postgres.graphqls

Comment thread internal/graph/schema/postgres.graphqls Outdated

Comment thread internal/graph/schema/postgres.graphqls

Comment thread internal/graph/schema/postgres.graphqls Outdated

jhrv added 3 commits September 29, 2026 10:59

leave old grantpgaccess for now

4bb168c

fixes

82c4d76

Preserve Zalando Postgres enum and assign Nais Postgres a distinct value

0e65a43

thokra-nav reviewed Sep 29, 2026

View reviewed changes

Comment thread internal/persistence/postgres/queries.go Outdated

Comment thread internal/persistence/postgres/queries.go Outdated

thokra-nav reviewed Sep 29, 2026

View reviewed changes

Use one PostgresAccess GVR for reads and creation

ab4a76d

thokra-nav reviewed Sep 29, 2026

View reviewed changes

Comment thread internal/graph/schema/postgres.graphqls

jhrv added 3 commits September 29, 2026 14:23

Resolve personal Postgres connections from PostgresAccess status

bcf6ee1

instances -> branches

2901eec

fix: build PostgresBranch API against published pgrator module

4d37b2d

thokra-nav reviewed Sep 30, 2026

View reviewed changes

jhrv added 2 commits October 1, 2026 07:41

test: update label selector Postgres expectations for local branch names

080ae36

thokra-nav approved these changes Oct 1, 2026

View reviewed changes

nais-team-app Bot removed the graphql-review-required label Oct 1, 2026

jhrv merged commit 49d23ab into main Oct 1, 2026
11 checks passed

jhrv deleted the pgaccess branch October 1, 2026 07:35

jhrv mentioned this pull request Oct 6, 2026

postgres: broker personal PostgresAccess through nais API #525

Closed

6 tasks

Conversation

jhrv commented Sep 17, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Files not reviewed (2)

Suppressed comments (15)

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

thokra-nav left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thokra-nav left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

thokra-nav left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jhrv commented Sep 29, 2026

Uh oh!

thokra-nav Sep 30, 2026

Choose a reason for hiding this comment

Uh oh!

thokra-nav Sep 30, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

thokra-nav left a comment •

edited

Loading