Skip to content
This repository has been archived by the owner on Jun 29, 2022. It is now read-only.

Latest commit

 

History

History
149 lines (107 loc) · 7.21 KB

baremetal.md

File metadata and controls

149 lines (107 loc) · 7.21 KB
Raw

Lokomotive bare metal configuration reference

Contents

Introduction

This configuration reference provides information on configuring a Lokomotive cluster on Bare Metal with all the configuration options available to the user.

Prerequisites

Configuration

To create a Lokomotive cluster, we need to define a configuration.

Example configuration file:

# baremetalcluster.lokocfg
variable "asset_dir" {}
variable "cluster_name" {}
variable "ssh_public_keys" {}
variable "matchbox_ca_path" {}
variable "matchbox_client_cert_path" {}
variable "matchbox_client_key_path" {}
variable "matchbox_endpoint" {}
variable "matchbox_http_endpoint" {}
variable "domain_name" {}
variable "controller_domains" {}
variable "controller_macs" {}
variable "controller_names" {}
variable "worker_domains" {}
variable "worker_macs" {}
variable "worker_names" {}
variable "management_cidrs" {}
variable "node_private_cidr" {}
variable "state_s3_bucket" {}
variable "lock_dynamodb_table" {}

cluster "bare-metal" {
  asset_dir = var.asset_dir

  cluster_name = var.cluster_name

  ssh_pubkeys = var.ssh_public_keys

  cached_install = "true"

  matchbox_ca_path = var.matchbox_ca_path

  matchbox_client_cert_path = var.matchbox_client_cert_path

  matchbox_client_key_path = var.matchbox_client_key_path

  matchbox_endpoint = var.mathbox_endpoint

  matchbox_http_endpoint = var.matchbox_http_endpoint

  k8s_domain_name = var.domain_name

  controller_domains = var.controller_domains

  controller_macs = var.controller_macs

  controller_names = var.controller_names

  worker_domains = var.worker_domains

  worker_macs = var.worker_macs

  worker_names = var.worker_names

  os_version = "current"

  os_channel = "flatcar-stable"
}

NOTE: Should you feel differently about the default values, you can set default values using the variable block in the cluster configuration.

Example:

The default for os_version is current. If you wish to change the default, then you define the variable and use it to refer in the cluster configuration.

variable "custom_default_os_version" {
  default = "2303.3.1"
}

.
.
.
os_version = var.custom_default_os_version
.
.
.

Attribute reference

Argument Description Default Required
asset_dir Location where Lokomotive stores cluster assets. - true
cached_install Whether the operating system should PXE boot and install from matchbox /assets cache. Note that the admin must have downloaded the os_version into matchbox assets. "false" false
cluster_name Name of the cluster. - true
controller_domains Ordered list of controller FQDNs. Example: ["node1.example.com"] - true
controller_macs Ordered list of controller identifying MAC addresses. Example: ["52:54:00:a1:9c:ae"] - true
controller_names Ordered list of controller names. Example: ["node1"] - true
k8s_domain_name Controller DNS name which resolves to a controller instance. Workers and kubeconfig's will communicate with this endpoint. Example: "cluster.example.com" - true
matchbox_ca_path Path to the CA to verify and authenticate client certificates. - true
matchbox_client_cert_path Path to the server TLS certificate file. - true
matchbox_client_key_path Path to the server TLS key file. - true
matchbox_endpoint Matchbox API endpoint. - true
matchbox_http_endpoint Matchbox HTTP read-only endpoint. Example: "http://matchbox.example.com:8080" - true
worker_names Ordered list of worker names. Example: ["node2", "node3"] - true
worker_macs Ordered list of worker identifying MAC addresses. Example ["52:54:00:b2:2f:86", "52:54:00:c3:61:77"] - true
worker_domains Ordered list of worker FQDNs. Example ["node2.example.com", "node3.example.com"] - true
ssh_pubkeys SSH public keys for user core. - true
os_version Flatcar Container Linux version to install. Version such as "2303.3.1" or "current". "current" false
os_channel Flatcar Container Linux channel to install from ("flatcar-stable", "flatcar-beta", "flatcar-alpha", "flatcar-edge"). "flatcar-stable" false

Applying

To create the cluster, execute the following command:

lokoctl cluster apply

Destroying

To destroy the Lokomotive cluster, execute the following command:

lokoctl cluster destroy --confirm