admin

package
v0.451.0 Latest Latest
Warning

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

 Go to latest Published: Feb 20, 2025 License: Apache-2.0 Imports: 43 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ShouldUseLocalClient 

func ShouldUseLocalClient(ctx context.Context, adminClient ftlv1connect.AdminServiceClient, endpoint *url.URL) (bool, error)

ShouldUseLocalClient returns whether a local admin client should be used based on the admin service client and the endpoint.

If the service is not present AND endpoint is local, then a local client should be used so that the user does not need to spin up a cluster just to run the `ftl config/secret` commands.

If true is returned, use NewLocalClient() to create a local client after setting up config and secret managers for the context.

func Start 

func Start(
	ctx context.Context,
	config Config,
	cm *manager.Manager[configuration.Configuration],
	sm *manager.Manager[configuration.Secrets],
	schr ftlv1connect.SchemaServiceClient,
	source *schemaeventsource.EventSource,
	timelineClient *timelineclient.Client,
	storage *artefacts.OCIArtefactService,
	waitFor []string) error

Types

type Config 

type Config struct {
	Bind              *url.URL `help:"Socket to bind to." default:"http://127.0.0.1:8892" env:"FTL_BIND"`
	ArtefactChunkSize int      `help:"Size of each chunk streamed to the client." default:"1048576"`
}

type EnvironmentClient added in v0.448.0 

type EnvironmentClient interface {
	// List configuration.
	ConfigList(ctx context.Context, req *connect.Request[ftlv1.ConfigListRequest]) (*connect.Response[ftlv1.ConfigListResponse], error)

	// Get a config value.
	ConfigGet(ctx context.Context, req *connect.Request[ftlv1.ConfigGetRequest]) (*connect.Response[ftlv1.ConfigGetResponse], error)

	// Set a config value.
	ConfigSet(ctx context.Context, req *connect.Request[ftlv1.ConfigSetRequest]) (*connect.Response[ftlv1.ConfigSetResponse], error)

	// Unset a config value.
	ConfigUnset(ctx context.Context, req *connect.Request[ftlv1.ConfigUnsetRequest]) (*connect.Response[ftlv1.ConfigUnsetResponse], error)

	// List secrets.
	SecretsList(ctx context.Context, req *connect.Request[ftlv1.SecretsListRequest]) (*connect.Response[ftlv1.SecretsListResponse], error)

	// Get a secret.
	SecretGet(ctx context.Context, req *connect.Request[ftlv1.SecretGetRequest]) (*connect.Response[ftlv1.SecretGetResponse], error)

	// Set a secret.
	SecretSet(ctx context.Context, req *connect.Request[ftlv1.SecretSetRequest]) (*connect.Response[ftlv1.SecretSetResponse], error)

	// Unset a secret.
	SecretUnset(ctx context.Context, req *connect.Request[ftlv1.SecretUnsetRequest]) (*connect.Response[ftlv1.SecretUnsetResponse], error)

	// MapConfigsForModule combines all configuration values visible to the module.
	// Local values take precedence.
	MapConfigsForModule(ctx context.Context, req *connect.Request[ftlv1.MapConfigsForModuleRequest]) (*connect.Response[ftlv1.MapConfigsForModuleResponse], error)

	// MapSecretsForModule combines all secrets visible to the module.
	// Local values take precedence.
	MapSecretsForModule(ctx context.Context, req *connect.Request[ftlv1.MapSecretsForModuleRequest]) (*connect.Response[ftlv1.MapSecretsForModuleResponse], error)
	// Get the full schema.
	GetSchema(ctx context.Context, req *connect.Request[ftlv1.GetSchemaRequest]) (*connect.Response[ftlv1.GetSchemaResponse], error)
}

EnvironmentClient standardizes an common interface between the Service as accessed via gRPC and a purely-local variant that doesn't require a running controller to access.

func NewLocalClient 

func NewLocalClient(cm *manager.Manager[cf.Configuration], sm *manager.Manager[cf.Secrets]) EnvironmentClient

NewLocalClient creates a admin client that reads and writes from the provided config and secret managers

type EnvironmentManager added in v0.448.0 

type EnvironmentManager struct {
	// contains filtered or unexported fields
}

EnvironmentManager is a client that reads and writes secrets and config entries

func NewEnvironmentClient added in v0.448.0 

func NewEnvironmentClient(cm *manager.Manager[configuration.Configuration], sm *manager.Manager[configuration.Secrets], schr SchemaClient) *EnvironmentManager

func (*EnvironmentManager) ConfigGet added in v0.448.0 

func (s *EnvironmentManager) ConfigGet(ctx context.Context, req *connect.Request[ftlv1.ConfigGetRequest]) (*connect.Response[ftlv1.ConfigGetResponse], error)

ConfigGet returns the configuration value for a given ref string.

func (*EnvironmentManager) ConfigList added in v0.448.0 

func (s *EnvironmentManager) ConfigList(ctx context.Context, req *connect.Request[ftlv1.ConfigListRequest]) (*connect.Response[ftlv1.ConfigListResponse], error)

ConfigList returns the list of configuration values, optionally filtered by module.

func (*EnvironmentManager) ConfigSet added in v0.448.0 

func (s *EnvironmentManager) ConfigSet(ctx context.Context, req *connect.Request[ftlv1.ConfigSetRequest]) (*connect.Response[ftlv1.ConfigSetResponse], error)

ConfigSet sets the configuration at the given ref to the provided value.

func (*EnvironmentManager) ConfigUnset added in v0.448.0 

func (s *EnvironmentManager) ConfigUnset(ctx context.Context, req *connect.Request[ftlv1.ConfigUnsetRequest]) (*connect.Response[ftlv1.ConfigUnsetResponse], error)

ConfigUnset unsets the config value at the given ref.

func (*EnvironmentManager) GetSchema added in v0.448.0 

func (s *EnvironmentManager) GetSchema(ctx context.Context, c *connect.Request[ftlv1.GetSchemaRequest]) (*connect.Response[ftlv1.GetSchemaResponse], error)

func (*EnvironmentManager) MapConfigsForModule added in v0.448.0 

func (s *EnvironmentManager) MapConfigsForModule(ctx context.Context, req *connect.Request[ftlv1.MapConfigsForModuleRequest]) (*connect.Response[ftlv1.MapConfigsForModuleResponse], error)

MapConfigsForModule combines all configuration values visible to the module.

func (*EnvironmentManager) MapSecretsForModule added in v0.448.0 

func (s *EnvironmentManager) MapSecretsForModule(ctx context.Context, req *connect.Request[ftlv1.MapSecretsForModuleRequest]) (*connect.Response[ftlv1.MapSecretsForModuleResponse], error)

MapSecretsForModule combines all secrets visible to the module.

func (*EnvironmentManager) SecretGet added in v0.448.0 

func (s *EnvironmentManager) SecretGet(ctx context.Context, req *connect.Request[ftlv1.SecretGetRequest]) (*connect.Response[ftlv1.SecretGetResponse], error)

SecretGet returns the secret value for a given ref string.

func (*EnvironmentManager) SecretSet added in v0.448.0 

func (s *EnvironmentManager) SecretSet(ctx context.Context, req *connect.Request[ftlv1.SecretSetRequest]) (*connect.Response[ftlv1.SecretSetResponse], error)

SecretSet sets the secret at the given ref to the provided value.

func (*EnvironmentManager) SecretUnset added in v0.448.0 

func (s *EnvironmentManager) SecretUnset(ctx context.Context, req *connect.Request[ftlv1.SecretUnsetRequest]) (*connect.Response[ftlv1.SecretUnsetResponse], error)

SecretUnset unsets the secret value at the given ref.

func (*EnvironmentManager) SecretsList added in v0.448.0 

func (s *EnvironmentManager) SecretsList(ctx context.Context, req *connect.Request[ftlv1.SecretsListRequest]) (*connect.Response[ftlv1.SecretsListResponse], error)

SecretsList returns the list of secrets, optionally filtered by module.

type OnceValue added in v0.448.0 

type OnceValue[T any] struct {
	// contains filtered or unexported fields
}

func NewOnceValue added in v0.448.0 

func NewOnceValue[T any]() *OnceValue[T]

func (*OnceValue[T]) Get added in v0.448.0 

func (o *OnceValue[T]) Get(ctx context.Context) (T, bool)

func (*OnceValue[T]) Set added in v0.448.0 

func (o *OnceValue[T]) Set(value T)

type SchemaClient added in v0.448.0 

type SchemaClient interface {
	GetSchema(ctx context.Context) (*schema.Schema, error)
}

func NewSchemaRetriever added in v0.448.0 

func NewSchemaRetriever(source *schemaeventsource.EventSource) SchemaClient

type Service added in v0.448.0 

type Service struct {
	// contains filtered or unexported fields
}

func NewAdminService 

func NewAdminService(config Config, env *EnvironmentManager,
	schr ftlv1connect.SchemaServiceClient, source *schemaeventsource.EventSource,
	storage *artefacts.OCIArtefactService, routes *routing.VerbCallRouter,
	waitFor []string) *Service

NewAdminService creates a new Service. bindAllocator is optional and should be set if a local client is to be used that accesses schema from disk using language plugins.

func (*Service) ApplyChangeset added in v0.448.0 

func (s *Service) ApplyChangeset(ctx context.Context, req *connect.Request[ftlv1.ApplyChangesetRequest]) (*connect.Response[ftlv1.ApplyChangesetResponse], error)

func (*Service) Call added in v0.448.0 

func (s *Service) Call(ctx context.Context, req *connect.Request[ftlv1.CallRequest]) (*connect.Response[ftlv1.CallResponse], error)

func (*Service) ClusterInfo added in v0.448.0 

func (s *Service) ClusterInfo(ctx context.Context, req *connect.Request[ftlv1.ClusterInfoRequest]) (*connect.Response[ftlv1.ClusterInfoResponse], error)

func (*Service) ConfigGet added in v0.448.0 

func (s *Service) ConfigGet(ctx context.Context, req *connect.Request[ftlv1.ConfigGetRequest]) (*connect.Response[ftlv1.ConfigGetResponse], error)

ConfigGet returns the configuration value for a given ref string.

func (*Service) ConfigList added in v0.448.0 

func (s *Service) ConfigList(ctx context.Context, req *connect.Request[ftlv1.ConfigListRequest]) (*connect.Response[ftlv1.ConfigListResponse], error)

ConfigList returns the list of configuration values, optionally filtered by module.

func (*Service) ConfigSet added in v0.448.0 

func (s *Service) ConfigSet(ctx context.Context, req *connect.Request[ftlv1.ConfigSetRequest]) (*connect.Response[ftlv1.ConfigSetResponse], error)

ConfigSet sets the configuration at the given ref to the provided value.

func (*Service) ConfigUnset added in v0.448.0 

func (s *Service) ConfigUnset(ctx context.Context, req *connect.Request[ftlv1.ConfigUnsetRequest]) (*connect.Response[ftlv1.ConfigUnsetResponse], error)

ConfigUnset unsets the config value at the given ref.

func (*Service) FailChangeset added in v0.448.0 

func (s *Service) FailChangeset(ctx context.Context, c *connect.Request[ftlv1.FailChangesetRequest]) (*connect.Response[ftlv1.FailChangesetResponse], error)

func (*Service) GetArtefactDiffs added in v0.448.0 

func (s *Service) GetArtefactDiffs(ctx context.Context, req *connect.Request[ftlv1.GetArtefactDiffsRequest]) (*connect.Response[ftlv1.GetArtefactDiffsResponse], error)

func (*Service) GetDeploymentArtefacts added in v0.448.0 

func (s *Service) GetDeploymentArtefacts(ctx context.Context, req *connect.Request[ftlv1.GetDeploymentArtefactsRequest], resp *connect.ServerStream[ftlv1.GetDeploymentArtefactsResponse]) error

func (*Service) GetSchema added in v0.448.0 

func (s *Service) GetSchema(ctx context.Context, c *connect.Request[ftlv1.GetSchemaRequest]) (*connect.Response[ftlv1.GetSchemaResponse], error)

func (*Service) MapConfigsForModule added in v0.448.0 

func (s *Service) MapConfigsForModule(ctx context.Context, req *connect.Request[ftlv1.MapConfigsForModuleRequest]) (*connect.Response[ftlv1.MapConfigsForModuleResponse], error)

MapConfigsForModule combines all configuration values visible to the module.

func (*Service) MapSecretsForModule added in v0.448.0 

func (s *Service) MapSecretsForModule(ctx context.Context, req *connect.Request[ftlv1.MapSecretsForModuleRequest]) (*connect.Response[ftlv1.MapSecretsForModuleResponse], error)

MapSecretsForModule combines all secrets visible to the module.

func (*Service) Ping added in v0.448.0 

func (s *Service) Ping(ctx context.Context, req *connect.Request[ftlv1.PingRequest]) (*connect.Response[ftlv1.PingResponse], error)

func (*Service) PullSchema added in v0.448.0 

func (s *Service) PullSchema(ctx context.Context, req *connect.Request[ftlv1.PullSchemaRequest], resp *connect.ServerStream[ftlv1.PullSchemaResponse]) error

func (*Service) ResetSubscription added in v0.448.0 

func (s *Service) ResetSubscription(ctx context.Context, req *connect.Request[ftlv1.ResetSubscriptionRequest]) (*connect.Response[ftlv1.ResetSubscriptionResponse], error)

func (*Service) RollbackChangeset added in v0.448.0 

func (s *Service) RollbackChangeset(ctx context.Context, c *connect.Request[ftlv1.RollbackChangesetRequest]) (*connect.Response[ftlv1.RollbackChangesetResponse], error)

func (*Service) SecretGet added in v0.448.0 

func (s *Service) SecretGet(ctx context.Context, req *connect.Request[ftlv1.SecretGetRequest]) (*connect.Response[ftlv1.SecretGetResponse], error)

SecretGet returns the secret value for a given ref string.

func (*Service) SecretSet added in v0.448.0 

func (s *Service) SecretSet(ctx context.Context, req *connect.Request[ftlv1.SecretSetRequest]) (*connect.Response[ftlv1.SecretSetResponse], error)

SecretSet sets the secret at the given ref to the provided value.

func (*Service) SecretUnset added in v0.448.0 

func (s *Service) SecretUnset(ctx context.Context, req *connect.Request[ftlv1.SecretUnsetRequest]) (*connect.Response[ftlv1.SecretUnsetResponse], error)

SecretUnset unsets the secret value at the given ref.

func (*Service) SecretsList added in v0.448.0 

func (s *Service) SecretsList(ctx context.Context, req *connect.Request[ftlv1.SecretsListRequest]) (*connect.Response[ftlv1.SecretsListResponse], error)

SecretsList returns the list of secrets, optionally filtered by module.

func (*Service) UploadArtefact added in v0.448.0 

func (s *Service) UploadArtefact(ctx context.Context, stream *connect.ClientStream[ftlv1.UploadArtefactRequest]) (*connect.Response[ftlv1.UploadArtefactResponse], error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.