Skip to content

docs(quick-start): replace nicocli site create with site verification#3111

Merged
shayan1995 merged 1 commit into
NVIDIA:mainfrom
shayan1995:docs/fix-site-bootstrap-quickstart
Jul 7, 2026
Merged

docs(quick-start): replace nicocli site create with site verification#3111
shayan1995 merged 1 commit into
NVIDIA:mainfrom
shayan1995:docs/fix-site-bootstrap-quickstart

Conversation

@shayan1995

Copy link
Copy Markdown
Contributor

Fix incorrect instruction in the quick-start guide that tells operators to run nicocli site create after setup.sh. The site is already bootstrapped and registered by setup.sh Phase 7g — running nicocli site create creates a second site the already-deployed site-agent cannot use, causing the site to be stuck in Pending.

Related issues

Closes #2245 - #2245

Type of Change

  • Add - New feature or capability
  • Change - Changes in existing functionality
  • Fix - Bug fixes
  • Remove - Removed features or deprecated functionality
  • Internal - Internal changes (refactoring, tests, docs, etc.)

Breaking Changes

  • This PR contains breaking changes
    No breaking changes. This is a documentation correction — no code, chart, or config is modified.

Testing

  • Unit tests added/updated
  • Integration tests added/updated
  • Manual testing performed
  • No testing required (docs, internal refactor, etc.)

Validated end-to-end on dev6: setup.sh Phase 7g bootstraps the site automatically, nicocli site list confirms exactly one site registered matching NICO_SITE_UUID, and the site-agent logs show successful bootstrap — no nicocli site create call required.

Additional Notes

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Summary by CodeRabbit

  • Documentation
    • Clarified Quick Start setup verification for NICo REST, including database connection guidance and supported override scenarios.
    • Updated the setup phase overview to reflect the databases now shown in the PostgreSQL service.
    • Reworked the site verification section to focus on confirming bootstrap completion, with clearer checks using site listing and service logs.

Walkthrough

This PR updates the Quick Start documentation to clarify database configuration defaults for the site-agent, revise the postgres StatefulSet description in setup phases, and replace "create your first site" instructions with site verification guidance using nicocli site list and site-agent logs.

Changes

Quick Start Documentation Update

Layer / File(s) Summary
Database config clarifications
docs/getting-started/quick-start.md
Clarifies that default site-agent config targets nico-pg-cluster with only DB_USER/DB_PASSWORD injected via db-creds Secret, and updates guidance for non-standard database overrides; updates the postgres StatefulSet description in the Step 4 setup phases diagram to reflect only temporal + keycloak databases.
Site verification steps
docs/getting-started/quick-start.md
Renames "Create your First Site" to "Verify your Site", broadens the 404 failure description to general site operations, prohibits manual nicocli site create usage, and adds verification steps using nicocli site list and nico-rest-site-agent log checks.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main documentation change: replacing site creation with site verification.
Description check ✅ Passed The description is directly related to the quick-start documentation fix and matches the documented behavior change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown

🔍 Container Scan Summary

No Grype artifacts were found to aggregate.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/getting-started/quick-start.md`:
- Around line 189-193: This section is out of sync with the site-agent defaults
and currently points to the wrong database configuration. Update the quick-start
text to match the actual `helm-prereqs/values/nico-site-agent.yaml` settings
used by the site agent, and make sure the references to `DB_ADDR` and
`DB_DATABASE` align with the `nico-site-agent` defaults instead of the stale
`nico-pg-cluster`/`nico_rest` values.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: f2043458-314f-4f66-845d-6c7e6f41bed7

📥 Commits

Reviewing files that changed from the base of the PR and between 12ef832 and 4c50801.

📒 Files selected for processing (1)
  • docs/getting-started/quick-start.md

Comment thread docs/getting-started/quick-start.md
@parmani-nv parmani-nv self-requested a review July 2, 2026 23:04
@polarweasel

Copy link
Copy Markdown
Contributor

@shayan1995 For whatever reason, the Fern preview build doesn't seem to have happened. Have you tested this locally to make sure it builds, and to make sure you didn't break any links when you renamed headings?

setup.sh Phase 7g bootstraps and registers the site automatically via
the nico-rest-site-agent bootstrap Job — operators must not run
nicocli site create after setup as it would create a second site that
the already-deployed site-agent cannot use.

- Replace "Create your First Site" step with a verification step
  explaining why site create must not be run and how to confirm the
  site was registered by setup.sh
- Update section header from "Create your First Site" to "Verify your Site"
- Fix step 3f: update DB reference from "dev postgres instance" to
  nico-pg-cluster (Zalando-managed), matching the current setup
- Fix component list: postgres StatefulSet hosts temporal + keycloak
  databases only; NICo REST DB runs on nico-pg-cluster
@shayan1995 shayan1995 force-pushed the docs/fix-site-bootstrap-quickstart branch from 4c50801 to 193c803 Compare July 7, 2026 00:05
@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown

@shayan1995

Copy link
Copy Markdown
Contributor Author

/ok-to-test 193c803

@shayan1995

Copy link
Copy Markdown
Contributor Author

@polarweasel The preview build is working as designed: both fern-docs-preview-build.yml and fern-docs-ci.yml gate on github.event.pull_request.head.repo.full_name == github.repository they skip fork PRs entirely until a maintainer issues /ok-to-test This PR is from my fork, hence no preview. I validated locally with the exact CI toolchain (fern-api@5.57.0, Node 20): fern check passes with 0 errors, and fern docs broken-links produces an identical error set on this branch vs main (27 pre-existing, none in this diff)

I also kicked off ok to test which is running now.

@polarweasel polarweasel left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM. Thanks for the ping!

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.

bug: [quickstart-automation] New site registration requires extensive manual patching

3 participants