# metal-stack.io

> Bring the cloud to your data center. metal-stack is an open source software that provides an API for provisioning and managing physical servers in the data center.

This file does not contain Community resources, blog posts and metal-stack enhancement proposals (MEP). These can be found in the [Community](https://metal-stack.io/community) tab.

For this, there are dedicated files following the llmstxt.org standard:
- [llms-community.txt](https://metal-stack.io/llms-community.txt) contains links to community sections
- [llms-community-full.txt](https://metal-stack.io/llms-community-full.txt) contains all community content in a single document
        

## Table of Contents

- [Home](https://metal-stack.io/docs/home): metal-stack is an open source software that provides an API for provisioning and managing physical servers in the data center. To categorize this p...
- [Getting Started](https://metal-stack.io/docs/02-General/01-quickstart): Before starting to buy any hardware, you should try out the metal-stack on your notebook and familiarize with the software.
- [Why metal-stack?](https://metal-stack.io/docs/02-General/02-why%20metal%20stack): Before we started with our mission to implement the metal-stack, we decided on a couple of key characteristics and constraints that we think are un...
- [Why Bare Metal?](https://metal-stack.io/docs/02-General/03-why%20bare%20metal): Bare metal has several advantages over virtual environments and overcomes several drawbacks of virtual machines. We also listed drawbacks of the ba...
- [Flavors of metal-stack](https://metal-stack.io/docs/02-General/04-flavors-of-metalstack): metal-stack bare metal provisioning offers machines, networks, firewalls and floating IPs. That`s it.
- [Client Libraries](https://metal-stack.io/docs/03-For%20Users/01-client_libraries): Our public-facing APIs are built on [swagger](https://swagger.io/), which allows you generating API clients in all sorts of programming languages.
- [Hardware Support](https://metal-stack.io/docs/04-For%20Operators/01-hardware): In order to keep the automation and maintenance overhead small, we strongly advise against building highly heterogeneous environments with metal-st...
- [Operating Systems](https://metal-stack.io/docs/04-For%20Operators/02-operating-systems): Our operating system images are built on regular basis from the [metal-images](https://github.com/metal-stack/metal-images) repository.
- [Deployment Guide](https://metal-stack.io/docs/04-For%20Operators/03-deployment-guide): We are bootstrapping the [metal control plane](../05-Concepts/01-architecture.mdx#metal-control-plane) as well as our [partitions](../05-Concepts/0...
- [Maintenance](https://metal-stack.io/docs/04-For%20Operators/04-maintenance): For new features and breaking changes we create a new minor release of metal-stack.
- [Monitoring](https://metal-stack.io/docs/04-For%20Operators/05-monitoring): ![Monitoring Stack](monitoring-stack.svg)
- [Troubleshooting](https://metal-stack.io/docs/04-For%20Operators/06-troubleshoot): This document summarizes help when something goes wrong and provides advice on debugging the metal-stack in certain situations.
- [Architecture](https://metal-stack.io/docs/05-Concepts/01-architecture): The metal-stack is a compound of microservices predominantly written in [Golang](https://go.dev/).
- [User Management](https://metal-stack.io/docs/05-Concepts/02-user-management): At the moment, metal-stack can more or less be seen as a low-level API that does not scope access based on projects and tenants.
- [Networking](https://metal-stack.io/docs/05-Concepts/03-Network/01-theory): We spent a lot of time on trying to provide state-of-the-art networking in the data center. This document describes the requirements, ideas and imp...
- [Firewalls](https://metal-stack.io/docs/05-Concepts/03-Network/02-firewalls): Firewalls in metal-stack are machines that connect networks to each other or the internet and allows traffic filtering.
- [Tailscale](https://metal-stack.io/docs/05-Concepts/03-Network/03-tailscale): These steps will guide you through the process quickly. For a deeper dive, or if you want to use alternative setups, the Tailscale articles are als...
- [Inventory Management](https://metal-stack.io/docs/05-Concepts/03-Network/04-inventory-management): metal-stack does not rely on external inventory files or an external IPAM. Physical resources are discovered by the service that owns each one, and...
- [Network Segmentation](https://metal-stack.io/docs/05-Concepts/03-Network/05-network-segmentation): metal-stack enforces network segmentation from a single source of truth. Tenants express intent at a high level (a project, a network, a machine al...
- [Gardener](https://metal-stack.io/docs/05-Concepts/04-Kubernetes/01-gardener): [Gardener](https://gardener.cloud/) is an open source project for orchestrated Kubernetes cluster provisioning. It supports many different cloud pr...
- [Cluster API](https://metal-stack.io/docs/05-Concepts/04-Kubernetes/02-cluster-api): [Cluster API](https://cluster-api.sigs.k8s.io/) is a Kubernetes project that aims to simplify the management of Kubernetes clusters. It provides a ...
- [Cloud Controller Manager](https://metal-stack.io/docs/05-Concepts/04-Kubernetes/03-cloud-controller-manager): CCM stands for [cloud-controller-manager](https://kubernetes.io/docs/concepts/architecture/cloud-controller/) and is the bridge between Kubernetes ...
- [Firewall Controller Manager](https://metal-stack.io/docs/05-Concepts/04-Kubernetes/04-firewall-controller-manager): To make the firewalls created with metal-stack easily configurable through Kubernetes resources, we add our [firewall-controller](https://github.co...
- [Isolated Clusters](https://metal-stack.io/docs/05-Concepts/04-Kubernetes/05-isolated-clusters): Some customers have the need to run their workloads in a very restricted environment. These restrictions are driven by regulatory requirements in s...
- [GPU Workers](https://metal-stack.io/docs/05-Concepts/04-Kubernetes/06-gpu-workers): For workloads which require the assistance of GPUs, support for GPUs in bare metal servers was added to metal-stack.io v0.18.0.
- [Storage](https://metal-stack.io/docs/05-Concepts/04-Kubernetes/07-storage): When working with bare-metal servers, providing cloud storage is a challenge. With physical machines there is no opportunity that a hypervisor can ...
- [Security Principles](https://metal-stack.io/docs/06-For%20CISOs/Security/01-principles): metal-stack adheres to several security principles to ensure the integrity, confidentiality and availability of its services and data. These princi...
- [SBOM](https://metal-stack.io/docs/06-For%20CISOs/Security/02-sbom): Every container image and binary that's part of metal-stack contains an _SBOM_ (Software Bill of Materials). It provides
- [Cryptography](https://metal-stack.io/docs/06-For%20CISOs/Security/03-cryptography): metal-stack incorporates multiple layers of cryptographic protection and secure communication to ensure system integrity and confidentiality:
- [Communication Matrix](https://metal-stack.io/docs/06-For%20CISOs/Security/04-communication-matrix): This matrix describes the communication between components in the metal-stack and their respective security properties. Please note that depending ...
- [Artifact Signing](https://metal-stack.io/docs/06-For%20CISOs/Security/05-artifacts-signing): To increase trust and integrity, metal-stack introduces artifact signing for its released components.
- [Remote Access](https://metal-stack.io/docs/06-For%20CISOs/remote-access): Remote access to machines and firewalls is essential for performing administrative tasks such as incident management, troubleshooting and sometimes...
- [v0.20.0](https://metal-stack.io/docs/07-Release%20Notes/v0.20/v0.20.0): metal-stack v0.20.0
- [v0.20.1](https://metal-stack.io/docs/07-Release%20Notes/v0.20/v0.20.1): metal-stack v0.20.1
- [v0.20.2](https://metal-stack.io/docs/07-Release%20Notes/v0.20/v0.20.2): metal-stack v0.20.2
- [v0.21.0](https://metal-stack.io/docs/07-Release%20Notes/v0.21/v0.21.0): metal-stack v0.21.0
- [v0.21.1](https://metal-stack.io/docs/07-Release%20Notes/v0.21/v0.21.1): metal-stack v0.21.1
- [v0.21.10](https://metal-stack.io/docs/07-Release%20Notes/v0.21/v0.21.10): metal-stack v0.21.10
- [v0.21.11](https://metal-stack.io/docs/07-Release%20Notes/v0.21/v0.21.11): metal-stack v0.21.11
- [v0.21.2](https://metal-stack.io/docs/07-Release%20Notes/v0.21/v0.21.2): metal-stack v0.21.2
- [v0.21.3](https://metal-stack.io/docs/07-Release%20Notes/v0.21/v0.21.3): metal-stack v0.21.3
- [v0.21.4](https://metal-stack.io/docs/07-Release%20Notes/v0.21/v0.21.4): metal-stack v0.21.4
- [v0.21.5](https://metal-stack.io/docs/07-Release%20Notes/v0.21/v0.21.5): metal-stack v0.21.5
- [v0.21.6](https://metal-stack.io/docs/07-Release%20Notes/v0.21/v0.21.6): metal-stack v0.21.6
- [v0.21.7](https://metal-stack.io/docs/07-Release%20Notes/v0.21/v0.21.7): metal-stack v0.21.7
- [v0.21.8](https://metal-stack.io/docs/07-Release%20Notes/v0.21/v0.21.8): metal-stack v0.21.8
- [v0.21.9](https://metal-stack.io/docs/07-Release%20Notes/v0.21/v0.21.9): metal-stack v0.21.9
- [v0.22.0](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.0): metal-stack v0.22.0
- [v0.22.1](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.1): metal-stack v0.22.1
- [v0.22.10](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.10): metal-stack v0.22.10
- [v0.22.11](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.11): metal-stack v0.22.11
- [v0.22.12](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.12): metal-stack v0.22.12
- [v0.22.13](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.13): metal-stack v0.22.13
- [v0.22.14](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.14): metal-stack v0.22.14
- [v0.22.15](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.15): metal-stack v0.22.15
- [v0.22.16](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.16): metal-stack v0.22.16
- [v0.22.17](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.17): metal-stack v0.22.17
- [v0.22.18](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.18): metal-stack v0.22.18
- [v0.22.19](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.19): metal-stack v0.22.19
- [v0.22.2](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.2): metal-stack v0.22.2
- [v0.22.20](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.20): metal-stack v0.22.20
- [v0.22.21](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.21): metal-stack v0.22.21
- [v0.22.3](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.3): metal-stack v0.22.3
- [v0.22.4](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.4): metal-stack v0.22.4
- [v0.22.5](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.5): metal-stack v0.22.5
- [v0.22.6](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.6): metal-stack v0.22.6
- [v0.22.7](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.7): metal-stack v0.22.7
- [v0.22.8](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.8): metal-stack v0.22.8
- [v0.22.9](https://metal-stack.io/docs/07-Release%20Notes/v0.22/v0.22.9): metal-stack v0.22.9
- [API](https://metal-stack.io/docs/references/api): useEffect(() => {
- [metalctl](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl): a cli to manage entities in the metal-stack api
- [metalctl_audit](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_audit): manage audit trace entities
- [metalctl_audit_describe](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_audit_describe): describes the audit trace
- [metalctl_audit_list](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_audit_list): list all audit traces
- [metalctl_completion](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_completion): Generate the autocompletion script for the specified shell
- [metalctl_completion_bash](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_completion_bash): Generate the autocompletion script for bash
- [metalctl_completion_fish](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_completion_fish): Generate the autocompletion script for fish
- [metalctl_completion_powershell](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_completion_powershell): Generate the autocompletion script for powershell
- [metalctl_completion_zsh](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_completion_zsh): Generate the autocompletion script for zsh
- [metalctl_context](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_context): manage metalctl context
- [metalctl_context_short](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_context_short): only show the default context name
- [metalctl_filesystemlayout](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_filesystemlayout): manage filesystemlayout entities
- [metalctl_filesystemlayout_apply](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_filesystemlayout_apply): applies one or more filesystemlayouts from a given file
- [metalctl_filesystemlayout_create](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_filesystemlayout_create): creates the filesystemlayout
- [metalctl_filesystemlayout_delete](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_filesystemlayout_delete): deletes the filesystemlayout
- [metalctl_filesystemlayout_describe](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_filesystemlayout_describe): describes the filesystemlayout
- [metalctl_filesystemlayout_edit](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_filesystemlayout_edit): edit the filesystemlayout through an editor and update
- [metalctl_filesystemlayout_list](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_filesystemlayout_list): list all filesystemlayouts
- [metalctl_filesystemlayout_match](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_filesystemlayout_match): check if a machine satisfies all disk requirements of a given filesystemlayout
- [metalctl_filesystemlayout_try](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_filesystemlayout_try): try to detect a filesystem by given size and image
- [metalctl_filesystemlayout_update](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_filesystemlayout_update): updates the filesystemlayout
- [metalctl_firewall](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_firewall): manage firewall entities
- [metalctl_firewall_create](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_firewall_create): creates the firewall
- [metalctl_firewall_describe](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_firewall_describe): describes the firewall
- [metalctl_firewall_list](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_firewall_list): list all firewalls
- [metalctl_firewall_ssh](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_firewall_ssh): SSH to a firewall
- [metalctl_firmware](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_firmware): manage firmwares
- [metalctl_firmware_delete](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_firmware_delete): delete a firmware
- [metalctl_firmware_list](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_firmware_list): list firmwares
- [metalctl_firmware_upload](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_firmware_upload): upload a firmware
- [metalctl_firmware_upload_bios](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_firmware_upload_bios): upload a BIOS firmware
- [metalctl_firmware_upload_bmc](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_firmware_upload_bmc): upload a BMC firmware
- [metalctl_health](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_health): shows the server health
- [metalctl_image](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_image): manage image entities
- [metalctl_image_apply](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_image_apply): applies one or more images from a given file
- [metalctl_image_create](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_image_create): creates the image
- [metalctl_image_delete](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_image_delete): deletes the image
- [metalctl_image_describe](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_image_describe): describes the image
- [metalctl_image_edit](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_image_edit): edit the image through an editor and update
- [metalctl_image_list](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_image_list): list all images
- [metalctl_image_update](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_image_update): updates the image
- [metalctl_login](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_login): login user and receive token
- [metalctl_logout](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_logout): logout user from OIDC SSO session
- [metalctl_machine](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine): manage machine entities
- [metalctl_machine_apply](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_apply): applies one or more machines from a given file
- [metalctl_machine_console](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_console): console access to a machine
- [metalctl_machine_consolepassword](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_consolepassword): fetch the consolepassword for a machine
- [metalctl_machine_create](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_create): creates the machine
- [metalctl_machine_delete](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_delete): deletes the machine
- [metalctl_machine_describe](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_describe): describes the machine
- [metalctl_machine_edit](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_edit): edit the machine through an editor and update
- [metalctl_machine_identify](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_identify): manage machine chassis identify LED power
- [metalctl_machine_identify_off](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_identify_off): power off the machine chassis identify LED
- [metalctl_machine_identify_on](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_identify_on): power on the machine chassis identify LED
- [metalctl_machine_ipmi](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_ipmi): display ipmi details of the machine, if no machine ID is given all ipmi addresses are returned.
- [metalctl_machine_ipmi_chassis-list](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_ipmi_chassis-list): display ipmi machines grouped by chassis serial
- [metalctl_machine_ipmi_events](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_ipmi_events): display machine hardware events
- [metalctl_machine_issues](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_issues): display machines which are in a potential bad state
- [metalctl_machine_issues_list](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_issues_list): list all machine issues that the metal-api can evaluate
- [metalctl_machine_list](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_list): list all machines
- [metalctl_machine_lock](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_lock): lock a machine
- [metalctl_machine_logs](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_logs): display machine provisioning logs
- [metalctl_machine_power](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_power): manage machine power
- [metalctl_machine_power_bios](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_power_bios): boot a machine into BIOS
- [metalctl_machine_power_cycle](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_power_cycle): power cycle a machine (graceful shutdown)
- [metalctl_machine_power_disk](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_power_disk): boot a machine from disk
- [metalctl_machine_power_off](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_power_off): power off a machine
- [metalctl_machine_power_on](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_power_on): power on a machine
- [metalctl_machine_power_pxe](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_power_pxe): boot a machine from PXE
- [metalctl_machine_power_reset](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_power_reset): power reset a machine
- [metalctl_machine_reinstall](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_reinstall): reinstalls an already allocated machine
- [metalctl_machine_reserve](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_reserve): reserve a machine
- [metalctl_machine_update-firmware](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_update-firmware): update a machine firmware
- [metalctl_machine_update-firmware_bios](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_update-firmware_bios): update a machine BIOS
- [metalctl_machine_update-firmware_bmc](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_update-firmware_bmc): update a machine BMC
- [metalctl_machine_update](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_machine_update): updates the machine
- [metalctl_markdown](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_markdown): create markdown documentation
- [metalctl_network](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_network): manage network entities
- [metalctl_network_allocate](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_network_allocate): allocate a network
- [metalctl_network_apply](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_network_apply): applies one or more networks from a given file
- [metalctl_network_create](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_network_create): creates the network
- [metalctl_network_delete](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_network_delete): deletes the network
- [metalctl_network_describe](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_network_describe): describes the network
- [metalctl_network_edit](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_network_edit): edit the network through an editor and update
- [metalctl_network_free](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_network_free): free a network
- [metalctl_network_ip](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_network_ip): manage ip entities
- [metalctl_network_ip_apply](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_network_ip_apply): applies one or more ips from a given file
- [metalctl_network_ip_create](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_network_ip_create): creates the ip
- [metalctl_network_ip_delete](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_network_ip_delete): deletes the ip
- [metalctl_network_ip_describe](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_network_ip_describe): describes the ip
- [metalctl_network_ip_edit](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_network_ip_edit): edit the ip through an editor and update
- [metalctl_network_ip_issues](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_network_ip_issues): display ips which are in a potential bad state
- [metalctl_network_ip_list](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_network_ip_list): list all ips
- [metalctl_network_ip_update](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_network_ip_update): updates the ip
- [metalctl_network_list](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_network_list): list all networks
- [metalctl_network_update](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_network_update): updates the network
- [metalctl_partition](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_partition): manage partition entities
- [metalctl_partition_apply](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_partition_apply): applies one or more partitions from a given file
- [metalctl_partition_capacity](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_partition_capacity): show partition capacity
- [metalctl_partition_create](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_partition_create): creates the partition
- [metalctl_partition_delete](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_partition_delete): deletes the partition
- [metalctl_partition_describe](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_partition_describe): describes the partition
- [metalctl_partition_edit](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_partition_edit): edit the partition through an editor and update
- [metalctl_partition_list](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_partition_list): list all partitions
- [metalctl_partition_update](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_partition_update): updates the partition
- [metalctl_project](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_project): manage project entities
- [metalctl_project_apply](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_project_apply): applies one or more projects from a given file
- [metalctl_project_create](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_project_create): creates the project
- [metalctl_project_delete](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_project_delete): deletes the project
- [metalctl_project_describe](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_project_describe): describes the project
- [metalctl_project_edit](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_project_edit): edit the project through an editor and update
- [metalctl_project_list](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_project_list): list all projects
- [metalctl_project_update](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_project_update): updates the project
- [metalctl_size](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size): manage size entities
- [metalctl_size_apply](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_apply): applies one or more sizes from a given file
- [metalctl_size_create](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_create): creates the size
- [metalctl_size_delete](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_delete): deletes the size
- [metalctl_size_describe](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_describe): describes the size
- [metalctl_size_edit](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_edit): edit the size through an editor and update
- [metalctl_size_imageconstraint](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_imageconstraint): manage imageconstraint entities
- [metalctl_size_imageconstraint_apply](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_imageconstraint_apply): applies one or more imageconstraints from a given file
- [metalctl_size_imageconstraint_create](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_imageconstraint_create): creates the imageconstraint
- [metalctl_size_imageconstraint_delete](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_imageconstraint_delete): deletes the imageconstraint
- [metalctl_size_imageconstraint_describe](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_imageconstraint_describe): describes the imageconstraint
- [metalctl_size_imageconstraint_edit](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_imageconstraint_edit): edit the imageconstraint through an editor and update
- [metalctl_size_imageconstraint_list](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_imageconstraint_list): list all imageconstraints
- [metalctl_size_imageconstraint_try](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_imageconstraint_try): try if size and image can be allocated
- [metalctl_size_imageconstraint_update](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_imageconstraint_update): updates the imageconstraint
- [metalctl_size_list](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_list): list all sizes
- [metalctl_size_reservation](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_reservation): manage reservation entities
- [metalctl_size_reservation_apply](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_reservation_apply): applies one or more reservations from a given file
- [metalctl_size_reservation_create](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_reservation_create): creates the reservation
- [metalctl_size_reservation_delete](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_reservation_delete): deletes the reservation
- [metalctl_size_reservation_describe](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_reservation_describe): describes the reservation
- [metalctl_size_reservation_edit](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_reservation_edit): edit the reservation through an editor and update
- [metalctl_size_reservation_list](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_reservation_list): list all reservations
- [metalctl_size_reservation_update](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_reservation_update): updates the reservation
- [metalctl_size_reservation_usage](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_reservation_usage): see current usage of size reservations
- [metalctl_size_suggest](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_suggest): suggest size from a given machine id
- [metalctl_size_update](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_size_update): updates the size
- [metalctl_switch](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_switch): manage switch entities
- [metalctl_switch_connected-machines](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_switch_connected-machines): shows switches with their connected machines
- [metalctl_switch_console](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_switch_console): connect to the switch console
- [metalctl_switch_delete](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_switch_delete): deletes the switch
- [metalctl_switch_describe](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_switch_describe): describes the switch
- [metalctl_switch_detail](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_switch_detail): switch details
- [metalctl_switch_edit](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_switch_edit): edit the switch through an editor and update
- [metalctl_switch_list](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_switch_list): list all switches
- [metalctl_switch_migrate](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_switch_migrate): migrate machine connections and other configuration from one switch to another
- [metalctl_switch_port](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_switch_port): sets the given switch port state up or down
- [metalctl_switch_port_describe](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_switch_port_describe): gets the given switch port state
- [metalctl_switch_port_down](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_switch_port_down): sets the given switch port state down
- [metalctl_switch_port_up](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_switch_port_up): sets the given switch port state up
- [metalctl_switch_replace](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_switch_replace): put a leaf switch into replace mode in preparation for physical replacement. For a description of the steps involved see the long help.
- [metalctl_switch_ssh](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_switch_ssh): connect to the switch via ssh
- [metalctl_switch_update](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_switch_update): updates the switch
- [metalctl_tenant](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_tenant): manage tenant entities
- [metalctl_tenant_apply](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_tenant_apply): applies one or more tenants from a given file
- [metalctl_tenant_create](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_tenant_create): creates the tenant
- [metalctl_tenant_delete](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_tenant_delete): deletes the tenant
- [metalctl_tenant_describe](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_tenant_describe): describes the tenant
- [metalctl_tenant_edit](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_tenant_edit): edit the tenant through an editor and update
- [metalctl_tenant_list](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_tenant_list): list all tenants
- [metalctl_tenant_update](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_tenant_update): updates the tenant
- [metalctl_update](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_update): update the program
- [metalctl_update_check](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_update_check): check for update of the program
- [metalctl_update_do](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_update_do): do the update of the program
- [metalctl_version](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_version): print the client and server version information
- [metalctl_vpn](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_vpn): access VPN
- [metalctl_vpn_key](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_vpn_key): create an auth key
- [metalctl_whoami](https://metal-stack.io/docs/08-References/Clients/metalctl/metalctl_whoami): shows current user
- [backup-restore-sidecar](https://metal-stack.io/docs/08-References/Control%20Plane/backup-restore-sidecar/backup-restore-sidecar): ![Go version](https://img.shields.io/github/go-mod/go-version/metal-stack/backup-restore-sidecar)
- [go-ipam](https://metal-stack.io/docs/08-References/Control%20Plane/go-ipam/go-ipam): [![Actions](https://github.com/metal-stack/go-ipam/actions/workflows/docker.yml/badge.svg?branch=master)](https://github.com/metal-stack/go-ipam/ac...
- [masterdata-api](https://metal-stack.io/docs/08-References/Control%20Plane/masterdata-api/masterdata-api): This Microservice provides the source of truth for master data.
- [metal-api](https://metal-stack.io/docs/08-References/Control%20Plane/metal-api/metal-api): [![Build](https://github.com/metal-stack/metal-api/actions/workflows/docker.yaml/badge.svg?branch=master)](https://github.com/metal-stack/metal-api...
- [metal-apiserver](https://metal-stack.io/docs/08-References/Control%20Plane/metal-apiserver/metal-apiserver): [![Actions](https://github.com/metal-stack/metal-apiserver/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/metal-stack/meta...
- [metal-console](https://metal-stack.io/docs/08-References/Control%20Plane/metal-console/metal-console): `metal-console` provides access to the serial console of metal machines.
- [tenant-apiserver](https://metal-stack.io/docs/08-References/Control%20Plane/tenant-apiserver/tenant-apiserver): This microservice provides the source of truth for tenant-related data.
- [helm-charts](https://metal-stack.io/docs/08-References/Deployment/helm-charts/helm-charts): Contains Helm Charts of metal-stack.
- [ARCHITECTURE](https://metal-stack.io/docs/08-References/Deployment/metal-images/ARCHITECTURE): * minimal set of installed packages
- [IMAGE_STORE](https://metal-stack.io/docs/08-References/Deployment/metal-images/IMAGE_STORE): The metal-images tarballs are stored on <https://images.metal-stack.io/>. The tarball must be compressed using lz4 and a md5 checksum must be provi...
- [metal-images](https://metal-stack.io/docs/08-References/Deployment/metal-images/metal-images): ![Go version](https://img.shields.io/github/go-mod/go-version/metal-stack/metal-images)
- [mini-lab](https://metal-stack.io/docs/08-References/Deployment/mini-lab/mini-lab): The mini-lab is a small, virtual setup to locally run the metal-stack. It deploys the metal control plane and a metal-stack partition with two simu...
- [gardener-extension-audit](https://metal-stack.io/docs/08-References/Gardener/gardener-extension-audit/gardener-extension-audit): Provides a Gardener extension for managing kube-apiserver audit logs for a shoot cluster.
- [gardener-extension-csi-driver-lvm](https://metal-stack.io/docs/08-References/Gardener/gardener-extension-csi-driver-lvm/gardener-extension-csi-driver-lvm): Provides a Gardener extension for managing [csi-driver-lvm](https://github.com/metal-stack/csi-driver-lvm) for a shoot cluster.
- [migration](https://metal-stack.io/docs/08-References/Gardener/gardener-extension-csi-driver-lvm/migration): The migration from the deprecated [`csi-lvm`](https://github.com/metal-stack/csi-lvm) to the new `csi-driver-lvm` must be performed in multiple ste...
- [README](https://metal-stack.io/docs/08-References/Gardener/gardener-extension-ontap/README): > Technical background documentation for the extension, ONTAP, and their integration into metal-stack.
- [gardener-extension-ontap](https://metal-stack.io/docs/08-References/Gardener/gardener-extension-ontap/gardener-extension-ontap): This repository contains the Gardener extension controller for managing the NetApp ONTAP CSI Plugin.
- [ontap-storage](https://metal-stack.io/docs/08-References/Gardener/gardener-extension-ontap/ontap-storage): > How NetApp ONTAP works as a MetroCluster and how it is provided to Kubernetes through Gardener and Trident.
- [gardener-vpn-gateway](https://metal-stack.io/docs/08-References/Gardener/gardener-vpn-gateway/gardener-vpn-gateway): This is a small piece of software that is intended to run in the shoot controlplane of a [Gardener](https://github.com/gardener/gardener) shoot clu...
- [os-metal-extension](https://metal-stack.io/docs/08-References/Gardener/os-metal-extension/os-metal-extension): This extension provides controllers to reconcile `OperatingSystemConfig`s and transforms them into [Ignition](https://www.flatcar.org/docs/latest/p...
- [DEVELOPMENT](https://metal-stack.io/docs/08-References/Kubernetes/cluster-api-provider-metal-stack/DEVELOPMENT): This project comes with a preconfigured version of the [mini-lab](https://github.com/metal-stack/mini-lab) in [capi-lab](./capi-lab) which runs a l...
- [cluster-api-provider-metal-stack](https://metal-stack.io/docs/08-References/Kubernetes/cluster-api-provider-metal-stack/cluster-api-provider-metal-stack): The Cluster API provider for metal-stack (CAPMS) implements the declarative management of Kubernetes cluster infrastructure on top of [metal-stack]...
- [droptailer](https://metal-stack.io/docs/08-References/Kubernetes/droptailer/droptailer): Droptailer gathers firewall drop or accept logs from different machines, enriches them with data from kubernetes api resources and makes them acces...
- [firewall-controller](https://metal-stack.io/docs/08-References/Kubernetes/firewall-controller/firewall-controller): This controller is installed on a bare-metal firewall in front of several kubernetes worker nodes and responsible to reconcile a `ClusterwideNetwor...
- [firewall-controller-manager](https://metal-stack.io/docs/08-References/Kubernetes/firewall-controller-manager/firewall-controller-manager): The firewall-controller-manager (FCM) is a collection of controllers which are responsible for managing the lifecycle of firewalls in a [Gardener](...
- [metal-ccm](https://metal-stack.io/docs/08-References/Kubernetes/metal-ccm/metal-ccm): metal-ccm is the Kubernetes cloud controller manager implementation for Metal.
- [metal-token-refresher](https://metal-stack.io/docs/08-References/Kubernetes/metal-token-refresher/metal-token-refresher): Refreshes metal-apiserver-tokens stored in Kubernetes secrets as a CronJob.
- [metal-metrics-exporter](https://metal-stack.io/docs/08-References/Monitoring/metal-metrics-exporter/metal-metrics-exporter): A simple exporter for metal-api metrics.
- [nftables-exporter](https://metal-stack.io/docs/08-References/Monitoring/nftables-exporter/nftables-exporter): Export nftables statistics to prometheus, original source from [https://github.com/Sheridan/nftables_exporter](https://github.com/Sheridan/nftables...
- [rethinkdb-exporter](https://metal-stack.io/docs/08-References/Monitoring/rethinkdb-exporter/rethinkdb-exporter): [![GitHub tag](https://img.shields.io/github/tag/rethinkdb/prometheus-exporter.svg?style=flat)](https://github.com/rethinkdb/prometheus-exporter/re...
- [go-hal](https://metal-stack.io/docs/08-References/Partition/go-hal/go-hal): [![GoDoc](https://godoc.org/github.com/metal-stack/go-hal?status.svg)](https://pkg.go.dev/github.com/metal-stack/go-hal)
- [metal-bmc](https://metal-stack.io/docs/08-References/Partition/metal-bmc/metal-bmc): `metal-bmc` is responsible to gather data from machines via the out of band interfaces and report them back to the metal-api.
- [metal-core](https://metal-stack.io/docs/08-References/Partition/metal-core/metal-core): metal-core dynamically reconfigures switches based on the state held in the metal-api. Therefore, it must run on every leaf switch and have control...
- [metal-hammer](https://metal-stack.io/docs/08-References/Partition/metal-hammer/metal-hammer): Hammer is used to boot a bare metal server via PXE together with the Metal Stack kernel. Hammer is a initrd which runs a small golang binary as ini...
- [pixie](https://metal-stack.io/docs/08-References/Partition/pixie/pixie): This project is a permanent fork of: [Pixiecore](https://github.com/danderson/netboot/tree/master/pixiecore)
- [csi-driver-lvm](https://metal-stack.io/docs/08-References/Storage/csi-driver-lvm/csi-driver-lvm): csi-driver-lvm utilizes local storage of Kubernetes nodes to provide persistent storage for pods.
- [MULTITENANCY](https://metal-stack.io/docs/08-References/Storage/duros-controller/MULTITENANCY): Multi tenancy is a crucial aspect when providing central storage. This divides into several aspects, impact to storage from one tenant to another t...
- [duros-controller](https://metal-stack.io/docs/08-References/Storage/duros-controller/duros-controller): A Bridge between cloud-native and duros storage controller. This controller is responsible to create a project in the duros-api and an authenticati...