mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-10 07:05:04 -05:00
293c1d6889
This PR introduces a significant update to the Toolbox configuration file format, which is one of the primary **breaking changes** required for the implementation of the Advanced Control Plane. # Summary of Changes The configuration schema has been updated to enforce resource isolation and facilitate atomic, incremental updates. * Resource Isolation: Resource definitions are now separated into individual blocks, using a distinct structure for each resource type (Source, Tool, Toolset, etc.). This improves readability, management, and auditing of configuration files. * Field Name Modification: Internal field names have been modified to align with declarative methodologies. Specifically, the configuration now separates kind (general resource type, e.g., Source) from type (specific implementation, e.g., Postgres). # User Impact Existing tools.yaml configuration files are now in an outdated format. Users must eventually update their files to the new YAML format. # Mitigation & Compatibility Backward compatibility is maintained during this transition to ensure no immediate user action is required for existing files. * Immediate Backward Compatibility: The source code includes a pre-processing layer that automatically detects outdated configuration files (v1 format) and converts them to the new v2 format under the hood. * [COMING SOON] Migration Support: The new toolbox migrate subcommand will be introduced to allow users to automatically convert their old configuration files to the latest format. # Example Example for config file v2: ``` kind: sources name: my-pg-instance type: cloud-sql-postgres project: my-project region: my-region instance: my-instance database: my_db user: my_user password: my_pass --- kind: authServices name: my-google-auth type: google clientId: testing-id --- kind: tools name: example_tool type: postgres-sql source: my-pg-instance description: some description statement: SELECT * FROM SQL_STATEMENT; parameters: - name: country type: string description: some description --- kind: tools name: example_tool_2 type: postgres-sql source: my-pg-instance description: returning the number one statement: SELECT 1; --- kind: toolsets name: example_toolset tools: - example_tool ``` --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com>
78 lines
2.6 KiB
Go
78 lines
2.6 KiB
Go
// Copyright 2024 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package sources
|
|
|
|
import (
|
|
"context"
|
|
|
|
"fmt"
|
|
|
|
"github.com/goccy/go-yaml"
|
|
"go.opentelemetry.io/otel/attribute"
|
|
"go.opentelemetry.io/otel/trace"
|
|
)
|
|
|
|
// SourceConfigFactory defines the function signature for creating a SourceConfig.
|
|
type SourceConfigFactory func(ctx context.Context, name string, decoder *yaml.Decoder) (SourceConfig, error)
|
|
|
|
var sourceRegistry = make(map[string]SourceConfigFactory)
|
|
|
|
// Register registers a new source type with its factory.
|
|
// It returns false if the type is already registered.
|
|
func Register(sourceType string, factory SourceConfigFactory) bool {
|
|
if _, exists := sourceRegistry[sourceType]; exists {
|
|
// Source with this type already exists, do not overwrite.
|
|
return false
|
|
}
|
|
sourceRegistry[sourceType] = factory
|
|
return true
|
|
}
|
|
|
|
// DecodeConfig decodes a source configuration using the registered factory for the given type.
|
|
func DecodeConfig(ctx context.Context, sourceType string, name string, decoder *yaml.Decoder) (SourceConfig, error) {
|
|
factory, found := sourceRegistry[sourceType]
|
|
if !found {
|
|
return nil, fmt.Errorf("unknown source type: %q", sourceType)
|
|
}
|
|
sourceConfig, err := factory(ctx, name, decoder)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to parse source %q as %q: %w", name, sourceType, err)
|
|
}
|
|
return sourceConfig, err
|
|
}
|
|
|
|
// SourceConfig is the interface for configuring a source.
|
|
type SourceConfig interface {
|
|
SourceConfigType() string
|
|
Initialize(ctx context.Context, tracer trace.Tracer) (Source, error)
|
|
}
|
|
|
|
// Source is the interface for the source itself.
|
|
type Source interface {
|
|
SourceType() string
|
|
ToConfig() SourceConfig
|
|
}
|
|
|
|
// InitConnectionSpan adds a span for database pool connection initialization
|
|
func InitConnectionSpan(ctx context.Context, tracer trace.Tracer, sourceType, sourceName string) (context.Context, trace.Span) {
|
|
ctx, span := tracer.Start(
|
|
ctx,
|
|
"toolbox/server/source/connect",
|
|
trace.WithAttributes(attribute.String("source_type", sourceType)),
|
|
trace.WithAttributes(attribute.String("source_name", sourceName)),
|
|
)
|
|
return ctx, span
|
|
}
|