Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 3.08 KB

KUBERNETES.md

File metadata and controls

65 lines (47 loc) · 3.08 KB

Quick start guide for Kubernetes

This option will walk through creating a light weight Kubernetes cluster, after which you will be able to deploy the Tinkerbell stack via the Helm chart, and then provision a machine. You will need to bring your own hardware (machine) for this guide.

Prerequisites

Steps

  1. Create a Kubernetes cluster with K3D

    k3d cluster create --network host --no-lb --k3s-arg "--disable=traefik,servicelb,metrics-server,local-storage"
# `--network host` : host network is used to allow the load balancer to advertise a layer 2 address.
# `--no-lb` : the K3D built in load balancer is disabled so we don't have conflicts with the stack load balancer.
# `--k3s-arg "--disable=traefik,servicelb,metrics-server,local-storage"` : disable the built in K3S load balancer, metrics server, and local storage.

  2. Install the Tinkerbell stack Helm chart

    trusted_proxies=$(kubectl get nodes -o jsonpath='{.items[*].spec.podCIDR}' | tr ' ' ',')
LB_IP=<specify a Load balancer IP>
STACK_CHART_VERSION=0.4.3
helm install tink-stack oci://ghcr.io/tinkerbell/charts/stack --version "$STACK_CHART_VERSION" --create-namespace --namespace tink-system --wait --set "smee.trustedProxies={${trusted_proxies}}" --set "hegel.trustedProxies={${trusted_proxies}}" --set "stack.loadBalancerIP=$LB_IP" --set "smee.publicIP=$LB_IP"

    These instructions above should be checked against the Charts repo before using. See the README.md in the Helm chart repository for more information on how to use the Helm chart.

  3. Verify the stack is up and running

    kubectl get pods -n tink-system # verify all pods are running
kubectl get svc -n tink-system # Verify the tink-stack service has the IP you specified with $LB_IP under the EXTERNAL-IP column

  4. Download and convert a cloud image to a raw image

    kubectl apply -n tink-system -f https://raw.githubusercontent.com/tinkerbell/playground/main/vagrant/ubuntu-download.yaml
# This will download and convert the Ubuntu Jammy 22.04 cloud image.

  5. Create and/or customize Hardware, Template, and Workflow objects and apply them to the cluster. You can use the Hardware, Template, and Workflow in this repo, in the vagrant/ directory, as a base from which to start.

    kubectl apply -n tink-system -f my-hardware.yaml
kubectl apply -n tink-system -f my-template.yaml
kubectl apply -n tink-system -f my-workflow.yaml

  6. Start the machine provision process by rebooting, into a netbooting state, the machine you have specified in the Hardware object above.

  7. Watch the progress of the workflow.

    kubectl get workflow -n tink-system --watch
# Once the workflow is state is `STATE_SUCCESS`, you can login to the machine via the console or via SSH.