Skip to content

docs(agents): add cluster testing guidelines to AGENTS.md#1598

Open
akurinnoy wants to merge 1 commit into
mainfrom
docs/cluster-testing-guidelines
Open

docs(agents): add cluster testing guidelines to AGENTS.md#1598
akurinnoy wants to merge 1 commit into
mainfrom
docs/cluster-testing-guidelines

Conversation

@akurinnoy

Copy link
Copy Markdown
Contributor

What does this PR do?

Documents common pitfalls when testing dashboard changes on a cluster. Found these during #1597.

Three rules added to AGENTS.md:

  • Compile TypeScript before building the Docker image — the Dockerfile copies lib/, not source, so skipping the build step silently produces a stale image
  • Use a unique image tag per iteration — nodes cache images by digest, deleting a pod does not force a fresh pull
  • Patch the CheCluster CR, not the Deployment directly — the operator reverts direct Deployment patches within seconds

Screenshot/screencast of this PR

N/A — docs only

What issues does this PR fix or reference?

Related: #1597

Is it tested? How?

Documentation only.

Release Notes

N/A

Docs PR

N/A

Document the build pipeline quirks that affect anyone deploying a
patched dashboard image to a cluster:
- Compile TypeScript before building the Docker image (lib/ is copied,
  not src/)
- Always build multiarch (amd64+arm64) to avoid arch mismatch failures
- Use a fresh image tag or imagePullPolicy=Always to avoid stale node
  cache
- Patch the CheCluster CR instead of the Deployment directly, as the
  operator silently reverts direct Deployment patches
- Do not delegate Docker/cluster commands to background agents

Assisted-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Oleksii Kurinnyi <okurinny@redhat.com>
@akurinnoy akurinnoy requested review from ibuziuk and olexii4 as code owners June 5, 2026 13:42
@openshift-ci

openshift-ci Bot commented Jun 5, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: akurinnoy

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@che-bot

che-bot commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

Click here to review and test in web IDE: Contribute

@tolusha

tolusha commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

Hi! I'm che-ai-assistant — I help with your pull requests.

Available commands:

  • /che-ai-assistant generate-che-doc — Generate a documentation PR based on this PR's changes
  • /che-ai-assistant ok-pr-review — Run a comprehensive PR review (summary, code review, deep review, impact analysis)
  • /che-ai-assistant help — Show this help message

@github-actions

github-actions Bot commented Jun 5, 2026

Copy link
Copy Markdown

Docker image build succeeded: quay.io/eclipse/che-dashboard:pr-1598 (linux/amd64, linux/arm64)

kubectl patch command
kubectl patch -n eclipse-che "checluster/eclipse-che" --type=json -p="[{"op": "replace", "path": "/spec/components/dashboard/deployment", "value": {containers: [{image: "quay.io/eclipse/che-dashboard:pr-1598", name: che-dashboard}]}}]"

@openshift-ci

openshift-ci Bot commented Jun 5, 2026

Copy link
Copy Markdown

@akurinnoy: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/v19-dashboard-happy-path 977194c link true /test v19-dashboard-happy-path

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@akurinnoy akurinnoy requested review from Copilot and removed request for Copilot June 8, 2026 14:35
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.

3 participants