Skip to content

Refresh AKS Flex Node documentation#165

Merged
bcho merged 13 commits into
mainfrom
hbc/usage-docs
May 22, 2026
Merged

Refresh AKS Flex Node documentation#165
bcho merged 13 commits into
mainfrom
hbc/usage-docs

Conversation

@bcho
Copy link
Copy Markdown
Member

@bcho bcho commented May 19, 2026

Summary

  • Refresh the README with a validated bootstrap-token getting started flow and reusable examples under docs/examples.
  • Split usage docs into focused joining, operations, and configuration guides under docs/usages.
  • Rework design docs around the current Unbounded/nspawn architecture and consolidate repave details into docs/design/agent-and-aks.md.
  • Refresh development and E2E documentation, and remove unused legacy diagrams.

Validation

  • Created a temporary Azure VM in bahe-dev and joined it to the bahe-dev AKS cluster using the README bootstrap-token flow.
  • Installed aks-flex-node with AKS_FLEX_NODE_VERSION=v0.1.0.alpha-4 for validation.
  • Verified aks-flex-node-agent became active and the node reported Ready with kubectl get nodes -o wide.
  • Ran uninstall/reset on the test VM and verified host cleanup before deleting the temporary VM, NIC, public IP, and disk.

@bcho bcho temporarily deployed to e2e-testing May 19, 2026 22:58 — with GitHub Actions Inactive
@bcho bcho temporarily deployed to e2e-testing May 20, 2026 00:11 — with GitHub Actions Inactive
@bcho bcho temporarily deployed to e2e-testing May 20, 2026 01:38 — with GitHub Actions Inactive
@bcho bcho temporarily deployed to e2e-testing May 20, 2026 01:52 — with GitHub Actions Inactive
@bcho bcho changed the title WIP: referesh docs Refresh AKS Flex Node documentation May 20, 2026
@bcho bcho marked this pull request as ready for review May 20, 2026 05:46
Copilot AI review requested due to automatic review settings May 20, 2026 05:46
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

This PR refreshes AKS Flex Node documentation to reflect the current Unbounded/systemd-nspawn architecture and provides a validated bootstrap-token getting-started flow with reusable examples.

Changes:

  • Reworked the top-level README getting-started flow around bootstrap tokens and added reusable config/RBAC examples under docs/examples.
  • Split the previous monolithic usage guide into focused guides under docs/usages (joining, operations, configuration) and updated design docs for the current repave model.
  • Updated E2E documentation and removed legacy diagram assets.

Reviewed changes

Copilot reviewed 16 out of 18 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
README.md New bootstrap-token walkthrough and updated project overview/links.
hack/e2e/README.md Updated E2E suite description, commands, options, and troubleshooting.
docs/usages/operations.md New operations guide (start/service/machinectl/reset/troubleshooting).
docs/usages/joining-nodes.md New joining guide covering auth mode options and bootstrap-token flow.
docs/usages/configuration.md New configuration reference and sample configs.
docs/usage.md Replaced old long-form usage doc with pointers to scenario guides.
docs/examples/bootstrap-token-rbac.yaml Added RBAC + bootstrap token manifest template for envsubst.
docs/examples/bootstrap-token-config.json Added bootstrap-token config template for envsubst.
docs/drift-repave.md Removed legacy repave doc (content consolidated elsewhere).
docs/development.md Updated dev docs (Go version reference, layout, links).
docs/design/agent-and-aks.md Added consolidated “Current Repave Implementation” section.
docs/design.md Reworked design summary; switched from static diagrams to mermaid and updated lifecycle/auth sections.
diagrams/system-overview.svg Removed legacy generated SVG diagram.
diagrams/system-overview.mmd Removed legacy mermaid source diagram.
diagrams/README.md Removed diagram regeneration documentation.
diagrams/generate.sh Removed diagram generation script.
diagrams/bootstrap-workflow.svg Removed legacy generated SVG sequence diagram.
diagrams/bootstrap-workflow.mmd Removed legacy mermaid source sequence diagram.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread docs/usages/configuration.md Outdated
Comment thread docs/design.md Outdated
@bcho bcho temporarily deployed to e2e-testing May 20, 2026 17:58 — with GitHub Actions Inactive
Copilot AI review requested due to automatic review settings May 20, 2026 18:11
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

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

Comment thread pkg/config/config_test.go
Comment thread README.md Outdated
Copilot AI review requested due to automatic review settings May 21, 2026 20:44
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

Copilot reviewed 22 out of 25 changed files in this pull request and generated 5 comments.

Comment thread scripts/aks-flex-config
Comment thread scripts/aks-flex-config
Comment thread pkg/config/config.go
Comment thread hack/e2e/README.md
Comment thread hack/e2e/lib/node-join-token.sh
@bcho bcho temporarily deployed to e2e-testing May 21, 2026 20:50 — with GitHub Actions Inactive
@bcho bcho merged commit 397494c into main May 22, 2026
9 checks passed
@bcho bcho deleted the hbc/usage-docs branch May 22, 2026 17:11
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.

4 participants