Skip to content

docs: restyle Alauda OS install-config templates with callouts and fix installation test findings - #1306

Open
jiazhiguang wants to merge 1 commit into
docs/misc-fixesfrom
docs/install-config-callouts
Open

jiazhiguang wants to merge 1 commit into
docs/misc-fixesfrom
docs/install-config-callouts

Conversation

@jiazhiguang

Copy link
Copy Markdown
Contributor

Stacked on #1295: review only the last commit. After #1295 merges, this branch is rebased onto master.

install-config.yaml, global and workload lines:

  • Templates carry no inline comments. Provider-specific lines are marked
    with callouts and described in a numbered field table under each
    template (Field, Type, Required, Description), styled by
    theme/field-table.css.
  • Common fields live on one reference page per line; the workload line
    gets its own common page. Per-provider parameter pages keep only
    provider-specific behavior.
  • Field rules follow ac release-4.5: the workload line rejects global,
    deployMode, and provider.baremetal; credentialRef is required on
    DCS, HCS, and vSphere; sshKeys go to the boot user; chrony servers
    use prefer; each CIDR states the overlap rule.
  • vSphere workload clusters support a dedicated registry.

Bare Metal:

  • A global cluster can run Alauda OS KU on amd64 or arm64 (osType,
    architecture), with the hybrid Core Package when the host
    architecture differs from the bootstrap node's. Image tables,
    catalog keys, and MachineRegistration and SeedImage rows cover KU.
  • One ctr script pushes the OS images of either OS, tagged with the
    archive file name, without rewriting the manifest.
  • The ISO is verified by comparing hashes, and hosts are listed with
    custom columns.

Shared requirements:

  • Self-built VIP requirements live in the common prerequisites, with
    one VRID range, 1 to 255, for every provider.
  • The Alauda OS image matches the platform version; the 4.2.1 note is
    removed.
  • Prerequisites, global and workload, are stated as concepts rather
    than install-config.yaml fields.

Communication matrix:

  • The bootstrap node serves no registry; nodes pull from the external
    registry.
  • global Bare Metal hosts download the ISO and register through the
    bootstrap node on port 12443.

Post-install checks, from a global installation test:

  • The VIP check logs in as boot and runs curl with sudo, because only
    root can read the cluster CA.
  • On the bootstrap node, Validation uses ac in place of kubectl.
  • After create returns, wait until ClusterModule/global is Completed
    Healthy before judging the checks.

🤖 Generated with Claude Code

…x installation test findings

install-config.yaml, global and workload lines:
- Templates carry no inline comments. Provider-specific lines are marked
  with callouts and described in a numbered field table under each
  template (Field, Type, Required, Description), styled by
  theme/field-table.css.
- Common fields live on one reference page per line; the workload line
  gets its own common page. Per-provider parameter pages keep only
  provider-specific behavior.
- Field rules follow ac release-4.5: the workload line rejects global,
  deployMode, and provider.baremetal; credentialRef is required on
  DCS, HCS, and vSphere; sshKeys go to the boot user; chrony servers
  use prefer; each CIDR states the overlap rule.
- vSphere workload clusters support a dedicated registry.

Bare Metal:
- A global cluster can run Alauda OS KU on amd64 or arm64 (osType,
  architecture), with the hybrid Core Package when the host
  architecture differs from the bootstrap node's. Image tables,
  catalog keys, and MachineRegistration and SeedImage rows cover KU.
- One ctr script pushes the OS images of either OS, tagged with the
  archive file name, without rewriting the manifest.
- The ISO is verified by comparing hashes, and hosts are listed with
  custom columns.

Shared requirements:
- Self-built VIP requirements live in the common prerequisites, with
  one VRID range, 1 to 255, for every provider.
- The Alauda OS image matches the platform version; the 4.2.1 note is
  removed.
- Prerequisites, global and workload, are stated as concepts rather
  than install-config.yaml fields.

Communication matrix:
- The bootstrap node serves no registry; nodes pull from the external
  registry.
- global Bare Metal hosts download the ISO and register through the
  bootstrap node on port 12443.

Post-install checks, from a global installation test:
- The VIP check logs in as boot and runs curl with sudo, because only
  root can read the cluster CA.
- On the bootstrap node, Validation uses ac in place of kubectl.
- After create returns, wait until ClusterModule/global is Completed
  Healthy before judging the checks.

Co-Authored-By: zgjia <[email protected]>
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