## Description This is a collection of open topics to improve the onboarding experience. ### TODO #### Concepts / Architecture / Birds Eye View - [ ] describe deployment flow - [ ] what problem does which flavor solve and how to run them - [ ] Improve architecture and quick-start documentation. - [ ] Document feature status, especially currently incomplete features #### Operator - [ ] Access leafs - [ ] Access machines and firewalls - [ ] Access monitoring #### Developer - [ ] local development flow - [x] how to test metal-stack components in the mini-lab - [ ] list all available env vars to configure the mini-lab #### Troubleshooting - [ ] Docker Login for ghcr.io and docker hub as mini-lab pulls a lot - [ ] File descriptors - [ ] Containerlab & firewalls (See https://containerlab.dev/manual/network/#external-access) - [ ] Machine reclamation step-by-step #### Usability and handling - [ ] Make SONiC switch VMs survive container restarts and host reboot @l0wl3vel - [x] allow using local checkouts of dependencies via env var @ma-hartma #294 - [ ] Either document that `MINI_LAB_FLAVOR=kamaji` is broken or fix it using [the PoC capi-lab example](https://github.com/metal-stack/cluster-api-provider-metal-stack/tree/main/capi-lab) and [the docs for it](https://github.com/metal-stack/cluster-api-provider-metal-stack/blob/main/DEVELOPMENT.md) Co-authored-by: Matthias Hartmann <mahartma@mahartma.com> <!-- If not used, delete the next section. #### Used AI-Tools ✨ For commits with substantial parts that were generated by AI, please also mark the commits with the Generated-By: [tool name] label as described in our contribution guideline: https://metal-stack.io/community/contribution-guideline/#usage-of-generative-ai-tools. - TOOL used for generation If possible, please reference other issues or pull requests. References: - ... If not already described in a referenced issue, please describe your PR and the motivation behind it. Just try to make life easy for the reviewers. Please be aware that the pull request's title will become part of the release notes, so try to make it understandable. --> References: #290 <!-- You maybe want to attach the triage label if you want it to be discussed in the next planning meeting. It might be useful to attend the meeting if you want to emphasize it. If you would like to add something to the release notes for the next metal-stack release (metal-stack/releases), you can do so by adding SPECIAL SECTIONS (code blocks) in this PR. Please only add a section when this is relevant for the entire project. You can use the following snippets as an example: ## Release Notes ### Breaking Change ```BREAKING_CHANGE Description of the breaking change and what an operator needs to do about it. This section is **not** intended for documentation of internal breaking changes. Release notes are meant to be read by users and operators of metal-stack, not metal-stack developers. ``` ### Required Actions ```ACTIONS_REQUIRED Description of the required action for operators. ``` ### Noteworthy ```NOTEWORTHY Description of noteworthy release information for the metal-stack project that users or operators should know. ``` -->
Description
This is a collection of open topics to improve the onboarding experience.
TODO
Concepts / Architecture / Birds Eye View
Operator
Developer
Troubleshooting
Usability and handling
MINI_LAB_FLAVOR=kamajiis broken or fix it using the PoC capi-lab example and the docs for itCo-authored-by: Matthias Hartmann mahartma@mahartma.com
References: #290