Skip to content

docs: add verified quickstart - #20

Merged
STRRL merged 1 commit into
masterfrom
docs/phase-a-closeout
Jul 26, 2026
Merged

docs: add verified quickstart#20
STRRL merged 1 commit into
masterfrom
docs/phase-a-closeout

Conversation

@STRRL

@STRRL STRRL commented Jul 26, 2026

Copy link
Copy Markdown
Owner

Problem

Phase A has verified manifests, but no complete fresh cluster setup guide.

Solution

Add a quickstart using CloudNativePG, MinIO, and the released operator chart.

Major Changes

  • Quickstart
    • Document dependency, operator, project, and Studio setup
  • README
    • Link the verified quickstart

Part of #18

@STRRL
STRRL marked this pull request as ready for review July 26, 2026 22:52
@STRRL
STRRL merged commit 234f7d9 into master Jul 26, 2026
3 checks passed
@STRRL
STRRL deleted the docs/phase-a-closeout branch July 26, 2026 22:52

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ff83c7e61a

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/quickstart.md
Comment on lines +134 to +138
kubectl wait \
--namespace supabase-quickstart \
--for=jsonpath='{.status.phase}'=Running \
supabaseproject/quickstart \
--timeout 10m

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Wait for component deployments before opening Studio

On a fresh cluster, this wait can finish before any component pod is ready: internal/controller/supabaseproject_controller.go:158-168 sets the phase to Running immediately after reconciliation, while internal/controller/reconciler/component.go:35-50 only creates or updates each Deployment without checking available replicas. The following Studio port-forward can therefore fail with no running pod while images are still pulling; wait for the component Deployments to roll out before proceeding.

Useful? React with 👍 / 👎.

Comment thread docs/quickstart.md
Comment on lines +140 to +141
kubectl get supabaseproject quickstart \
--namespace supabase-quickstart

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Request the PHASE column in the get command

The packaged SupabaseProject CRD defines no additional printer columns, so this plain kubectl get command displays the default NAME and AGE columns rather than the documented NAME and PHASE result. The validation record uses an explicit -o custom-columns='NAME:.metadata.name,PHASE:.status.phase'; use that here as well so users can actually perform the stated status check.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant