Merge pull request #15 from oracle/main

syncup

Author: rcitton-oracle

CODEOWNERS

@@ -1,7 +1,7 @@
 # The last matching pattern has the most precedence.
 *                         @gvenzl
 /ContainerTools/          @AmedeeBulle
-/OLCNE/                   @rafabene
+/OCNE/                    @scoter-oracle
 /OracleDatabase/          @gvenzl
 /OracleLinux/             @scoter-oracle
 /OracleDG/                @rcitton

ContainerTools/README.md

@@ -4,17 +4,18 @@ A Vagrantfile that installs and configures the Container Tools module on Oracle
 This module provides the tools to use container runtimes. That is: mainly Podman, but also Buildah, Skopeo...
 
 __Note:__ This Vagrant project is deprecated. However, the same functionality is
-available as an extension to the OracleLinux/8 project. For more information,
-see the [Container Tools](../OracleLinux/8/README.md#container-tools) section of
-the OracleLinux/8 [README.md](../OracleLinux/8/README.md) file.
+available as an extension to the OracleLinux/8 and OracleLinux/9 projects. For
+more information, see the Container Tools section of the Oracle Linux/8
+[README.md](../OracleLinux/8/README.md#container-tools) file or the Oracle
+Linux/9 [README.md](../OracleLinux/9/README.md#container-tools) file.
 
 ## Prerequisites
 1. Install [Oracle VM VirtualBox](https://www.virtualbox.org/wiki/Downloads)
 1. Install [Vagrant](https://vagrantup.com/)
 
 ## Getting started
-1. Clone this repository `git clone https://github.com/oracle/vagrant-boxes`
-1. Change into the `vagrant-boxes/ContainerTools` folder
+1. Clone this repository `git clone https://github.com/oracle/vagrant-projects`
+1. Change into the `vagrant-projects/ContainerTools` folder
 1. Run `vagrant up; vagrant ssh`
 1. Within the guest, run Podman commands, for example `podman run -it oraclelinux:7-slim` to run an Oracle Linux 7 container, or `podman run -ti oraclelinux:8-slim` to run an Oracle Linux 8 container
 

ContainerTools/Vagrantfile

@@ -17,7 +17,7 @@
 VAGRANTFILE_API_VERSION = "2"
 
 # Box metadata location and box name
-BOX_URL = "https://oracle.github.io/vagrant-boxes/boxes"
+BOX_URL = "https://oracle.github.io/vagrant-projects/boxes"
 BOX_NAME = "oraclelinux/8"
 
 # define hostname

OLCNE/.env renamed to OCNE/.env

@@ -1,4 +1,7 @@
-# Oracle Linux Cloud Native Environment configuration file
+# -*- mode: shell-script -*-
+# vi: set ft=shell :
+
+# Oracle Cloud Native Environment configuration file
 #
 # Requires vagrant-env plugin
 #
@@ -8,12 +11,22 @@
 # Verbose console
 # VERBOSE=false
 
-# Set vCPU count and memory for the VMs (3GB minimum required for Istio)
-# CPUS=2
-# MEMORY=3072
+# Set the VM provider host-only / private network subnet
+# SUBNET=192.168.99
+
+# Set vCPU count and memory for the VMs:
+#   +  2 vCPU/1770MB absloute memory minimum for Master node(s)
+#   +  1 vCPU/700MB absloute memory minimum for Worker node(s)
+#   +  3GB memory minimum required for Istio module on Worker nodes
+# OPERATOR_CPUS=1
+# OPERATOR_MEMORY=1024
+# MASTER_CPUS=2
+# MASTER_MEMORY=2048
+# WORKER_CPUS=1
+# WORKER_MEMORY=1024
 
 # Group VirtualBox containers
-# VB_GROUP="OLCNE"
+# VB_GROUP="OCNE"
 
 # Create a separate instance for the operator node?
 # The default is to install the Platform API Server and CLI tool on
@@ -26,7 +39,7 @@
 
 # Creates an extra disk (/dev/sdb) so it can be used as a
 # Gluster Storage for Kubernetes Persistent Volumes
-# EXTRA_DISK = false
+# EXTRA_DISK=false
 
 # Number of worker nodes to provision
 # NB_WORKERS=2
@@ -37,29 +50,40 @@
 # Additional yum channel to consider (e.g. local repo)
 # YUM_REPO=
 
-# Add OLCNE developer channel
-# OLCNE_DEV=false
+# Add OCNE developer channel
+# OCNE_DEV=false
 
-# Container registry for Oracle Linux Cloud Native Environment images
+# Container registry for Oracle Cloud Native Environment images
 # You can use registry mirrors in a region close to you.
 # Check the README.md file for more details.
-# REGISTRY_OLCNE='container-registry.oracle.com/olcne'
+# REGISTRY_OCNE='container-registry.oracle.com/olcne'
 
 # Use specific NGINX version (mainly used for development)
-# NGINX_IMAGE=
+# NGINX_IMAGE=nginx:1.17.7
 
 # Environment and cluster names
-# OLCNE_ENV_NAME="olcne-env"
-# OLCNE_CLUSTER_NAME="olcne-cluster"
+# OCNE_ENV_NAME="ocne-env"
+# OCNE_CLUSTER_NAME="ocne-cluster"
 
 # Deploy the Helm module?
 # DEPLOY_HELM=false
-# HELM_MODULE_NAME="olcne-helm"
+# HELM_MODULE_NAME="ocne-helm"
 
 # Deploy the Istio module? Requires the Helm module and will set DEPLOY_HELM to 1 if not set.
 # DEPLOY_ISTIO=false
-# ISTIO_MODULE_NAME="olcne-istio"
+# ISTIO_MODULE_NAME="ocne-istio"
+
+# Deploy the Gluster module? Requires the Helm module and will set DEPLOY_HELM to 1 if not set.
+# DEPLOY_GLUSTER=false
+# GLUSTER_MODULE_NAME="ocne-gluster"
+
+# Deploy the MetalLB module? Requires the Helm module and will set DEPLOY_HELM to 1 if not set.
+# DEPLOY_METALLB=false
+# METALLB_MODULE_NAME="ocne-metallb"
 
 # Override number of masters to deploy
 # This should not be changed -- for development purpose
 # NB_MASTERS=1
+
+# Update Base OS
+# UPDATE_OS=false

OLCNE/.gitattributes renamed to OCNE/.gitattributes

@@ -0,0 +1,10 @@
+.env.local*
+admin.conf
+local
+id_rsa*
+known_hosts*
+*.swp
+heketi.json*
+topology-olcne.json*
+hyperconverged.yaml*
+ignore-systemd-session-slice.conf*

OCNE/.gitignore

@@ -1,45 +1,47 @@
-# Vagrant project to set up Oracle Linux Cloud Native Environment on Oracle Linux 8
+# Vagrant project to set up Oracle Cloud Native Environment on Oracle Linux 8
 
 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 worker nodes (2 by default)
-- An optional operator node for the Oracle Linux Cloud Native Environment
+- 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)
 
 If you enable multiple master nodes, an operator node is automatically deployed
 to provide egress routing for the cluster.
 
-All master and worker nodes will have the Oracle Linux Cloud Native
+All master 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.
 
-The installation includes the Kubernetes module for Oracle Linux Cloud
-Native Environment which deploys Kubernetes 1.18.10 configured to use
+The installation includes the Kubernetes module for Oracle Cloud
+Native Environment which deploys Kubernetes [1.24.8](https://docs.oracle.com/en/operating-systems/olcne/1.5/relnotes/components.html#d672e108) configured to use
 the CRI-O runtime interface. Two runtime engines are installed, runc and
 Kata Containers.
 
-You may optionally enable the deployment of the Helm and Istio modules. Note
-that enabling the Istio module will automatically enable the Helm module.
+You may optionally enable the deployment of the Helm, Istio, MetalLB or Gluster
+modules. Note that enabling the Istio, MetalLB or Gluster modules will
+automatically enable the Helm module.
 
 _Note:_ Kata Containers requires Intel hardware virtualization support and
 will not work in a VirtualBox guest until nested virtualization support is
 released for Intel CPUs.
 
 ## Prerequisites
 
-1. Read the [prerequisites in the top level README](../README.md#prerequisites) to set up Vagrant with either VirtualBox or KVM
-1. [vagrant-env](https://github.com/gosuri/vagrant-env) plugin is optional but
+1. Read the [prerequisites in the top level README](../README.md#prerequisites)
+to set up Vagrant with either VirtualBox or KVM
+2. [vagrant-env](https://github.com/gosuri/vagrant-env) plugin is optional but
 makes configuration much easier
 
 ## Quick start
 
 1. Clone this repository `git clone https://github.com/oracle/vagrant-projects`
-1. Change into the `vagrant-projects/OLCNE` directory
-1. Run `vagrant up`
+2. Change into the `vagrant-projects/OCNE` directory
+3. Run `vagrant up`
 
-Your Oracle Linux Cloud Native Environment is ready!
+Your Oracle Cloud Native Environment is ready!
 
 From any master node (e.g. master1) you can check the status of the cluster (as
 the `vagrant` user). E.g.:
@@ -56,30 +58,33 @@ to the Dashboard from a browser on your Vagrant host, you will need to set
 `BIND_PROXY` to `true` in your `.env.local` file.
 
 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/kube-system/services/https:kubernetes-dashboard:/proxy/>.
+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`
 
-## About the Vagrantfile
+## About the `Vagrantfile`
 
 The VMs communicate via a private network:
 
-- Controller node (if any): 192.168.99.100
-- Master node i: 192.168.99.(100+i) / master*i*.vagrant.vm
-- Worker node i: 192.168.99.(110+i) / worker*i*.vagrant.vm
+- Controller node IP: 192.168.99.100 (if `STANDALONE_OPERATOR=true`)
+- Master node _i_: 192.168.99.(100+ _i_ ) / master *_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`)
+- LoadBalancer IPs: 192.168.99.240 - 192.168.99.250 (if `DEPLOY_METALLB=true`)
 
 ## Configuration
 
-The Vagrantfile can be used _as-is_; there are a couple of parameters you
+The `Vagrantfile` can be used _as-is_; there are a couple of parameters you
 can set to tailor the installation to your needs.
 
 ### How to configure
 
 There are several ways to set parameters:
 
-1. Update the Vagrantfile. This is straightforward; the downside is that you
+1. Update the `Vagrantfile`. This is straightforward; the downside is that you
 will lose changes when you update this repository.
-1. Use environment variables. Might be difficult to remember the parameters
+2. Use environment variables. Might be difficult to remember the parameters
 used when the VM was instantiated.
-1. Use the `.env`/`.env.local` files (requires
+3. Use the `.env`/`.env.local` files (requires
 [vagrant-env](https://github.com/gosuri/vagrant-env) plugin). Configure
 your cluster by editing the `.env` file; or better copy `.env` to `.env.local`
 and edit the latter one, it won't be overridden when you update this repository
@@ -89,46 +94,58 @@ local configuration!)
 Parameters are considered in the following order (first one wins):
 
 1. Environment variables
-1. `.env.local` (if [vagrant-env](https://github.com/gosuri/vagrant-env) plugin
+2. `.env.local` (if [vagrant-env](https://github.com/gosuri/vagrant-env) plugin
 is installed)
-1. `.env` (if [vagrant-env](https://github.com/gosuri/vagrant-env) plugin
+3. `.env` (if [vagrant-env](https://github.com/gosuri/vagrant-env) plugin
 is installed)
-1. Vagrantfile definitions
+4. `Vagrantfile` definitions
 
 ### VM parameters
 
 - `VERBOSE` (default: `false`): verbose output during VM deployment.
-- `MEMORY` (default: 3072): all VMs are provisioned with 3GB memory.
-- `VB_GROUP` (default: `OLCNE`): group all VirtualBox VMs under this label.
-- `EXTRA_DISK` (default: `false`): Creates an extra disk (/dev/sdb) that can be used for GlusterFS for Kubernetes Persistent Volumes
+- `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`.
+- `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`): create a separate VM for the
-operator node -- default is to install the operator components on the (first)
-master node.
+- `STANDALONE_OPERATOR` (default: `false` unless `MULTI_MASTER=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
 HA mode.
-- `NB_WORKERS` (default: 2): number of worker nodes to provision.
+- `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
 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.
+- `DEPLOY_HELM` (default: `false`): deploys the Helm module.
+- `DEPLOY_ISTIO` (default: `false`): deploys the Istio and Helm modules.
+- `DEPLOY_METALLB` (default: `false`): deploys the MetalLB and Helm modules.
+- `DEPLOY_GLUSTER` (default: `false`): deploys the Gluster and Helm modules.
+__Note__: if `NB_WORKERS` is less than `3`, the `hyperconverged` `storageclass`
+is patched to adjust the number of Gluster replicas accordingly.
+__Note__: This provisioning script also installs Heketi on the operator node.
 
 ### Repositories
 
 - `YUM_REPO` (default: none): additional yum repository to consider
 (e.g. local repo)
-- `OLCNE_DEV` (default: `false`): whether to enable the Oracle Linux Cloud
+- `OCNE_DEV` (default: `false`): whether to enable the Oracle Cloud
 Native Environment developer channel.
-- `REGISTRY_OLCNE` (default: `container-registry.oracle.com/olcne`): Container
-registry for Oracle Linux Cloud Native Environment images.
+- `REGISTRY_OCNE` (default: `container-registry.oracle.com/olcne`): Container
+registry for Oracle Cloud Native Environment images.
 
 For performance reasons, we recommend using the closest Oracle Container Registry mirror to your region. A list of available regions can be found on the [Regions and Availability Domains](https://docs.cloud.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm) page of the Oracle Cloud Infrastructure documentation.
 
-To specify an Oracle Container Registry mirror, either edit the Vagrantfile or install the vagrant-env plugin and create a .env.local file that specifies the mirror.
+To specify an Oracle Container Registry mirror, either edit the `Vagrantfile` or install the vagrant-env plugin and create a `.env.local` file that specifies the mirror.
 
 The following syntax can be used to specify a mirror:
 
@@ -145,16 +162,18 @@ 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.
+- `NB_MASTERS` (default: none): override number of masters to deploy. Requires `MULTI_MASTER=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.
 
 ## Optional plugins
 
-When installed, this Vagrantfile will make use of the following third party Vagrant plugins:
+When installed, this `Vagrantfile` will make use of the following third party Vagrant plugins:
 
 - [vagrant-env](https://github.com/gosuri/vagrant-env): loads environment
 variables from .env files;
 - [vagrant-hosts](https://github.com/oscar-stack/vagrant-hosts): maintains
-/etc/hosts for the guest VMs;
+`/etc/hosts` for the guest VMs;
 - [vagrant-proxyconf](https://github.com/tmatilai/vagrant-proxyconf): set
 proxies in the guest VMs if you need to access the Internet through proxy. See
 plugin documentation for the configuration.
@@ -167,9 +186,9 @@ vagrant plugin install <name>...
 
 ## Product Documentation
 
-- [Oracle Linux Cloud Native Environment: Getting Started](https://docs.oracle.com/en/operating-systems/olcne/start/index.html)
-- [Oracle Linux Cloud Native Environment: Using Container Orchestration](https://docs.oracle.com/en/operating-systems/olcne/orchestration/index.html)
-- [Oracle Linux Cloud Native Environment: Using Container Runtimes](https://docs.oracle.com/en/operating-systems/olcne/runtimes/index.html)
+- [Oracle Cloud Native Environment: Getting Started](https://docs.oracle.com/en/operating-systems/olcne/start/index.html)
+- [Oracle Cloud Native Environment: Using Container Orchestration](https://docs.oracle.com/en/operating-systems/olcne/orchestration/index.html)
+- [Oracle Cloud Native Environment: Using Container Runtimes](https://docs.oracle.com/en/operating-systems/olcne/runtimes/index.html)
 
 ## Feedback