Skip to content

docs(konveyor): add the Alauda support for Konveyor installation guide - #821

Merged
SuJinpei merged 1 commit into
mainfrom
docs/konveyor-installation-guide
Jul 29, 2026
Merged

docs(konveyor): add the Alauda support for Konveyor installation guide#821
SuJinpei merged 1 commit into
mainfrom
docs/konveyor-installation-guide

Conversation

@SuJinpei

@SuJinpei SuJinpei commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

The certified Alauda support for Konveyor package is going GA, and its marketplace Overview links
to solutions/ecosystem/konveyor/Konveyor_Installation_Guide.html — which did not exist. This adds
it, following the Knative / Nacos / OpenSearch guide convention.

New: ecosystem/konveyor/Konveyor_Installation_Guide.md

The guide leads with storage planning, because that is what actually blocks installs. The
platform asks for two ReadWriteOnce volumes; hand-written YAML that omits the size fields inherits an
upstream default of 100Gi for the file store, which many clusters cannot bind. The console form
is prefilled with smaller tested values (5Gi / 10Gi) and the guide says so explicitly rather than
leaving the discrepancy to be discovered.

Known limitations are stated up front:

  • Authentication cannot be enabled in this release (feature_auth_required must stay false) —
    the Keycloak images it needs are published for amd64 only and are not shipped with the package.
  • The AI-assisted migration feature is not available, for the same reason.
  • ui_ingress_class_name defaults to nginx, which many clusters do not run.
  • No upgrade path from the older community konveyor-operator catalog entry (0.6.0-beta.1) —
    this is a separate, newly published package.

Uses the factory:auto:* marker convention so later releases regenerate only the version and
limitation slots, leaving the prose human-owned.

Corrected: How_to_Use_Konveyor.md

That page describes the older community entry and actively contradicts the certified package — it
recommends feature_auth_required: true, rwx_supported: true and a 100Gi bucket. Rather than
rewrite content that is still correct for its own audience, it now states which package it applies
to, and carries warnings at the two places that would break someone following it on the certified
package (the Tackle example and the KAI section), each pointing at the new guide.

Conventions followed

  • en only. The zh mirrors are produced by the translation pipeline from the en sources (tracked
    via sourceSHA) and are not committed by hand.
  • No id: in the new file's frontmatteradd_id.sh allocates it from the CRM by H1 title on
    merge to main, and skips any file that already has one.

The certified "Alauda support for Konveyor" package is going GA, and its
marketplace Overview links to
solutions/ecosystem/konveyor/Konveyor_Installation_Guide.html, which did not
exist. This adds it, following the Knative/Nacos/OpenSearch guide convention.

The guide leads with storage planning, because that is what actually blocks
installs: the platform asks for two ReadWriteOnce volumes, and hand-written YAML
that omits the size fields inherits an upstream default of 100Gi for the file
store, which many clusters cannot bind. The console form is prefilled with
smaller tested values (5Gi / 10Gi) and the guide says so explicitly.

Known limitations are stated rather than left to be discovered: authentication
and the AI-assisted migration feature cannot be enabled in this release (their
images are published for amd64 only and are not shipped), ui_ingress_class_name
defaults to a class many clusters do not run, and there is no upgrade path from
the older community konveyor-operator catalog entry.

The existing How_to_Use_Konveyor.md described that older entry and actively
contradicted the certified package -- it recommends feature_auth_required: true,
rwx_supported: true and a 100Gi bucket. Rather than rewrite content that is
still correct for its own audience, it now states which package it applies to,
and carries warnings at the two places that would break someone following it on
the certified package (the Tackle example and the KAI section), each pointing at
the new guide.

en only: the zh mirrors are produced by the translation pipeline from the en
sources (tracked via sourceSHA) and should not be committed by hand. No id: in
the new file's frontmatter either -- add_id.sh allocates it from the CRM by
title on merge to main, and skips files that already have one.
@SuJinpei
SuJinpei force-pushed the docs/konveyor-installation-guide branch from bc4685d to 8d75929 Compare July 29, 2026 03:08
@SuJinpei
SuJinpei merged commit 85c4137 into main Jul 29, 2026
1 check passed
@SuJinpei
SuJinpei deleted the docs/konveyor-installation-guide branch July 29, 2026 15:15
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