From 2731c41b92f92223425d4162067bde931cb9f336 Mon Sep 17 00:00:00 2001 From: Nicole McAllister Date: Thu, 23 Jan 2025 14:29:22 -0800 Subject: [PATCH 1/4] Capture Z's changes from #328 --- .../user-guide/appendix/releasenotes-nv-ingest.md | 4 +++- docs/docs/user-guide/developer-guide/SUMMARY.md | 2 +- .../user-guide/developer-guide/kubernetes-dev.md | 14 +++++++------- 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/docs/user-guide/appendix/releasenotes-nv-ingest.md b/docs/docs/user-guide/appendix/releasenotes-nv-ingest.md index 299746c1..551ba956 100644 --- a/docs/docs/user-guide/appendix/releasenotes-nv-ingest.md +++ b/docs/docs/user-guide/appendix/releasenotes-nv-ingest.md @@ -1,3 +1,5 @@ # Release Notes -There are no release notes avaiable at this time. +## Known Issues + + We currently do not support OCR-based text extraction. This was discovered in an unsupported use case and is not a product functionality issue. \ No newline at end of file diff --git a/docs/docs/user-guide/developer-guide/SUMMARY.md b/docs/docs/user-guide/developer-guide/SUMMARY.md index 429fb0ae..fad31ce3 100644 --- a/docs/docs/user-guide/developer-guide/SUMMARY.md +++ b/docs/docs/user-guide/developer-guide/SUMMARY.md @@ -1,6 +1,6 @@ - [Authenticating Local Docker with NGC](ngc-api-key.md) - [Content Metadata](content-metadata.md) -- [NV-Ingest Deployment](nv-ingest.md) +- [NV-Ingest Deployment](deployment.md) - [Environment Configuration Variables](environment-config.md) - [Developing with Kubernetes](kubernetes-dev.md) - [NV-Ingest Command Line (CLI)](nv-ingest_cli.md) diff --git a/docs/docs/user-guide/developer-guide/kubernetes-dev.md b/docs/docs/user-guide/developer-guide/kubernetes-dev.md index 974baa5e..a0b83a04 100644 --- a/docs/docs/user-guide/developer-guide/kubernetes-dev.md +++ b/docs/docs/user-guide/developer-guide/kubernetes-dev.md @@ -1,14 +1,14 @@ # Developing with Kubernetes -Developing directly on Kubernetes gives us more confidence that things will work as expected in end user deployments. +Developing directly on Kubernetes gives us more confidence that end-user deployments will work as expected. -This page describes how to use Kubernetes generally, and how to deploy nv-ingest on a local Kubernetes clusters. +This page describes how to use Kubernetes generally and how to deploy nv-ingest on a local Kubernetes cluster. > **NOTE:** _Unless otherwise noted, all commands below should be run from the root of this repo._ ## Kubernetes Cluster -To start you need a Kubernetes cluster. We recommend that you use `kind`, which creates a single Docker container with a Kubernetes cluster inside it. +To start, you need a Kubernetes cluster. We recommend that you use `kind`, which creates a single Docker container with a Kubernetes cluster inside it. Because the `kind` cluster needs access to the GPUs on your system, you need to install `nvkind`. For details, see [Running kind clusters with GPUs using nvkind](https://github.com/NVIDIA/nvkind/tree/main). @@ -89,13 +89,13 @@ docker ps | grep kind You should be able to use `kubectl` immediately, and it should be pointed at that cluster you just created. -For example, to ensure the cluster was set up successfully, try listing nodes. +For example, try listing notes to verify that the cluster was set up successfully. ```shell kubectl get nodes ``` -If that worked, you should see a single node, like this: +If that worked, you should see a single node like this: ```text NAME STATUS ROLES AGE VERSION @@ -122,7 +122,7 @@ In a single command, Skaffold does the following: ### Directory Structure -- `skaffold/sensitive/` contains any secrets or manifests you want deployed to your cluster, but not checked into git, as your local cluster is unlikely to have ESO installed. If it does, feel free to use `kind: ExternalSecret` instead. +- `skaffold/sensitive/` contains any secrets or manifests you want deployed to your cluster but not checked into git, as your local cluster is unlikely to have ESO installed. If it does, feel free to use `kind: ExternalSecret` instead. - `skaffold/components` contains any k8s manifests you want deployed in any skaffold file. The paths are relative and can be used in either `kustomize` or `rawYaml` formats: ```yaml @@ -141,7 +141,7 @@ In a single command, Skaffold does the following: #### Add Helm Repos The retriever-ingest service's deployment requires pulling in configurations for other services from third-party sources, -for example, Elasticsearch, OpenTelemetry, and Postgres. +such as Elasticsearch, OpenTelemetry, and Postgres. The first time you deploy this project to a local Kubernetes, you might need to tell your local version of `Helm` (a package manager for Kubernetes configurations) From 848134ed406f344cedcc8c392b84960eee42b472 Mon Sep 17 00:00:00 2001 From: Nicole McAllister Date: Thu, 23 Jan 2025 14:34:57 -0800 Subject: [PATCH 2/4] Added newline to end of file --- docs/docs/user-guide/appendix/releasenotes-nv-ingest.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/user-guide/appendix/releasenotes-nv-ingest.md b/docs/docs/user-guide/appendix/releasenotes-nv-ingest.md index 551ba956..4481057f 100644 --- a/docs/docs/user-guide/appendix/releasenotes-nv-ingest.md +++ b/docs/docs/user-guide/appendix/releasenotes-nv-ingest.md @@ -2,4 +2,4 @@ ## Known Issues - We currently do not support OCR-based text extraction. This was discovered in an unsupported use case and is not a product functionality issue. \ No newline at end of file + We currently do not support OCR-based text extraction. This was discovered in an unsupported use case and is not a product functionality issue. From 6f11fdba7ab79cbff710cd4b9a2f3802818eef5a Mon Sep 17 00:00:00 2001 From: Nicole McAllister Date: Thu, 23 Jan 2025 14:38:19 -0800 Subject: [PATCH 3/4] Add version to release notes --- docs/docs/user-guide/appendix/releasenotes-nv-ingest.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/docs/user-guide/appendix/releasenotes-nv-ingest.md b/docs/docs/user-guide/appendix/releasenotes-nv-ingest.md index 4481057f..81cbaf19 100644 --- a/docs/docs/user-guide/appendix/releasenotes-nv-ingest.md +++ b/docs/docs/user-guide/appendix/releasenotes-nv-ingest.md @@ -1,5 +1,7 @@ -# Release Notes +# NVIDIA-Ingest Release Notes -## Known Issues +## Release 24.12 + +### Known Issues We currently do not support OCR-based text extraction. This was discovered in an unsupported use case and is not a product functionality issue. From 05df5f340dca369c8145fe76068aba10443a3c10 Mon Sep 17 00:00:00 2001 From: Nicole McAllister Date: Thu, 23 Jan 2025 14:45:43 -0800 Subject: [PATCH 4/4] Trim trailing whitespace --- docs/docs/user-guide/appendix/releasenotes-nv-ingest.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/user-guide/appendix/releasenotes-nv-ingest.md b/docs/docs/user-guide/appendix/releasenotes-nv-ingest.md index 81cbaf19..d7dafcba 100644 --- a/docs/docs/user-guide/appendix/releasenotes-nv-ingest.md +++ b/docs/docs/user-guide/appendix/releasenotes-nv-ingest.md @@ -1,4 +1,4 @@ -# NVIDIA-Ingest Release Notes +# NVIDIA-Ingest Release Notes ## Release 24.12