Skip to content

Latest commit

 

History

History

control-plane

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

README.md

control-plane

Contains roles for deploying the metal-control-plane.

Requirements

  • ansible-common

  • an ingress-controller in your cluster (nginx-ingress is the default of this project)

  • As our control plane also requires layer-4 services to be exposed to the outside world, you need to take care of exposing them in order to make them reachable from a partition. This can for instance be achieved through tcp and udp service exposal of Kubernetes nginx-ingress. You can look up how it can be done in the mini-lab. Here comes the list of required ports:

    Port Protocol Service Name Description
    4150 TCP nsqd nsq Daemon (TLS)
    5222 TCP metal-console Console forwarding (SSH)
    50051 TCP metal-api metal-api gRPC API (protobuf)

Variables

The defaults folder contains defaults that are used by multiple roles in the control-plane directory. You can look up all the default values.

Name Mandatory Description
metal_control_plane_provider_tenant The name of the provider tenant, has extended privileges
metal_control_plane_ingress_dns (yes) The dns name used for exposing services via ingress, either this or metal_control_plane_gateway_dns needs to be defined
metal_control_plane_gateway_dns (yes) The dns name used for exposing services via Gateway API routes (when *_httproute_enabled is set)
metal_control_plane_stage_name The name of the current stage, can be used for prefixing
metal_control_plane_namespace The target namespace of all deployed kubernetes resources of the metal-control-plane
metal_control_plane_image_pull_policy Global value for an ImagePullPolicy that will be used for Kubernetes entities
metal_control_plane_host_provider The control-planes hosting provider, one of metal or gcp. Required for gardener deployment.

Roles

Role Name Description
auditing-meili Deploys an audit backend based on meilisearch
auditing-timescaledb Deploys an audit backend based on timescaledb
gardener-cloud-profile Deploys a Gardener cloud profile for metal-stack
gardener-extensions Deploys Gardener operator extension resources
gardener-gardenlet Deploys Gardener operator gardenlet resources
gardener-logging Deploys gardener-logging into the virtual garden.
gardener-managed-seeds Deploys managed seeds into the virtual garden
gardener-monitoring-certs Deploys monitoring ingress certificates for seed clusters
gardener-operator Deploys the Gardener operator
gardener-partition-proxy Deploys a partition proxy into a shooted seed
gardener-projects Deploys gardener projects into the virtual garden.
gardener-shoots Deploys managed shoots into the virtual garden.
gardener-virtual-garden-access Deploys a managed resource to access the the Virtual Garden with operator setup
headscale Deploys headscale for firewall VPN
ipam-db Deploys a database for the IPAM of the metal-api
isolated-clusters Deploys services for Gardener isolated clusters
logging Deploys metal-stack control plane logging components
masterdata-db Deploys a database for the masterdata-api and tenant-apiserver
meili-backup-restore A role for deploying a meilisearch database with a backup-restore-sidecar
metal-db Deploys a database for the metal-api
metal-python Installs metal-python
metal Deploys all metal-stack components of the metal-control-plane via Helm chart
monitoring Deploys metal-stack control plane monitoring components
nsq Deploys nsq
postgres-backup-restore A role for deploying a postgres database with a backup-restore-sidecar
prepare Contains tasks for preparing the deployment of the metal-control-plane
rethinkdb-backup-restore A role for deploying a rethinkdb database with a backup-restore-sidecar
valkey Deploys a valkey cluster

Examples

An example playbook for deploying the metal-control-plane with the roles provided by this project can be found in the mini-lab project.