OneLens Installation Scripts

Simplified Kubernetes cost optimization and monitoring deployment

📋 Overview

OneLens Installation Scripts provides automated deployment tools for setting up comprehensive Kubernetes cost monitoring and optimization infrastructure. This repository contains Helm charts and automation scripts to deploy OneLens agents and supporting monitoring stack.

🏗️ Components

🚀 OneLens Deployer

A Kubernetes job orchestrator that handles the initial setup and configuration of OneLens infrastructure in your cluster.

Features:

• One-time setup jobs
• Cluster configuration automation
• Cross-platform Docker images (AMD64/ARM64)

📊 OneLens Agent

The core monitoring agent that collects cost and resource utilization data from your Kubernetes cluster.

Includes:

• OneLens Agent: Main cost monitoring and optimization agent
• Prometheus: Metrics collection and storage
• OpenCost Exporter: Kubernetes cost metrics calculation
• Custom Storage Classes: Optimized storage configurations

🚀 Quick Start

Prerequisites

• Kubernetes cluster (1.25+)
• Helm 3.0+
• kubectl configured for your cluster

Installation

1. Add the OneLens Helm repository:

   helm repo add onelens https://astuto-ai.github.io/onelens-installation-scripts/
   helm repo update

2. Deploy OneLens Deployer:

   helm upgrade --install onelensdeployer onelens/onelensdeployer \
     --set job.env.CLUSTER_NAME=your-cluster-name \
     --set job.env.REGION=your-aws-region \
     --set-string job.env.ACCOUNT=your-aws-account-id \
     --set job.env.REGISTRATION_TOKEN="your-registration-token"

3. Deploy OneLens Agent:

   helm upgrade --install onelens-agent onelens/onelens-agent \
     --namespace onelens-system \
     --create-namespace

Configuration

OneLens Deployer Configuration

Parameter	Description	Default
job.env.CLUSTER_NAME	Your Kubernetes cluster name	""
job.env.REGION	AWS region where cluster is located	""
job.env.ACCOUNT	AWS account ID	""
job.env.REGISTRATION_TOKEN	OneLens registration token	""

OneLens Agent Configuration

Parameter	Description	Default
onelens-agent.enabled	Enable OneLens agent	true
prometheus.enabled	Enable Prometheus monitoring	true
prometheus-opencost-exporter.enabled	Enable cost metrics	true
onelens-agent.cronJob.cronSchedule	Data collection schedule	"0 * * * *"

📚 Documentation

• 🏗️ CI/CD Architecture - Complete CI/CD pipeline documentation
• ⚡ Quick Reference - Fast commands and troubleshooting
• 📖 Release Process - How to create new releases
• 🔄 CI/CD Flow - Understanding the automation pipeline
• ⚙️ Configuration Guide - Detailed configuration options
• 🔧 Development Guide - Contributing and development setup

🛠️ Scripts & Tools

• 🔍 Pre-requisite Checker - Automated environment validation script
• 📦 Tools Installation Guide - Step-by-step installation for required tools

🔄 Architecture

graph TB
    subgraph "OneLens Installation"
        A[OneLens Deployer] --> B[Cluster Setup]
        B --> C[OneLens Agent Deployment]
    end
    
    subgraph "Monitoring Stack"
        C --> D[OneLens Agent]
        D --> E[Prometheus]
        D --> F[OpenCost Exporter]
        E --> G[Metrics Storage]
        F --> G
    end
    
    subgraph "Data Flow"
        G --> H[Cost Analysis]
        H --> I[OneLens Platform]
    end

Loading

🏷️ Versioning

This project follows Semantic Versioning. Version history and release notes are available in:

• OneLens Agent Versions
• Release Tags

🤝 Contributing

We welcome contributions! Please see our Development Guide for details on:

• Setting up development environment
• Running tests
• Submitting pull requests

📞 Support

• 📧 Email: [email protected]
• 📖 Documentation: OneLens Docs
• 🐛 Issues: GitHub Issues

🚀 What's Next?

After installation, your cluster will be monitored by OneLens. Visit the OneLens platform to:

• View real-time cost analytics
• Get optimization recommendations
• Set up cost alerts and budgets
• Analyze resource utilization trends

---

Made with ❤️ by the OneLens Team