phoenix/litellm
1
0
Fork 0
forked from phoenix/litellm-mirror
Code Pull requests Activity

(oidc): Improve docs for unofficial provider.

Browse source
This commit is contained in:
David Manouchehri 2024-08-16 20:30:41 +00:00
parent 11668c31c1
commit bef8568cb3
No known key found for this signature in database
1 changed files with 34 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

34
docs/my-website/docs/oidc.md
View file

@ -19,9 +19,17 @@ LiteLLM supports the following OIDC identity providers:
| CircleCI v2 | `circleci_v2`| No | | CircleCI v2 | `circleci_v2`| No |
| GitHub Actions | `github` | Yes | | GitHub Actions | `github` | Yes |
| Azure Kubernetes Service | `azure` | No | | Azure Kubernetes Service | `azure` | No |
| File | `file` | No |
| Environment Variable | `env` | No |
| Environment Path | `env_path` | No |
If you would like to use a different OIDC provider, please open an issue on GitHub. If you would like to use a different OIDC provider, please open an issue on GitHub.
:::tip
Do not use the `file`, `env`, or `env_path` providers unless you know what you're doing, and you are sure none of the other providers will work for your use-case. Hint: they probably will.
:::
## OIDC Connect Relying Party (RP) ## OIDC Connect Relying Party (RP)
@ -46,6 +54,32 @@ For providers that do not use the `audience` parameter, you can (and should) omi
oidc/config_name_here/ oidc/config_name_here/
``` ```
#### Unofficial Providers (not recommended)
For the unofficial `file` provider, you can use the following format:
```
oidc/file/home/user/dave/this_is_a_file_with_a_token.txt
```
For the unofficial `env`, use the following format, where `SECRET_TOKEN` is the name of the environment variable that contains the token:
```
oidc/env/SECRET_TOKEN
```
For the unofficial `env_path`, use the following format, where `SECRET_TOKEN` is the name of the environment variable that contains the path to the file with the token:
```
oidc/env_path/SECRET_TOKEN
```
:::tip
If you are tempted to use oidc/env_path/AZURE_FEDERATED_TOKEN_FILE, don't do that. Instead, use `oidc/azure/`, as this will ensure continued support from LiteLLM if Azure changes their OIDC configuration and/or adds new features.
:::
## Examples ## Examples
### Google Cloud Run -> Amazon Bedrock ### Google Cloud Run -> Amazon Bedrock