Merge pull request #484 from jromers/ocne_quickinstall

Ocne quickinstall procedure with "olcnectl provision"

Author: scoter-oracle

OCNE/.env

@@ -20,8 +20,8 @@
 #   +  3GB memory minimum required for Istio module on Worker nodes
 # OPERATOR_CPUS=1
 # OPERATOR_MEMORY=1024
-# MASTER_CPUS=2
-# MASTER_MEMORY=2048
+# CONTROL_PLANE_CPUS=2
+# CONTROL_PLANE_MEMORY=2048
 # WORKER_CPUS=1
 # WORKER_MEMORY=1024
 
@@ -30,12 +30,12 @@
 
 # Create a separate instance for the operator node?
 # The default is to install the Platform API Server and CLI tool on
-# the (first) master node
+# the (first) control_plane node
 # STANDALONE_OPERATOR=false
 
-# Multi-master setup. Deploy 3 masters in HA mode.
+# Multi-control_plane setup. Deploy 3 control_planes in HA mode.
 # Will automatically enable STANDALONE_OPERATOR if true
-# MULTI_MASTER=false
+# MULTI_CONTROL_PLANE=false
 
 # Creates an extra disk (/dev/sdb) so it can be used as a
 # Gluster Storage for Kubernetes Persistent Volumes
@@ -44,7 +44,7 @@
 # Number of worker nodes to provision
 # NB_WORKERS=2
 
-# Bind the kubectl proxy from the (first) master to the vagrant host
+# Bind the kubectl proxy from the (first) control_plane to the vagrant host
 # BIND_PROXY=false
 
 # Additional yum channel to consider (e.g. local repo)
@@ -58,17 +58,11 @@
 # Check the README.md file for more details.
 # REGISTRY_OCNE='container-registry.oracle.com/olcne'
 
-# Use specific NGINX version (mainly used for development)
-# NGINX_IMAGE=nginx:1.17.7
-
 # Environment and cluster names
 # OCNE_ENV_NAME="ocne-env"
 # OCNE_CLUSTER_NAME="ocne-cluster"
 
-# Pod networking technology: flannel, calico, none. Note: flannel is deprecated.
-# POD_NETWORK=calico
-
-# Deploy Calico networking module? Sets POD_NETWORK=none. Place your config file in the current directory named: calico-config.yaml
+# Deploy Calico networking module? Place your config file in the current directory named: calico-config.yaml
 # DEPLOY_CALICO=false
 # CALICO_MODULE_NAME="ocne-calico"
 
@@ -92,9 +86,9 @@
 # DEPLOY_METALLB=false
 # METALLB_MODULE_NAME="ocne-metallb"
 
-# Override number of masters to deploy
+# Override number of control_planes to deploy
 # This should not be changed -- for development purpose
-# NB_MASTERS=1
+# NB_CONTROL_PLANES=1
 
 # Update Base OS (experimental)
 # UPDATE_OS=false

OCNE/README.md

@@ -2,16 +2,16 @@
 
 This Vagrant project will deploy and configure the following components:
 
-- One or more master nodes (one by default, 3 in HA mode)
+- One or more control plane nodes (one by default, 3 in HA mode)
 - One or more worker nodes (2 by default)
 - An optional operator node for the Oracle Cloud Native Environment
 Platform API Server and Platform CLI tool (default is to install these
-components on the first master node)
+components on the first control plane node)
 
-If you enable multiple master nodes, an operator node is automatically deployed
+If you enable multiple control plane nodes, an operator node is automatically deployed
 to provide egress routing for the cluster.
 
-All master and worker nodes will have the Oracle Cloud Native
+All control plane and worker nodes will have the Oracle Cloud Native
 Environment Platform Agent installed and configured to communicate with the
 Platform API Server on the operator node.
 
@@ -21,7 +21,7 @@ configured to use the CRI-O runtime interface. Two runtime engines are installed
 [runC](https://docs.oracle.com/en/operating-systems/olcne/1.6/runtimes/runc.html#runc)
 and (now deprecated) [Kata](https://docs.oracle.com/en/operating-systems/olcne/1.6/runtimes/kata.html#kata) Containers.
 
-You may set your cluster networking to Calico (default), Flannel (deprecated) or Multus on top of either Calico or Flannel.
+You may set your cluster networking to Flannel (default), Calico or Multus on top of either Calico or Flannel.
 
 You may optionally enable the deployment of Istio, MetalLB or Gluster (deprecated)
 modules. Note that Helm is now installed automatically.
@@ -45,7 +45,7 @@ makes configuration much easier
 
 Your Oracle Cloud Native Environment is ready!
 
-From any master node (e.g. master1) you can check the status of the cluster (as
+From any control plane node (e.g. controlplane1) you can check the status of the cluster (as
 the `vagrant` user). E.g.:
 
 - `kubectl cluster-info`
@@ -61,16 +61,16 @@ to the Dashboard from a browser on your Vagrant host, you will need to set
 
 To access the Kubernetes Dashboard, remember to use `localhost` or `127.0.0.1`
 in the URL, i.e. <http://localhost:8001/api/v1/namespaces/kubernetes-dashboard/services/https:kubernetes-dashboard:/proxy/>.
-To obtain token from any Master node, you may run: `kubectl -n kubernetes-dashboard get secret -o=jsonpath='{.items[?(@.metadata.annotations.kubernetes\.io/service-account\.name=="kubernetes-dashboard")].data.token}' | base64 --decode`
+To obtain token from any Control plane node, you may run: `kubectl -n kubernetes-dashboard get secret -o=jsonpath='{.items[?(@.metadata.annotations.kubernetes\.io/service-account\.name=="kubernetes-dashboard")].data.token}' | base64 --decode`
 
 ## About the `Vagrantfile`
 
 The VMs communicate via a private network:
 
 - Controller node IP: 192.168.99.100 (if `STANDALONE_OPERATOR=true`)
-- Master node _i_: 192.168.99.(100+ _i_ ) / master *_i_* .vagrant.vm
+- Control plane node _i_: 192.168.99.(100+ _i_ ) / controlplane *_i_* .vagrant.vm
 - Worker node _i_: 192.168.99.(110+ _i_ ) / worker *_i_* .vagrant.vm
-- Master Virtual IP: 192.168.99.99 (if `MULTI_MASTER=true`)
+- Control plane Virtual IP: 192.168.99.99 (if `MULTI_CONTROL_PLANE=true`)
 - LoadBalancer IPs: 192.168.99.240 - 192.168.99.250 (if `DEPLOY_METALLB=true`)
 
 ## Configuration
@@ -107,28 +107,27 @@ is installed)
 - `VERBOSE` (default: `false`): verbose output during VM deployment.
 - `WORKER_CPUS` (default: `1`):  Provision Worker Node with 1 vCPU.
 - `WORKER_MEMORY` (default: `1024`): Provision Worker Node with 1GB memory.
-- `MASTER_CPUS` (default: `2`): At least 2 vCPUS are required for Master Nodes.
-- `MASTER_MEMORY` (default: `2048`): At least 1700MB are required for Master Nodes.
-- `OPERATOR_CPUS` (default: `1`): Only applicable if `STANDALONE_OPERATOR=true` or `MULTI_MASTER=true`.
-- `OPERATOR_MEMORY` (default: `1024`): Only applicable if `STANDALONE_OPERATOR=true` or `MULTI_MASTER=true`.
+- `CONTROL_PLANE_CPUS` (default: `2`): At least 2 vCPUS are required for Control plane Nodes.
+- `CONTROL_PLANE_MEMORY` (default: `2048`): At least 1700MB are required for Control plane Nodes.
+- `OPERATOR_CPUS` (default: `1`): Only applicable if `STANDALONE_OPERATOR=true` or `MULTI_CONTROL_PLANE=true`.
+- `OPERATOR_MEMORY` (default: `1024`): Only applicable if `STANDALONE_OPERATOR=true` or `MULTI_CONTROL_PLANE=true`.
 - `VB_GROUP` (default: `OCNE`): group all VirtualBox VMs under this label.
 - `EXTRA_DISK` (default: `false`): Creates an extra disk (`/dev/sdb`) on Worker nodes that can be used for GlusterFS for Kubernetes Persistent Volumes
 
 ### Cluster parameters
 
-- `STANDALONE_OPERATOR` (default: `false` unless `MULTI_MASTER=true`): create
+- `STANDALONE_OPERATOR` (default: `false` unless `MULTI_CONTROL_PLANE=true`): create
 a separate VM for the operator node -- default is to install the operator
-components on the (first) master node.
-- `MULTI_MASTER` (default: `false`): multi-master setup. Deploy 3 masters in
+components on the (first) control plane node.
+- `MULTI_CONTROL_PLANE` (default: `false`): multi-control-plane setup. Deploy 3 control planes in
 HA mode.
 - `NB_WORKERS` (default: `2`): number of worker nodes to provision.
 At least one worker node is required.
 - `BIND_PROXY` (default: `false`): bind the kubectl proxy port (8001) from the
-(first) master to the Vagrant host. This is required if you want to access the
+(first) control plane to the Vagrant host. This is required if you want to access the
 Kubernetes Dashboard from a browser on your host.
 __Note__: you only need this if you want to expose the kubectl proxy to other
 hosts in your network.
-- `POD_NETWORK` (default: `calico`): deploys the Calico networking module with default configuration. Can be set to [`calico`, `flannel`, `none`].
 - `DEPLOY_CALICO` (default: `false`): deploys the Calico networking module with custom configuration `calico-config.yaml`.
 - `DEPLOY_MULTUS` (default: `false`): deploys the Multus networking module with custom configuration `multus-config.yaml`.
 - `DEPLOY_HELM` (default: `false`): deploys the Helm module (deprecated).
@@ -165,9 +164,7 @@ The following syntax can be used to specify a mirror:
 Danger zone!
 Mainly used for development.
 
-- The following parameters can be set to use specific component version:
-`OLCNE_VERSION`, `NGINX_IMAGE`.
-- `NB_MASTERS` (default: none): override number of masters to deploy. Requires `MULTI_MASTER=true` to function properly.
+- `NB_CONTROL_PLANES` (default: none): override number of control planes to deploy. Requires `MULTI_CONTROL_PLANE=true` to function properly.
 - `SUBNET` (default: `192.168.99`): Set the VM provider host-only / private network subnet.
 - `UPDATE_OS` (default: false): Runs `dnf -y update` on the VM.
 

OCNE/Vagrantfile

@@ -14,13 +14,13 @@
 # vi: set ft=ruby :
 
 # This Vagrantfile creates an Oracle Cloud Native Environment and
-# deploys the Kubernetes module to the master and worker nodes.
+# deploys the Kubernetes module to the control plane and worker nodes.
 # VMs communicate via a private network using subnet 192.168.99.* (by default):
-#   - HA Master IP: 192.168.99.99          (Virtual IP, when in HA mode)
-#   - Operator    : 192.168.99.100         (Optional, none by default)
-#   - Master i    : 192.168.99.(100+i)     (1 by default, 3 in HA mode)
-#   - Worker i    : 192.168.99.(110+i)     (2 by default)
-#   - MetalLB Pool: 192.168.99.240 - 192.168.99.250
+#   - HA Control plane IP: 192.168.99.99          (Virtual IP, when in HA mode)
+#   - Operator           : 192.168.99.100         (Optional, none by default)
+#   - Control plane i    : 192.168.99.(100+i)     (1 by default, 3 in HA mode)
+#   - Worker i           : 192.168.99.(110+i)     (2 by default)
+#   - MetalLB Pool       : 192.168.99.240 - 192.168.99.250
 #
 # Optional plugins:
 #     vagrant-hosts (maintains /etc/hosts for the VMs)
@@ -54,24 +54,24 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
   # vCPUS and Memory for the VMs
   OPERATOR_CPUS = default_i('OPERATOR_CPUS', 1)
   OPERATOR_MEMORY = default_i('OPERATOR_MEMORY', 1024)
-  MASTER_CPUS = default_i('MASTER_CPUS', 2)
-  MASTER_MEMORY = default_i('MASTER_MEMORY', 2048)
+  CONTROL_PLANE_CPUS = default_i('CONTROL_PLANE_CPUS', 2)
+  CONTROL_PLANE_MEMORY = default_i('CONTROL_PLANE_MEMORY', 2048)
   WORKER_CPUS = default_i('WORKER_CPUS', 1)
   WORKER_MEMORY = default_i('WORKER_MEMORY', 1024)
 
   # Group VirtualBox containers
   VB_GROUP = default_s('VB_GROUP', 'OCNE')
 
-  # Multi-master setup. Deploy 3 masters in HA mode.
-  MULTI_MASTER = default_b('MULTI_MASTER', false)
+  # Multi-control-plane setup. Deploy 3 control planes in HA mode.
+  MULTI_CONTROL_PLANE = default_b('MULTI_CONTROL_PLANE', false)
 
   # Separate operator node for the Oracle Cloud Native Environment
   # Platform API Server and Platform Agent (default is to install the
-  # components on the (first) master node
+  # components on the (first) control plane node
   #
-  # If multi-master is enabled, the standalone operator is automatically
+  # If multi-control-plane is enabled, the standalone operator is automatically
   # enabled for routing purposes
-  if MULTI_MASTER
+  if MULTI_CONTROL_PLANE
     STANDALONE_OPERATOR = true
   else
     STANDALONE_OPERATOR = default_b('STANDALONE_OPERATOR', false)
@@ -81,14 +81,14 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
   # Gluster Storage for Kubernetes Persistent Volumes
   EXTRA_DISK = default_b('EXTRA_DISK', false)
 
-  # Override number of masters to deploy
+  # Override number of control planes to deploy
   # This should not be changed -- for development purpose
-  NB_MASTERS = default_i('NB_MASTERS', MULTI_MASTER ? 3 : 1)
+  NB_CONTROL_PLANES = default_i('NB_CONTROL_PLANES', MULTI_CONTROL_PLANE ? 3 : 1)
 
   # Number of worker nodes to provision
   NB_WORKERS = default_i('NB_WORKERS', 2)
 
-  # Bind the kubectl proxy from the (first) master to the vagrant host
+  # Bind the kubectl proxy from the (first) control plane to the vagrant host
   BIND_PROXY = default_b('BIND_PROXY', false)
 
   # Additional yum channel to consider (e.g. local repo)
@@ -112,13 +112,6 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
   # Deploy Multus networking module?
   DEPLOY_MULTUS = default_b('DEPLOY_MULTUS', false)
 
-  # Pod networking technology: flannel, calico, none. Note: flannel is deprecated.
-  if DEPLOY_CALICO
-    POD_NETWORK = 'none'
-  else
-    POD_NETWORK = default_s('POD_NETWORK', 'calico')
-  end
-  
   # Deploy Istio?
   DEPLOY_ISTIO = default_b('DEPLOY_ISTIO', false)
 
@@ -138,9 +131,6 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
   METALLB_MODULE_NAME = default_s('METALLB_MODULE_NAME', 'ocne-metallb')
   GLUSTER_MODULE_NAME = default_s('GLUSTER_MODULE_NAME', 'ocne-gluster')
 
-  # Use specific component version (mainly used for development)
-  NGINX_IMAGE = default_s('NGINX_IMAGE', 'nginx:1.17.7')
-
   # Update Base OS
   UPDATE_OS = default_b('UPDATE_OS', false)
 
@@ -178,10 +168,9 @@ def provision_vm(vm, vm_args)
   args = vm_args.clone
   args.push("--ocne-environment-name", OCNE_ENV_NAME)
   args.push("--ocne-cluster-name", OCNE_CLUSTER_NAME)
-  args.push("--multi-master") if MULTI_MASTER
+  args.push("--multi-control-plane") if MULTI_CONTROL_PLANE
   args.push("--repo", YUM_REPO) unless YUM_REPO == ""
   args.push("--ocne-dev") if OCNE_DEV
-  args.push("--pod-network", POD_NETWORK) if POD_NETWORK
   args.push("--with-calico") if DEPLOY_CALICO
   args.push("--calico-module-name", CALICO_MODULE_NAME) if DEPLOY_CALICO
   args.push("--with-multus") if DEPLOY_MULTUS
@@ -206,6 +195,7 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
 
   config.vm.box = BOX_NAME
   config.vm.box_url = "#{BOX_URL}/#{BOX_NAME}.json"
+  # config.vm.box_version = "8.6.359"
 
   # If we use the vagrant-proxyconf plugin, we should not proxy k8s/local IPs
   # Unfortunately we can't use CIDR with no_proxy, so we have to enumerate and
@@ -263,6 +253,7 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
       ip = 110 + i
       ip_addr = "#{SUBNET}.#{ip}"
       workers += "#{ip_addr},"
+#      worker.vm.network :private_network, nic_type: "virtio", ip: ip_addr, nm_controlled: "yes"
       worker.vm.network :private_network, nic_type: "virtio", ip: ip_addr
       if Vagrant.has_plugin?("vagrant-hosts")
         worker.vm.provision :hosts, :sync_hosts => true, :add_localhost_hostnames => false
@@ -289,42 +280,42 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
     end
   end
 
-  # Masters provisioning
-  masters = ""
-  NB_MASTERS.downto(1) do |i|
-    config.vm.define "master#{i}" do |master|
-      master.vm.hostname = "master#{i}.vagrant.vm"
+  # Control plane provisioning
+  control_planes = ""
+  NB_CONTROL_PLANES.downto(1) do |i|
+    config.vm.define "controlplane#{i}" do |control_plane|
+      control_plane.vm.hostname = "controlplane#{i}.vagrant.vm"
       ip = 100 + i
       ip_addr = "#{SUBNET}.#{ip}"
-      masters += "#{ip_addr},"
-      master.vm.network :private_network, nic_type: "virtio", ip: ip_addr
+      control_planes += "#{ip_addr},"
+      control_plane.vm.network :private_network, nic_type: "virtio", ip: ip_addr
       if Vagrant.has_plugin?("vagrant-hosts")
-        master.vm.provision :hosts, :sync_hosts => true, :add_localhost_hostnames => false
+        control_plane.vm.provision :hosts, :sync_hosts => true, :add_localhost_hostnames => false
       end
-      master.vm.provider :virtualbox do |vb|
-        vb.name = "master#{i}"
-        vb.memory = MASTER_MEMORY
-        vb.cpus = MASTER_CPUS
+      control_plane.vm.provider :virtualbox do |vb|
+        vb.name = "control_plane#{i}"
+        vb.memory = CONTROL_PLANE_MEMORY
+        vb.cpus = CONTROL_PLANE_CPUS
       end
       config.vm.provider :libvirt do |lv|
-        lv.memory = MASTER_MEMORY
-        lv.cpus = MASTER_CPUS
+        lv.memory = CONTROL_PLANE_MEMORY
+        lv.cpus = CONTROL_PLANE_CPUS
       end
       if BIND_PROXY && i == 1
         # Bind kubectl proxy port
-        master.vm.network :forwarded_port, guest: 8001, host: 8001
+        control_plane.vm.network :forwarded_port, guest: 8001, host: 8001
       end
       # Update OS if UPDATE_OS=true
-      update_os(master.vm)
-      # Provisioning: Master Node
-      args = ["--master", "--nginx-image", NGINX_IMAGE]
+      update_os(control_plane.vm)
+      # Provisioning: Control plane Node
+      args = ["--control-plane"]
       if !STANDALONE_OPERATOR && i == 1
         args.push("--operator")
         args.push("--subnet", SUBNET)
         args.push("--workers", workers.chop)
-        args.push("--masters", masters.chop)
+        args.push("--control-planes", control_planes.chop)
       end
-      provision_vm(master.vm, args)
+      provision_vm(control_plane.vm, args)
     end
   end
 
@@ -351,8 +342,7 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
       args = ["--operator"]
       args.push("--subnet", SUBNET)
       args.push("--workers", workers.chop)
-      args.push("--masters", masters.chop)
-      args.push("--nginx-image", NGINX_IMAGE)
+      args.push("--control-planes", control_planes.chop)
       provision_vm(operator.vm, args)
     end
   end