Skip to content

README.md

Latest commit

 

History

History
65 lines (42 loc) · 2.6 KB

README.md

File metadata and controls

65 lines (42 loc) · 2.6 KB

Agones Headlamp Plugin

⚠️ Early Development This plugin is under active development as part of the LFX Mentorship programme. APIs and features may change between releases. Manual installation is currently required.

A Headlamp plugin to visualise Agones resources and workflows directly in your Kubernetes UI.

Agones is an open-source, batteries-included, multiplayer dedicated game server scaling and orchestration platform built on Kubernetes.

Features

The plugin currently provides the following capabilities:

  • Overview — At-a-glance summary of your Agones resources across the cluster.
  • Fleets — List and detail views for Agones Fleet resources, including replica status and scaling controls.
  • Game Servers — List and detail views for individual GameServer resources, with state chips and pod previews.
  • Fleet Autoscalers — List and detail views for FleetAutoscaler resources, including autoscaler status.
  • Map View — Visual graph showing relationships between Fleets, Game Servers, and Pods.
  • Allocations — Allocate game servers directly from the UI via an allocation dialog.

Prerequisites

  • Headlamp installed and running (desktop app or in-cluster).
  • Agones installed in your Kubernetes cluster.

Installation (Manual)

This plugin is not yet published to any registry. To install it manually:

  1. Build the plugin:

    npm install
npm run build

  2. Copy the built plugin to your Headlamp plugins directory.

    For the Headlamp desktop app, the plugins directory is typically:

    • Linux: ~/.config/Headlamp/plugins/
    • macOS: ~/Library/Application Support/Headlamp/plugins/
    • Windows: %APPDATA%\Headlamp\plugins\
    mkdir -p ~/.config/Headlamp/plugins/agones-plugin
cp -r dist/* ~/.config/Headlamp/plugins/agones-plugin/

  3. Restart Headlamp. The Agones section will appear in the sidebar.

Development

This plugin follows the standard Headlamp plugin development workflow. See the Headlamp Plugin Getting Started guide for full instructions.

Contributing

See CONTRIBUTING.md for development setup, CI checks, and pull request guidelines.

License

Apache 2.0