├── .gitattributes
├── IndividualSteps
    ├── configure_storage.sh
    └── configure_tcpip.sh
├── LICENSE
├── NodeParameters_Master.md
├── NodeParameters_Worker.md
├── README.md
├── TestManifests
    └── Storage
    │   ├── nfs.yaml
    │   └── smb.yaml
├── changelog.md
├── setup_master_node.sh
└── setup_worker_node.sh


/.gitattributes:
--------------------------------------------------------------------------------
1 | # Auto detect text files and perform LF normalization
2 | * text=auto
3 | 


--------------------------------------------------------------------------------
/IndividualSteps/configure_storage.sh:
--------------------------------------------------------------------------------
  1 | #!/bin/bash
  2 | 
  3 | # ------------------------------
  4 | # Kubernetes Storage Classes
  5 | # ------------------------------
  6 | # If the 'nfsInstallServer' or 'smbInstallServer' values are set to 'false' but the 'nfsServer' or 'smbServer' values are set to anything 
  7 | # other than this machines hostname, the CSI driver(s) will be installed and storage class(es) created and configured for the specifed server(s).
  8 | #
  9 | # WARNING: Using the master node as a storage server is not standard practice nor recommended. This option exists so that those who are new to k8s
 10 | # can quickly and easily try out Kubernetes features and applications that rely on persistent storage. Do not do this in a production environment.
 11 | #
 12 | export nfsInstallServer=true
 13 | export nfsServer=$HOSTNAME 
 14 | export nfsSharePath="/shares/nfs"   # Local server only
 15 | export nfsDefaultStorageClass=false
 16 | 
 17 | export smbInstallServer=true
 18 | export smbServer=$HOSTNAME
 19 | export smbSharePath="/shares/smb"   # Local server only
 20 | export smbShareName="persistentvolumes"
 21 | export smbUsername=$SUDO_USER
 22 | export smbPassword="password"
 23 | export smbDefaultStorageClass=true  # Only one storage class should be set as default.
 24 | 
 25 | # REMOTE SMB SERVER CONFIG EXAMPLE:
 26 | 
 27 | # export smbInstallServer=false
 28 | # export smbServer="FileServer01"
 29 | # export smbShareName="pvs"
 30 | # export smbUsername="user@domain.local"
 31 | # export smbPassword="SecurePassword"
 32 | # export smbDefaultStorageClass=false 
 33 | 
 34 | # Install NFS Server and/or CSI and Storage Classes https://github.com/kubernetes-csi/csi-driver-nfs
 35 | 
 36 | export INSTALL_NFS_DRIVER=false
 37 | 
 38 | if [ $nfsInstallServer == true ]; then
 39 |   echo -e "\033[32mInstall NFS File Server\033[0m"
 40 |   apt install -qqy nfs-kernel-server
 41 |   export NFS_CONFIG_FILE="/etc/exports"  
 42 |   if ! grep -q "$nfsSharePath" "$NFS_CONFIG_FILE"; then
 43 |     mkdir -p $nfsSharePath
 44 |     chown -R nobody:nogroup $nfsSharePath
 45 |     cat << EOF >> $NFS_CONFIG_FILE
 46 | $nfsSharePath    *(rw,sync,no_subtree_check)
 47 | EOF
 48 |     systemctl restart nfs-kernel-server
 49 |     showmount -e
 50 |     export INSTALL_NFS_DRIVER=true
 51 |   fi
 52 | elif [ "$nfsServer" != "$HOSTNAME" ]; then
 53 |   echo -e "\033[32mCreating NFS storge class for server $nfsServer \033[0m"
 54 |   export INSTALL_NFS_DRIVER=true
 55 | fi
 56 | 
 57 | # NFS CSI Driver https://github.com/kubernetes-csi/csi-driver-nfs/tree/master/charts
 58 | 
 59 | if [ $INSTALL_NFS_DRIVER == true ]; then
 60 |   echo -e "\033[32mInstall NFS CSI driver Helm chart\033[0m"
 61 |   export NFS_SERVER_NAME_SAFE=$(echo "$nfsServer" | tr '.' '-')
 62 |   export NFS_NAME_SPACE="kube-system"    
 63 |   export NFS_STORAGE_CLASS_FILE="nfsStorageClass.yaml"
 64 |   helm repo add csi-driver-nfs https://raw.githubusercontent.com/kubernetes-csi/csi-driver-nfs/master/charts 
 65 |   helm install csi-driver-nfs csi-driver-nfs/csi-driver-nfs --namespace $NFS_NAME_SPACE
 66 |   # See this page for all available parameters https://github.com/kubernetes-csi/csi-driver-nfs/blob/master/docs/driver-parameters.md
 67 |   cat <<EOF > $NFS_STORAGE_CLASS_FILE
 68 | apiVersion: storage.k8s.io/v1
 69 | kind: StorageClass
 70 | metadata:
 71 |   name: nfs-$NFS_SERVER_NAME_SAFE
 72 |   annotations:
 73 |     storageclass.kubernetes.io/is-default-class: "$nfsDefaultStorageClass"
 74 | provisioner: nfs.csi.k8s.io
 75 | parameters:
 76 |   server: $nfsServer
 77 |   share: $nfsSharePath
 78 | reclaimPolicy: Retain
 79 | volumeBindingMode: Immediate
 80 | mountOptions:
 81 |   - nfsvers=4.1
 82 | EOF
 83 |   kubectl apply -f $NFS_STORAGE_CLASS_FILE -n $NFS_NAME_SPACE
 84 |   rm $NFS_STORAGE_CLASS_FILE
 85 | fi
 86 | 
 87 | # Install SMB Server and/or CSI and Storage Classes https://ubuntu.com/tutorials/install-and-configure-samba#2-installing-samba
 88 | 
 89 | export INSTALL_SMB_DRIVER=false
 90 | 
 91 | if [ $smbInstallServer == true ]; then
 92 |   echo -e "\033[32mInstall SMB File Server\033[0m"
 93 |   apt install -qqy samba
 94 |   export SMB_CONFIG_FILE="/etc/samba/smb.conf"  
 95 |   if ! grep -q "$smbShareName" "$SMB_CONFIG_FILE"; then
 96 |     mkdir -p $smbSharePath
 97 |     chown -R $smbUsername:$smbUsername $smbSharePath
 98 |     cat << EOF >> $SMB_CONFIG_FILE
 99 | [$smbShareName]
100 |     comment = SMB Share for Kubernetes PVC's
101 |     path = $smbSharePath
102 |     read only = no
103 |     browsable = yes
104 | EOF
105 |     (echo "$smbPassword"; echo "$smbPassword") | smbpasswd -s -a "$smbUsername"  
106 |     service smbd restart
107 |     export INSTALL_SMB_DRIVER=true
108 |   fi
109 | elif [ "$smbServer" != "$HOSTNAME" ]; then
110 |   echo -e "\033[32mCreating SMB storge class for server $nfsServer \033[0m"
111 |   export INSTALL_SMB_DRIVER=true
112 | fi
113 | 
114 | # SMB CSI Driver https://github.com/kubernetes-csi/csi-driver-smb/tree/master/charts
115 | 
116 | if [ $INSTALL_SMB_DRIVER == true ]; then
117 |   echo -e "\033[32mInstall SMB CSI driver Helm chart\033[0m"
118 |   export SMB_SERVER_NAME_SAFE=$(echo "$smbServer" | tr '.' '-')
119 |   export SMB_NAME_SPACE="kube-system"
120 |   export SMB_SECRET_NAME="smb-credentials-$SMB_SERVER_NAME_SAFE"  
121 |   export SMB_STORAGE_CLASS_FILE="smbStorageClass.yaml"
122 |   helm repo add csi-driver-smb https://raw.githubusercontent.com/kubernetes-csi/csi-driver-smb/master/charts
123 |   helm install csi-driver-smb csi-driver-smb/csi-driver-smb --namespace $SMB_NAME_SPACE --set controller.runOnControlPlane=true
124 |   kubectl create secret generic $SMB_SECRET_NAME --from-literal username="$smbUsername" --from-literal password="$smbPassword" -n $SMB_NAME_SPACE
125 |   # See this page for all available parameters https://github.com/kubernetes-csi/csi-driver-smb/blob/master/docs/driver-parameters.md
126 |   cat <<EOF > $SMB_STORAGE_CLASS_FILE
127 | apiVersion: storage.k8s.io/v1
128 | kind: StorageClass
129 | metadata:
130 |   name: smb-$SMB_SERVER_NAME_SAFE
131 |   annotations:
132 |     storageclass.kubernetes.io/is-default-class: "$smbDefaultStorageClass"
133 | provisioner: smb.csi.k8s.io
134 | parameters:
135 |   source: "//$smbServer/$smbShareName"
136 |   csi.storage.k8s.io/node-stage-secret-name: $SMB_SECRET_NAME
137 |   csi.storage.k8s.io/node-stage-secret-namespace: $SMB_NAME_SPACE
138 |   csi.storage.k8s.io/provisioner-secret-name: $SMB_SECRET_NAME
139 |   csi.storage.k8s.io/provisioner-secret-namespace: $SMB_NAME_SPACE
140 | reclaimPolicy: Retain      # only Retain is supported
141 | volumeBindingMode: Immediate
142 | mountOptions:
143 |   - dir_mode=0777
144 |   - file_mode=0777
145 |   - uid=1001
146 |   - gid=1001
147 | EOF
148 |   kubectl apply -f $SMB_STORAGE_CLASS_FILE -n $SMB_NAME_SPACE
149 |   rm $SMB_STORAGE_CLASS_FILE
150 | fi
151 | 
152 | echo -e "\033[32mComplete\033[0m"


--------------------------------------------------------------------------------
/IndividualSteps/configure_tcpip.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | # Define variables
 4 | 
 5 | # ------------------------------
 6 | # Host TCP/IP Settings
 7 | # ------------------------------
 8 | # WARNING: If this is enabled and the IP address will be changed, make sure you are not running this script from a remote shell.
 9 | # 
10 | export interface="ens160"
11 | export ipAddress="192.168.0.10"
12 | export netmask="255.255.255.0"
13 | export defaultGateway="192.168.0.1"
14 | export dnsServers=("192.168.0.2" "8.8.8.8")
15 | export dnsSearch=("domain.local")
16 | 
17 | # Check sudo & keep sudo running
18 | 
19 | echo -e "\033[32mChecking root access\033[0m"
20 | 
21 | if [ "$(id -u)" -ne 0 ]
22 | then
23 |   echo -e "\033[31mYou must run this script as root\033[0m"
24 |   exit
25 | fi
26 | 
27 | # Configure IP Settings
28 | 
29 | echo -e "\033[32mConfiguring Network Settings\033[0m"
30 | 
31 | IFS=. read -r i1 i2 i3 i4 <<< "$ipAddress"
32 | IFS=. read -r m1 m2 m3 m4 <<< "$netmask"
33 | 
34 | maskDec=$(( (m1 * 16777216) + (m2 * 65536) + (m3 * 256) + m4 ))
35 | maskBin=$(echo "obase=2; $maskDec" | bc)
36 | cidr=$(echo "$maskBin" | tr -d '\n' | sed 's/0*$//' | wc -c)
37 | 
38 | cat <<EOF | sudo tee /etc/netplan/01-netcfg.yaml > /dev/null
39 | network:
40 |   version: 2
41 |   ethernets:
42 |     $interface:
43 |       dhcp4: false
44 |       dhcp6: false
45 |       addresses: [$ipAddress/$cidr]
46 |       routes:
47 |       - to: default
48 |         via: $defaultGateway
49 |       nameservers:
50 |         search: [$(echo "${dnsSearch[@]}" | tr ' ' ',')]          
51 |         addresses: [$(echo "${dnsServers[@]}" | tr ' ' ',')]
52 | EOF
53 | 
54 | sudo netplan apply
55 | 
56 | echo -e "\033[32mComplete\033[0m"


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 | GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <https://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <https://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <https://www.gnu.org/licenses/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------
/NodeParameters_Master.md:
--------------------------------------------------------------------------------
  1 | # Master Node Parameters
  2 | 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. 
  3 | 
  4 | Parameter values which are wraped in quotes must include the quotes when applied.
  5 | <br>
  6 | <br>
  7 | 
  8 | |Parameter Name|Description|Default Value|Example Value|Required|
  9 | |--- |--- |--- |--- |--- |
 10 | |`--configure-tcpip`|Set to `true` to configure TCP/IP settings of this server.|`false`|`true`|No|
 11 | |`--interface`|The interface to configure IP settings for.|`eth0`|`ens160`|When `--configure-tcpip` is `true`|
 12 | |`--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.|
 13 | |`--netmask`|The netmask to use.|-|`255.255.255.0`|When `--configure-tcpip` is `true`|
 14 | |`--default-gateway`|The default gateway to use.|-|`192.168.0.1`|When `--configure-tcpip` is `true`|
 15 | |`--dns-servers`|The DNS servers to use.|`"8.8.8.8 4.4.4.4"`|`"192.168.0.2 192.168.0.3"`|No|
 16 | |`--dns-search`|The local DNS search domains.|`"domain.local"`|`"example.com domain.internal"`|No|
 17 | |`--k8s-version`|The version of Kubernetes to install.|`latest`|`1.25.0-00`|No|
 18 | |`--k8s-load-balancer-ip-range`|The IP range or CIDR for Kubernetes load balancer.|-|`192.168.0.10-192.168.0.15`<br>or<br>`192.168.0.1/24`|No|
 19 | |`--k8s-cni`|The Kubernetes network plugin to install.|`flannel`|`cilium` or `none`|No|
 20 | |`--k8s-allow-master-node-schedule`|Set to `true` to allow master node to schedule pods.|`true`|`false`|No|
 21 | |`--k8s-kubeadm-options`|Additional options to pass into the `kubeadm init` command.|-|`"--ignore-preflight-errors=all"`|No|
 22 | |`--nfs-install-server`|Set to `true` to install NFS server.|`true`|`false`|No|
 23 | |`--nfs-server`|The NFS server to use.|`$HOSTNAME`|`192.168.0.100`|When `--nfs-install-server` is `true`|
 24 | |`--nfs-share-path`|The NFS share path to use.|`/shares/nfs`|`/mnt/nfs`|When `--nfs-install-server` is `true`|
 25 | |`--nfs-default-storage-class`|Set to `true` to use NFS as the default storage class.|`false`|`true`|No|
 26 | |`--smb-install-server`|Set to `true` to install SMB server.|`true`|`false`|No|
 27 | |`--smb-server`|The SMB server to use.|`$HOSTNAME`|`192.168.0.100`|When `--smb-install-server` is `true`|
 28 | |`--smb-share-path`|The SMB share path to use.|`/shares/smb`|`/mnt/smb`|When `--smb-install-server` is `true`|
 29 | |`--smb-share-name`|The name of the SMB share.|`persistentvolumes`|`pv`|When `--smb-install-server` is `true`|
 30 | |`--smb-username`|The username for the SMB share.|`$SUDO_USER`|`john`|No|
 31 | |`--smb-password`|The password for the SMB share.|`password`|`mypass`|No|
 32 | |`--smb-default-storage-class`|Set to `true` to use SMB as the default storage class.|`true`|`false`|No|
 33 | <br>
 34 | 
 35 | ## Notes
 36 | 
 37 | ### Persistent Volumes
 38 | 
 39 | To use an existing NFS and/or SMB file server for [PersistentVolumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) (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.
 40 | 
 41 | Applying these options will install the NFS and/or SMB CSI driver(s) and create [StorageClass(es)](https://kubernetes.io/docs/concepts/storage/storage-classes/) configured to use your existing file server for Persistent Volumes.
 42 | 
 43 | ### Control-Plane (Master) Node Scheduling
 44 | 
 45 | 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.
 46 | ```
 47 | # Enable
 48 | kubectl taint node $HOSTNAME node-role.kubernetes.io/control-plane:NoSchedule-
 49 | 
 50 | # Disable
 51 | kubectl taint node $HOSTNAME node-role.kubernetes.io/control-plane:NoSchedule
 52 | ```
 53 | 
 54 | ### Host Network DNS Servers
 55 | 
 56 | 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.
 57 | 
 58 | ## Parameter Examples
 59 | 
 60 | <br>
 61 | Example Usage - Minimum Required:
 62 | 
 63 | ```
 64 | ./setup_master_node.sh \
 65 |     --k8s-load-balancer-ip-range 192.168.0.20-192.168.0.29
 66 | ```
 67 | <p style="width=100%; text-align: center; font-style: italic">Or if your server has more than one IP address</p>
 68 | 
 69 | ```
 70 | ./setup_master_node.sh \
 71 |     --ip-address 192.168.0.230 \
 72 |     --k8s-load-balancer-ip-range 192.168.0.20-192.168.0.29
 73 | ```
 74 | 
 75 | <br>
 76 | Example Usage - TCP/IP Setup:
 77 | 
 78 | ```
 79 | ./setup_master_node.sh \
 80 |     --configure-tcpip true \
 81 |     --interface ens160 \
 82 |     --ip-address 192.168.0.230 \
 83 |     --netmask 255.255.255.0 \
 84 |     --default-gateway 192.168.0.1 \
 85 |     --dns-servers "192.168.0.30 192.168.0.31 8.8.8.8" \
 86 |     --dns-search "domain1.local domain2.local" \
 87 |     --k8s-load-balancer-ip-range 192.168.0.20-192.168.0.29    
 88 | ```
 89 | 
 90 | <br>
 91 | Example Usage - Remote NFS Server:
 92 | 
 93 | ```
 94 | ./setup_master_node.sh \  
 95 |     --nfs-install-server false \
 96 |     --nfs-server file-server.domain1.local \
 97 |     --nfs-default-storage-class true
 98 | ```
 99 | 
100 | <br>
101 | Example Usage - Remote SMB Server:
102 | 
103 | ```
104 | ./setup_master_node.sh \
105 |     --smb-install-server false \
106 |     --smb-server file-server.domain1.local \
107 |     --smb-share-name pvcs \
108 |     --smb-username user \
109 |     --smb-password pass \
110 |     --smb-default-storage-class true
111 | ```
112 | 
113 | <br>
114 | Example Usage - No Storage (No CSI drivers or Storage Classes will be installed)
115 | 
116 | ```
117 | ./setup_master_node.sh \  
118 |     --nfs-install-server false \
119 |     --smb-install-server false \
120 | ```
121 | 
122 | <br>
123 | Example Usage - Additional kubeadm init options
124 | 
125 | ```
126 | ./setup_master_node.sh \  
127 |     --k8s-kubeadm-options "--ignore-preflight-errors=all" 
128 | ```
129 | > Available options for `kubeadm init` [here](https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm-init/). <br> **Do not** include `--apiserver-advertise-address` or `--pod-network-cidr` as these are already set in the script.
130 | 
131 | <br>
132 | Example Usage - Kubernetes CNI
133 | 
134 | ```
135 | ./setup_master_node.sh \  
136 |     --k8s-cni cilium
137 | ```
138 | > Currently the options are `flannel`, `cilium` or `none`. If you choose `none`, MetalLB will also be skipped, and your control-plane node will be in a `NotReady` state until you install your own CNI.
139 | 
140 | <br>
141 | Example Usage - All:
142 | 
143 | ```
144 | ./setup_master_node.sh \
145 |     --configure-tcpip true \
146 |     --interface ens160 \
147 |     --ip-address 192.168.0.230 \
148 |     --netmask 255.255.255.0 \
149 |     --default-gateway 192.168.0.1 \
150 |     --dns-servers "192.168.0.30 192.168.0.31 8.8.8.8" \
151 |     --dns-search "domain1.local domain2.local" \
152 |     --k8s-version 1.26.0-00 \
153 |     --k8s-load-balancer-ip-range 192.168.0.20-192.168.0.29 \
154 |     --k8s-cni cilium \
155 |     --k8s-allow-master-node-schedule true \
156 |     --k8s-kubeadm-options "--ignore-preflight-errors=all" \
157 |     --nfs-install-server true \
158 |     --nfs-server srv-k8s-master.domain1.local \
159 |     --nfs-share-path /some/path/nfs \
160 |     --nfs-default-storage-class true \
161 |     --smb-install-server true \
162 |     --smb-server srv-k8s-master.domain1.local \
163 |     --smb-share-path /some/path/smb \
164 |     --smb-share-name pvcs \
165 |     --smb-username user \
166 |     --smb-password pass \
167 |     --smb-default-storage-class false    
168 | ```


--------------------------------------------------------------------------------
/NodeParameters_Worker.md:
--------------------------------------------------------------------------------
 1 | # Worker Node Parameters
 2 | The following is a list of all available parameters you can use with the `setup_worker_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. 
 3 | 
 4 | Parameter values which are wraped in quotes must include the quotes when applied.
 5 | 
 6 | Parameters that have default values but are marked as required can still be ommited from the command line. In this event the default value will be used.
 7 | 
 8 | <br>
 9 | <br>
10 | 
11 | |Parameter Name|Description|Default Value|Example Value|Required|
12 | |--- |--- |--- |--- |--- |
13 | |`--configure-tcpip`|Set to `true` to configure TCP/IP settings of this server.|`false`|`true`|No|
14 | |`--interface`|The interface to configure IP settings for.|`eth0`|`ens160`|When `--configure-tcpip` is `true`|
15 | |`--ip-address`|The IP address to use.|-|`192.168.0.100`|When `--configure-tcpip` is `true`|
16 | |`--netmask`|The netmask to use.|-|`255.255.255.0`|When `--configure-tcpip` is `true`|
17 | |`--default-gateway`|The default gateway to use.|-|`192.168.0.1`|When `--configure-tcpip` is `true`|
18 | |`--dns-servers`|The DNS servers to use.|`"8.8.8.8 4.4.4.4"`|`"192.168.0.2 192.168.0.3"`|No|
19 | |`--dns-search`|The local DNS search domains.|`"domain.local"`|`"example.com domain.internal"`|No|
20 | |`--k8s-version`|The version of Kubernetes to install.|`latest`|`1.25.0-00`|No|
21 | |`--k8s-master-ip`|The IP address of the control-plane node.|-|`192.168.0.10`|Yes|
22 | |`--k8s-master-port`|The Kubernetes API server port on the control-plane node.|`6443`|`6443`|Yes|
23 | |`--k8s-kubeadm-options`|Additional options to pass into the `kubeadm join` command.|-|`"--ignore-preflight-errors=all"`|No|
24 | |`--token`|The `token` portion of the `kubeadm join` command.|-|`kspnlk.7h[..]3f`|Yes|
25 | |`--discovery-token-ca-cert-hash`|The `discovery-token-ca-cert-hash` portion of the `kubeadm join` command.|-|`sha256:68d[..]bb2`|Yes|
26 | 
27 | <br>
28 | 
29 | ## Notes
30 | 
31 | The `--token` and `--discovery-token-ca-cert-hash` parameters should be exactly the same as the output from the `kubeadm join` command. To obtain these values again run `kubeadm token create --print-join-command` on the control-plane (master) node.
32 | 
33 | ## Parameter Examples
34 | 
35 | <br>
36 | Example Usage - Minimum Required:
37 | 
38 | ```
39 | ./setup_worker_node.sh \
40 |     --k8s-master-ip 192.168.0.230 \    
41 |     --token fbdzi9.5yedbdve20r \
42 |     --discovery-token-ca-cert-hash sha256:68d0860434a20c9eb533b640f23134c0fdacc4b929e97c8f8e537f9b4befabb2 
43 | ```
44 | 
45 | <br>
46 | Example Usage - Additional kubeadm join options
47 | 
48 | ```
49 | ./setup_master_node.sh \  
50 |     --k8s-kubeadm-options "--ignore-preflight-errors=all" 
51 | ```
52 | > Available options for `kubeadm join` [here](https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm-join/). <br> **Do not** include `--token` or `--discovery-token-ca-cert-hash` as these are already set in the script.
53 | 
54 | <br>
55 | Example Usage - All:
56 | 
57 | ```
58 | ./setup_worker_node.sh \
59 |     --configure-tcpip true \
60 |     --interface ens160 \
61 |     --ip-address 192.168.0.231 \
62 |     --netmask 255.255.255.0 \
63 |     --default-gateway 192.168.0.1 \
64 |     --dns-servers "192.168.0.30 192.168.0.31 8.8.8.8" \
65 |     --dns-search "domain1.local domain2.local" \
66 |     --k8s-master-ip 192.168.0.230 \
67 |     --k8s-master-port 6443 \
68 |     --k8s-kubeadm-options "--ignore-preflight-errors=all" \
69 |     --token fbdzi9.5yedbdve20r \
70 |     --discovery-token-ca-cert-hash sha256:68d0860434a20c9eb533b640f23134c0fdacc4b929e97c8f8e537f9b4befabb2 
71 | ```


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # Autok8s (Automatic Kubernetes)
  2 | 
  3 | Autok8s aims to fully automate the installation of self-hosted Kubernetes clusters in a bare-metal or virtual machine based environment. 
  4 | 
  5 | This will be of interest to anyone wanting to try out Kubernetes for the first time without spending any money, k8s enthusiasts/profesionals that want a cluster at home for free, or those who are familiar with cloud offerings such as EKS or AKS but would like to learn more about how Kubernetes works under the hood. This may also help those looking to create an on-premis or entirely spot instance cluster in a professional environment.
  6 | 
  7 | In managed Kubernetes services such as EKS, AKS or GKE, the control-plane (master) node is abstracted away from you. For self-hosted clusters though, you have to create the control-plane node yourself. There are plenty of great articles out there on how to do this, but the process is not arbitrary. It can take a long time to get working and involves quite a bit of manual work. 
  8 | 
  9 | This project aims to fully automate the installation and configuration of a Kubernetes control-plane node along with the worker nodes with no more than one command per node. It includes manifests and Helm charts for pod networking, a load balancer & persistent storage.
 10 | 
 11 | In short, the idea of Autok8s is to run a script, wait a few minutes, and have a fully functional, ready to go Kubernetes cluster, just as you would have in the cloud.
 12 | 
 13 | Here's a video that demonstrates a brand-new 2 node cluster being created in just over 5 minutes.
 14 | 
 15 | [![Self-Hosted Kubernetes Cluster in 5 Minutes](https://user-images.githubusercontent.com/13077550/223282256-3fd23787-94a8-4789-bbeb-8e47c8963a7e.png)](https://www.youtube.com/watch?v=KK3W76xrN9E "Self-Hosted Kubernetes Cluster in 5 Minutes")
 16 | 
 17 | ## What Does This Do?
 18 | 
 19 | ### Master (Control-Plane) Node Script:
 20 | 
 21 | Here's a high-level overview of the steps `setup_master_node.sh` will perform:
 22 | 
 23 | - Performs validation to ensure the hardware meets the minimum requirements and checks that parameter values are valid.
 24 | 
 25 | - Configure TCP/IP settings including DNS servers and search domains. (Optional. Added for convenience and time saving).
 26 | 
 27 | - Installs prerequisite packages such as `apt-transport-https`, `ca-certificates`, etc.  
 28 | 
 29 | - Adds Docker and Kubernetes repositories.
 30 | 
 31 | - Installs Docker CE and containerd, then applies required configuration for Kubernetes.
 32 | 
 33 | - Installs Kubernetes packages.
 34 | 
 35 | - Configures prerequisites such as disabling swap and enabling IPv4 packet forwarding
 36 | 
 37 | - Initializes Kubernetes with the `kubeadm init` command.
 38 | 
 39 | - Creates the `~/.kube/config` files so you can use `kubectl` as soon as its finished.
 40 | 
 41 | - Installs a CNI (You can choose between `flannel` (default), `cilium`, or `none` if you want to install your own later)
 42 | 
 43 | - Installs Helm.
 44 | 
 45 | - Installs NFS file server on the host, NFS CSI drivers via Helm chart, and adds storage class.
 46 | 
 47 |     (This is entirely optional and not recommended for production use. It's mainly for those that want a working storage solution out of the box).
 48 | 
 49 | - Installs SMB file server on the host, SMB CSI drivers via Helm chart, and adds storage class.
 50 | 
 51 |     (Again this is optional. You can also specify an existing SMB and/or NFS server to use rather than make the master node a file server).
 52 | 
 53 | - Installs MetalLB via Helm chart (Requires that you reserve a range of IP addresses on your local network to be used by Kubernetes [services](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer) of type `LoadBalancer`).
 54 | 
 55 | - Installs Metrics Server via Helm chart.
 56 | 
 57 | - Prints a message containing the command and parameters for joining a node to the cluster using the AutoK8s `setup_worker_node.sh` script.
 58 | 
 59 | Once your master node is up and running you can use the manifests found in the [TestManifests/Storage](https://github.com/7wingfly/autok8s/tree/main/TestManifests/Storage) directory to test out NFS and SMB and storage. In the near future other manifests will be added for things like networking.
 60 | 
 61 | ### Worker Node Script:
 62 | 
 63 | Here's a high-level overview of the steps `setup_worker_node.sh` will perform:
 64 | 
 65 | - Performs validation to ensure the hardware meets the minimum requirements and checks that parameter values are valid.
 66 | 
 67 | - Configure TCP/IP settings including DNS servers and search domains. (Optional. Added for convenience and time saving).
 68 | 
 69 | - Installs prerequisite packages such as `apt-transport-https`, `ca-certificates`, etc.  
 70 | 
 71 | - Adds Docker and Kubernetes repositories.
 72 | 
 73 | - Installs Docker CE and containerd, then applies required configuration for Kubernetes.
 74 | 
 75 | - Installs Kubernetes packages.
 76 | 
 77 | - Configures prerequisites such as disabling swap and enabling IPv4 packet forwarding
 78 | 
 79 | - Joins the Kubernetes cluster using the `kubeadm join` command.
 80 | 
 81 | ## Getting Ready!
 82 | 
 83 | The minimum hardware requirements for a Kubernetes node is 2 CPU's and 1,700 MB of RAM. If your hardware does not meet these requirements the Autok8s scripts will not proceed.
 84 | 
 85 | It's highly recommended that you run this on a brand new Ubuntu 20.04 server virtual machine. When you install the Ubuntu OS and are presented with the list of optional packages to install, **DO NOT** select docker. This will install the `docker.io` package which is no longer compatible with Kubernetes. This script will install the `docker-ce` package for you instead.
 86 | 
 87 | If you run this on a VM and have the ability to take a snapshot before you start, it is recommended you do so because if the script fails or if you want to do it again with different options then running the script more than once may have unexpected results. 
 88 | 
 89 | There a quite a few paramters you can pass into the script. At the very least you will need to provide the IP range for the load balancer. The IP range should be outside of your DHCP scope, or alternatively DHCP reservations should be made to ensure you do not have IP address conflicts between the [services](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer) in Kubernetes and other devices on your local network.
 90 | 
 91 | It's recommended to read the Master Node Parameters [document](https://github.com/7wingfly/autok8s/tree/main/NodeParameters_Master.md) for details on all available parameters before you begin.
 92 | 
 93 | ## Go Time!
 94 | You can run the `setup_master_node.sh` script in one of two ways. Download or copy & paste the script directly from [here](https://raw.githubusercontent.com/7wingfly/autok8s/main/setup_master_node.sh), give it execute permissions and run it as `sudo`.
 95 | 
 96 | ```
 97 | sudo chmod +x ./setup_master_node.sh
 98 | sudo ./setup_master_node.sh --k8s-load-balancer-ip-range <IP range or CIDR>
 99 | ```
100 | 
101 | Or you can run it straight from GitHub using the `curl` command as follows:
102 | 
103 | ```
104 | curl -s https://raw.githubusercontent.com/7wingfly/autok8s/main/setup_master_node.sh | sudo bash -s -- \
105 |     --k8s-load-balancer-ip-range <IP range or CIDR>
106 | ```
107 | 
108 | Note that if your server has more than one IP address you will need to specify which to use for the Kubernetes Server API. The script will not proceed if more than one is detected.
109 | 
110 | ```
111 | curl -s https://raw.githubusercontent.com/7wingfly/autok8s/main/setup_master_node.sh | sudo bash -s -- \
112 |     --ip-address <master node IP> \
113 |     --k8s-load-balancer-ip-range <IP range or CIDR>
114 | ```
115 | 
116 | The installation can take a fairly long time depending on your hardware and internet speed. Allow for around 30 minutes on slower internet connections and/or hardware.
117 | 
118 | Once installation is complete the following message will be shown detailing the command for joining worker nodes to your cluster using the `setup_worker_node.sh` script as well as some other tips and useful infomation.
119 | 
120 | ![complete-message](https://user-images.githubusercontent.com/13077550/222972633-63b91c73-e922-486a-9025-9ae78a630175.JPG)
121 | 
122 | The `setup_worker_node.sh` script also has several parameters you can use to configure the worker nodes as needed. Read the Worker Node Parameters [document](https://github.com/7wingfly/autok8s/tree/main/NodeParameters_Worker.md) for details on all available parameters before you begin.
123 | 
124 | As shown earlier in the success message, the `setup_worker_node.sh` command can also be ran from GitHub using the `curl` command:
125 | 
126 | ```
127 | curl -s https://raw.githubusercontent.com/7wingfly/autok8s/main/setup_worker_node.sh | sudo bash -s -- \
128 |     --k8s-master-ip <master node IP> \
129 |     --k8s-master-port 6443 \
130 |     --token <token> \
131 |     --discovery-token-ca-cert-hash <ca cert hash> 
132 | ```
133 | 
134 | Lastly, run the `cat ~/.kube/config` command on the control-plane node, copy the kube config and save to `.kube/config` under your home directory on your local machine to use `kubectl` or a Kubernetes IDE such as [Lens](https://k8slens.dev/).
135 | 
136 | ## Links
137 | 
138 | Links to documentation used to create this project:
139 | 
140 | Docker install docs:
141 | <br>
142 | https://docs.docker.com/engine/install/ubuntu/
143 | 
144 | Containerd config:
145 | <br>
146 | https://kubernetes.io/docs/setup/production-environment/container-runtimes/#containerd-systemd
147 | 
148 | Kubernetes install docs:
149 | <br>
150 | https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/
151 | 
152 | Kubeadm init docs:
153 | <br>
154 | https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm-init/
155 | 
156 | 
157 | Flannel networking docs:
158 | <br>
159 | https://github.com/flannel-io/flannel/#readme
160 | 
161 | NFS CSI driver:
162 | <br>
163 | https://github.com/kubernetes-csi/csi-driver-nfs
164 | <br>
165 | https://github.com/kubernetes-csi/csi-driver-nfs/tree/master/charts
166 | 
167 | SMB CSI driver:
168 | <br>
169 | https://github.com/kubernetes-csi/csi-driver-smb
170 | <br>
171 | https://github.com/kubernetes-csi/csi-driver-smb/tree/master/charts
172 | <br>
173 | https://ubuntu.com/tutorials/install-and-configure-samba#2-installing-samba
174 | 
175 | 
176 | MetalLB load balancer 
177 | <br>
178 | https://metallb.universe.tf/installation/
179 | <br>
180 | https://metallb.universe.tf/configuration/_advanced_l2_configuration/
181 | 


--------------------------------------------------------------------------------
/TestManifests/Storage/nfs.yaml:
--------------------------------------------------------------------------------
 1 | apiVersion: v1
 2 | kind: Namespace
 3 | metadata:
 4 |   name: nfs-storage-tests  
 5 |   labels:
 6 |     name: nfs-storage-tests
 7 | ---
 8 | kind: PersistentVolumeClaim
 9 | apiVersion: v1
10 | metadata:
11 |   name: pvc-nfs
12 |   namespace: nfs-storage-tests
13 | spec:  
14 |   accessModes:
15 |     - ReadWriteMany
16 |   resources:
17 |     requests:
18 |       storage: 1Gi  
19 |   storageClassName: nfs-srv-k8s-green-master
20 | ---
21 | apiVersion: apps/v1
22 | kind: Deployment
23 | metadata:
24 |   name: pwsh-nfs
25 |   namespace: nfs-storage-tests
26 |   labels:
27 |     app: pwsh
28 | spec:
29 |   replicas: 1
30 |   template:
31 |     metadata:
32 |       name: pwsh
33 |       labels:
34 |         app: pwsh
35 |     spec:      
36 |       containers:
37 |         - name: pwsh
38 |           image: mcr.microsoft.com/powershell:lts-ubuntu-20.04
39 |           command:
40 |             - "pwsh"
41 |             - "-Command"
42 |             - "write-host Starting; while (1) { Add-Content -Encoding Ascii /mnt/nfs/data.txt $(Get-Date -Format u); sleep 5; write-host hello; }"
43 |           volumeMounts:
44 |             - name: nfs
45 |               mountPath: "/mnt/nfs"
46 |               subPath: subPath
47 |       volumes:
48 |         - name: nfs
49 |           persistentVolumeClaim:
50 |             claimName: pvc-nfs
51 |   selector:
52 |     matchLabels:
53 |       app: pwsh
54 | 


--------------------------------------------------------------------------------
/TestManifests/Storage/smb.yaml:
--------------------------------------------------------------------------------
 1 | apiVersion: v1
 2 | kind: Namespace
 3 | metadata:
 4 |   name: smb-storage-tests  
 5 |   labels:
 6 |     name: smb-storage-tests
 7 | ---
 8 | kind: PersistentVolumeClaim
 9 | apiVersion: v1
10 | metadata:
11 |   name: pvc-smb
12 |   namespace: smb-storage-tests
13 | spec:  
14 |   accessModes:
15 |     - ReadWriteMany
16 |   resources:
17 |     requests:
18 |       storage: 1Gi  
19 |   storageClassName: smb-srv-k8s-green-master
20 | ---
21 | apiVersion: apps/v1
22 | kind: Deployment
23 | metadata:
24 |   name: pwsh-smb
25 |   namespace: smb-storage-tests
26 |   labels:
27 |     app: pwsh
28 | spec:
29 |   replicas: 1
30 |   template:
31 |     metadata:
32 |       name: pwsh
33 |       labels:
34 |         app: pwsh
35 |     spec:      
36 |       containers:
37 |         - name: pwsh
38 |           image: mcr.microsoft.com/powershell:lts-ubuntu-20.04
39 |           command:
40 |             - "pwsh"
41 |             - "-Command"
42 |             - "write-host Starting; while (1) { Add-Content -Encoding Ascii /mnt/smb/data.txt $(Get-Date -Format u); sleep 5; write-host hello; }"
43 |           volumeMounts:
44 |             - name: smb
45 |               mountPath: "/mnt/smb"
46 |               subPath: subPath
47 |       volumes:
48 |         - name: smb
49 |           persistentVolumeClaim:
50 |             claimName: pvc-smb
51 |   selector:
52 |     matchLabels:
53 |       app: pwsh
54 | 


--------------------------------------------------------------------------------
/changelog.md:
--------------------------------------------------------------------------------
 1 | 
 2 | ---
 3 | ### 1.3.0
 4 | *April 26th 2025*
 5 | 
 6 | - Add installation of Metrics Server
 7 | 
 8 | ---
 9 | ### 1.2.0
10 | *March 26th 2025*
11 | 
12 | - Add feature for installing Cilium CNI.
13 | - Refactor control-plane node taint removal steps.
14 | - Add 10 second sleep after any warning message.
15 | - Fun improvements to splash screen.
16 | - Hide output of `apt-get update`.
17 | 
18 | Tested with:
19 | 
20 | - Ubuntu Server 24.04
21 | - Kubernetes Version 1.32.3
22 | 
23 | ---
24 | ### 1.1.0
25 | *March 24th 2025*
26 | 
27 | - Add feature for choosing CNI.
28 | 
29 | Tested with:
30 | 
31 | - Ubuntu Server 24.04
32 | - Kubernetes Version 1.32.3
33 | 
34 | ---
35 | ### 1.0.1
36 | *March 23th 2025*
37 | 
38 | - Use community package repository (pkgs.k8s.io). (Google ones are dead)
39 | - Use GitHub to determine latest version (required due to the above).
40 | - Add validation for `--k8s-version` parameter.
41 | - Reorder steps, placing prerequisite config between package install and `kubeadm [init|join]`. Also place splash and sudo checks at top of script.
42 | - Add script version to banner.
43 | - Change CIDR generator code so it doesn't break syntax highlighting.
44 | - Added `--k8s-kubeadm-options` parameter.
45 | - Added `set -euo pipefail` to terminate script on failure.
46 | - Update documentation.
47 | - Added 1 second sleep before `apt-get update` due to observed file locks / race conditions.
48 | - Added changelog.md.
49 | 
50 | Tested with:
51 | 
52 | - Ubuntu Server 24.04
53 | - Kubernetes Version 1.32.3
54 | 


--------------------------------------------------------------------------------
/setup_master_node.sh:
--------------------------------------------------------------------------------
  1 | #!/bin/bash
  2 | set -euo pipefail
  3 | 
  4 | echo -e '\e[35m      _         _       \e[36m _    ___       \e[0m'
  5 | echo -e '\e[35m     / \  _   _| |_ ___ \e[36m| | _( _ ) ___  \e[0m'
  6 | echo -e '\e[35m    / ▲ \| | | | __/   \\\e[36m| |/ /   \/ __| \e[0m'
  7 | echo -e '\e[35m   / ___ \ |_| | ||  ●  \e[36m|   <  ♥  \__ \ \e[0m'
  8 | echo -e '\e[35m  /_/   \_\__,_|\__\___/\e[36m|_|\_\___/|___/ \e[0m'
  9 | echo -e '\e[35m                Version:\e[36m 1.3.0\e[0m\n'
 10 | echo -e '\e[35m  Kubernetes Installation Script:\e[36m Control-Plane Edition\e[0m\n'
 11 | 
 12 | # Check sudo & keep sudo running
 13 | # --------------------------------------------------------------------------------------------------------------------------------------------------------
 14 | 
 15 | if [ "$(id -u)" -ne 0 ]; then
 16 |   echo -e "\033[31mYou must run this script as root\033[0m"
 17 |   exit
 18 | fi
 19 | 
 20 | sudo -v
 21 | while true; do  
 22 |   sudo -nv; sleep 1m
 23 |   kill -0 $$ 2>/dev/null || exit
 24 | done &
 25 | 
 26 | # Define Variables, Default Values & Parameters 
 27 | # --------------------------------------------------------------------------------------------------------------------------------------------------------
 28 | 
 29 | # ------------------------------
 30 | # Host TCP/IP Settings
 31 | # ------------------------------
 32 | # These options configure the TCP/IP settings of this server. These options have been added for your convenience however, you may not want to
 33 | # do this if your settings are already configured. You will still need to specify this machines IP address though as it will be required by 
 34 | # other parts of the script.
 35 | #
 36 | # WARNING: If this is enabled and the IP address will be changed, make sure you are not running this script from a remote shell.
 37 | # 
 38 | export configureTCPIPSetting=false
 39 | export interface="eth0"                                     # Find with 'ip addr'
 40 | export ipAddress=""                                         # Require even if 'configureTCPIPSetting' is set to 'false'.
 41 | export netmask=""
 42 | export defaultGateway=""
 43 | export dnsServers=("8.8.8.8" "4.4.4.4")                     # Don't specify more than 3. K8s will only use the first three and throw errors.
 44 | export dnsSearch=("domain.local")                           # Your local DNS search domain if you have one.
 45 | 
 46 | # ------------------------------
 47 | # Kubernetes
 48 | # ------------------------------
 49 | #
 50 | export k8sVersion="latest"                                  # You can specify a specific version such as "1.25.0-00".
 51 | export k8sLoadBalancerIPRange=""                            # Either a range such as "192.168.0.100-192.168.0.150" or a CIDR (Add /32 for a single IP).
 52 | export k8sCNI="flannel"                                     # Choose a Kubernetes network plugin.
 53 | export k8sAllowMasterNodeSchedule=true                      # Disabling this is best practice however without it MetalLB cannot be deployed until a node is added.
 54 | export k8sKubeadmOptions=""                                 # Additional options you can pass into the kubeadm init command. 
 55 | 
 56 | # ------------------------------
 57 | # Kubernetes Storage Classes
 58 | # ------------------------------
 59 | # If the 'nfsInstallServer' or 'smbInstallServer' values are set to 'false' but the 'nfsServer' or 'smbServer' values are set to anything 
 60 | # other than this machines hostname, the CSI driver(s) will be installed and storage class(es) created and configured for the specifed server(s).
 61 | #
 62 | # WARNING: Using the master node as a storage server is not standard practice nor recommended. This option exists so that those who are new to k8s
 63 | # can quickly and easily try out Kubernetes features and applications that rely on persistent storage. Do not do this in a production environment.
 64 | #
 65 | export nfsInstallServer=true
 66 | export nfsServer=$HOSTNAME 
 67 | export nfsSharePath="/shares/nfs"                           # Local server only.
 68 | export nfsDefaultStorageClass=false
 69 | 
 70 | export smbInstallServer=true
 71 | export smbServer=$HOSTNAME
 72 | export smbSharePath="/shares/smb"                           # Local server only.
 73 | export smbShareName="persistentvolumes"
 74 | export smbUsername=$SUDO_USER
 75 | export smbPassword="password"
 76 | export smbDefaultStorageClass=true                          # Only one storage class should be set as default.
 77 | 
 78 | # ------------------------------
 79 | # Parameters
 80 | # ------------------------------
 81 | #
 82 | while [[ $# -gt 0 ]]; do
 83 |     key="$1"
 84 |     case $key in
 85 |         --configure-tcpip) configureTCPIPSetting="$2"; shift; shift;;
 86 |         --interface) interface="$2"; shift; shift;;
 87 |         --ip-address) ipAddress="$2"; shift; shift;;
 88 |         --netmask) netmask="$2"; shift; shift;;
 89 |         --default-gateway) defaultGateway="$2"; shift; shift;;
 90 |         --dns-servers) dnsServers=($2); shift; shift;;
 91 |         --dns-search) dnsSearch=($2); shift; shift;;
 92 |         --k8s-version) k8sVersion="$2"; shift; shift;;
 93 |         --k8s-load-balancer-ip-range) k8sLoadBalancerIPRange="$2"; shift; shift;;
 94 |         --k8s-cni) k8sCNI="$2"; shift; shift;;
 95 |         --k8s-allow-master-node-schedule) k8sAllowMasterNodeSchedule="$2"; shift; shift;;
 96 |         --k8s-kubeadm-options) k8sKubeadmOptions="$2"; shift; shift;;
 97 |         --nfs-install-server) nfsInstallServer="$2"; shift; shift;;
 98 |         --nfs-server) nfsServer="$2"; shift; shift;;
 99 |         --nfs-share-path) nfsSharePath="$2"; shift; shift;;
100 |         --nfs-default-storage-class) nfsDefaultStorageClass="$2"; shift; shift;;
101 |         --smb-install-server) smbInstallServer="$2"; shift; shift;;
102 |         --smb-server) smbServer="$2"; shift; shift;;
103 |         --smb-share-path) smbSharePath="$2"; shift; shift;;
104 |         --smb-share-name) smbShareName="$2"; shift; shift;;
105 |         --smb-username) smbUsername="$2"; shift; shift;;
106 |         --smb-password) smbPassword="$2"; shift; shift;;
107 |         --smb-default-storage-class) smbDefaultStorageClass="$2"; shift; shift;;
108 |         *) echo -e "\e[31mError:\e[0m Parameter \e[35m$key\e[0m is not recognised."; exit 1;;
109 |     esac
110 | done
111 | 
112 | # Perform Validation
113 | # --------------------------------------------------------------------------------------------------------------------------------------------------------
114 | 
115 | export HARDWARE_CHECK_PASS=true
116 | 
117 | export MIN_CPUS=2
118 | export CPU_COUNT=$(grep -c "^processor" /proc/cpuinfo)
119 | if [ $CPU_COUNT -lt $MIN_CPUS ]; then
120 |     echo -e "\e[31mError:\e[0m The system must have at least \e[35m$MIN_CPUS\e[0m CPU's to run Kubernetes. You currently have \e[35m${CPU_COUNT}\e[0m."
121 |     HARDWARE_CHECK_PASS=false
122 | else
123 |     echo -e "\e[32mInfo:\e[0m The system has \e[35m$CPU_COUNT\e[0m CPU's."
124 | fi
125 | 
126 | export MIN_RAM=1700
127 | export RAM_TOTAL=$(awk '/^MemTotal:/{print $2}' /proc/meminfo)
128 | export RAM_MB=$((RAM_TOTAL / 1024))
129 | if [ $RAM_MB -lt $MIN_RAM ]; then
130 |     echo -e "\e[31mError:\e[0m The system must have at least \e[35m${MIN_RAM} MB\e[0m of memory to run Kubernetes. You currently have \e[35m${RAM_MB} MB\e[0m."
131 |     HARDWARE_CHECK_PASS=false
132 | else
133 |     echo -e "\e[32mInfo:\e[0m The system has \e[35m${RAM_MB} MB\e[0m of memory."
134 | fi
135 | 
136 | if [ $HARDWARE_CHECK_PASS == false ]; then
137 |   exit 1
138 | fi
139 | 
140 | export PARAM_CHECK_PASS=true
141 | export PARAM_CHECK_WARN=false
142 | 
143 | # Try and determine IP address if one is not specified
144 | 
145 | if [[ "$configureTCPIPSetting" == false ]]; then
146 |   if [[ -z "$ipAddress" ]]; then
147 |     eth_adapters=$(ip link | grep "state UP" | grep -v "lo:" | awk -F': ' '{print $2}')
148 |     num_eth_adapters=$(echo $eth_adapters | wc -w)
149 |     if [ $num_eth_adapters -eq 1 ]; then
150 |         interface=$(echo $eth_adapters)
151 |         export CIDR=$(ip addr show $eth_adapters | grep -E "inet .* $eth_adapters" | awk '{print $2}')
152 |         ipAddress=$(echo $CIDR | cut -d "/" -f 1)
153 |         echo -e "\e[32mInfo:\e[0m The system has IP address \e[35m$ipAddress\e[0m on interface \e[35m$interface\e[0m. This will be used for the Kubernetes server API advertise IP address."        
154 |     else
155 |         echo -e "\e[31mError:\e[0m This machine has more than one IP address. \e[35m--ip-address\e[0m is required."
156 |         PARAM_CHECK_PASS=false
157 |     fi  
158 |   elif [[ ! -z "$ipAddress" && ! $ipAddress =~ ^([0-9]{1,3}\.){3}[0-9]{1,3}$ ]]; then
159 |     echo -e "\e[31mError:\e[0m \e[35m--ip-address\e[0m value \e[35m$ipAddress\e[0m is not a valid IP address."
160 |     PARAM_CHECK_PASS=false
161 |   fi
162 | fi
163 | 
164 | if [[ ! "$configureTCPIPSetting" =~ ^(true|false)$ ]]; then
165 |   echo -e "\e[31mError:\e[0m \e[35m--configure-tcpip\e[0m must be set to either \e[35mtrue\e[0m or \e[35mfalse\e[0m."
166 |   PARAM_CHECK_PASS=false
167 | fi
168 | 
169 | if [[ ! "$k8sAllowMasterNodeSchedule" =~ ^(true|false)$ ]]; then
170 |   echo -e "\e[31mError:\e[0m \e[35m--k8s-allow-master-node-schedule\e[0m must be set to either \e[35mtrue\e[0m or \e[35mfalse\e[0m."
171 |   PARAM_CHECK_PASS=false
172 | elif [[ "$k8sAllowMasterNodeSchedule" == false ]]; then
173 |   cnischedulewarn=""
174 |   if [ $k8sCNI == "cilium" ]; then cnischedulewarn=" and some Cilium pods"; fi
175 |   echo -e "\e[33mWarning:\e[0m Master (control-plane) node scheduling will not be enabled. This means that non-core pods will not be scheduled until a worker node is added to the cluster. This includes Metal LB$cnischedulewarn which will result in networking issues."
176 |   PARAM_CHECK_WARN=true
177 | fi
178 | 
179 | if [[ ! "$smbInstallServer" =~ ^(true|false)$ ]]; then
180 |   echo -e "\e[31mError:\e[0m \e[35m--configure-tcpip\e[0m must be set to either \e[35mtrue\e[0m or \e[35mfalse\e[0m."
181 |   PARAM_CHECK_PASS=false
182 | fi
183 | 
184 | if [[ "$configureTCPIPSetting" == true ]]; then
185 |   if [[ -z "$interface" ]]; then
186 |     echo -e "\e[31mError:\e[0m \e[35m--interface\e[0m is required when \e[35m--configure-tcpip\e[0m is set to \e[35mtrue\e[0m."
187 |     PARAM_CHECK_PASS=false
188 |   fi
189 |   if [[ -z "$ipAddress" ]]; then
190 |     echo -e "\e[31mError:\e[0m \e[35m--ip-address\e[0m is required when \e[35m--configure-tcpip\e[0m is set to \e[35mtrue\e[0m."
191 |     PARAM_CHECK_PASS=false
192 |   elif [[ ! $ipAddress =~ ^([0-9]{1,3}\.){3}[0-9]{1,3}$ ]]; then
193 |     echo -e "\e[31mError:\e[0m \e[35m--ip-address\e[0m value \e[35m$ipAddress\e[0m is not a valid IP address."
194 |     PARAM_CHECK_PASS=false
195 |   fi
196 |   if [[ -z "$netmask" ]]; then
197 |     echo -e "\e[31mError:\e[0m \e[35m--netmask\e[0m is required when \e[35m--configure-tcpip\e[0m is set to \e[35mtrue\e[0m."
198 |     PARAM_CHECK_PASS=false    
199 |   elif [[ ! "$netmask" =~ ^(255|254|252|248|240|224|192|128|0)\.((255|254|252|248|240|224|192|128|0)\.){2}(255|254|252|248|240|224|192|128|0)$ ]]; then  
200 |     echo -e "\e[31mError:\e[0m \e[35m--netmask\e[0m value \e[35m$netmask\e[0m is not a valid network mask."
201 |     PARAM_CHECK_PASS=false
202 |   fi
203 |   if [[ -z "$defaultGateway" ]]; then
204 |     echo -e "\e[31mError:\e[0m \e[35m--default-gateway\e[0m is required when \e[35m--configure-tcpip\e[0m is set to \e[35mtrue\e[0m."
205 |     PARAM_CHECK_PASS=false
206 |   elif [[ ! $defaultGateway =~ ^([0-9]{1,3}\.){3}[0-9]{1,3}$ ]]; then
207 |     echo -e "\e[31mError:\e[0m \e[35m--default-gateway\e[0m value \e[35m$defaultGateway\e[0m is not a valid IP address."
208 |     PARAM_CHECK_PASS=false
209 |   fi
210 |   if [[ "${#dnsServers[@]}" -gt 3 ]]; then
211 |     echo -e "\e[33mWarning:\e[0m Number of DNS servers should not be greater than 3. Kubernetes may display errors but will continue to work."
212 |     PARAM_CHECK_WARN=true
213 |   fi
214 |   for ip in "${dnsServers[@]}"; do
215 |     if [[ ! $ip =~ ^([0-9]{1,3}\.){3}[0-9]{1,3}$ ]]; then
216 |         echo -e "\e[31mError:\e[0m DNS server \e[35m$ip\e[0m is not a valid IP address."
217 |         PARAM_CHECK_PASS=false
218 |     fi
219 |   done
220 | fi
221 | 
222 | if [[ ! $k8sVersion =~ ^(latest)$|^[0-9]{1,2}\.[0-9]{1,2}$ ]]; then
223 |     echo -e "\e[31mError:\e[0m \e[35m--k8s-version\e[0m value \e[35m$k8sVersion\e[0m is not in the correct format."
224 |     PARAM_CHECK_PASS=false
225 | fi
226 | 
227 | if [[ ! $k8sCNI =~ ^(flannel|cilium|none)$ ]]; then
228 |     echo -e "\e[31mError:\e[0m \e[35m--k8s-cni\e[0m value \e[35m$k8sVersion\e[0m is not valid. Options are: flannel, none."
229 |     PARAM_CHECK_PASS=false
230 | fi
231 | 
232 | if [ $k8sCNI == "none" ]; then
233 |   echo -e "\033[33mWarning:\033[0m You have chosen not to install a CNI. Your master node will not be in a 'ready' state until you install one."
234 |   PARAM_CHECK_WARN=true
235 | fi
236 | 
237 | if [[ -z "$k8sLoadBalancerIPRange" ]]; then
238 |   echo -e "\e[31mError:\e[0m \e[35m--k8s-load-balancer-ip-range\e[0m is required. Must be a valid IP range or CIDR."
239 |   PARAM_CHECK_PASS=false
240 | elif [[ ! "$k8sLoadBalancerIPRange" =~ ^([0-9]{1,3}\.){3}[0-9]{1,3}-([0-9]{1,3}\.){3}[0-9]{1,3}$|^([0-9]{1,3}\.){3}[0-9]{1,3}/[0-9]+$ ]]; then
241 |   echo -e "\e[31mError:\e[0m \e[35m--k8s-load-balancer-ip-range\e[0m range must be a valid IP range or CIDR."
242 |   PARAM_CHECK_PASS=false
243 | fi
244 | 
245 | if [[ ! "$nfsInstallServer" =~ ^(true|false)$ ]]; then
246 |   echo -e "\e[31mError:\e[0m \e[35m--nfs-install-server\e[0m must be set to either \e[35mtrue\e[0m or \e[35mfalse\e[0m."
247 |   PARAM_CHECK_PASS=false
248 | elif [[ "$nfsInstallServer" = true ]]; then
249 |   if [[ -z "$nfsSharePath" ]]; then
250 |     echo -e "\e[31mError:\e[0m \e[35m--nfs-share-path\e[0m is required if \e[35m--nfs-install-server\e[0m is set to \e[35mtrue\e[0m."
251 |     PARAM_CHECK_PASS=false  
252 |   elif [[ ! "$nfsSharePath" =~ ^\/(.+\/)*[^\/]+$ ]]; then  
253 |     echo -e "\e[31mError:\e[0m \e[35m--nfs-share-path\e[0m value \e[35m$nfsSharePath\e[0m is not a valid path."
254 |     PARAM_CHECK_PASS=false
255 |   fi
256 |   if [[ -z "$nfsServer" ]]; then
257 |     echo -e "\e[31mError:\e[0m \e[35m--nfs-server\e[0m is required if \e[35m--nfs-install-server\e[0m is set to \e[35mtrue\e[0m."
258 |     PARAM_CHECK_PASS=false  
259 |   fi
260 |   if [[ ! "$nfsDefaultStorageClass" =~ ^(true|false)$ ]]; then
261 |     echo -e "\e[31mError:\e[0m \e[35m--nfs-default-storage-class\e[0m must be set to either \e[35mtrue\e[0m or \e[35mfalse\e[0m."
262 |     PARAM_CHECK_PASS=false
263 |   fi
264 | fi
265 | 
266 | if [[ -n "$nfsServer" && ! $nfsServer =~ ^[a-zA-Z0-9][a-zA-Z0-9.-]*[a-zA-Z0-9]$ ]]; then
267 |   echo -e "\e[31mError:\e[0m \e[35m--nfs-server\e[0m value \e[35m$smbServer\e[0m is not a valid hostname."
268 |   PARAM_CHECK_PASS=false
269 | fi
270 | 
271 | if [[ ! "$smbInstallServer" =~ ^(true|false)$ ]]; then
272 |   echo -e "\e[31mError:\e[0m \e[35m--smb-install-server\e[0m must be set to either \e[35mtrue\e[0m or \e[35mfalse\e[0m."
273 |   PARAM_CHECK_PASS=false
274 | elif [[ "$smbInstallServer" = true ]]; then
275 |   if [[ -z "$smbSharePath" ]]; then
276 |     echo -e "\e[31mError:\e[0m \e[35m--smb-share-path\e[0m is required if \e[35m--smb-install-server\e[0m is set to \e[35mtrue\e[0m."
277 |     PARAM_CHECK_PASS=false  
278 |   elif [[ ! "$smbSharePath" =~ ^\/(.+\/)*[^\/]+$ ]]; then
279 |     echo -e "\e[31mError:\e[0m \e[35m--smb-share-path\e[0m value \e[35m$smbSharePath\e[0m is not a valid path."
280 |     PARAM_CHECK_PASS=false
281 |   fi
282 |   if [[ -z "$smbShareName" ]]; then
283 |     echo -e "\e[31mError:\e[0m \e[35m--smb-share-name\e[0m is required if \e[35m--smb-install-server\e[0m is set to \e[35mtrue\e[0m."
284 |     PARAM_CHECK_PASS=false
285 |   elif [[ ! "$smbShareName" =~ ^[a-zA-Z0-9_\$\.\-]+$ ]]; then
286 |     echo -e "\e[31mError:\e[0m \e[35m--smb-share-name\e[0m value \e[35m$smbShareName\e[0m is not a SMB share name."
287 |     PARAM_CHECK_PASS=false
288 |   fi
289 |   if [[ -z "$smbServer" ]]; then
290 |     echo -e "\e[31mError:\e[0m \e[35m--smb-server\e[0m is required if \e[35m--smb-install-server\e[0m is set to \e[35mtrue\e[0m."
291 |     PARAM_CHECK_PASS=false  
292 |   fi
293 |   if [[ ! "$smbDefaultStorageClass" =~ ^(true|false)$ ]]; then
294 |     echo -e "\e[31mError:\e[0m \e[35m--smb-default-storage-class\e[0m must be set to either \e[35mtrue\e[0m or \e[35mfalse\e[0m."
295 |     PARAM_CHECK_PASS=false
296 |   fi
297 | fi
298 | 
299 | if [[ -n "$smbServer" && ! $smbServer =~ ^[a-zA-Z0-9][a-zA-Z0-9.-]*[a-zA-Z0-9]$ ]]; then
300 |   echo -e "\e[31mError:\e[0m \e[35m--smb-server\e[0m value \e[35m$smbServer\e[0m is not a valid hostname."
301 |   PARAM_CHECK_PASS=false
302 | fi
303 | 
304 | if [[ "$nfsDefaultStorageClass" = true && "$smbDefaultStorageClass" = true ]]; then
305 |   echo -e "\e[31mError:\e[0m \e[35m--smb-default-storage-class\e[0m and \e[35m--nfs-default-storage-class\e[0m cannot both be set to true at the same time.\e[0m"
306 | fi
307 | 
308 | if [ $PARAM_CHECK_PASS == false ]; then
309 |   exit 1
310 | fi
311 | 
312 | if [ $PARAM_CHECK_WARN == true ]; then
313 |   sleep 10
314 | fi
315 | 
316 | # Install Kubernetes
317 | # --------------------------------------------------------------------------------------------------------------------------------------------------------
318 | 
319 | # Prevent interactive needsrestart command
320 | 
321 | export NEEDSRESART_CONF="/etc/needrestart/needrestart.conf"
322 | 
323 | if [ -f $NEEDSRESART_CONF ]; then 
324 |   echo -e "\033[32mDisabling needsrestart interactive mode\033[0m"  
325 |   sed -i "/#\$nrconf{restart} = 'i';/s/.*/\$nrconf{restart} = 'a';/" $NEEDSRESART_CONF
326 | fi
327 | 
328 | # Configure IP Settings
329 | 
330 | if [ "$configureTCPIPSetting" == true ]; then
331 | 
332 |   echo -e "\033[32mConfiguring Network Settings\033[0m"
333 | 
334 |   IFS=. read -r i1 i2 i3 i4 <<< "$ipAddress"
335 |   IFS=. read -r m1 m2 m3 m4 <<< "$netmask"
336 | 
337 |   maskDec=$(( (m1 * 16777216) + (m2 * 65536) + (m3 * 256) + m4 ))
338 |   maskBin=$(echo "obase=2; $maskDec" | bc)
339 |   cidr=$(echo "$maskBin" | tr -d '\n' | sed 's/0*$//' | wc -c)
340 | 
341 |   cat <<EOF | tee /etc/netplan/01-netcfg.yaml > /dev/null
342 | network:
343 |   version: 2
344 |   ethernets:
345 |     $interface:
346 |       dhcp4: false
347 |       dhcp6: false
348 |       addresses: [$ipAddress/$cidr]
349 |       routes:
350 |       - to: default
351 |         via: $defaultGateway
352 |       nameservers:
353 |         search: [$(echo "${dnsSearch[@]}" | tr ' ' ',')]
354 |         addresses: [$(echo "${dnsServers[@]}" | tr ' ' ',')]
355 | EOF
356 | 
357 |   netplan apply
358 | fi
359 | 
360 | # Install Prerequsite Packages
361 | 
362 | echo -e "\033[32mInstalling prerequisites\033[0m"
363 | 
364 | sleep 1 # Sleep for a second in case of file locks
365 | 
366 | apt-get update -qq
367 | apt-get install -qqy apt-transport-https ca-certificates curl software-properties-common gzip gnupg lsb-release
368 | 
369 | # Add Docker Repository https://docs.docker.com/engine/install/ubuntu/
370 | 
371 | export KEYRINGS_DIR="/etc/apt/keyrings"
372 | 
373 | if [ ! -d $KEYRINGS_DIR ]; then
374 |   mkdir -m 0755 -p $KEYRINGS_DIR
375 | fi
376 | 
377 | if [ ! -f /etc/apt/sources.list.d/docker.list ]; then
378 |   echo -e "\033[32mAdding Docker repository\033[0m"
379 |   curl -fsSL https://download.docker.com/linux/ubuntu/gpg | gpg --dearmor -o $KEYRINGS_DIR/docker.gpg
380 |   echo "deb [arch=$(dpkg --print-architecture) signed-by=$KEYRINGS_DIR/docker.gpg] https://download.docker.com/linux/ubuntu \
381 |     $(lsb_release -cs) stable" | tee /etc/apt/sources.list.d/docker.list > /dev/null
382 | fi
383 | 
384 | # Install Docker https://docs.docker.com/engine/install/ubuntu/
385 | 
386 | echo -e "\033[32mInstalling Docker\033[0m"
387 | 
388 | sleep 1 # Sleep for a second in case of file locks
389 | 
390 | apt-get update -qq
391 | apt-get install -qqy docker-ce docker-ce-cli
392 | 
393 | tee /etc/docker/daemon.json >/dev/null <<EOF
394 | {
395 |   "exec-opts": ["native.cgroupdriver=systemd"],
396 |   "log-driver": "json-file",
397 |   "log-opts": {
398 |     "max-size": "100m"
399 |   },
400 |   "storage-driver": "overlay2"
401 | }
402 | EOF
403 | 
404 | mkdir -p /etc/systemd/system/docker.service.d
405 | 
406 | # Replace default config file to enable CRI plugin and SystemdCgroup
407 | # https://kubernetes.io/docs/setup/production-environment/container-runtimes/#containerd-systemd
408 | tee /etc/containerd/config.toml >/dev/null <<EOF
409 | version = 2
410 | 
411 | [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc]
412 | runtime_type = "io.containerd.runc.v2"
413 | 
414 | [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc.options]
415 | SystemdCgroup = true
416 | EOF
417 | 
418 | systemctl daemon-reload
419 | systemctl restart docker
420 | systemctl restart containerd
421 | 
422 | # Install Kubernetes https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/
423 | 
424 | echo -e "\033[32mInstalling Kubernetes\033[0m"
425 | 
426 | # Discover latest kubernetes version
427 | 
428 | export K8S_LATEST_VERSION=$(curl -s https://api.github.com/repos/kubernetes/kubernetes/releases/latest | grep tag_name | cut -d '"' -f4 | sed 's/^v//')
429 | 
430 | if [ $k8sVersion == "latest" ]; then
431 |   k8sVersion=$K8S_LATEST_VERSION
432 |   echo "Detected latest Kubernetes version: $k8sVersion"
433 | fi
434 | 
435 | export K8S_REPO_VERSION="v$(echo "$k8sVersion" | cut -d. -f1,2)"
436 | 
437 | echo "Using APT repo: $K8S_REPO_VERSION"
438 | 
439 | # Add Kubernetes Respository
440 | 
441 | if [ -f /etc/apt/sources.list.d/kubernetes.list ]; then
442 |   rm $KEYRINGS_DIR/kubernetes-apt-keyring.gpg
443 |   rm /etc/apt/sources.list.d/kubernetes.list
444 | fi
445 | 
446 | echo -e "\033[32mAdding Kubernetes community repository\033[0m"
447 | curl -fsSL https://pkgs.k8s.io/core:/stable:/$K8S_REPO_VERSION/deb/Release.key | gpg --dearmor -o $KEYRINGS_DIR/kubernetes-apt-keyring.gpg    
448 | echo "deb [signed-by=$KEYRINGS_DIR/kubernetes-apt-keyring.gpg] https://pkgs.k8s.io/core:/stable:/$K8S_REPO_VERSION/deb/ /" | tee /etc/apt/sources.list.d/kubernetes.list
449 | 
450 | sleep 1 # Sleep for a second in case of file locks
451 | 
452 | apt-get update -qq
453 | apt-get install -qqy kubelet kubeadm kubectl
454 | 
455 | # Configuring Prerequisite
456 | 
457 | echo -e "\033[32mEnable IPv4 packet forwarding\033[0m"
458 | 
459 | cat <<EOF | tee /etc/modules-load.d/k8s.conf
460 | overlay
461 | br_netfilter
462 | EOF
463 | 
464 | modprobe overlay
465 | modprobe br_netfilter
466 | 
467 | # Some of this config was required for older versions of Kubernetes.
468 | # See here: https://v1-28.docs.kubernetes.io/docs/setup/production-environment/container-runtimes/
469 | 
470 | cat <<EOF | tee /etc/sysctl.d/k8s.conf
471 | net.bridge.bridge-nf-call-iptables  = 1
472 | net.bridge.bridge-nf-call-ip6tables = 1
473 | net.ipv4.ip_forward                 = 1
474 | EOF
475 | 
476 | sysctl --system
477 | 
478 | # Disabling Swap
479 | 
480 | echo -e "\033[32mDisabling Swapping\033[0m"
481 | 
482 | if grep -v '^#' /etc/fstab | grep -q swap; then
483 |   export BACKUP_FSTAB="/etc/fstab.backup.$(date +%s)"
484 | 
485 |   cp /etc/fstab $BACKUP_FSTAB
486 |   sed -i '/swap/ s/^/#/' /etc/fstab
487 |   swapoff -a
488 | 
489 |   echo "The file /etc/fstab has been backed-up to $BACKUP_FSTAB"
490 |   echo "Swap is now disabled"
491 | else
492 |   echo "Swap is already disabled"
493 | fi
494 | 
495 | # Init Kubernetes https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm-init/
496 | 
497 | echo -e "\033[32mInitilizing Kubernetes\033[0m"
498 | 
499 | kubeadm init --apiserver-advertise-address=$ipAddress --pod-network-cidr=10.244.0.0/16 $k8sKubeadmOptions
500 | 
501 | # Setup kube config files.
502 | 
503 | echo -e "\033[32mSetting up kubectl config files\033[0m"
504 | 
505 | # Setup root user kubectl config file
506 | mkdir -p $HOME/.kube
507 | cp -f /etc/kubernetes/admin.conf $HOME/.kube/config
508 | chown $(id -u):$(id -g) $HOME/.kube/config
509 | 
510 | # Setup your user kubectl config file
511 | mkdir -p /home/$SUDO_USER/.kube
512 | cp -f /etc/kubernetes/admin.conf /home/$SUDO_USER/.kube/config 
513 | chown $SUDO_USER /home/$SUDO_USER/.kube/config
514 | 
515 | # Remove control-plane node taints
516 | 
517 | if [ $k8sAllowMasterNodeSchedule == true ]; then
518 |   echo -e "\033[32mRemoving NoSchedule taints\033[0m"
519 | 
520 |   kubectl taint node $HOSTNAME node-role.kubernetes.io/control-plane:NoSchedule- || true
521 |   kubectl taint node $HOSTNAME node-role.kubernetes.io/master:NoSchedule- || true # for older versions
522 | fi
523 | 
524 | # Install a CNI
525 | 
526 | if [ $k8sCNI == "flannel" ]; then
527 |   # Flannel https://github.com/flannel-io/flannel/#readme
528 | 
529 |   echo -e "\033[32mInstalling CNI: Flannel\033[0m"
530 | 
531 |   sysctl net.bridge.bridge-nf-call-iptables=1
532 |   sysctl -p
533 |   kubectl apply -f https://github.com/flannel-io/flannel/releases/latest/download/kube-flannel.yml --wait --timeout=2m
534 | 
535 | elif [ $k8sCNI == "cilium" ]; then
536 |   # Cilium https://docs.cilium.io/en/stable/gettingstarted/k8s-install-default/
537 | 
538 |   echo -e "\033[32mInstalling CNI: Cilium\033[0m"
539 | 
540 |   # Install Cilium CLI
541 | 
542 |   if [ ! -f /usr/local/bin/cilium ]; then  
543 |     CILIUM_CLI_VERSION=$(curl -s https://raw.githubusercontent.com/cilium/cilium-cli/main/stable.txt)
544 |     CLI_ARCH=amd64
545 |     if [ "$(uname -m)" = "aarch64" ]; then CLI_ARCH=arm64; fi
546 |     curl -L --fail --remote-name-all https://github.com/cilium/cilium-cli/releases/download/${CILIUM_CLI_VERSION}/cilium-linux-${CLI_ARCH}.tar.gz{,.sha256sum}
547 |     sha256sum --check cilium-linux-${CLI_ARCH}.tar.gz.sha256sum
548 |     sudo tar xzvfC cilium-linux-${CLI_ARCH}.tar.gz /usr/local/bin
549 |     rm cilium-linux-${CLI_ARCH}.tar.gz{,.sha256sum}
550 |   fi
551 | 
552 |   # Install Hubble Client
553 | 
554 |   if [ ! -f /usr/local/bin/hubble ]; then
555 |     HUBBLE_VERSION=$(curl -s https://raw.githubusercontent.com/cilium/hubble/master/stable.txt)
556 |     HUBBLE_ARCH=amd64
557 |     if [ "$(uname -m)" = "aarch64" ]; then HUBBLE_ARCH=arm64; fi
558 |     curl -L --fail --remote-name-all https://github.com/cilium/hubble/releases/download/$HUBBLE_VERSION/hubble-linux-${HUBBLE_ARCH}.tar.gz{,.sha256sum}
559 |     sha256sum --check hubble-linux-${HUBBLE_ARCH}.tar.gz.sha256sum
560 |     sudo tar xzvfC hubble-linux-${HUBBLE_ARCH}.tar.gz /usr/local/bin
561 |     rm hubble-linux-${HUBBLE_ARCH}.tar.gz{,.sha256sum}
562 |   fi
563 | 
564 |   # Install Cilium
565 | 
566 |   cilium install || true
567 | 
568 |   # Enable Hubble & Hubble UI
569 | 
570 |   if ! kubectl get deployment -n kube-system hubble-relay &> /dev/null; then
571 |     echo -e "\033[32mEnabling Hubble\033[0m"
572 |     cilium hubble enable
573 |   fi
574 | 
575 |   if ! kubectl get deployment -n kube-system hubble-ui &> /dev/null; then
576 |     echo -e "\033[32mEnabling Hubble UI\033[0m"
577 |     cilium hubble enable --ui
578 |   fi
579 | 
580 |   # Get Cilium status (Not all pods start up unless taint is removed)
581 |   
582 |   if [ $k8sAllowMasterNodeSchedule == true ]; then
583 |     cilium status --wait 
584 |   else
585 |     cilium status
586 |   fi
587 | fi
588 | 
589 | # Install Helm
590 | 
591 | echo -e "\033[32mInstalling Helm\033[0m"
592 | 
593 | curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash
594 | 
595 | # Install NFS Server and/or CSI and Storage Classes https://github.com/kubernetes-csi/csi-driver-nfs
596 | 
597 | export INSTALL_NFS_DRIVER=false # Do not edit. Will be set to true if required
598 | 
599 | if [ $nfsInstallServer == true ]; then
600 |   echo -e "\033[32mInstall NFS File Server\033[0m"
601 | 
602 |   apt install -qqy nfs-kernel-server
603 |   export NFS_CONFIG_FILE="/etc/exports"  
604 |   if ! grep -q "$nfsSharePath" "$NFS_CONFIG_FILE"; then
605 |     mkdir -p $nfsSharePath
606 |     chown -R nobody:nogroup $nfsSharePath
607 |     cat << EOF >> $NFS_CONFIG_FILE
608 | $nfsSharePath    *(rw,sync,no_subtree_check)
609 | EOF
610 |     systemctl restart nfs-kernel-server
611 |     showmount -e
612 |     export INSTALL_NFS_DRIVER=true
613 |   fi
614 | elif [ "$nfsServer" != "$HOSTNAME" ]; then
615 |   echo -e "\033[32mCreating NFS storge class for server $nfsServer \033[0m"
616 |   export INSTALL_NFS_DRIVER=true
617 | fi
618 | 
619 | # Define annotations for CSI drivers based on CNI choice
620 | 
621 | export CSI_CNI_ANNOTATIONS=""
622 | 
623 | if [ $k8sCNI == "cilium" ]; then
624 |   CSI_CNI_ANNOTATIONS="--set controller.podAnnotations.\"cilium\.io/unmanaged\"=\"true\" --set node.podAnnotations.\"cilium\.io/unmanaged\"=\"true\""
625 | fi
626 | 
627 | # NFS CSI Driver https://github.com/kubernetes-csi/csi-driver-nfs/tree/master/charts
628 | 
629 | if [ $INSTALL_NFS_DRIVER == true ]; then
630 |   echo -e "\033[32mInstall NFS CSI driver Helm chart\033[0m"
631 | 
632 |   export NFS_SERVER_NAME_SAFE=$(echo "$nfsServer" | tr '.' '-')
633 |   export NFS_NAME_SPACE="kube-system"    
634 |   export NFS_STORAGE_CLASS_FILE="nfsStorageClass.yaml"
635 |   helm repo add csi-driver-nfs https://raw.githubusercontent.com/kubernetes-csi/csi-driver-nfs/master/charts
636 |   helm install csi-driver-nfs csi-driver-nfs/csi-driver-nfs --namespace $NFS_NAME_SPACE $CSI_CNI_ANNOTATIONS
637 |    
638 |   # See this page for all available parameters https://github.com/kubernetes-csi/csi-driver-nfs/blob/master/docs/driver-parameters.md
639 |   cat <<EOF > $NFS_STORAGE_CLASS_FILE
640 | apiVersion: storage.k8s.io/v1
641 | kind: StorageClass
642 | metadata:
643 |   name: nfs-$NFS_SERVER_NAME_SAFE
644 |   annotations:
645 |     storageclass.kubernetes.io/is-default-class: "$nfsDefaultStorageClass"
646 | provisioner: nfs.csi.k8s.io
647 | parameters:
648 |   server: $nfsServer
649 |   share: $nfsSharePath
650 | reclaimPolicy: Retain
651 | volumeBindingMode: Immediate
652 | mountOptions:
653 |   - nfsvers=4.1
654 | EOF
655 |   kubectl apply -f $NFS_STORAGE_CLASS_FILE -n $NFS_NAME_SPACE
656 |   rm $NFS_STORAGE_CLASS_FILE
657 | fi
658 | 
659 | # Install SMB Server and/or CSI and Storage Classes https://ubuntu.com/tutorials/install-and-configure-samba#2-installing-samba
660 | 
661 | export INSTALL_SMB_DRIVER=false # Do not edit. Will be set to true if required
662 | 
663 | if [ $smbInstallServer == true ]; then
664 |   echo -e "\033[32mInstall SMB File Server\033[0m"
665 | 
666 |   apt install -qqy samba
667 |   export SMB_CONFIG_FILE="/etc/samba/smb.conf"  
668 |   if ! grep -q "$smbShareName" "$SMB_CONFIG_FILE"; then
669 |     mkdir -p $smbSharePath
670 |     chown -R $smbUsername:$smbUsername $smbSharePath
671 |     cat << EOF >> $SMB_CONFIG_FILE
672 | [$smbShareName]
673 |     comment = SMB Share for Kubernetes PVC's
674 |     path = $smbSharePath
675 |     read only = no
676 |     browsable = yes
677 | EOF
678 |     (echo "$smbPassword"; echo "$smbPassword") | smbpasswd -s -a "$smbUsername"  
679 |     service smbd restart
680 |     export INSTALL_SMB_DRIVER=true
681 |   fi
682 | elif [ "$smbServer" != "$HOSTNAME" ]; then
683 |   echo -e "\033[32mCreating SMB storge class for server $nfsServer \033[0m"
684 |   export INSTALL_SMB_DRIVER=true
685 | fi
686 | 
687 | # SMB CSI Driver https://github.com/kubernetes-csi/csi-driver-smb/tree/master/charts
688 | 
689 | if [ $INSTALL_SMB_DRIVER == true ]; then
690 |   echo -e "\033[32mInstall SMB CSI driver Helm chart\033[0m"
691 | 
692 |   export SMB_SERVER_NAME_SAFE=$(echo "$smbServer" | tr '.' '-')
693 |   export SMB_NAME_SPACE="kube-system"
694 |   export SMB_SECRET_NAME="smb-credentials-$SMB_SERVER_NAME_SAFE"  
695 |   export SMB_STORAGE_CLASS_FILE="smbStorageClass.yaml"
696 |   helm repo add csi-driver-smb https://raw.githubusercontent.com/kubernetes-csi/csi-driver-smb/master/charts
697 |   helm install csi-driver-smb csi-driver-smb/csi-driver-smb --namespace $SMB_NAME_SPACE --set controller.runOnControlPlane=true $CSI_CNI_ANNOTATIONS
698 |   kubectl create secret generic $SMB_SECRET_NAME --from-literal username="$smbUsername" --from-literal password="$smbPassword" -n $SMB_NAME_SPACE
699 | 
700 |   # See this page for all available parameters https://github.com/kubernetes-csi/csi-driver-smb/blob/master/docs/driver-parameters.md
701 |   cat <<EOF > $SMB_STORAGE_CLASS_FILE
702 | apiVersion: storage.k8s.io/v1
703 | kind: StorageClass
704 | metadata:
705 |   name: smb-$SMB_SERVER_NAME_SAFE
706 |   annotations:
707 |     storageclass.kubernetes.io/is-default-class: "$smbDefaultStorageClass"
708 | provisioner: smb.csi.k8s.io
709 | parameters:
710 |   source: "//$smbServer/$smbShareName"
711 |   csi.storage.k8s.io/node-stage-secret-name: $SMB_SECRET_NAME
712 |   csi.storage.k8s.io/node-stage-secret-namespace: $SMB_NAME_SPACE
713 |   csi.storage.k8s.io/provisioner-secret-name: $SMB_SECRET_NAME
714 |   csi.storage.k8s.io/provisioner-secret-namespace: $SMB_NAME_SPACE
715 | reclaimPolicy: Retain      # only Retain is supported
716 | volumeBindingMode: Immediate
717 | mountOptions:
718 |   - dir_mode=0777
719 |   - file_mode=0777
720 |   - uid=1001
721 |   - gid=1001
722 | EOF
723 |   kubectl apply -f $SMB_STORAGE_CLASS_FILE -n $SMB_NAME_SPACE
724 |   rm $SMB_STORAGE_CLASS_FILE
725 | fi
726 | 
727 | # Install MetalLB https://metallb.universe.tf/installation/
728 | 
729 | if [[ $k8sAllowMasterNodeSchedule == true && $k8sCNI != "none" ]]; then
730 |   echo -e "\033[32mInstall and Configure MetalLB\033[0m"
731 | 
732 |   kubectl create namespace metallb-system || true
733 |   helm repo add metallb https://metallb.github.io/metallb
734 |   helm repo update
735 |   helm upgrade -i metallb metallb/metallb -n metallb-system --wait
736 | 
737 |   # https://metallb.universe.tf/configuration/_advanced_l2_configuration/
738 |   export METALLB_IPPOOL_L2AD="metallb-ippool-l2ad.yaml" 
739 |   cat <<EOF > $METALLB_IPPOOL_L2AD
740 | apiVersion: metallb.io/v1beta1
741 | kind: IPAddressPool
742 | metadata:
743 |   name: local-lan-pool
744 |   namespace: metallb-system
745 | spec:
746 |   addresses:
747 |   - $k8sLoadBalancerIPRange
748 | ---
749 | apiVersion: metallb.io/v1beta1
750 | kind: L2Advertisement
751 | metadata:
752 |   name: l2-advert
753 |   namespace: metallb-system
754 | EOF
755 | 
756 |   kubectl apply -f $METALLB_IPPOOL_L2AD -n metallb-system
757 |   rm $METALLB_IPPOOL_L2AD
758 | else
759 |   echo -e "\033[33mSkipping Metal LB step. You will need to run this manually once you've added another node in order to access your pods from your local network.\033[0m"
760 | fi
761 | 
762 | # Install Metrics Server
763 | 
764 | echo -e "\033[32mInstall Metrics Server\033[0m"
765 | 
766 | helm repo add metrics-server https://kubernetes-sigs.github.io/metrics-server/
767 | helm upgrade --install metrics-server metrics-server/metrics-server -n kube-system --set args={--kubelet-insecure-tls} --wait
768 | 
769 | # Print success message and tips
770 | 
771 | export JOIN_COMMAND_OUTPUT=$(kubeadm token create --print-join-command)
772 | read -ra JOIN_WORDS <<< "$JOIN_COMMAND_OUTPUT"
773 | 
774 | export JOIN_IP=$(echo ${JOIN_WORDS[2]} | cut -d: -f1)
775 | export JOIN_PORT=$(echo ${JOIN_WORDS[2]} | cut -d: -f2)
776 | export JOIN_TOKEN="${JOIN_WORDS[4]}"
777 | export JOIN_CERT_HASH="${JOIN_WORDS[6]}"
778 | 
779 | echo -e "\033[32m\nInstallation Complete!\n\033[0m"
780 | echo -e "\033[36mRun \033[0m\033[35mkubectl get nodes\033[0m\033[36m to test your connection to your master node.\033[0m"
781 | echo -e "\033[36mRun \033[0m\033[35mcat ~/.kube/config\033[0m\033[36m to get the kube config. You can use this on your workstation with kubectl or Lens to manager your new cluster.\033[0m"
782 | echo -e "\033[36mRun \033[0m\033[35mkubeadm token create --print-join-command\033[0m\033[36m to print the node join command for your cluster. \033[0m"
783 | echo -e "\033[36m\nThe Kubernetes node join command is:\n\033[0m\033[35m$JOIN_COMMAND_OUTPUT\033[0m"
784 | echo -e "\033[36m\nThe Autok8s node join command which uses the setup_worker_node.sh script is:\033[0m\033[35m"
785 | echo -e "curl -s https://raw.githubusercontent.com/7wingfly/autok8s/main/setup_worker_node.sh | sudo bash -s -- \\
786 |     --k8s-master-ip $JOIN_IP \\
787 |     --k8s-master-port $JOIN_PORT \\
788 |     --token $JOIN_TOKEN \\
789 |     --discovery-token-ca-cert-hash $JOIN_CERT_HASH\n"
790 | 


--------------------------------------------------------------------------------
/setup_worker_node.sh:
--------------------------------------------------------------------------------
  1 | #!/bin/bash
  2 | set -euo pipefail
  3 | 
  4 | echo -e '\e[35m      _         _       \e[36m _    ___       \e[0m'
  5 | echo -e '\e[35m     / \  _   _| |_ ___ \e[36m| | _( _ ) ___  \e[0m'
  6 | echo -e '\e[35m    / ▲ \| | | | __/   \\\e[36m| |/ /   \/ __| \e[0m'
  7 | echo -e '\e[35m   / ___ \ |_| | ||  ●  \e[36m|   <  ♥  \__ \ \e[0m'
  8 | echo -e '\e[35m  /_/   \_\__,_|\__\___/\e[36m|_|\_\___/|___/ \e[0m'
  9 | echo -e '\e[35m                Version:\e[36m 1.3.0\e[0m\n'
 10 | echo -e '\e[35m  Kubernetes Installation Script:\e[36m Worker Node Edition\e[0m\n'
 11 | 
 12 | # Check sudo & keep sudo running
 13 | # --------------------------------------------------------------------------------------------------------------------------------------------------------
 14 | 
 15 | if [ "$(id -u)" -ne 0 ]
 16 | then
 17 |   echo -e "\033[31mYou must run this script as root\033[0m"
 18 |   exit
 19 | fi
 20 | 
 21 | sudo -v
 22 | while true; do  
 23 |   sudo -nv; sleep 1m
 24 |   kill -0 $$ 2>/dev/null || exit
 25 | done &
 26 | 
 27 | # Define Variables, Default Values & Parameters 
 28 | # --------------------------------------------------------------------------------------------------------------------------------------------------------
 29 | 
 30 | # ------------------------------
 31 | # Host TCP/IP Settings
 32 | # ------------------------------
 33 | # These options configure the TCP/IP settings of this server. These options have been added for your convenience however, you may not want to
 34 | # do this if your settings are already configured. You will still need to specify this machines IP address though as it will be required by 
 35 | # other parts of the script.
 36 | #
 37 | # WARNING: If this is enabled and the IP address will be changed, make sure you are not running this script from a remote shell.
 38 | # 
 39 | export configureTCPIPSetting=false
 40 | export interface="eth0"                                     # Find with 'ip addr'
 41 | export ipAddress=""
 42 | export netmask=""
 43 | export defaultGateway=""
 44 | export dnsServers=("8.8.8.8" "4.4.4.4")                     # Don't specify more than 3. K8s will only use the first three and throw errors.
 45 | export dnsSearch=("domain.local")                           # Your local DNS search domain if you have one.
 46 | 
 47 | # ------------------------------
 48 | # Kubernetes
 49 | # ------------------------------
 50 | #
 51 | export k8sVersion="latest"
 52 | export k8sMasterIP=""
 53 | export k8sMasterPort="6443"
 54 | export k8sToken=""                                          # This and the cert hash can be found by running 'kubeadm token create --print-join-command'
 55 | export k8sTokenDiscoveryCaCertHash=""                       # on the master node
 56 | export k8sKubeadmOptions=""                                   # Additional options you can pass into the kubeadm join command.
 57 | 
 58 | # ------------------------------
 59 | # Parameters
 60 | # ------------------------------
 61 | #
 62 | while [[ $# -gt 0 ]]; do
 63 |     key="$1"
 64 |     case $key in
 65 |         --configure-tcpip) configureTCPIPSetting="$2"; shift; shift;;
 66 |         --interface) interface="$2"; shift; shift;;
 67 |         --ip-address) ipAddress="$2"; shift; shift;;
 68 |         --netmask) netmask="$2"; shift; shift;;
 69 |         --default-gateway) defaultGateway="$2"; shift; shift;;
 70 |         --dns-servers) dnsServers=($2); shift; shift;;
 71 |         --dns-search) dnsSearch=($2); shift; shift;;
 72 |         --k8s-version) k8sVersion="$2"; shift; shift;;
 73 |         --k8s-master-ip) k8sMasterIP="$2"; shift; shift;;
 74 |         --k8s-master-port) k8sMasterPort="$2"; shift; shift;;
 75 |         --k8s-kubeadm-options) k8sKubeadmOptions="$2"; shift; shift;;
 76 |         --token) k8sToken="$2"; shift; shift;;
 77 |         --discovery-token-ca-cert-hash) k8sTokenDiscoveryCaCertHash="$2"; shift; shift;;
 78 |         *) echo -e "\e[31mError:\e[0m Parameter \e[35m$key\e[0m is not recognised."; exit 1;;
 79 |     esac
 80 | done
 81 | 
 82 | # Perform Validation
 83 | # --------------------------------------------------------------------------------------------------------------------------------------------------------
 84 | 
 85 | export HARDWARE_CHECK_PASS=true
 86 | export PARAM_CHECK_WARN=false
 87 | 
 88 | export MIN_CPUS=2
 89 | export CPU_COUNT=$(grep -c "^processor" /proc/cpuinfo)
 90 | if [ $CPU_COUNT -lt $MIN_CPUS ]; then
 91 |     echo -e "\e[31mError:\e[0m The system must have at least \e[35m$MIN_CPUS\e[0m CPU's to run Kubernetes. You currently have \e[35m${CPU_COUNT}\e[0m."
 92 |     HARDWARE_CHECK_PASS=false
 93 | else
 94 |     echo -e "\e[32mInfo:\e[0m The system has \e[35m$CPU_COUNT\e[0m CPU's."
 95 | fi
 96 | 
 97 | export MIN_RAM=1700
 98 | export RAM_TOTAL=$(awk '/^MemTotal:/{print $2}' /proc/meminfo)
 99 | export RAM_MB=$((RAM_TOTAL / 1024))
100 | if [ $RAM_MB -lt $MIN_RAM ]; then
101 |     echo -e "\e[31mError:\e[0m The system must have at least \e[35m${MIN_RAM} MB\e[0m of memory to run Kubernetes. You currently have \e[35m${RAM_MB} MB\e[0m."
102 |     HARDWARE_CHECK_PASS=false
103 | else
104 |     echo -e "\e[32mInfo:\e[0m The system has \e[35m${RAM_MB} MB\e[0m of memory."
105 | fi
106 | 
107 | if [ $HARDWARE_CHECK_PASS == false ]; then
108 |   exit 1
109 | fi
110 | 
111 | export PARAM_CHECK_PASS=true
112 | 
113 | if [[ ! "$configureTCPIPSetting" =~ ^(true|false)$ ]]; then
114 |   echo -e "\e[31mError:\e[0m \e[35m--configure-tcpip\e[0m must be set to either \e[35mtrue\e[0m or \e[35mfalse\e[0m."
115 |   PARAM_CHECK_PASS=false
116 | fi
117 | 
118 | if [[ "$configureTCPIPSetting" == true ]]; then
119 |   if [[ -z "$interface" ]]; then
120 |     echo -e "\e[31mError:\e[0m \e[35m--interface\e[0m is required when \e[35m--configure-tcpip\e[0m is set to \e[35mtrue\e[0m."
121 |     PARAM_CHECK_PASS=false
122 |   fi
123 |   if [[ -z "$ipAddress" ]]; then
124 |     echo -e "\e[31mError:\e[0m \e[35m--ip-address\e[0m is required when \e[35m--configure-tcpip\e[0m is set to \e[35mtrue\e[0m."
125 |     PARAM_CHECK_PASS=false
126 |   elif [[ ! $ipAddress =~ ^([0-9]{1,3}\.){3}[0-9]{1,3}$ ]]; then
127 |     echo -e "\e[31mError:\e[0m \e[35m--ip-address\e[0m value \e[35m$ipAddress\e[0m is not a valid IP address."
128 |     PARAM_CHECK_PASS=false
129 |   fi
130 |   if [[ -z "$netmask" ]]; then
131 |     echo -e "\e[31mError:\e[0m \e[35m--netmask\e[0m is required when \e[35m--configure-tcpip\e[0m is set to \e[35mtrue\e[0m."
132 |     PARAM_CHECK_PASS=false    
133 |   elif [[ ! "$netmask" =~ ^(255|254|252|248|240|224|192|128|0)\.((255|254|252|248|240|224|192|128|0)\.){2}(255|254|252|248|240|224|192|128|0)$ ]]; then  
134 |     echo -e "\e[31mError:\e[0m \e[35m--netmask\e[0m value \e[35m$netmask\e[0m is not a valid network mask."
135 |     PARAM_CHECK_PASS=false
136 |   fi
137 |   if [[ -z "$defaultGateway" ]]; then
138 |     echo -e "\e[31mError:\e[0m \e[35m--default-gateway\e[0m is required when \e[35m--configure-tcpip\e[0m is set to \e[35mtrue\e[0m."
139 |     PARAM_CHECK_PASS=false
140 |   elif [[ ! $defaultGateway =~ ^([0-9]{1,3}\.){3}[0-9]{1,3}$ ]]; then
141 |     echo -e "\e[31mError:\e[0m \e[35m--default-gateway\e[0m value \e[35m$defaultGateway\e[0m is not a valid IP address."
142 |     PARAM_CHECK_PASS=false
143 |   fi
144 |   if [[ "${#dnsServers[@]}" -gt 3 ]]; then
145 |     echo -e "\e[33mWarning:\e[0m Number of DNS servers should not be greater than 3. Kubernetes may display errors but will continue to work."
146 |     PARAM_CHECK_WARN=true
147 |   fi
148 |   for ip in "${dnsServers[@]}"; do
149 |     if [[ ! $ip =~ ^([0-9]{1,3}\.){3}[0-9]{1,3}$ ]]; then
150 |         echo -e "\e[31mError:\e[0m DNS server \e[35m$ip\e[0m is not a valid IP address."
151 |         PARAM_CHECK_PASS=false
152 |     fi
153 |   done
154 | fi
155 | 
156 | if [[ ! $k8sVersion =~ ^(latest)$|^[0-9]{1,2}\.[0-9]{1,2}$ ]]; then
157 |     echo -e "\e[31mError:\e[0m \e[35m--k8s-version\e[0m value \e[35m$k8sVersion\e[0m is not in the correct format."
158 |     PARAM_CHECK_PASS=false
159 | fi
160 | 
161 | if [[ -z "$k8sMasterIP" ]]; then
162 |   echo -e "\e[31mError:\e[0m \e[35m--k8s-master-ip\e[0m is required."
163 |   PARAM_CHECK_PASS=false
164 | elif [[ ! $k8sMasterIP =~ ^([0-9]{1,3}\.){3}[0-9]{1,3}$ ]]; then
165 |   echo -e "\e[31mError:\e[0m \e[35m--k8s-master-ip\e[0m value \e[35m$k8sMasterIP\e[0m is not a valid IP address."
166 |   PARAM_CHECK_PASS=false
167 | fi
168 | 
169 | if [[ -z "$k8sMasterIP" ]]; then
170 |   echo -e "\e[31mError:\e[0m \e[35m--k8s-master-ip\e[0m is required."
171 |   PARAM_CHECK_PASS=false
172 | fi
173 | 
174 | if [[ -z "$k8sMasterPort" ]]; then
175 |   echo -e "\e[31mError:\e[0m \e[35m--k8s-master-port\e[0m is required."
176 |   PARAM_CHECK_PASS=false
177 | fi
178 | 
179 | if [[ -z "$k8sToken" ]]; then
180 |   echo -e "\e[31mError:\e[0m \e[35m--token\e[0m is required."
181 |   PARAM_CHECK_PASS=false
182 | fi
183 | 
184 | if [[ -z "$k8sTokenDiscoveryCaCertHash" ]]; then
185 |   echo -e "\e[31mError:\e[0m \e[35m--discovery-token-ca-cert-hash\e[0m is required."
186 |   PARAM_CHECK_PASS=false
187 | fi
188 | 
189 | if [ $PARAM_CHECK_PASS == false ]; then
190 |   exit 1
191 | fi
192 | 
193 | if [ $PARAM_CHECK_WARN == true ]; then
194 |   sleep 10
195 | fi
196 | 
197 | # Install Kubernetes
198 | # --------------------------------------------------------------------------------------------------------------------------------------------------------
199 | 
200 | # Prevent interactive needsrestart command
201 | 
202 | export NEEDSRESART_CONF="/etc/needrestart/needrestart.conf"
203 | 
204 | if [ -f $NEEDSRESART_CONF ]; then 
205 |   echo -e "\033[32mDisabling needsrestart interactive mode\033[0m"  
206 |   sed -i "/#\$nrconf{restart} = 'i';/s/.*/\$nrconf{restart} = 'a';/" $NEEDSRESART_CONF
207 | fi
208 | 
209 | # Configure IP Settings
210 | 
211 | if [ $configureTCPIPSetting == true ]; then
212 | 
213 |   echo -e "\033[32mConfiguring Network Settings\033[0m"
214 | 
215 |   IFS=. read -r i1 i2 i3 i4 <<< "$ipAddress"
216 |   IFS=. read -r m1 m2 m3 m4 <<< "$netmask"
217 | 
218 |   maskDec=$(( (m1 * 16777216) + (m2 * 65536) + (m3 * 256) + m4 ))
219 |   maskBin=$(echo "obase=2; $maskDec" | bc)
220 |   cidr=$(echo "$maskBin" | tr -d '\n' | sed 's/0*$//' | wc -c)
221 | 
222 |   cat <<EOF | tee /etc/netplan/01-netcfg.yaml > /dev/null
223 | network:
224 |   version: 2
225 |   ethernets:
226 |     $interface:
227 |       dhcp4: false
228 |       dhcp6: false
229 |       addresses: [$ipAddress/$cidr]
230 |       routes:
231 |       - to: default
232 |         via: $defaultGateway
233 |       nameservers:
234 |         search: [$(echo "${dnsSearch[@]}" | tr ' ' ',')]          
235 |         addresses: [$(echo "${dnsServers[@]}" | tr ' ' ',')]
236 | EOF
237 | 
238 |   netplan apply
239 | fi
240 | 
241 | # Install Prerequsite Packages
242 | 
243 | echo -e "\033[32mInstalling prerequisites\033[0m"
244 | 
245 | apt-get update -qq
246 | apt-get install -qqy apt-transport-https ca-certificates curl software-properties-common gzip gnupg lsb-release
247 | 
248 | # Add Docker Repository https://docs.docker.com/engine/install/ubuntu/
249 | 
250 | export KEYRINGS_DIR="/etc/apt/keyrings"
251 | 
252 | if [ ! -d $KEYRINGS_DIR ]; then
253 |   mkdir -m 0755 -p $KEYRINGS_DIR
254 | fi
255 | 
256 | if [ ! -f /etc/apt/sources.list.d/docker.list ]; then
257 |   echo -e "\033[32mAdding Docker repository\033[0m"
258 |   curl -fsSL https://download.docker.com/linux/ubuntu/gpg | gpg --dearmor -o $KEYRINGS_DIR/docker.gpg
259 |   echo "deb [arch=$(dpkg --print-architecture) signed-by=$KEYRINGS_DIR/docker.gpg] https://download.docker.com/linux/ubuntu \
260 |     $(lsb_release -cs) stable" | tee /etc/apt/sources.list.d/docker.list > /dev/null
261 | fi
262 | 
263 | # Install Docker https://docs.docker.com/engine/install/ubuntu/
264 | 
265 | echo -e "\033[32mInstalling Docker\033[0m"
266 | 
267 | sleep 1 # Sleep for a second in case of file locks
268 | 
269 | apt-get update -qq
270 | apt-get install -qqy docker-ce docker-ce-cli
271 | 
272 | tee /etc/docker/daemon.json >/dev/null <<EOF
273 | {
274 |   "exec-opts": ["native.cgroupdriver=systemd"],
275 |   "log-driver": "json-file",
276 |   "log-opts": {
277 |     "max-size": "100m"
278 |   },
279 |   "storage-driver": "overlay2"
280 | }
281 | EOF
282 | 
283 | mkdir -p /etc/systemd/system/docker.service.d
284 | 
285 | # Replace default config file to enable CRI plugin and SystemdCgroup
286 | # https://kubernetes.io/docs/setup/production-environment/container-runtimes/#containerd-systemd
287 | tee /etc/containerd/config.toml >/dev/null <<EOF
288 | version = 2
289 | 
290 | [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc]
291 | runtime_type = "io.containerd.runc.v2"
292 | 
293 | [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc.options]
294 | SystemdCgroup = true
295 | EOF
296 | 
297 | systemctl daemon-reload
298 | systemctl restart docker
299 | systemctl restart containerd
300 | 
301 | # Install Kubernetes https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/
302 | 
303 | echo -e "\033[32mInstalling Kubernetes\033[0m"
304 | 
305 | # Discover latest kubernetes version
306 | 
307 | export K8S_LATEST_VERSION=$(curl -s https://api.github.com/repos/kubernetes/kubernetes/releases/latest | grep tag_name | cut -d '"' -f4 | sed 's/^v//')
308 | 
309 | if [ $k8sVersion == "latest" ]; then
310 |   k8sVersion=$K8S_LATEST_VERSION
311 |   echo "Detected latest Kubernetes version: $k8sVersion"
312 | fi
313 | 
314 | export K8S_REPO_VERSION="v$(echo "$k8sVersion" | cut -d. -f1,2)"
315 | 
316 | echo "Using APT repo: $K8S_REPO_VERSION"
317 | 
318 | # Add Kubernetes Respository
319 | 
320 | if [ -f /etc/apt/sources.list.d/kubernetes.list ]; then
321 |   rm $KEYRINGS_DIR/kubernetes-apt-keyring.gpg
322 |   rm /etc/apt/sources.list.d/kubernetes.list
323 | fi
324 | 
325 | echo -e "\033[32mAdding Kubernetes community repository\033[0m"
326 | curl -fsSL https://pkgs.k8s.io/core:/stable:/$K8S_REPO_VERSION/deb/Release.key | gpg --dearmor -o $KEYRINGS_DIR/kubernetes-apt-keyring.gpg    
327 | echo "deb [signed-by=$KEYRINGS_DIR/kubernetes-apt-keyring.gpg] https://pkgs.k8s.io/core:/stable:/$K8S_REPO_VERSION/deb/ /" | tee /etc/apt/sources.list.d/kubernetes.list
328 | 
329 | sleep 1 # Sleep for a second in case of file locks
330 | 
331 | apt-get update -qq
332 | apt-get install -qqy kubelet kubeadm kubectl
333 | 
334 | # Configuring Prerequisite
335 | 
336 | echo -e "\033[32mEnable IPv4 packet forwarding\033[0m"
337 | 
338 | cat <<EOF | tee /etc/modules-load.d/k8s.conf
339 | overlay
340 | br_netfilter
341 | EOF
342 | 
343 | modprobe overlay
344 | modprobe br_netfilter
345 | 
346 | # Some of this config was required for older versions of Kubernetes.
347 | # See here: https://v1-28.docs.kubernetes.io/docs/setup/production-environment/container-runtimes/
348 | 
349 | cat <<EOF | tee /etc/sysctl.d/k8s.conf
350 | net.bridge.bridge-nf-call-iptables  = 1
351 | net.bridge.bridge-nf-call-ip6tables = 1
352 | net.ipv4.ip_forward                 = 1
353 | EOF
354 | 
355 | sysctl --system
356 | 
357 | # Disabling Swap
358 | 
359 | echo -e "\033[32mDisabling Swapping\033[0m"
360 | 
361 | if grep -v '^#' /etc/fstab | grep -q swap; then
362 |   export BACKUP_FSTAB="/etc/fstab.backup.$(date +%s)"
363 | 
364 |   cp /etc/fstab $BACKUP_FSTAB
365 |   sed -i '/swap/ s/^/#/' /etc/fstab
366 |   swapoff -a
367 | 
368 |   echo "The file /etc/fstab has been backed-up to $BACKUP_FSTAB"
369 |   echo "Swap is now disabled"
370 | else
371 |   echo "Swap is already disabled"
372 | fi
373 | 
374 | # Join Cluster
375 | 
376 | echo -e "\033[32mJoining Kubernetes Cluster\033[0m"
377 | 
378 | kubeadm join $k8sMasterIP:$k8sMasterPort --token $k8sToken --discovery-token-ca-cert-hash $k8sTokenDiscoveryCaCertHash $k8sKubeadmOptions
379 | 
380 | # Print success message
381 | 
382 | echo -e "\033[32m\nInstallation Complete!\n\033[0m"
383 | 


--------------------------------------------------------------------------------