Skip to content

Latest commit

 

History

History
92 lines (71 loc) · 3.24 KB

index.md

File metadata and controls

92 lines (71 loc) · 3.24 KB

Flame API Reference

This document provides the API reference for Flame's gRPC services.

Services Overview

Flame exposes three gRPC services:

Service Description Proto File
Frontend Client-facing API for sessions, tasks, and applications frontend.proto
Backend Executor-facing API for node and executor management backend.proto
Instance Application instance lifecycle management shim.proto

Quick Links

Package

All services and messages are defined in the flame.v1 package.

package flame.v1;

Metadata storage

The session manager supports filesystem storage and none (in memory). Filesystem is the default: cluster.storage: "fs://data". Relative filesystem paths resolve beneath FLAME_HOME; use fs:///absolute/path for an absolute path. The file:// and filesystem:// aliases are also supported.

none retains records only for the current process and starts empty after a restart. SQLite storage URLs and the flmctl migrate command are no longer supported. Existing SQLite databases are not converted or deleted; configure filesystem storage for a new durable store.

Authentication

Flame supports TLS for secure communication. Configure TLS certificates in your client configuration:

current-context: flame
contexts:
  - name: flame
    cluster:
      endpoint: "https://flame-session-manager:8080"
      tls:
        ca_file: "/etc/flame/certs/ca.crt"
        cert_file: "/etc/flame/certs/client.crt"
        key_file: "/etc/flame/certs/client.key"
    cache:
      endpoint: "grpcs://flame-object-cache:9090"
      tls:
        ca_file: "/etc/flame/certs/ca.crt"
        cert_file: "/etc/flame/certs/client.crt"
        key_file: "/etc/flame/certs/client.key"

Client TLS also supports ca_data, cert_data, and key_data containing base64-encoded PEM, allowing a self-contained configuration. Each credential can use a file or embedded data; conflicting sources and incomplete identities are rejected. See Portable TLS Configuration for a shared flmctl/Rust/Flamepy example and encoding instructions.

Error Handling

gRPC status codes are used for error reporting:

Code Description
OK Operation succeeded
NOT_FOUND Resource not found
ALREADY_EXISTS Resource already exists
INVALID_ARGUMENT Invalid request parameters
FAILED_PRECONDITION Operation not allowed in current state
INTERNAL Internal server error

Related Documentation