Wallaroo Prerequisites Guide
Before installing Wallaroo version, verify that the following hardware and software requirements are met.
Environment Hardware Requirements
The following system requirements are required for the minimum settings for running Wallaroo in a Kubernetes cloud cluster.
- Minimum number of nodes: 4
- Minimum Number of CPU Cores: 8
- Minimum RAM per node: 16 GB
- Minimum Storage: A total of 625 GB of storage will be allocated for the entire cluster based on 5 users with up to four pipelines with five steps per pipeline, with 50 GB allocated per node, including 50 GB specifically for the Jupyter Hub service. Enterprise users who deploy additional pipelines will require an additional 50 GB of storage per lab node deployed.
Wallaroo recommends at least 16 cores total to enable all services. At less than 16 cores, services will have to be disabled to allow basic functionality as detailed in this table.
Cluster Size | < 8 core | 8 core/48GB | 16 core/48GB | 32 core/48GB | |
Inference | ✔ | ✔ | ✔ | ✔ | |
Dashboard | ✘ | ✔ | ✔ | ✔ | |
Jupyter HUB/Lab | |||||
Single Lab | ✘ | ✔ | ✔ | ✔ | |
Multiple Labs | ✘ | ✘ | ✔ | ✔ | |
Prometheus | ✘ | ✔ | ✔ | ✔ | |
Alerting | ✘ | ✘ | ✔ | ✔ | |
Model Validation | ✘ | ✘ | ✔ | ✔ | |
Dashboard Graphs | ✘ | ✔ | ✔ | ✔ | |
Plateau | ✘ | ✘ | ✔ | ✔ | |
Model Insights | ✘ | ✘ | ✔ | ✔ | |
Python API | |||||
Model Conversion | ✘ | ✔ | ✔ | ✔ |
For instructions on installing Wallaroo on a system with less than 16 cores, see the Install Wallaroo with Minimum Services.
Enterprise Network Requirements
The following network requirements are required for the minimum settings for running Wallaroo:
-
For Wallaroo Enterprise users: 200 IP addresses are required to be allocated per cloud environment.
-
For Wallaroo Community users: 98 IP addresses are required to be allocated per cloud environment.
-
DNS services integration is required for Wallaroo Enterprise edition. See the DNS Integration Guide for the instructions on configuring Wallaroo Enterprise with your DNS services.
DNS services integration is required to provide access to the various supporting services that are part of the Wallaroo instance. These include:
- Simplified user authentication and management.
- Centralized services for accessing the Wallaroo Dashboard, Wallaroo SDK and Authentication.
- Collaboration features allowing teams to work together.
- Managed security, auditing and traceability.
Environment Software Requirements
Running Wallaroo has two sets of software requirements:
- Environment Requirements: The following software must be installed on the environment that will be running Wallaroo version. Most are automatically available through the supported cloud providers.
- Kubernetes Version 1.18 to 1.23.
- Kubernetes Version
1.20
is the minimum requirement1.21
is preferred for versions of Wallaroo released before July 2022.1.22
:- Is preferred for versions of Wallaroo after the July 2022 release (code name Simca) and beyond.
- Is not supported for versions of Wallaroo released before July 2022.
1.23
:- Is the preferred version for Wallaroo version 2022.4.
- Is not supported for versions of Wallaroo released before Wallaroo version 2022.4.
- Kubernetes Version
- Runtime: containerd is required.
- Kubernetes Version 1.18 to 1.23.
- Kubernetes Admin Requirements: The following software must be installed in the system where the Kubernetes environment is being managed - aka where
kubectl
andkots
will be installed. This requires the following software be installed to manage the Kubernetes environment:kubectl
: https://kubernetes.io/docs/tasks/tools/- If using kots for installation:
- Version
1.91.3
: Preferred for Wallaroo versions 2022.4 and later. - Version
1.81.0
: Preferred for Wallaroo versions before 2022.4 and after the August 2022 release. - Version
1.70.1
: Preferred for versions of Wallaroo before the August 2022 release.
- Version
- If using helm for installation:
helm
: Install Helmkrew
: Install Krewkrew preflight
andkrew support-bundle
.
- If using kots for installation:
Environment Software Requirements
Running Wallaroo has two sets of software requirements:
- Environment Requirements: The following software must be installed on the environment that will be running Wallaroo version. Most are automatically available through the supported cloud providers.
- Kubernetes Version 1.18 to 1.23.
- Kubernetes Version
1.20
is the minimum requirement1.21
is preferred for versions of Wallaroo released before July 2022.1.22
:- Is preferred for versions of Wallaroo after the July 2022 release (code name Simca) and beyond.
- Is not supported for versions of Wallaroo released before July 2022.
1.23
:- Is the preferred version for Wallaroo version 2022.4.
- Is not supported for versions of Wallaroo released before Wallaroo version 2022.4.
- Kubernetes Version
- Runtime: containerd is required.
- Kubernetes Version 1.18 to 1.23.
- Kubernetes Admin Requirements: The following software must be installed in the system where the Kubernetes environment is being managed - aka where
kubectl
and eitherkots
orhelm
will be installed. This requires the following software be installed to manage the Kubernetes environment:kubectl
: https://kubernetes.io/docs/tasks/tools/- If using kots for installation:
- Version
1.91.3
: Preferred for Wallaroo versions 2022.4 and later. - Version
1.81.0
: Preferred for Wallaroo versions before 2022.4 and after the August 2022 release. - Version
1.70.1
: Preferred for versions of Wallaroo before the August 2022 release.
- Version
- If using helm for installation:
helm
: Install Helmkrew
: Install Krewkrew preflight
andkrew support-bundle
.
- If using kots for installation:
Node Selectors
Wallaroo uses different nodes for various services, which can be assigned to a different node pool to contain resources separate from other nodes. The following nodes selectors can be configured:
- ML Engine node selector
- ML Engine Load Balance node selector
- Database Node Selector
- Grafana node selector
- Prometheus node selector
- Each Lab * Node Selector
Cost Calculators
Organizations that intend to install Wallaroo into a Cloud environment can obtain an estimate of environment costs. The Wallaroo Install Guides list recommended virtual machine types and other settings that can be used to calculate costs for the environment.
For more information, see the pricing calculators for the following cloud services:
- Microsoft Azure Pricing Calculator
- Amazon Web Services Pricing Calculator
- Google Cloud Pricing Calculator
Kubernetes Admin Requirements
Before starting to install Wallaroo, the following requirements must be met at the local system level where Kubernetes commands are issued to the cluster:
- kubectl: This interfaces with the Kubernetes server created in the Wallaroo environment.
- If using kots for installation:
- Version
1.91.3
: Preferred for Wallaroo versions 2022.4 and later. - Version
1.81.0
: Preferred for Wallaroo versions before 2022.4 and after the August 2022 release. - Version
1.70.1
: Preferred for versions of Wallaroo before the August 2022 release.
- Version
- If using kots for installation:
The following are quick guides on how to install the required software to install and perform updates to Wallaroo. See the respective web sites for full installation information.
kubectl Quick Install Guide
The following are quick guides for installing kubectl
for different operating systems. For more details, see the instructions for your specific environment.
kubectl Install For Deb Package based Linux Systems
For users running a deb based package system such as Ubuntu Linux, the following commands will install kubectl
and kots
into the local system. They assume the user has sudo
level access to the system.
-
Update the
apt-get
repository:sudo apt-get update
-
Install the prerequisite software
apt-transport-https
,ca-certificates
, andcurl
.sudo apt-get install -y \ apt-transport-https \ ca-certificates curl
-
Download the install the Google Cloud repository key:
sudo curl -fsSLo \ /usr/share/keyrings/kubernetes-archive-keyring.gpg \ https://packages.cloud.google.com/apt/doc/apt-key.gpg
-
Install the Google Cloud repository into the local repository configuration:
echo "deb [signed-by=/usr/share/keyrings/kubernetes-archive-keyring.gpg] https://apt.kubernetes.io/ kubernetes-xenial main" \ | sudo tee /etc/apt/sources.list.d/kubernetes.list
-
Update the
apt-get
repository, then installkubectl
:sudo apt-get update
sudo apt-get install -y kubectl
-
Verify the
kubectl
installation:kubectl version --client
kubectl Install For macOS Using Homebrew
To install kubectl
on a macOS system using Homebrew:
-
Issue the
brew install
command:brew install kubectl
-
Verify the installation:
kubectl version --client
kots Quick Install Guide
The following are quick guides for installing kots
for different operating systems. For more details, see the instructions for your specific environment.
IMPORTANT NOTE
As of this time, Wallaroo <strong>requires</strong> <code>kots</code> version 1.91.3. Please verify that version is installed before starting the Wallaroo installation process.
-
Install
curl
.-
For deb based Linux systems, update the
apt-get
repository and installcurl
:sudo apt-get update sudo apt-get install curl
-
For macOS based systems
curl
is installed by default.
-
-
Install
kots
by downloading the script and piping it into thebash
shell:curl https://kots.io/install/1.91.3 | sudo bash
Manual Kots Install
A manual method to install KOTS is:
-
Download from https://github.com/replicatedhq/kots/releases/tag/v1.91.3. Linux and MacOS are supported.
-
Unpack the release
-
Rename the kots executable to kubectl-kots.
-
Copy the renamed kubectl-kots to anywhere on the PATH.
-
Next, verify successful installation.
~ kubectl kots version Replicated KOTS 1.91.3