Juergen Kunz
8ebd677478
- Added base interface and abstract class for platform service providers. - Created MinIOProvider class for S3-compatible storage with deployment, provisioning, and deprovisioning functionalities. - Implemented MongoDBProvider class for MongoDB service with similar capabilities. - Introduced error handling utilities for better error management. - Developed TokensComponent for managing registry tokens in the UI, including creation, deletion, and display of tokens.
124 lines
3.5 KiB
TypeScript
124 lines
3.5 KiB
TypeScript
/**
|
|
* Base interface and types for platform service providers
|
|
*/
|
|
|
|
import type {
|
|
IService,
|
|
IPlatformService,
|
|
IPlatformResource,
|
|
IPlatformServiceConfig,
|
|
IProvisionedResource,
|
|
IEnvVarMapping,
|
|
TPlatformServiceType,
|
|
TPlatformResourceType,
|
|
} from '../../../types.ts';
|
|
import type { Onebox } from '../../onebox.ts';
|
|
|
|
/**
|
|
* Interface that all platform service providers must implement
|
|
*/
|
|
export interface IPlatformServiceProvider {
|
|
/** Unique identifier for this provider type */
|
|
readonly type: TPlatformServiceType;
|
|
|
|
/** Human-readable display name */
|
|
readonly displayName: string;
|
|
|
|
/** Resource types this provider can provision */
|
|
readonly resourceTypes: TPlatformResourceType[];
|
|
|
|
/**
|
|
* Get the default configuration for this platform service
|
|
*/
|
|
getDefaultConfig(): IPlatformServiceConfig;
|
|
|
|
/**
|
|
* Deploy the platform service container
|
|
* @returns The container ID
|
|
*/
|
|
deployContainer(): Promise<string>;
|
|
|
|
/**
|
|
* Stop the platform service container
|
|
*/
|
|
stopContainer(containerId: string): Promise<void>;
|
|
|
|
/**
|
|
* Check if the platform service is healthy and ready to accept connections
|
|
*/
|
|
healthCheck(): Promise<boolean>;
|
|
|
|
/**
|
|
* Provision a resource for a user service (e.g., create database, bucket)
|
|
* @param userService The user service requesting the resource
|
|
* @returns Provisioned resource with credentials and env var mappings
|
|
*/
|
|
provisionResource(userService: IService): Promise<IProvisionedResource>;
|
|
|
|
/**
|
|
* Deprovision a resource (e.g., drop database, delete bucket)
|
|
* @param resource The resource to deprovision
|
|
*/
|
|
deprovisionResource(resource: IPlatformResource, credentials: Record<string, string>): Promise<void>;
|
|
|
|
/**
|
|
* Get the environment variable mappings for this provider
|
|
*/
|
|
getEnvVarMappings(): IEnvVarMapping[];
|
|
}
|
|
|
|
/**
|
|
* Base class for platform service providers with common functionality
|
|
*/
|
|
export abstract class BasePlatformServiceProvider implements IPlatformServiceProvider {
|
|
abstract readonly type: TPlatformServiceType;
|
|
abstract readonly displayName: string;
|
|
abstract readonly resourceTypes: TPlatformResourceType[];
|
|
|
|
protected oneboxRef: Onebox;
|
|
|
|
constructor(oneboxRef: Onebox) {
|
|
this.oneboxRef = oneboxRef;
|
|
}
|
|
|
|
abstract getDefaultConfig(): IPlatformServiceConfig;
|
|
abstract deployContainer(): Promise<string>;
|
|
abstract stopContainer(containerId: string): Promise<void>;
|
|
abstract healthCheck(): Promise<boolean>;
|
|
abstract provisionResource(userService: IService): Promise<IProvisionedResource>;
|
|
abstract deprovisionResource(resource: IPlatformResource, credentials: Record<string, string>): Promise<void>;
|
|
abstract getEnvVarMappings(): IEnvVarMapping[];
|
|
|
|
/**
|
|
* Get the internal Docker network name for platform services
|
|
*/
|
|
protected getNetworkName(): string {
|
|
return 'onebox-network';
|
|
}
|
|
|
|
/**
|
|
* Get the container name for this platform service
|
|
*/
|
|
protected getContainerName(): string {
|
|
return `onebox-${this.type}`;
|
|
}
|
|
|
|
/**
|
|
* Generate a resource name from a user service name
|
|
*/
|
|
protected generateResourceName(serviceName: string, prefix: string = 'onebox'): string {
|
|
// Replace dashes with underscores for database compatibility
|
|
const sanitized = serviceName.replace(/-/g, '_');
|
|
return `${prefix}_${sanitized}`;
|
|
}
|
|
|
|
/**
|
|
* Generate a bucket name from a user service name
|
|
*/
|
|
protected generateBucketName(serviceName: string, prefix: string = 'onebox'): string {
|
|
// Buckets use dashes, lowercase
|
|
const sanitized = serviceName.toLowerCase().replace(/_/g, '-');
|
|
return `${prefix}-${sanitized}`;
|
|
}
|
|
}
|