Helm

Installing Siglens using Helm

This comprehensive guide will help you install SigLens on your local Minikube Kubernetes cluster using Helm. Helm simplifies the deployment of Kubernetes applications, making it a breeze to set up SigLens.

Helm streamlines SigLens deployment on Kubernetes, offering a standardized, scalable, and version-controlled approach. Ideal for Kubernetes users, it simplifies installation as a Kubernetes package, providing templating and packaging for easy configuration and sharing within Kubernetes-native environments.

Quickstart

This is a quickstart if you are already familiar with the prerequisites and have the setup ready. For a detailed installation guide, refer Step-by-Step Installation Guide.

Install SigLens using Helm

helm repo add siglens-repo https://siglens.github.io/charts
helm repo update

Port forward the ingestion and query server

helm install siglens siglens-repo/siglens
kubectl port-forward svc/siglens-ingest-svc 8081:8081
kubectl port-forward svc/siglens-query-svc 5122:5122

Access the SigLens UI at: http://localhost:5122.

Prerequisites

Before installing SigLens, ensure you have the following tools installed on your system:

• Helm CLI
• Docker
• Minikube
• Kubernetes command-line interface (kubectl)

Step-by-Step Installation Guide

Step 1: Installing Minikube

Minikube is a tool that helps you set up a single-node Kubernetes cluster within a virtual machine on your local system.

• Follow the instructions here to install Minikube using a package manager or the official installation guide.

Step 2: Installing Docker, kubectl and Helm

Before proceeding, ensure you have both kubectl and Helm CLI installed. Open your terminal and check the versions of Docker, kubectl, and Helm:

To install Docker, kubectl, and Helm on different operating systems, you can use the following commands:

Windows

Docker:

Download and install Docker Desktop from the official Docker website: Docker Desktop for Windows

kubectl:

You can install kubectl on Windows using the following PowerShell command:

curl -LO https://storage.googleapis.com/kubernetes-release/release/v1.22.2/bin/windows/amd64/kubectl.exe
Move-Item -Path .\kubectl.exe -Destination C:\Windows\System32\kubectl.exe

Helm:

• Installing Helm on Windows
• Go to the Helm releases page at https://github.com/helm/helm/releases.
• Download the latest Windows executable file (ending with ".exe").
• Double-click the downloaded file to start the installation wizard.
• Follow the prompts to complete the installation.

MacOS

We will be installing Docker, kubectl and Helm using Homebrew. If you don’t have Homebrew on you MacOS, use the command below:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

Proceed to installing Docker, kubectl and Helm, once Homebrew has been installed.

Docker:

You can install Docker on MacOS using Homebrew:

brew install --cask docker

Alternatively, you may also install Docker Desktop from the official Docker website: Docker Desktop for Mac

kubectl:

You can install kubectl on MacOS using Homebrew:

brew install kubectl

Helm:

You can install Helm on MacOS using Homebrew as well:

1. Once Homebrew is installed, run the following command to install Helm:

brew install helm

Linux

Docker:

1. Set up Docker's apt repository.

# Add Docker's official GPG key:
sudo apt-get update
sudo apt-get install ca-certificates curl
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc

# Add the repository to Apt sources:
echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
  $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update

2. Install the Docker packages: To install the latest version, run:

sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

Alternatively, install Docker on Linux by following the official Docker installation guide for your Linux distribution at Docker Installation Guide

kubectl:

You can install kubectl on Linux using the following commands:

sudo apt-get update && sudo apt-get install -y kubectl   # For Debian/Ubuntu

Or for other package managers, refer to the official Kubernetes documentation: Install kubectl

Helm:

Ubuntu/Debian

Open a terminal window, Run the following commands to download and install Helm:

curl https://baltocdn.com/helm/signing.asc | sudo apt-key add -
sudo apt-get install apt-transport-https --yes
echo "deb https://baltocdn.com/helm/stable/debian/ all main" | sudo tee /etc/apt/sources.list.d/helm-stable-debian.list
sudo apt-get update
sudo apt-get install helm

Red Hat/CentOS/Fedora Open a terminal window. Run the following commands to download and install Helm:

sudo curl -fsSL -o /etc/yum.repos.d/helm.repo https://baltocdn.com/helm/stable/rpm/helm.repo
sudo yum install helm

Note: Make sure to check for the latest versions on the respective official websites or package managers. And follow any additional commands as required in the official documentation

Step 3: Starting Minikube

Now that we have Minikube, kubectl, and Helm installed, let's start our Minikube cluster. In your terminal, enter the following command:

minikube start

This command initializes Minikube, and it may take a few minutes as it downloads dependencies and sets up the cluster. Once the initialization is complete, you should see output similar to the following:

😄  minikube v1.30.1 on Darwin 12.6 (arm64)
✨  Using the docker driver based on existing profile
👍  Starting control plane node minikube in cluster minikube
🚜  Pulling base image ...
🏃  Updating the running docker "minikube" container ...
🐳  Preparing Kubernetes v1.26.3 on Docker 23.0.2 ...
🔎  Verifying Kubernetes components...
    ▪ Using image gcr.io/k8s-minikube/storage-provisioner:v5
🌟  Enabled addons: storage-provisioner, default-storageclass
🏄  Done! kubectl is now configured to use "minikube" cluster and "default" namespace by default

To verify the status of your Minikube cluster, run:

minikube status

You should see a status indicating that the cluster is running.

minikube
type: Control Plane
host: Running
kubelet: Running
apiserver: Running
kubeconfig: Configured

Run kubectl get nodes to make sure that the minikube node is up and running.

Step 4: Adding SigLens Helm Repository

To get started, add the SigLens Helm repository to your Helm configuration:

helm repo add siglens-repo https://siglens.github.io/charts

Update the Helm repository to ensure you have the latest charts:

helm repo update

Step 5: Installing SigLens

With everything set up, it's time to install SigLens. Use Helm to install the latest version of the SigLens Helm chart:

helm install siglens siglens-repo/siglens

Once the installation is complete, you'll see an output similar to this example:

NAME: siglens
LAST DEPLOYED: Fri Jun 16 16:43:51 2023
NAMESPACE: default
STATUS: deployed
REVISION: 1
NOTES:
Thank you for installing siglens.
To learn more about the release, try:
  $ helm status siglens
To run tests, try:
  $ helm test siglens
...

Step 6: Accessing SigLens

SigLens is now installed in your local Minikube cluster. To access the SigLens UI, follow these steps:

1. Forward local port 8081 to the ingest service using:

kubectl port-forward svc/siglens-ingest-svc 8081:8081

2. Get data in SigLens by loading sample data, using our supported ingestion methods, or integrating with your existing tools. Forward local port 8000 to the UI / query service using:

kubectl port-forward svc/siglens-query-svc 5122:5122

3. Open your web browser and navigate to: http://localhost:5122 to access the SigLens UI.

Step 7: Clean Up

Once you've finished working with SigLens, you can stop and delete your Minikube cluster to free up resources, all the configuration files and other data related to the Minikube cluster stored on your system:

• Stop the cluster

minikube stop

• Delete the cluster

minikube delete

Before deleting, it's recommended to stop the cluster using minikube stop. Otherwise, the deletion might fail.

Next Steps

Log Ingestion

Explore the features and functionalities of SigLens within your Minikube environment. If you encounter any issues or have questions, refer to the documentation or join the SigLens community for assistance.