services

package
v0.28.0-alpha2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 21, 2026 License: MIT Imports: 89 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildLocalK8sConfig added in v0.21.0

func BuildLocalK8sConfig() (*rest.Config, error)

BuildLocalK8sConfig creates a Kubernetes config for local cluster access

func SetupLogBridges added in v0.26.0

func SetupLogBridges()

SetupLogBridges routes the loggers dependencies use into the current slog default. It must run after the slog handler is installed - logr captures the handler here, so an earlier call pins the wrong one.

The klog and controller-runtime wiring is permanent; the Kubernetes libraries always log through klog. The nah and logrus pieces are interception, needed only until nah and kinm migrate to slog themselves.

Types

type AuditConfig added in v0.8.0

type AuditConfig audit.Options

type Config

type Config struct {
	GitMaxRepoSizeMB                               int      `usage:"Maximum git repository size in MB" default:"100" name:"git-max-repo-size-mb"`
	ModelProxyURL                                  string   `usage:"MCP Tester model proxy base URL; empty disables the model proxy" default:"https://model-service.obot.ai"`
	HTTPListenPort                                 int      `usage:"HTTP port to listen on" default:"8080" name:"http-listen-port"`
	AllowedOrigin                                  string   `usage:"Allowed origin for CORS"`
	ProviderRegistries                             []string `usage:"Local filesystem paths to provider registries (directories) to load providers from"`
	EnableAuthentication                           bool     `usage:"Enable authentication" default:"false"`
	AuthAdminEmails                                []string `usage:"Emails of admin users"`
	AuthOwnerEmails                                []string `usage:"Emails of owner users"`
	LocalAuthInitialOwnerEmail                     string   `usage:"Email address for the initial local-auth owner" env:"OBOT_SERVER_LOCAL_AUTH_INITIAL_OWNER_EMAIL"`
	LocalAuthInitialOwnerSetupToken                string   `usage:"High-entropy setup token for the initial local-auth owner" env:"OBOT_SERVER_LOCAL_AUTH_INITIAL_OWNER_SETUP_TOKEN"`
	LocalAuthInitialOwnerSetupTokenExpirationHours int      `` /* 153-byte string literal not displayed */
	TunnelPeerID                                   string   `usage:"Unique Pod UID of this Obot replica for tunnel peering"`
	TunnelPeerToken                                string   `usage:"Shared internal credential for tunnel peering"`

	MCPOAuthClientExpiration       string                `` /* 158-byte string literal not displayed */
	MCPOAuthClientNativeExceptions []string              `` /* 128-byte string literal not displayed */
	ForceDynamicClient             bool                  `usage:"Force Dynamic Client Registration for MCP OAuth instead of Client ID Metadata Documents"`
	ProductAnalyticsMode           producttelemetry.Mode `usage:"Product analytics mode: consent, on, or off" default:"consent" env:"OBOT_SERVER_PRODUCT_ANALYTICS_MODE"`

	DevMode              bool   `usage:"Enable development mode" default:"false" name:"dev-mode" env:"OBOT_DEV_MODE"`
	DevUIPort            int    `usage:"The port on localhost running the dev instance of the UI" default:"5174"`
	UserUIPort           int    `usage:"The port on localhost running the user production instance of the UI" env:"OBOT_SERVER_USER_UI_PORT"`
	ElectionFile         string `usage:"Use this file for leader election instead of database leases"`
	ForceEnableBootstrap bool   `usage:"Enables the bootstrap user even if other admin users have been created" default:"false"`
	MetricsBearerToken   string `usage:"Bearer token for metrics endpoint authentication" name:"metrics-bearer-token"`

	DefaultMCPCatalogPath       string `usage:"The path to the default MCP catalog (accessible to all users)" default:""`
	DefaultSystemMCPCatalogPath string `usage:"The path to the default System MCP catalog" default:""`
	MDMAssetSource              string `` /* 233-byte string literal not displayed */
	DefaultSkillRepoURL         string `` /* 151-byte string literal not displayed */
	DefaultSkillRepoRef         string `usage:"The ref (branch/tag) for the default skill repository" default:"" env:"OBOT_DEFAULT_SKILL_REPO_REF"`
	DisableUpdateCheck          bool   `usage:"Disable Obot server update checks"`
	HideK8sDetails              bool   `usage:"Hide Kubernetes configuration details such as the Server Scheduling page from the UI" default:"false"`
	EnableRegistryAuth          bool   `usage:"Enable authentication for the MCP registry API" default:"false" env:"OBOT_SERVER_ENABLE_REGISTRY_AUTH"`
	EgressAuditLogRetentionDays int    `usage:"Days to retain egress audit logs (0 disables cleanup)." default:"90"`
	LLMAuditLogRetentionDays    int    `usage:"Number of days to retain LLM audit logs (0 to disable cleanup)." default:"90"`
	DisableLLMAuditLog          bool   `usage:"Disable LLM gateway audit logging" default:"false"`
	LLMGatewayDataDir           string `` /* 219-byte string literal not displayed */
	LLMGatewayPostgresDSN       string `` /* 296-byte string literal not displayed */
	LLMGatewayEncryptionKey     string `` /* 348-byte string literal not displayed */
	LLMGatewayLogLevel          string `` /* 157-byte string literal not displayed */
	LLMGatewayModelDataURL      string `` /* 276-byte string literal not displayed */
	DeviceScanRetentionDays     int    `usage:"Number of days to retain submitted device scans (0 to disable cleanup)." default:"90"`
	SubstrateRunnerImage        string `` /* 193-byte string literal not displayed */
	SubstrateWorkerImage        string `usage:"Default Substrate worker image for new environments"`
	SubstrateWorkerNodeSelector string `usage:"JSON node selector applied to all Substrate workers" default:"{\"kubernetes.io/os\":\"linux\"}"`
	SubstrateWorkerTolerations  string `` /* 171-byte string literal not displayed */
	SubstrateNamespace          string `usage:"Namespace for Claude environment worker pools" default:"obot-agents"`
	SubstrateAddress            string `usage:"Substrate gRPC address; empty disables Claude environments"`
	SubstrateSnapshotLocation   string `usage:"Substrate snapshot bucket URI"`
	SubstrateObotURL            string `usage:"Obot URL reachable from actors; defaults to server URL"`

	MCPNetworkPolicyProviderChartRepo    string `usage:"Helm repository URL for the network policy provider chart"`
	MCPNetworkPolicyProviderChartName    string `usage:"Helm chart name for the network policy provider chart"`
	MCPNetworkPolicyProviderChartVersion string `usage:"Helm chart version for the network policy provider chart"`
	MCPNetworkPolicyProviderChartPath    string `usage:"Local filesystem path to the network policy provider chart"`
	MCPNetworkPolicyProviderValues       string `usage:"YAML or JSON values blob merged into the network policy provider chart values"`
	MCPDefaultDenyAllEgress              bool   `usage:"Default new MCP servers to deny all egress when network policy enforcement is enabled" default:"false"`

	GatewayConfig
	EncryptionConfig
	AuditConfig
	RateLimiterConfig
	MCPConfig
	LicenseConfig
	storageservices.Config
}

type EncryptionConfig added in v0.8.0

type EncryptionConfig encryption.Options

type GatewayConfig

type GatewayConfig gserver.Options

type LicenseConfig added in v0.23.0

type LicenseConfig license.Config

type MCPConfig added in v0.8.0

type MCPConfig mcp.Options

type RateLimiterConfig added in v0.8.0

type RateLimiterConfig ratelimiter.Options

type Services

type Services struct {
	GitMaxRepoSizeMB      int
	EncryptionConfig      *encryptionconfig.EncryptionConfiguration
	StorageClient         storage.Client
	StorageDB             *kinmdb.Factory
	Router                *router.Router
	PersistentTokenServer *persistent.TokenService
	APIServer             *server.Server
	GatewayClient         *client.Client
	ProxyManager          *proxy.Manager
	ProviderDispatcher    *dispatcher.Dispatcher
	Otel                  *otel.Otel
	AuditLogger           audit.Logger
	DSN                   string
	ServerURL             string
	// LocalServerURL is Obot's address as Obot itself can reach it, which differs
	// from ServerURL when the public port is mapped by a Service or ingress.
	LocalServerURL    string
	MCPSessionManager *mcp.SessionManager
	TunnelManager     *tunnel.Manager
	OAuthServerConfig handlers.OAuthAuthorizationServerConfig

	// Global token storage client for MCP OAuth
	MCPOAuthTokenStorage         mcp.GlobalTokenStore
	MCPSecretBindingAllowedLabel string
	RegistryNoAuth               bool

	PostgresDSN           string
	ProviderRegistryPaths []string
	DevUIPort             int
	DevMode               bool
	UserUIPort            int
	GatewayServer         *gserver.Server
	Bootstrapper          *bootstrap.Bootstrap
	LocalAuthProvider     *localauth.Provider
	// BifrostEngine is the embedded LLM gateway.
	BifrostEngine *llmengine.Engine
	// GuardrailEngine checks LLM gateway traffic and MCP tool calls.
	GuardrailEngine             *guardrails.Engine
	AuthEnabled                 bool
	DefaultMCPCatalogPath       string
	DefaultSystemMCPCatalogPath string
	MDMAssetSource              string
	DefaultSkillRepoURL         string
	DefaultSkillRepoRef         string

	// Used for indexed lookups of access control rules.
	AccessControlRuleHelper *accesscontrolrule.Helper

	// Used for indexed lookups of model access policies.
	ModelAccessPolicyHelper *modelaccesspolicy.Helper

	// Used for indexed lookups of skill access rules.
	SkillAccessRuleHelper *skillaccessrule.Helper

	MCPOAuthClientSecretExpiration time.Duration
	MCPOAuthClientNativeExceptions []string
	ForceDynamicClient             bool
	ProductTelemetryConsent        *producttelemetry.Consent
	ProductTelemetryPublisher      *producttelemetry.Publisher

	// LocalK8sClient is a kclient for the local Kubernetes cluster — the
	// cluster the obot pod runs in, where source Secrets for
	// secretBindings live. Nil on the docker backend.
	LocalK8sClient            kclient.Client
	LocalRouter               *router.Router
	K8SEveryReplicaRouter     *router.Router
	EveryReplicaRouter        *router.Router
	MCPServerNamespace        string
	ServiceAccountIssuerURL   string
	ServiceAccountIssuerError string
	MCPClusterDomain          string
	ServiceName               string
	ServiceNamespace          string
	ServiceAccountName        string
	StorageListenPort         int

	// ObotNamespace is the Kubernetes namespace in which the obot server
	// runs; mcp.MergeBoundCreds reads source Secrets from here.
	ObotNamespace string

	// Parsed settings from Helm for k8s to pass to controller
	// PodSchedulingSettingsFromHelm contains affinity, tolerations, resources, runtimeClassName
	// when explicitly set via Helm. If non-nil, SetViaHelm=true and UI cannot modify these.
	PodSchedulingSettingsFromHelm *v1.K8sSettingsSpec
	// PSASettingsFromHelm contains Pod Security Admission settings, always sourced from
	// environment/Helm config and not modifiable via UI.
	PSASettingsFromHelm *v1.PodSecurityAdmissionSettings

	HideK8sDetails                       bool
	MCPRuntimeBackend                    string
	MCPImagePullSecrets                  []string
	MCPHTTPWebhookBaseImage              string
	MCPNetworkPolicyEnabled              bool
	MCPDefaultDenyAllEgress              bool
	Substrate                            *substrate.Client
	MCPNetworkPolicyProviderChartRepo    string
	MCPNetworkPolicyProviderChartName    string
	MCPNetworkPolicyProviderChartVersion string
	MCPNetworkPolicyProviderChartPath    string
	MCPNetworkPolicyProviderValues       string
	SingleUserIdleServerShutdownInterval time.Duration
	MultiUserIdleServerShutdownInterval  time.Duration

	// License provider
	LicenseProvider *license.Provider
	VersionChecker  *upgrade.VersionChecker

	ModelProxyConfiguredURL string
	ModelProxyURL           *url.URL
}

func New

func New(ctx context.Context, config Config) (*Services, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL