Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: self-hosted cleanups #430

Merged
merged 6 commits into from
Sep 13, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .github/workflows/spell-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Spell Checking

on: [pull_request]

jobs:
codespell:
name: Check spelling with codespell
runs-on: ubuntu-latest
steps:
uses: codespell-project/actions-codespell@v2
with:
check_filenames: true
misspell:
name: Check spelling with misspell
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Install
run: wget -O - -q https://git.io/misspell | sh -s -- -b .
- name: Misspell
run: ./misspell -error
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ However, you can configure LangSmith to use an external Postgres database (**str
- A user with admin access to the Postgres database. This user will be used to create the necessary tables, indexes, and schemas.
- This user will also need to have the ability to create extensions in the database. We use/will try to install the btree_gin, btree_gist, pgcrypto, citext, and pg_trgm extensions.
- If using a schema other than public, ensure that you do not have any other schemas with the extensions enabled, or you must include that in your search path.
- By default, we recommend an instance with at least 2 vCPUs and 8GB of memory. However, the actual requirements will depend on your workload and the number of users you have. We recommend monitoring your Postgres instance and scaling up as needed.

## Connection String

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@ However, you can configure LangSmith to use an external Redis instance (**strong
- [Amazon ElastiCache](https://aws.amazon.com/elasticache/redis/)
- [Google Cloud Memorystore](https://cloud.google.com/memorystore)
- [Azure Cache for Redis](https://azure.microsoft.com/en-us/services/cache/)
- Note: We do only officially support Redis versions >= 5.
- Note: We only officially support Redis versions >= 5.
- We do not support Redis Cluster.
- By default, we recommend an instance with at least 2 vCPUs and 8GB of memory. However, the actual requirements will depend on your tracing workload. We recommend monitoring your Redis instance and scaling up as needed.

:::important Redis Cluster Not Supported
Certain tiers of managed Redis services may use Redis Cluster under the hood, but you can point to a single node in the cluster.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Ensure you have the following tools/items ready. Some items are marked optional:
- You may need to tune resource requests/limits for all of our different services based off of organization size/usage
- We recommend using a cluster autoscaler to handle scaling up/down of nodes based on resource usage
- We recommend setting up the metrics server so that autoscaling can be turned on
- You must have a node with at least 4 vCPUs and 16GB of memory available as ClickHouse will request this amount of resources by default.
- You must have a node with at least 4 vCPUs and 16GB of memory **allocatable** as ClickHouse will request this amount of resources by default.
1. Valid Dynamic PV provisioner or PVs available on your cluster. You can verify this by running:
- We will be using a PostgreSQL database, Redis, and ClickHouse for storing traces. These services require persistent storage.
- If using PVs in your cluster, we highly recommend setting up backups in a production environment.
Expand Down Expand Up @@ -96,7 +96,11 @@ Ensure you have the following tools/items ready. Some items are marked optional:
helm repo add langchain https://langchain-ai.github.io/helm/
"langchain" has been added to your repositories

3. Run `helm install langsmith langchain/langsmith --values langsmith_config.yaml --namespace <your-namespace> --version <version> --debug`
:::note Namespace
If you are using a namespace other than the default namespace, you will need to specify the namespace in the `helm` and `kubectl` commands by using the `-n <namespace` flag.
:::

3. Run `helm install langsmith langchain/langsmith --values langsmith_config.yaml --version <version> --debug`

- Replace `<your-namespace>` with the namespace you want to deploy LangSmith to.
- Replace `<version>` with the version of LangSmith you want to deploy. You can find the available versions in the [Helm Chart repository](https://github.com/langchain-ai/helm/releases). We generally recommend using the latest version.
Expand Down
4 changes: 4 additions & 0 deletions versioned_docs/version-2.0/self_hosting/upgrades.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ Update your helm chart config file with any updates that are needed in the new v

Run the following command to upgrade the chart(replace version with the version you want to upgrade to):

:::note Namespace
If you are using a namespace other than the default namespace, you will need to specify the namespace in the `helm` and `kubectl` commands by using the `-n <namespace` flag.
:::

```bash
helm upgrade <release-name> langchain/langsmith --version <version> --values <path-to-values-file>
```
Expand Down
4 changes: 4 additions & 0 deletions versioned_docs/version-2.0/self_hosting/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,7 @@ langchainhub.Client(

After setting the above, you should be able to run your code and see the results in your self-hosted instance.
We recommend running through the [<u>quickstart guide</u>](https://docs.smith.langchain.com/#quick-start) to get a feel for how to use LangSmith.

### API Reference

To access the API reference, navigate to `http://<host>/api/docs` in your browser.
Loading