Skip to content

Commit

Permalink
Capture Z's changes from #328 (#375)
Browse files Browse the repository at this point in the history
  • Loading branch information
nkmcalli authored Jan 23, 2025
1 parent fbdb380 commit 8b1d50d
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 10 deletions.
8 changes: 6 additions & 2 deletions docs/docs/user-guide/appendix/releasenotes-nv-ingest.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Release Notes
# NVIDIA-Ingest Release Notes

There are no release notes avaiable at this time.
## 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.
2 changes: 1 addition & 1 deletion docs/docs/user-guide/developer-guide/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
14 changes: 7 additions & 7 deletions docs/docs/user-guide/developer-guide/kubernetes-dev.md
Original file line number Diff line number Diff line change
@@ -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).
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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)
Expand Down

0 comments on commit 8b1d50d

Please sign in to comment.