Skip to content

dev-toolsets.md

Latest commit

 

History

History
174 lines (130 loc) · 4.66 KB

dev-toolsets.md

File metadata and controls

174 lines (130 loc) · 4.66 KB
Raw
Back To Main

🛠 Development Toolsets used in Sandbox

Development toolsets used and their purposes:

⚙️ Core Development Tools

Go (Golang)

  • Version: 1.25.10
  • Uses:
    • Building Symphony API server
    • Building Maestro CLI tool
    • Building Workload Fleet Management Client applications
    • Go module management and dependencies

Docker & Docker Compose

  • Version: Docker Compose V2
  • Uses:
    • Container orchestration for services
    • Building and running Workload Fleet Management Client containers
    • Running Symphony API as containerized service
    • Managing multi-container applications (Harbor, Observability stack)

Rust

  • Uses:
    • Building Rust components in Symphony API
    • Compiling providers in /symphony/api/pkg/apis/v1alpha1/providers/target/rust

🧭 Container Orchestration & Kubernetes

K3s (Lightweight Kubernetes)

  • Uses:
    • Running Workload Fleet Management Client pods with ServiceAccount authentication
    • Container orchestration for production workloads
    • RBAC and security management

Helm

  • Version: 3.15.1
  • Uses:
    • Package management for Kubernetes applications
    • Deploying Workload Fleet Management Client and workload charts
    • Managing observability stack (Prometheus, Grafana, Jaeger, Loki)
    • Installing OTEL Collector and Promtail

kubectl

  • Uses:
    • Kubernetes cluster management
    • Pod and service administration
    • ConfigMap and Secret management

📦 Container Registry & Repository Management

Harbor

  • Uses:
    • Private container registry
    • Storing and managing Docker images and helm artefacts
    • Image security scanning and vulnerability management
    • Management of workload packages as per MARGO defined specification
    • Nextcloud, Nginx and Custom OTEL workload packages are uploaded to Harbor while environment setup. These Margo Packages are based on MARGO application description specification
    • API-based repository creation and management

📈 Observability & Monitoring Stack

Prometheus

  • Uses:
    • Metrics collection and storage
    • Scraping OTEL Collector metrics
    • Time-series database for monitoring

Grafana

  • Uses:
    • Metrics visualization and dashboards
    • Data source integration with Prometheus and Loki

Jaeger

  • Uses:
    • Distributed tracing
    • OTLP (OpenTelemetry Protocol) support
    • Performance monitoring and debugging

Loki

  • Uses:
    • Log aggregation and storage
    • Centralized logging solution
    • Receives logs via Promtail

OTEL Collector (OpenTelemetry)

  • Uses:
    • Telemetry data collection (metrics, traces)
    • Data processing and forwarding
    • Integration with observability backends

Promtail

  • Uses:
    • Log shipping agent
    • Pushing logs from Kubernetes pods to Loki

🔐 Security & Authentication

OpenSSL

  • Uses:
    • Root CA certificate generation (MIS Minting and Normative Server)

🧰 Build & Development Utilities

Git

  • Uses:
    • Source code version control
    • Repository cloning and branch management
    • Integration with GitHub private repositories

npm

  • Uses:

    • Building Symphony UI components
    • JavaScript dependency management

    Note: Symphony UI is not used. Application, deployment and workload LCM operations are performed using the script /scripts/wfm-cli.sh which we call it as EasyCLI implemented as a wrapper on top of Maestro CLI

curl & wget

  • Uses:
    • HTTP requests and API testing
    • Downloading installation packages
    • Service health checks

jq

  • Uses:
    • JSON parsing and manipulation
    • API response processing

🖥 System Utilities

dos2unix

  • Uses:
    • Converting line endings for cross-platform compatibility

build-essential, gcc, libc6-dev

  • Uses:
    • Compilation toolchain for building native applications
    • C/C++ development dependencies

📦 Workload Packages

Nextcloud

  • Uses:
    • File sharing and collaboration platform
    • Test application for deployment scenarios

📡 Custom OTEL Application

  • Uses:

    • Custom telemetry application.

    • Test application for deploying a custom application with telemetry capabilities.

    • This is a sample online ordering application written in GO language which sends metrics and traces to OpenTelemetry collector. This application is defined as MARGO-specified application package and deployed as a workload on device along with the collector. The MARGO package and application source code is available at Custom OTEL

    • Demonstration of observability integration