Skip to content

Latest commit

 

History

History
146 lines (121 loc) · 6.39 KB

NodeParameters_Master.md

File metadata and controls

146 lines (121 loc) · 6.39 KB

Master Node Parameters

The following is a list of all available parameters you can use with the setup_master_node.sh script. At the bottom are some examples that can help you get started and some notes on things to watch out for when setting some of the parameter values.

Parameter values which are wraped in quotes must include the quotes when applied.

Parameter Name Description Default Value Example Value Required
--configure-tcpip Set to true to configure TCP/IP settings of this server. false true No
--interface The interface to configure IP settings for. eth0 ens160 When --configure-tcpip is true
--ip-address The IP address to use. Also used for the Kubernetes API. - 192.168.0.100 When --configure-tcpip is true or when there is more than one IP address found.
--netmask The netmask to use. - 255.255.255.0 When --configure-tcpip is true
--default-gateway The default gateway to use. - 192.168.0.1 When --configure-tcpip is true
--dns-servers The DNS servers to use. "8.8.8.8 4.4.4.4" "192.168.0.2 192.168.0.3" No
--dns-search The local DNS search domains. "domain.local" "example.com domain.internal" No
--k8s-version The version of Kubernetes to install. latest 1.25.0-00 No
--k8s-load-balancer-ip-range The IP range or CIDR for Kubernetes load balancer. - 192.168.0.10-192.168.0.15
or
192.168.0.1/24		 No
--k8s-allow-master-node-schedule Set to true to allow master node to schedule pods. true false No
--nfs-install-server Set to true to install NFS server. true false No
--nfs-server The NFS server to use. $HOSTNAME 192.168.0.100 When --nfs-install-server is true
--nfs-share-path The NFS share path to use. /shares/nfs /mnt/nfs When --nfs-install-server is true
--nfs-default-storage-class Set to true to use NFS as the default storage class. false true No
--smb-install-server Set to true to install SMB server. true false No
--smb-server The SMB server to use. $HOSTNAME 192.168.0.100 When --smb-install-server is true
--smb-share-path The SMB share path to use. /shares/smb /mnt/smb When --smb-install-server is true
--smb-share-name The name of the SMB share. persistentvolumes pv When --smb-install-server is true
--smb-username The username for the SMB share. $SUDO_USER john No
--smb-password The password for the SMB share. password mypass No
--smb-default-storage-class Set to true to use SMB as the default storage class. true false No

Notes

Persistent Volumes

To use an existing NFS and/or SMB file server for PersistentVolumes (Instead of using the master node as a file server), simply set --smb-install-nfs or --smb-install-smb to false and set --nfs-server or --smb-server to the host name or IP address of your existing file server. For SMB you will need to provide the credentials with --smb-username and --smb-password aswell.

Applying these options will install the NFS and/or SMB CSI driver(s) and create StorageClass(es) configured to use your existing file server for Persistent Volumes.

Control-Plane (Master) Node Scheduling

If you set --k8s-allow-master-node-schedule to false it will not be possible to deploy any workloads until a worker node has joined the cluster. This includes MetalLB (the load-balancer used to give make your cluster accessible from your local network). You can enable or disable scheduling after installation with these kubectl commands.

# Enable
kubectl taint node $HOSTNAME node-role.kubernetes.io/control-plane:NoSchedule-

# Disable
kubectl taint node $HOSTNAME node-role.kubernetes.io/control-plane:NoSchedule

Host Network DNS Servers

If you add more than 3 DNS servers to the host TCP/IP settings, Kubernetes will display errors about exceeding the nameserver limit. While this will not prevent anything from working, the error messages can be annoying and Kubernetes will only use the first three anyway so you should aim to keep it between 1 and 3.

Parameter Examples


Example Usage - Minimum Required: 
./setup_master_node.sh \
    --dns-servers "192.168.0.30 192.168.0.31 8.8.8.8"

Or if your server has more than one IP address

./setup_master_node.sh \
    --ip-address 192.168.0.230 \
    --dns-servers "192.168.0.30 192.168.0.31 8.8.8.8"

Example Usage - TCP/IP Setup: 
./setup_master_node.sh \
    --configure-tcpip true \
    --interface ens160 \
    --ip-address 192.168.0.230 \
    --netmask 255.255.255.0 \
    --default-gateway 192.168.0.1 \
    --dns-servers "192.168.0.30 192.168.0.31 8.8.8.8" \
    --dns-search "domain1.local domain2.local" \
    --k8s-load-balancer-ip-range 192.168.0.20-192.168.0.29

Example Usage - Remote NFS Server: 
./setup_master_node.sh \  
    --nfs-install-server false \
    --nfs-server file-server.domain1.local \
    --nfs-default-storage-class true

Example Usage - Remote SMB Server: 
./setup_master_node.sh \
    --smb-install-server false \
    --smb-server file-server.domain1.local \
    --smb-share-name pvcs \
    --smb-username user \
    --smb-password pass \
    --smb-default-storage-class true

Example Usage - No Storage (No CSI drivers or Storage Classes will be installed) 
./setup_master_node.sh \  
    --nfs-install-server false \
    --smb-install-server false \

Example Usage - All: 
./setup_master_node.sh \
    --configure-tcpip true \
    --interface ens160 \
    --ip-address 192.168.0.230 \
    --netmask 255.255.255.0 \
    --default-gateway 192.168.0.1 \
    --dns-servers "192.168.0.30 192.168.0.31 8.8.8.8" \
    --dns-search "domain1.local domain2.local" \
    --k8s-version 1.26.0-00 \
    --k8s-load-balancer-ip-range 192.168.0.20-192.168.0.29 \
    --k8s-allow-master-node-schedule true \
    --nfs-install-server true \
    --nfs-server srv-k8s-master.domain1.local \
    --nfs-share-path /some/path/nfs \
    --nfs-default-storage-class true \
    --smb-install-server true \
    --smb-server srv-k8s-master.domain1.local \
    --smb-share-path /some/path/smb \
    --smb-share-name pvcs \
    --smb-username user \
    --smb-password pass \
    --smb-default-storage-class false