From 0fbd23c8e1ee153479d04a92a409ca9cec558aec Mon Sep 17 00:00:00 2001 From: infra Date: Thu, 12 Sep 2024 19:59:17 -0400 Subject: [PATCH 1/6] docs: add debug flag, namespaces note --- .../version-2.0/self_hosting/installation/kubernetes.mdx | 2 +- versioned_docs/version-2.0/self_hosting/upgrades.mdx | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/versioned_docs/version-2.0/self_hosting/installation/kubernetes.mdx b/versioned_docs/version-2.0/self_hosting/installation/kubernetes.mdx index 3fde6bcb..4afe5b37 100644 --- a/versioned_docs/version-2.0/self_hosting/installation/kubernetes.mdx +++ b/versioned_docs/version-2.0/self_hosting/installation/kubernetes.mdx @@ -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. diff --git a/versioned_docs/version-2.0/self_hosting/upgrades.mdx b/versioned_docs/version-2.0/self_hosting/upgrades.mdx index 51f3d66e..d9ab6e21 100644 --- a/versioned_docs/version-2.0/self_hosting/upgrades.mdx +++ b/versioned_docs/version-2.0/self_hosting/upgrades.mdx @@ -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 langchain/langsmith --version --values ``` From a51fdf33c4379d5e46a5840c433b8b23b2422c9e Mon Sep 17 00:00:00 2001 From: infra Date: Thu, 12 Sep 2024 20:07:40 -0400 Subject: [PATCH 2/6] docs: add debug flag, namespaces note --- .../self_hosting/configuration/external_postgres.mdx | 1 + .../self_hosting/configuration/external_redis.mdx | 3 ++- .../version-2.0/self_hosting/installation/kubernetes.mdx | 6 +++++- versioned_docs/version-2.0/self_hosting/usage.mdx | 3 +++ 4 files changed, 11 insertions(+), 2 deletions(-) diff --git a/versioned_docs/version-2.0/self_hosting/configuration/external_postgres.mdx b/versioned_docs/version-2.0/self_hosting/configuration/external_postgres.mdx index 78008577..db4ca952 100644 --- a/versioned_docs/version-2.0/self_hosting/configuration/external_postgres.mdx +++ b/versioned_docs/version-2.0/self_hosting/configuration/external_postgres.mdx @@ -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 diff --git a/versioned_docs/version-2.0/self_hosting/configuration/external_redis.mdx b/versioned_docs/version-2.0/self_hosting/configuration/external_redis.mdx index bcbf4a5b..761746e7 100644 --- a/versioned_docs/version-2.0/self_hosting/configuration/external_redis.mdx +++ b/versioned_docs/version-2.0/self_hosting/configuration/external_redis.mdx @@ -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. diff --git a/versioned_docs/version-2.0/self_hosting/installation/kubernetes.mdx b/versioned_docs/version-2.0/self_hosting/installation/kubernetes.mdx index 4afe5b37..1c6478e5 100644 --- a/versioned_docs/version-2.0/self_hosting/installation/kubernetes.mdx +++ b/versioned_docs/version-2.0/self_hosting/installation/kubernetes.mdx @@ -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 --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 --debug` - Replace `` with the namespace you want to deploy LangSmith to. - Replace `` 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. diff --git a/versioned_docs/version-2.0/self_hosting/usage.mdx b/versioned_docs/version-2.0/self_hosting/usage.mdx index 536a643d..73315a59 100644 --- a/versioned_docs/version-2.0/self_hosting/usage.mdx +++ b/versioned_docs/version-2.0/self_hosting/usage.mdx @@ -49,3 +49,6 @@ 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 [quickstart guide](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:///api/docs` in your browser. From 376bb4a7a2edea321d8061702f7bd646cc9644c9 Mon Sep 17 00:00:00 2001 From: infra Date: Thu, 12 Sep 2024 20:27:45 -0400 Subject: [PATCH 3/6] docs: add debug flag, namespaces note --- versioned_docs/version-2.0/self_hosting/usage.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/versioned_docs/version-2.0/self_hosting/usage.mdx b/versioned_docs/version-2.0/self_hosting/usage.mdx index 73315a59..f49c4060 100644 --- a/versioned_docs/version-2.0/self_hosting/usage.mdx +++ b/versioned_docs/version-2.0/self_hosting/usage.mdx @@ -51,4 +51,5 @@ After setting the above, you should be able to run your code and see the results We recommend running through the [quickstart guide](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:///api/docs` in your browser. From 47a62f596449d33e45f3328bb8c5d712b95c34f8 Mon Sep 17 00:00:00 2001 From: infra Date: Thu, 12 Sep 2024 20:32:01 -0400 Subject: [PATCH 4/6] add spellcheck --- .github/workflows/spell-check.yml | 33 +++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 .github/workflows/spell-check.yml diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml new file mode 100644 index 00000000..31c08525 --- /dev/null +++ b/.github/workflows/spell-check.yml @@ -0,0 +1,33 @@ +name: Spell Checking + +on: [pull_request] + +jobs: + codespell: + name: Check spelling with codespell + runs-on: ubuntu-latest + strategy: + matrix: + python-version: [3.8] + steps: + - uses: actions/checkout@v2 + - name: Set up Python $ + uses: actions/setup-python@v2 + with: + python-version: $ + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install codespell + if [ -f requirements.txt ]; then pip install -r requirements.txt; fi + - name: Check spelling with codespell + run: codespell --ignore-words=codespell.txt || exit 1 + 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 From 17f6d73028fc72b3d1fbb285e7ec22b3e690d73b Mon Sep 17 00:00:00 2001 From: infra Date: Thu, 12 Sep 2024 20:36:27 -0400 Subject: [PATCH 5/6] add spellcheck --- .github/workflows/spell-check.yml | 18 +++--------------- 1 file changed, 3 insertions(+), 15 deletions(-) diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml index 31c08525..e2070a52 100644 --- a/.github/workflows/spell-check.yml +++ b/.github/workflows/spell-check.yml @@ -6,22 +6,10 @@ jobs: codespell: name: Check spelling with codespell runs-on: ubuntu-latest - strategy: - matrix: - python-version: [3.8] steps: - - uses: actions/checkout@v2 - - name: Set up Python $ - uses: actions/setup-python@v2 - with: - python-version: $ - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install codespell - if [ -f requirements.txt ]; then pip install -r requirements.txt; fi - - name: Check spelling with codespell - run: codespell --ignore-words=codespell.txt || exit 1 + uses: codespell-project/actions-codespell@v2 + with: + check_filenames: true misspell: name: Check spelling with misspell runs-on: ubuntu-latest From c5f8533fef05bb65ba1ebb6d26f701a490872ce4 Mon Sep 17 00:00:00 2001 From: infra Date: Thu, 12 Sep 2024 20:39:40 -0400 Subject: [PATCH 6/6] add spellcheck --- .github/workflows/spell-check.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml index e2070a52..3bfeae28 100644 --- a/.github/workflows/spell-check.yml +++ b/.github/workflows/spell-check.yml @@ -7,9 +7,9 @@ jobs: name: Check spelling with codespell runs-on: ubuntu-latest steps: - uses: codespell-project/actions-codespell@v2 - with: - check_filenames: true + - uses: codespell-project/actions-codespell@v2 + with: + check_filenames: true misspell: name: Check spelling with misspell runs-on: ubuntu-latest