Skip to content

[master] docs: clarify OCI Connector pull secret requirements - #984

Merged
tossmilestone merged 1 commit into
masterfrom
ACP-54758-oci-connector-pull-secret
Jul 31, 2026
Merged

[master] docs: clarify OCI Connector pull secret requirements#984
tossmilestone merged 1 commit into
masterfrom
ACP-54758-oci-connector-pull-secret

Conversation

@tossmilestone

Copy link
Copy Markdown
Member

Summary

Cherry-pick the docs-only OCI Connector pull Secret clarification from the merged release-4.4 delivery into master for ACP-54758.

Source delivery: #981

Changes

  • Clarify that an OCI Connector workload still requires a Connector proxy image pull Secret.
  • Document Pod imagePullSecrets and ServiceAccount inheritance as alternative sources.
  • Document proxy server, authorized ServiceAccount token, namespace, Secret type, token lifetime, and troubleshooting order.
  • Apply the same contract to Deployment, StatefulSet, DaemonSet, CronJob, and Image Application documentation.
  • Keep the documentation Connector-version-neutral.
  • Preserve existing private registry and platform Integration credential behavior.

Scope

  • Target branch: master
  • Changed files: six approved MDX files only
  • Component image: N/A — docs-only change
  • Connector runtime E2E: SKIPPED — user-approved out of scope

Verification

  • yarn lint: PASS, 0 errors and 0 warnings
  • yarn build: PASS
  • Static scope and version-neutral checks: PASS
  • Independent cherry-pick review: no Critical, Important, or Minor findings
  • Cherry-pick provenance: source merge commit 565ca97fccc9ee09511e09ed43b289a9549e12b8

Rollback

Revert the resulting squash merge commit on master through a standard pull request.

)

* docs: clarify OCI Connector pull secret requirements

Signed-off-by: Xiaoxi He <xxhe@alauda.io>

* docs: remove Connector version references

Signed-off-by: Xiaoxi He <xxhe@alauda.io>

---------

Signed-off-by: Xiaoxi He <xxhe@alauda.io>
(cherry picked from commit 565ca97)
@tossmilestone

Copy link
Copy Markdown
Member Author

ACP-54758 Test Cases

Status: Test plan for the master documentation backport. Connector runtime functionality is not part of the approved verification scope.

TC-1 — Cherry-pick scope

Given the ACP-54758 pull request targets master,
When the cumulative diff is reviewed,
Then only the six approved MDX files are changed and their content matches the resolved docs fix.

TC-2 — Connector-version-neutral documentation

Given the six changed pages,
When their source and rendered output are inspected,
Then no concrete Connector version, versioned Connector URL, guessed latest URL, or obsolete third-party-image-only Pull Secret restriction remains.

TC-3 — Unified image pull Secret contract

Given the common ImagePullSecret guide and the five workload entry pages,
When the documentation is read,
Then it describes the Connector proxy server, an authorized ServiceAccount token, the workload namespace, kubernetes.io/dockerconfigjson, Pod direct reference or ServiceAccount inheritance, token lifetime, and the troubleshooting sequence.

TC-4 — Entry consistency

Given Deployment, StatefulSet, DaemonSet, CronJob, and Image Application documentation,
When each create/update path is reviewed,
Then every entry links to the same internal OCI Connector ImagePullSecret guide and preserves its workload-specific update guidance.

TC-5 — Non-Connector regression

Given a private registry image or a platform Integration image that does not use an OCI Connector,
When the credential documentation is reviewed,
Then the existing registry or Integration credential behavior remains unchanged and is not replaced by a Connector proxy Secret requirement.

TC-6 — Documentation verification

Given the PR head revision,
When repository lint, build, preview, and CI checks run,
Then they complete successfully without MDX parsing, link, or rendering failures.

Scope exclusion

Connector runtime E2E, including admission annotation handling, image rewriting, Pod state, and Events, is SKIPPED — user-approved out of scope. This documentation verification does not claim that Connector runtime functionality was tested.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying alauda-container-platform with  Cloudflare Pages  Cloudflare Pages

Latest commit: 03e27b5
Status: ✅  Deploy successful!
Preview URL: https://812ab517.alauda-container-platform.pages.dev
Branch Preview URL: https://acp-54758-oci-connector-pull.alauda-container-platform.pages.dev

View logs

@tossmilestone
tossmilestone merged commit 6bcd4ae into master Jul 31, 2026
2 checks passed
@tossmilestone
tossmilestone deleted the ACP-54758-oci-connector-pull-secret branch July 31, 2026 06:15
chinameok added a commit that referenced this pull request Aug 7, 2026
* [release-4.4] docs: clarify OCI Connector pull secret requirements (#981) (#984)

* docs: clarify OCI Connector pull secret requirements



* docs: remove Connector version references



---------


(cherry picked from commit 565ca97)

Signed-off-by: Xiaoxi He <xxhe@alauda.io>

* update aml version

* docs(upgrade): clarify required Aligned plugin packages (#989)

* docs(upgrade): clarify required Aligned plugin packages

* docs: clarify aligned plugin upgrade workflow

---------

Co-authored-by: Chao Zhou <chaozhou@alauda.io>

* docs: align ACP 4.4 version and upgrade guidance

* docs: clarify Alauda OS preprocessing scope

* docs: point cnpg subsite at the 1.29 release docs (#995)

sites.yaml resolved the CloudNativePG subsite to the cnpg-docs main
branch (version: "main"), so ExternalSite links landed on the
in-development docs instead of the released ones. Point it at the
released version 1.29, matching the convention used by the other
data-service subsites.

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>

* docs: correct HCP OS support boundary

* point to npu v26.6 (#1000)

Signed-off-by: Yuan Fang <yuanfang@alauda.io>

* feat: remove servicemeshv1 from sites.yaml (#998)

Signed-off-by: 王然 <ranwang@alauda.io>

* chore: updated kafka/rabbitmq site version (#1002)

* docs: simplify OS compatibility guidance

* docs: centralize upgrade and support boundaries

* docs: address remaining ACP 4.4 review feedback

* Revert "Merge remote-tracking branch 'origin/master' into chao/ait-73302-acp-44-doc-alignment"

This reverts commit f28310b, reversing
changes made to dd6f4ee.

* docs: scope node baseline to Kubernetes 1.35 and later

* docs: restore third-party validation scope

* docs: route onboarding prerequisites to workflow guides

---------

Signed-off-by: Xiaoxi He <xxhe@alauda.io>
Signed-off-by: Yuan Fang <yuanfang@alauda.io>
Signed-off-by: 王然 <ranwang@alauda.io>
Co-authored-by: Shaw Ho <xxhe@alauda.io>
Co-authored-by: Xiaolu Zhao <xlzhao@alauda.io>
Co-authored-by: Chao Zhou <chaozhou@alauda.io>
Co-authored-by: SuJinpei <jpsu@alauda.io>
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-authored-by: fyuan1316 <yuanfang@alauda.io>
Co-authored-by: Alan Wang <ranwang@alauda.io>
Co-authored-by: Seer <hfxia@alauda.io>
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.

1 participant