Is go-marathon stable enough for production use?

No, the README notes it's under active development with frequent, possibly breaking API changes. It's best for development or projects that can handle updates, not mission-critical systems requiring stability.

How do I connect go-marathon to a Marathon cluster with multiple endpoints?

Specify a comma-separated list of URLs in the configuration. The library uses the first available endpoint and automatically fails over if it goes offline, with background pinging to detect recovery, as shown in the client creation example.

What's the difference between SSE and callback events in go-marathon?

SSE events use Server-Sent Events and work with Marathon >= 0.9.0 without extra setup. Callback events require starting a built-in web server for Marathon to push events to, adding configuration complexity for interface and port settings.

go-marathon vs writing my own Marathon client in Go – which is better?

Go-marathon saves time with a comprehensive, tested API abstraction, HA support, and event handling. Rolling your own client might be simpler for minimal needs, but you'll miss out on these features and the included fake implementation for testing.

How do I create and scale applications using go-marathon?

Use the DSL methods like `NewDockerApplication()` to define apps and `ScaleApplicationInstances()` to scale them, with helper functions like `WaitOnApplication`. The README has code snippets showing deployment from definition to scaling.

Does go-marathon support Marathon's pod feature?

Yes, it fully supports pods with methods for creation, scaling, and deletion using an idiomatic Go API. Examples are in the `examples/pods` directory and summarized in the README with snippets for pod management.

How can I mock Marathon API responses in tests with go-marathon?

Use the included fake Marathon implementation, which relies on YML-encoded response messages. You can define static or indexed responses and scopes to simulate API behaviors, as detailed in the Development section of the README.

go-marathon — Go Client for Marathon API

What is go-marathon?

Go-marathon is a comprehensive Go library for interacting with the Marathon container orchestration platform's REST API. It provides a native Go interface for managing applications, groups, and pods, simplifying the integration of Go applications with Marathon's deployment and orchestration features.

Target Audience

Go developers building tooling, services, or automation scripts that need to programmatically interact with a Marathon cluster for container orchestration.

Value Proposition

Developers choose go-marathon for its idiomatic Go API that abstracts Marathon's REST complexity, built-in high-availability support for multiple endpoints, and flexible event subscription handling via Server-Sent Events or callbacks.

A GO API library for working with Marathon

Use Cases

Best For

Building Go-based CLI tools or internal services to automate Marathon application deployments and scaling.
Developing custom operators or controllers in Go that need to react to Marathon events like application status updates.
Managing Marathon pods programmatically for deploying groups of co-located tasks from Go applications.
Integrating Marathon with existing Go infrastructure where custom HTTP clients with specific TLS or timeout configurations are required.
Creating high-availability Go clients that can automatically failover between multiple Marathon endpoints.
Writing tests for Marathon-related Go code using the included fake Marathon implementation for mocking API responses.

Not Ideal For

Production environments that require a stable, versioned API without breaking changes for long-term support.
Teams using container orchestration platforms other than Marathon, such as Kubernetes or Docker Swarm.
Simple automation scripts where direct HTTP calls to the Marathon REST API might be more lightweight and sufficient.
Setups where deploying a separate web server for event callback subscriptions is impractical or overly complex.

Pros & Cons

Pros

High-Availability Endpoint Support

Built-in support for multiple Marathon endpoints with automatic failover, as shown in the README's client configuration with comma-separated URLs and background pinging.

Flexible Event Subscriptions

Offers both Server-Sent Events (SSE) and callback-based event handling, allowing developers to choose based on Marathon version and setup, with detailed examples for each transport.

Comprehensive Pod Management

Includes full support for Marathon pods with idiomatic Go methods for creation, scaling, and deletion, as demonstrated in the pod examples and DSL snippets.

Custom HTTP Client Configuration

Allows independent configuration of HTTP clients for API and SSE connections with custom timeouts and TLS settings, detailed in the README's customization section.

Cons

Unstable API with Breaking Changes

The README explicitly warns that the library is under active development with frequent, possibly breaking API changes, making it risky for production systems needing stability.

Complex Event Callback Setup

Callback-based event subscriptions require configuring a built-in web server with specific interface and port settings, adding operational overhead compared to SSE or simpler approaches.

Marathon-Specific Lock-in

Tightly coupled to Marathon's API, so if you switch to a different orchestrator, the library becomes obsolete and requires significant code rewrites, limiting future flexibility.

Frequently Asked Questions

What is go-marathon?

Target Audience

Go developers building tooling, services, or automation scripts that need to programmatically interact with a Marathon cluster for container orchestration.

Value Proposition

Use Cases

Best For

Building Go-based CLI tools or internal services to automate Marathon application deployments and scaling.
Developing custom operators or controllers in Go that need to react to Marathon events like application status updates.
Managing Marathon pods programmatically for deploying groups of co-located tasks from Go applications.
Integrating Marathon with existing Go infrastructure where custom HTTP clients with specific TLS or timeout configurations are required.
Creating high-availability Go clients that can automatically failover between multiple Marathon endpoints.
Writing tests for Marathon-related Go code using the included fake Marathon implementation for mocking API responses.

Not Ideal For

Production environments that require a stable, versioned API without breaking changes for long-term support.
Teams using container orchestration platforms other than Marathon, such as Kubernetes or Docker Swarm.
Simple automation scripts where direct HTTP calls to the Marathon REST API might be more lightweight and sufficient.
Setups where deploying a separate web server for event callback subscriptions is impractical or overly complex.

Pros & Cons

Pros

High-Availability Endpoint Support

Built-in support for multiple Marathon endpoints with automatic failover, as shown in the README's client configuration with comma-separated URLs and background pinging.

Flexible Event Subscriptions

Offers both Server-Sent Events (SSE) and callback-based event handling, allowing developers to choose based on Marathon version and setup, with detailed examples for each transport.

Comprehensive Pod Management

Includes full support for Marathon pods with idiomatic Go methods for creation, scaling, and deletion, as demonstrated in the pod examples and DSL snippets.

Custom HTTP Client Configuration

Allows independent configuration of HTTP clients for API and SSE connections with custom timeouts and TLS settings, detailed in the README's customization section.

Cons

Unstable API with Breaking Changes

The README explicitly warns that the library is under active development with frequent, possibly breaking API changes, making it risky for production systems needing stability.

Complex Event Callback Setup

Callback-based event subscriptions require configuring a built-in web server with specific interface and port settings, adding operational overhead compared to SSE or simpler approaches.

Marathon-Specific Lock-in

Tightly coupled to Marathon's API, so if you switch to a different orchestrator, the library becomes obsolete and requires significant code rewrites, limiting future flexibility.

Frequently Asked Questions

go-marathon

What is go-marathon?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

go-marathon

What is go-marathon?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?