genai-toolbox/docs/en/resources/sources/alloydb-admin.md at 735cb760ea6077965e99260bf6da5f0ee4d4e809

mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-01-08 23:18:04 -05:00

Files

Sri Varshitha 12bdd95459 feat(source/alloydb, source/cloud-sql-postgres,source/cloud-sql-mysql,source/cloud-sql-mssql): Use project from env for alloydb and cloud sql control plane tools (#1588 )

## Description

---
This change introduces the `DefaultProject` field for the
`alloydb-admin` and `cloud-sql-admin` sources. This field allows the
alloydb and cloud sql control plane tools to use the project value from
the environment variables (Ex: `ALLOYDB_POSTGRES_PROJECT`) if it is
already set instead of asking the user.

## PR Checklist

---
> Thank you for opening a Pull Request! Before submitting your PR, there
are a
> few things you can do to make sure it goes smoothly:

- [x] Make sure you reviewed

[CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md)
- [x] Make sure to open an issue as a

[bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose)
before writing your code! That way we can discuss the change, evaluate
  designs, and agree on the general idea
- [x] Ensure the tests and linter pass
- [x] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)
- [x] Make sure to add `!` if this involve a breaking change

🛠️ Fixes: https://github.com/gemini-cli-extensions/alloydb/issues/47

---------

Co-authored-by: Averi Kitsch <akitsch@google.com>

2025-11-11 04:14:47 +00:00

1.9 KiB

Raw Blame History

title, linkTitle, type, weight, description, aliases

title

linkTitle

type

weight

description

aliases

AlloyDB Admin

docs

The "alloydb-admin" source provides a client for the AlloyDB API.

/resources/sources/alloydb-admin

About

The alloydb-admin source provides a client to interact with the Google AlloyDB API. This allows tools to perform administrative tasks on AlloyDB resources, such as managing clusters, instances, and users.

Authentication can be handled in two ways:

Application Default Credentials (ADC): By default, the source uses ADC to authenticate with the API.
Client-side OAuth: If useClientOAuth is set to true, the source will expect an OAuth 2.0 access token to be provided by the client (e.g., a web browser) for each request.

Example

sources:
    my-alloydb-admin:
        kind: alloy-admin

    my-oauth-alloydb-admin:
        kind: alloydb-admin
        useClientOAuth: true

Reference

field	type	required	description
kind	string	true	Must be "alloydb-admin".
defaultProject	string	false	The Google Cloud project ID to use for AlloyDB infrastructure tools.
useClientOAuth	boolean	false	If true, the source will use client-side OAuth for authorization. Otherwise, it will use Application Default Credentials. Defaults to `false`.

1.9 KiB Raw Blame History

About

Example

Reference

1.9 KiB

Raw Blame History