Installing ezbrew¶
Note for MVP
ezbrew MVP has currently only been tested on a MacOS
Pre-requisites¶
Docker Desktop¶
ezbrew uses Docker to set up a local development environment where you can build and test your data pipelines.
Use the link to download and install docker desktop on your computer.Select the platform that best suits your computer for the downloadable.
Once downloaded, run through the installation wizard to install docker desktop on your computer. Detailed instructions can be found here for:
ezbrew installs a Kubernetes cluster using Docker Desktop within which an environmont is set up i.e. all the ingest, transform, quality, visualize, and orchestrate tools are installed. In order to accomodate all these tools, the below resources are required on Docker for optimal performance.
Recommended Docker Resources
Following resources are recommended: CPUs: 10, Memory: 16GB, Swap: 2.5 GB Lower resources can be allocated, however, over the course of time, could slow down the performance
Anaconda¶
We use Anaconda to manage virtual environments for python.
First, download the installer for your computer from here. Make sure you select the package that best suits your computer.
After the download, run through the installation wizard to install Anaconda on your computer. Detailed instructions can be found here for
Alternatives
You could also use an out-of-the-box python 3 or install python 3 version with a virtual environment package of your choice like pyenv, virtualenv, etc.
Kubernetes Related Packages¶
The following Kubernetes related packages are used to set up the local development environment kubernetes cluster
The easiest way to install these tools is by using a package manager like Homebrew on MacOS or Chocolatay on Windows.
kind¶
kind lets you run Kubernetes on your local computer. This tool requires that you have Docker installed and configured. Use these instructions to install kind.
kubectl¶
The Kubernetes command-line tool, kubectl, allows you to run commands against Kubernetes clusters. You can use kubectl to deploy applications, inspect and manage cluster resources, and view logs. For more information on details for installation can be found here and a complete list of kubectl operations, see the reference documentation.
helm¶
helm is the best way to find, share, and use software built for Kubernetes. Installation steps can be found here.
Installation Steps¶
Open your favorite terminal application on your computer and create an ezbrew workspace directory to house the application and all underlying ezbrew projects.
We have chosen to create the ezbrew-workspace directory in the HOME path. Select a path of your choice and replace all the below commands to point to the selected path.
Download the free version of the ezbrew application from here. <-- * <
Give execute permissions to executable
Add the executable to the PATH variable
Test ezbrew is successfully installed.
OPTIONAL: To avoid adding the executable path to the PATH variable everytime you open a new terminal, you can add the above export command to your bash profile and source your bash profile. ezbrew command should now work every time you open a new terminal.