OCPCLOUD-3569: Initial import of rough provider tooling documentation

[mdbooth]

Summary by CodeRabbit

• Documentation
  • Added a new guide defining the required “Provider Contract” for CAPI provider repositories, including expected manifest-generation inputs, required kustomization structure, and standard manifest transformations.
  • Updated provider onboarding instructions by removing the old operator asset workflow and replacing it with steps for adding provider metadata and referencing provider images in the OpenShift release payload/operator manifests.

[openshift-merge-bot]

Pipeline controller notification
This repo is configured to use the pipeline controller. Second-stage tests will be triggered either automatically or after lgtm label is added, depending on the repository configuration. The pipeline controller will automatically detect which contexts are required and will utilize /test Prow commands to trigger the second stage.

For optional jobs, comment /test ? to see a list of all defined jobs. To trigger manually all jobs from second stage use /pipeline required command.

This repository is configured in: LGTM mode

[openshift-ci-robot]

@mdbooth: This pull request references OCPCLOUD-3569 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "5.0.0" version, but no target version was set.

Details

In response to this:

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 openshift-eng/jira-lifecycle-plugin repository.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: f622d984-dc15-4e75-80c3-66df032411b2

📥 Commits

Reviewing files that changed from the base of the PR and between 3d21797 and c94e9e7.

📒 Files selected for processing (2)

• docs/provider-contract.md
• docs/provideronboarding.md

✅ Files skipped from review due to trivial changes (1)

• docs/provider-contract.md

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/provideronboarding.md

---

Walkthrough

Adds docs/provider-contract.md defining how CAPI provider repos invoke manifests-gen, structure kustomization.yaml, and apply standard manifest transformations. Updates docs/provideronboarding.md to replace the old workflow with the new contract and image-registration steps.

Changes

Provider Contract and Onboarding Docs

Layer / File(s)	Summary
Manifests-gen invocation and inputs docs/provider-contract.md	Defines the ocp-manifests target invocation and required manifests-gen inputs, including self-image-ref validation against registry.ci.openshift.org.
Provider kustomization structure and transforms docs/provider-contract.md	Documents the required kustomization.yaml shape, inclusion of the manifests-gen component, and the standard manifest transformations applied to generated provider manifests.
Onboarding contract and image registration docs/provideronboarding.md	Replaces the old asset workflow with references to the provider contract and the release-payload image registration steps.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 14 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Microshift Test Compatibility	⚠️ Warning	New e2e Ginkgo suites use unsupported OpenShift APIs (config.openshift.io, machine.openshift.io) with no MicroShift skip/tag guard.	Add [Skipped:MicroShift], an [apigroup:...] tag, or an exutil.IsMicroShiftCluster() g.Skip() guard to the affected suites, or remove MicroShift-unsupported APIs.

✅ Passed checks (14 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately reflects the main change: an initial import of provider tooling documentation.
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.
Stable And Deterministic Test Names	✅ Passed	834 Ginkgo titles were parsed; none used dynamic first args or fmt.Sprintf, and the only hyphenated matches were static descriptions.
Test Structure And Quality	✅ Passed	PR only adds/edits docs; no Ginkgo test code was changed, so the test-structure checklist is not applicable.
Single Node Openshift (Sno) Test Compatibility	✅ Passed	PR changes only docs/provider-contract.md and docs/provideronboarding.md; no Ginkgo tests or cluster-assumption code were added.
Topology-Aware Scheduling Compatibility	✅ Passed	PASS: The PR only changes onboarding docs; no manifests, controllers, or scheduling logic were added, and the docs don’t introduce topology-sensitive constraints.
Ote Binary Stdout Contract	✅ Passed	PR changes only docs/provider-contract.md and docs/provideronboarding.md; no executable code or process-level stdout writes were introduced.
Ipv6 And Disconnected Network Test Compatibility	✅ Passed	PR only updates docs/provider-contract.md and docs/provideronboarding.md; no new Ginkgo e2e tests or network-related code were added.
No-Weak-Crypto	✅ Passed	Touched docs contain no MD5/SHA1/DES/RC4/3DES/Blowfish/ECB or secret-comparison code; only documentation text was added/updated.
Container-Privileges	✅ Passed	Only two docs changed; no manifest files or privileged/hostPID/hostNetwork/hostIPC/allowPrivilegeEscalation settings were added.
No-Sensitive-Data-In-Logs	✅ Passed	PASS: Changes are docs-only; no logging code or log statements were added, and no secrets/PII/session data appear in the modified files.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

[openshift-ci]

[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 stephenfin for approval. For more information see the 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:

• OWNERS

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

[coderabbitai]

Actionable comments posted: 3

🤖 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/provider-contract.md`:
- Line 5: The provider-contract docs contain a typo in the Makefile reference:
the onboarding path should point to the existing openshift/Makefile, not
openshift/Makfile. Update the sentence in the docs text that mentions the
ocp-manifests target so the path name is spelled correctly and matches the
actual file referenced by manifests-gen.
- Around line 74-76: Update the contract text in the provider document to match
the actual `manifests-gen` behavior: it does not translate all cert-manager
manifests, but instead drops `cert-manager.io` resources and rewrites the
relevant annotations on the remaining webhook-related objects to use OpenShift
Service CA. Keep the surrounding guidance about excluding `Namespace` and
`Secret` objects, and adjust the wording near the cert-manager note so providers
understand which resources are removed versus transformed.
- Line 84: The priorityClassName value in the provider contract text has a typo
and should match the manifests-gen behavior. Update the wording in the relevant
documentation entry that mentions priorityClassName so it uses
system-cluster-critical instead of sytem-cluster-critical.

🪄 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: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: 14f517df-b39c-4ac2-8c88-6a6144d9ac2c

📥 Commits

Reviewing files that changed from the base of the PR and between 5656e20 and 3d21797.

📒 Files selected for processing (2)

• docs/provider-contract.md
• docs/provideronboarding.md

[openshift-ci]

@mdbooth: all tests passed!

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.