Skip to content

Commit

Permalink
Update README. (#109)
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewnguonly authored Jun 27, 2024
1 parent 6477ac8 commit f7e9e68
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 10 deletions.
32 changes: 27 additions & 5 deletions charts/langgraph-cloud/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# langgraph-cloud

![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.1.0](https://img.shields.io/badge/AppVersion-0.1.0-informational?style=flat-square)
![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.1.0](https://img.shields.io/badge/AppVersion-0.1.0-informational?style=flat-square)

Helm chart to deploy the LangGraph Cloud application and all services it depends on.

Expand All @@ -21,7 +21,7 @@ Ensure you have the following tools/items ready.
1. `Helm`
1. `brew install helm`
1. LangGraph Cloud License Key
1. You can get this from your Langchain representative. Contact us at sales@langchain.dev for more information.
1. You can get this from your LangChain representative. Contact us at sales@langchain.dev for more information.
1. A LangGraph Cloud API image
1. You can use the [langgraph-cli](https://langchain-ai.github.io/langgraph/cloud/reference/cli/) to build your own image.
1. SSL(optional)
Expand Down Expand Up @@ -55,6 +55,28 @@ config:
langGraphCloudLicenseKey: ""
```

If your application reads from environment variables, specify `apiServer.deployment.extraEnv`:

```yaml
images:
# Make sure to replace this with your own LangGraph Cloud API image built with the cli.
apiServerImage:
pullPolicy: IfNotPresent
repository: <your repository>
tag: <image tag>
config:
langGraphCloudLicenseKey: ""
apiServer:
deployment:
extraEnv:
- name: ENV_VAR_1
value: "foo"
- name: ENV_VAR_2
value: "bar"
```

Example `EKS` config file with certificates setup using ACM:

```jsx
Expand Down Expand Up @@ -96,7 +118,7 @@ postgres:
```

You can also use existingSecretName to avoid checking in secrets. This secret will need to follow
the same format as the secret in the corresponding `secrets.yaml` file.
the same format as the secret in the corresponding `secrets.yaml` file. Note: API keys such as `OPENAI_API_KEY` should not be specified as environment variables. These values should be stored as secrets (e.g. Kubernetes secrets).

### Deploying to Kubernetes:

Expand All @@ -110,7 +132,7 @@ the same format as the secret in the corresponding `secrets.yaml` file.
No resources found in default namespace.
```

2. Ensure you have the Langchain Helm repo added. (skip this step if you are using local charts)
2. Ensure you have the LangChain Helm repo added. (skip this step if you are using local charts)

helm repo add langchain https://langchain-ai.github.io/helm/
"langchain" has been added to your repositories
Expand Down Expand Up @@ -296,6 +318,6 @@ the same format as the secret in the corresponding `secrets.yaml` file.
| Ankush | <ankush@langchain.dev> | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.3](https://github.com/norwoodj/helm-docs/releases/v1.11.3)
Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
## Docs Generated by [helm-docs](https://github.com/norwoodj/helm-docs)
`helm-docs -t ./charts/langgraph-cloud/README.md.gotmpl`
28 changes: 25 additions & 3 deletions charts/langgraph-cloud/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Ensure you have the following tools/items ready.
1. `Helm`
1. `brew install helm`
1. LangGraph Cloud License Key
1. You can get this from your Langchain representative. Contact us at [email protected] for more information.
1. You can get this from your LangChain representative. Contact us at [email protected] for more information.
1. A LangGraph Cloud API image
1. You can use the [langgraph-cli](https://langchain-ai.github.io/langgraph/cloud/reference/cli/) to build your own image.
1. SSL(optional)
Expand Down Expand Up @@ -55,6 +55,28 @@ config:
langGraphCloudLicenseKey: ""
```

If your application reads from environment variables, specify `apiServer.deployment.extraEnv`:

```yaml
images:
# Make sure to replace this with your own LangGraph Cloud API image built with the cli.
apiServerImage:
pullPolicy: IfNotPresent
repository: <your repository>
tag: <image tag>

config:
langGraphCloudLicenseKey: ""

apiServer:
deployment:
extraEnv:
- name: ENV_VAR_1
value: "foo"
- name: ENV_VAR_2
value: "bar"
```

Example `EKS` config file with certificates setup using ACM:

```jsx
Expand Down Expand Up @@ -96,7 +118,7 @@ postgres:
```

You can also use existingSecretName to avoid checking in secrets. This secret will need to follow
the same format as the secret in the corresponding `secrets.yaml` file.
the same format as the secret in the corresponding `secrets.yaml` file. Note: API keys such as `OPENAI_API_KEY` should not be specified as environment variables. These values should be stored as secrets (e.g. Kubernetes secrets).

### Deploying to Kubernetes:

Expand All @@ -110,7 +132,7 @@ the same format as the secret in the corresponding `secrets.yaml` file.
No resources found in default namespace.
```

2. Ensure you have the Langchain Helm repo added. (skip this step if you are using local charts)
2. Ensure you have the LangChain Helm repo added. (skip this step if you are using local charts)

helm repo add langchain https://langchain-ai.github.io/helm/
"langchain" has been added to your repositories
Expand Down
2 changes: 0 additions & 2 deletions charts/langgraph-cloud/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,6 @@ postgres:
password: "postgres"
database: "postgres"
schema: "public"
# If connection string is specified, we will ignore all above values and use the connection string instead.
# Do not include the driver name(something like "postgres://" in the connection string.
connectionUrl: ""
existingSecretName: ""
containerPort: 5432
Expand Down

0 comments on commit f7e9e68

Please sign in to comment.