Skip to content

update skills docs#488

Merged
clyang82 merged 1 commit intoopenshift-online:mainfrom
skeeey:skills-update
Feb 13, 2026
Merged

update skills docs#488
clyang82 merged 1 commit intoopenshift-online:mainfrom
skeeey:skills-update

Conversation

@skeeey
Copy link
Contributor

@skeeey skeeey commented Feb 12, 2026

No description provided.

Signed-off-by: Wei Liu <liuweixa@redhat.com>
@coderabbitai
Copy link

coderabbitai bot commented Feb 12, 2026

Walkthrough

This PR updates documentation files to clarify terminology around ManifestWork and resource bundles across two SKILL.md files, and modifies a bash script to prioritize querying maestro-db pods in the maestro namespace when available, with postgres-breakglass as a fallback option.

Changes

Cohort / File(s) Summary
Documentation - Terminology Clarification
.claude/skills/trace-manifestwork/SKILL.md, .claude/skills/trace-resource-request/SKILL.md
Adds Terminology sections clarifying that ManifestWork, resource bundle, and Resource are interchangeable terms in Maestro, with notes on equivalence to database storage and cluster resources.
Query Script - Database Access Priority
.claude/skills/trace-manifestwork/scripts/trace.sh
Modifies query_db() function to prioritize maestro-db pod queries in maestro namespace when available, detecting PostgreSQL user and executing via psql. Removes previous service-cluster maestro-db path. Retains postgres-breakglass as fallback with pod health checks and manual access guidance.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 1 | ❌ 2
❌ Failed checks (2 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'update skills docs' is vague and generic, using non-descriptive phrasing that doesn't convey what specific documentation updates were made. Provide a more specific title that describes the actual changes, such as 'Add terminology clarifications to skills documentation' or 'Update ManifestWork trace skills docs'.
Description check ❓ Inconclusive No pull request description was provided by the author, making it impossible to assess whether the description relates to the changeset. Add a pull request description that explains the purpose of the documentation updates and clarifies what terminology was added and why.
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.claude/skills/trace-manifestwork/scripts/trace.sh (1)

279-282: ⚠️ Potential issue | 🟡 Minor

Error message lists pods in reverse order of actual check sequence.

The error message states it checked for postgres-breakglass first, then maestro-db, but the code actually checks maestro-db first (line 186) then falls back to postgres-breakglass (line 206). Consider reordering for consistency.

Suggested fix
     echo "ERROR: No database pod found on service cluster"
     echo "Checked for:"
-    echo "  - postgres-breakglass deployment (ARO-HCP INT)"
     echo "  - maestro-db pod (Service cluster)"
+    echo "  - postgres-breakglass deployment (ARO-HCP INT)"

@skeeey
Copy link
Contributor Author

skeeey commented Feb 12, 2026

/cc @clyang82

- **ManifestWork**: The formal Kubernetes Custom Resource Definition (CRD) name used by the Open Cluster Management SDK
- **Resource bundle**: The term used in Maestro's RESTful API endpoints (e.g., `/api/maestro/v1/resource-bundles`)

When users refer to "resource bundles," they are talking about ManifestWork resources. Both terms describe a collection of Kubernetes manifests packaged together for delivery to target clusters. The database stores these in the `resources` table, while the Kubernetes cluster manages them as ManifestWork/AppliedManifestWork CRs.
Copy link
Contributor

Choose a reason for hiding this comment

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

we do not have ManifestWork CR, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

we have, it just exist in memory

Copy link
Contributor

@clyang82 clyang82 left a comment

Choose a reason for hiding this comment

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

LGTM

@clyang82 clyang82 merged commit 081c1f6 into openshift-online:main Feb 13, 2026
13 checks passed
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.

2 participants