Documentation
¶
Overview ¶
Package cloudsqlconnectgce provides a single tool that connects any Cloud SQL instance (PostgreSQL, MySQL, or SQL Server) to a Google Compute Engine VM. The engine is auto-detected from the DatabaseVersion returned by the Cloud SQL Admin API, so the caller does not have to specify it.
The tool validates network reachability between the instance and the VM, recommends a connection method (Auth Proxy, Connector, or Direct Private IP) with ranked alternatives, and returns ready-to-paste setup steps and an optional language-specific code snippet with floor-pinned dependency versions.
Identity boundary: both the Cloud SQL Admin call and the Compute Engine call now honor the caller's access token when the underlying cloud-sql-admin source is configured with useClientOAuth. When no caller token is supplied the tool falls back to Application Default Credentials for the Compute Engine call.
Index ¶
- type Config
- type Tool
- func (t Tool) GetSourceName() string
- func (t Tool) Invoke(ctx context.Context, s sources.Source, params parameters.ParamValues, ...) (any, util.ToolboxError)
- func (t Tool) RequiresClientAuthorization(source sources.Source) (bool, error)
- func (t Tool) ToConfig() tools.ToolConfig
- func (t Tool) ValidateSource(src sources.Source) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
tools.ConfigBase `yaml:",inline"`
Type string `yaml:"type" validate:"required"`
Source string `yaml:"source" validate:"required"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`
}
Config defines the configuration for the cloud-sql-connect-gce tool.
func (Config) Initialize ¶
Initialize initializes the tool from the configuration.
func (Config) ToolConfigType ¶
ToolConfigType returns the type of the tool.
type Tool ¶
Tool represents the cloud-sql-connect-gce tool.
func (Tool) GetSourceName ¶
func (Tool) Invoke ¶
func (t Tool) Invoke(ctx context.Context, s sources.Source, params parameters.ParamValues, accessToken tools.AccessToken) (any, util.ToolboxError)
Invoke fetches the Cloud SQL instance, detects its engine, validates connectivity to the target VM, and returns connection recommendations.
func (Tool) RequiresClientAuthorization ¶
func (Tool) ToConfig ¶
func (t Tool) ToConfig() tools.ToolConfig
Source Files