Skip to content

docs: add ARM64/AArch64 validation and troubleshooting guide#3397

Open
iknowmaaz-mz wants to merge 17 commits intokubeflow:masterfrom
iknowmaaz-mz:docs-arm64-validation
Open

docs: add ARM64/AArch64 validation and troubleshooting guide#3397
iknowmaaz-mz wants to merge 17 commits intokubeflow:masterfrom
iknowmaaz-mz:docs-arm64-validation

Conversation

@iknowmaaz-mz
Copy link
Copy Markdown
Contributor

✏️ Summary of Changes

  • Added a new ARM64/AArch64 validation and troubleshooting guide at docs/arm64.md.
    • Includes recommended versions (v1.9 branch / default branch), prerequisites, and common ARM-related failure modes (ImagePullBackOff, ErrImagePull, exec format error, CrashLoopBackOff).
    • Provides copy/paste commands to collect useful debugging data (kubectl describe, kubectl logs) and extract the full list of images referenced by kustomize build example.
    • Adds a concise “report template” to standardize what users should post back for ARM64 failures.
  • Linked the new document from README.md under a new Documentation section.
  • Ran kustomize build example successfully; it prints existing warnings about deprecated kustomize fields and unused vars (kfp-app-name, kfp-app-version).

📦 Dependencies

  • None.

🐛 Related Issues

✅ Contributor Checklist

  • I have tested these changes with kustomize. See Installation Prerequisites.
  • All commits are signed-off to satisfy the DCO check.
  • I have considered adding my company to the adopters page to support Kubeflow and help the community, since I expect help from the community for my issue (see 1. and 2.).

Signed-off-by: iknowmaaz-mz <iknowmaaz@gmail.com>
Signed-off-by: iknowmaaz-mz <iknowmaaz@gmail.com>
Copilot AI review requested due to automatic review settings March 17, 2026 19:29
@google-oss-prow google-oss-prow Bot requested a review from kimwnasptd March 17, 2026 19:29
@google-oss-prow
Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign juliusvonkohout for approval. For more information see the Kubernetes Code Review Process.

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

@google-oss-prow google-oss-prow Bot requested a review from tarekabouzeid March 17, 2026 19:29
@github-actions
Copy link
Copy Markdown

Welcome to the Kubeflow Manifests Repository

Thanks for opening your first PR. Your contribution means a lot to the Kubeflow community.

Before making more PRs:
Please ensure your PR follows our Contributing Guide.
Please also be aware that many components are synchronizes from upstream via the scripts in /scripts.
So in some cases you have to fix the problem in the upstream repositories first, but you can use a PR against kubeflow/manifests to test the platform integration.

Community Resources:

Thanks again for helping to improve Kubeflow.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds an ARM64/AArch64 validation + troubleshooting document and exposes it from the repository README to help users collect consistent debugging info for ARM-related failures (image pulls, wrong-arch binaries, crash loops).

Changes:

  • Added docs/arm64.md with ARM64/AArch64 prerequisites, common failure modes, and copy/paste debugging commands.
  • Added a short Documentation section to README.md linking to the new ARM64 guide.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/arm64.md New ARM64/AArch64 install validation & troubleshooting guide, including debugging commands and a reporting template.
README.md Adds a Documentation section pointing readers to the new ARM64 guide.

You can also share your feedback on Copilot code review. Take the survey.

Comment thread docs/arm64.md Outdated
Comment thread README.md Outdated
Signed-off-by: iknowmaaz-mz <iknowmaaz@gmail.com>
Comment thread docs/arm64.md Outdated
Signed-off-by: iknowmaaz-mz <iknowmaaz@gmail.com>
@iknowmaaz-mz
Copy link
Copy Markdown
Contributor Author

Hi @christian-heusel , thanks again for the earlier guidance. I’ve addressed the feedback in the thread and the PR should be ready now.
When you have a moment, could you please take another look and let me know if anything else is needed for approval/merge?

Comment thread docs/arm64.md Outdated
Signed-off-by: iknowmaaz-mz <iknowmaaz@gmail.com>
Signed-off-by: iknowmaaz-mz <iknowmaaz@gmail.com>
Signed-off-by: iknowmaaz-mz <iknowmaaz@gmail.com>
Comment thread .github/workflows/arm64_validation.yaml Outdated
Comment thread .github/workflows/arm64_validation.yaml Outdated
Comment thread .github/workflows/arm64_validation.yaml Outdated
Comment thread .github/workflows/arm64_validation.yaml Outdated
exit 1
fi

echo "SUCCESS: All checked multi-arch images advertise linux/arm64 (excluding allowlist)."
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
echo "SUCCESS: All checked multi-arch images advertise linux/arm64 (excluding allowlist)."

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I noticed the suggestion is the same as the current code:
echo "SUCCESS: All checked multi-arch images advertise linux/arm64 (excluding allowlist)."
Could you clarify if you’d like the success message revised further or if this is fine as is? I can simplify it to something more concise if needed.

Comment thread .github/workflows/arm64_validation.yaml
Comment thread .github/workflows/arm64_validation.yaml Outdated
Comment thread docs/arm64.md Outdated
@google-oss-prow google-oss-prow Bot added size/M and removed size/L labels Apr 5, 2026
Signed-off-by: iknowmaaz-mz <iknowmaaz@gmail.com>
Signed-off-by: iknowmaaz-mz <iknowmaaz@gmail.com>
@iknowmaaz-mz iknowmaaz-mz force-pushed the docs-arm64-validation branch from 43335b6 to 9379756 Compare April 5, 2026 18:36
Signed-off-by: iknowmaaz-mz <iknowmaaz@gmail.com>
- Removed unnecessary debug outputs.
- Adjusted to only report unsupported images.
- Updated triggers and preserved allowlist handling.
- Focused solely on test results and summary output.

Signed-off-by: iknowmaaz-mz <iknowmaaz@gmail.com>
- Added retry logic for Kustomize download to handle network failures.
- Added fallback to Kustomize v5.8.0 if v5.8.1 fails to download.
- Verified checksums before installation.
- Improved error handling for readability.
Signed-off-by: Your Name <your.email@example.com>

Signed-off-by: iknowmaaz-mz <iknowmaaz@gmail.com>
@google-oss-prow google-oss-prow Bot added size/L and removed size/M labels Apr 5, 2026
Signed-off-by: iknowmaaz-mz <iknowmaaz@gmail.com>
…nore

Signed-off-by: iknowmaaz-mz <iknowmaaz@gmail.com>
Signed-off-by: iknowmaaz-mz <iknowmaaz@gmail.com>
@google-oss-prow google-oss-prow Bot added size/M and removed size/L labels Apr 5, 2026
Signed-off-by: iknowmaaz-mz <iknowmaaz@gmail.com>
@google-oss-prow google-oss-prow Bot added size/L and removed size/M labels Apr 5, 2026
Signed-off-by: iknowmaaz-mz <iknowmaaz@gmail.com>
Signed-off-by: iknowmaaz-mz <iknowmaaz@gmail.com>
@juliusvonkohout
Copy link
Copy Markdown
Member

juliusvonkohout commented Apr 5, 2026

And this might not be needed anymore after the KFP arm Backport for the 2.16 release. Please also read the copilot instructions.md

/hold

@iknowmaaz-mz
Copy link
Copy Markdown
Contributor Author

Thanks for pointing this out! I’ll review the KFP ARM backport for 2.16 and check the copilot_instructions.md to see if this is still needed. Will follow up soon.

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants