From 1c9bb539de487a0ccef460f4fdade0b060e3bf3e Mon Sep 17 00:00:00 2001 From: Brent George Date: Fri, 31 May 2024 16:36:51 -0500 Subject: [PATCH 1/5] update README with correct Helm repo link --- charts/deepgram-self-hosted/Chart.yaml | 2 +- charts/deepgram-self-hosted/README.md | 4 ++-- charts/deepgram-self-hosted/README.md.gotmpl | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/charts/deepgram-self-hosted/Chart.yaml b/charts/deepgram-self-hosted/Chart.yaml index 043dcdf..d7fe8cf 100644 --- a/charts/deepgram-self-hosted/Chart.yaml +++ b/charts/deepgram-self-hosted/Chart.yaml @@ -1,7 +1,7 @@ apiVersion: v2 name: deepgram-self-hosted type: application -version: 0.1.0-alpha +version: 0.1.1-alpha appVersion: "release-240528" description: A Helm chart for running Deepgram services in a self-hosted environment home: "https://developers.deepgram.com/docs/self-hosted-introduction" diff --git a/charts/deepgram-self-hosted/README.md b/charts/deepgram-self-hosted/README.md index d9ed7d9..9554512 100644 --- a/charts/deepgram-self-hosted/README.md +++ b/charts/deepgram-self-hosted/README.md @@ -1,6 +1,6 @@ # deepgram-self-hosted -![Version: 0.1.0-alpha](https://img.shields.io/badge/Version-0.1.0--alpha-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: release-240528](https://img.shields.io/badge/AppVersion-release--240528-informational?style=flat-square) [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/deepgram-self-hosted)](https://artifacthub.io/packages/search?repo=deepgram-self-hosted) +![Version: 0.1.1-alpha](https://img.shields.io/badge/Version-0.1.1--alpha-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: release-240528](https://img.shields.io/badge/AppVersion-release--240528-informational?style=flat-square) [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/deepgram-self-hosted)](https://artifacthub.io/packages/search?repo=deepgram-self-hosted) A Helm chart for running Deepgram services in a self-hosted environment @@ -23,7 +23,7 @@ Kubernetes: `>=1.27.0-0` ## Get Repository Info ```bash -helm repo add deepgram https://deepgram.github.io/helm-charts +helm repo add deepgram https://deepgram.github.io/self-hosted-resources helm repo update ``` diff --git a/charts/deepgram-self-hosted/README.md.gotmpl b/charts/deepgram-self-hosted/README.md.gotmpl index 2179193..9ba5560 100644 --- a/charts/deepgram-self-hosted/README.md.gotmpl +++ b/charts/deepgram-self-hosted/README.md.gotmpl @@ -16,7 +16,7 @@ ## Get Repository Info ```bash -helm repo add deepgram https://deepgram.github.io/helm-charts +helm repo add deepgram https://deepgram.github.io/self-hosted-resources helm repo update ``` From e746d1a49c52cec9a4b8ba3fcf42433f3a1aa0a1 Mon Sep 17 00:00:00 2001 From: Brent George Date: Sat, 1 Jun 2024 08:04:32 -0500 Subject: [PATCH 2/5] include more troubleshooting resources --- README.md | 15 +++++---- charts/deepgram-self-hosted/README.md | 8 +++-- charts/deepgram-self-hosted/README.md.gotmpl | 8 +++-- docker/README.md | 32 ++++++++++++++++++ podman/README.md | 34 +++++++++++++++++++- 5 files changed, 86 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 639d2cc..417c837 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,13 @@ You can learn more about the Deepgram API at [developers.deepgram.com](https://d ## Getting Help -We love to hear from you so if you have questions, comments or find a bug in the -charts, let us know! You can either: - -- [Open an issue in this repository](https://github.com/deepgram/helm-charts/issues/new/choose) -- [Join the Deepgram Github Discussions Community](https://github.com/orgs/deepgram/discussions) -- [Join the Deepgram Discord Community](https://discord.gg/xWRaCDBtW4) +We love to hear from you so if you have questions, comments or find a bug in this repo, let us know! + +- If you have a Premium or VIP Support Plan with Deepgram you can find details and links to contact us for support on your [Console dashboard](https://console.deepgram.com). +- If you're interested in learning more about self-hosting Deepgram products, [contact us here](https://deepgram.com/contact-us)! +- If you have a specific bug or feature request for these resources, [you can open an issue in this repo](https://github.com/deepgram/helm-charts/issues/new/choose). +- The [Deepgram documentation](https://developers.deepgram.com) and [Deepgram Help Center](https://deepgram.gitbook.io/help-center) have answers to many common questions. +- Deepgram also has a developer community! + - [Join the Deepgram Github Discussions Community](https://github.com/orgs/deepgram/discussions) + - [Join the Deepgram Discord Community](https://discord.gg/xWRaCDBtW4) diff --git a/charts/deepgram-self-hosted/README.md b/charts/deepgram-self-hosted/README.md index 9554512..b28e41c 100644 --- a/charts/deepgram-self-hosted/README.md +++ b/charts/deepgram-self-hosted/README.md @@ -98,7 +98,11 @@ The Deepgram Helm chart takes references to two existing secrets - one containin Consult the [official Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/secret/) for best practices on configuring Secrets for use in your cluster. -## Troubleshooting +## Getting Help + +See the [Getting Help](https://github.com/deepgram/self-hosted-resources#getting-help) section in the root of this repository for a list of resources to help you troubleshoot and resolve issues. + +### Troubleshooting If you encounter issues while deploying or using Deepgram, consider the following troubleshooting steps: @@ -123,7 +127,7 @@ If you encounter issues while deploying or using Deepgram, consider the followin ```bash helm get values [RELEASE_NAME] > my-deployed-values.yaml ``` - - Reach out to the Deepgram support team, providing the collected diagnostic information for assistance. + - Provide the collected diagnostic information to Deepgram for assistance. ## Values diff --git a/charts/deepgram-self-hosted/README.md.gotmpl b/charts/deepgram-self-hosted/README.md.gotmpl index 9ba5560..518d396 100644 --- a/charts/deepgram-self-hosted/README.md.gotmpl +++ b/charts/deepgram-self-hosted/README.md.gotmpl @@ -91,7 +91,11 @@ The Deepgram Helm chart takes references to two existing secrets - one containin Consult the [official Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/secret/) for best practices on configuring Secrets for use in your cluster. -## Troubleshooting +## Getting Help + +See the [Getting Help](https://github.com/deepgram/self-hosted-resources#getting-help) section in the root of this repository for a list of resources to help you troubleshoot and resolve issues. + +### Troubleshooting If you encounter issues while deploying or using Deepgram, consider the following troubleshooting steps: @@ -116,7 +120,7 @@ If you encounter issues while deploying or using Deepgram, consider the followin ```bash helm get values [RELEASE_NAME] > my-deployed-values.yaml ``` - - Reach out to the Deepgram support team, providing the collected diagnostic information for assistance. + - Provide the collected diagnostic information to Deepgram for assistance. {{ template "chart.valuesSection" . }} diff --git a/docker/README.md b/docker/README.md index b2ab42e..5730b06 100644 --- a/docker/README.md +++ b/docker/README.md @@ -22,3 +22,35 @@ There are several [Docker Compose](https://docs.docker.com/compose/) templates f $ export DEEPGRAM_API_KEY= ``` 4. Finish the walkthrough documentation by completing the [Deploy Deepgram Services](https://developers.deepgram.com/docs/deploy-deepgram-services) guide. + +## Getting Help + +See the [Getting Help](https://github.com/deepgram/self-hosted-resources#getting-help) section in the root of this repository for a list of resources to help you troubleshoot and resolve issues. + +### Troubleshooting + +If you encounter issues while deploying or using Deepgram, consider the following troubleshooting steps: + +1. Check the pod status and logs: + - Use `docker ps` to check the status of the Deepgram containers. + - Use `docker logs ` to view the logs of a specific container. + - Use `docker inspect ` to view the configuration and status of a specific container. + +2. Verify resource availability: + - Ensure that the host machine has sufficient CPU, memory, and storage resources to accommodate the Deepgram components. + - Check for any resource constraints or limits imposed by your Docker Compose file or `docker run` command. + +3. Check the network connectivity: + - Verify that the Deepgram components can communicate with each other and with the Deepgram license server (license.deepgram.com). + - Check the network policies and firewall rules to ensure that the necessary ports and protocols are allowed. + +4. Collect diagnostic information: + - Gather relevant logs and metrics. + - Collect your existing configuration files: + - `api.toml` + - `engine.toml` + - `docker-compose.yml` + - `license-proxy.toml`, if applicable + - Provide the collected diagnostic information to Deepgram for assistance. + + diff --git a/podman/README.md b/podman/README.md index d65d583..3bb5217 100644 --- a/podman/README.md +++ b/podman/README.md @@ -10,7 +10,7 @@ There are several [Podman Compose](https://github.com/containers/podman-compose) * [Podman Compose template](./podman-compose.license-proxy.yml) for a deployment with the [Deepgram License Proxy](https://developers.deepgram.com/docs/license-proxy) * [Associated Deepgram configuration files](../common/license_proxy_deploy/) ## Usage -1. Read the [Deepgram self-hosted introduction](https://developers.deepgram.com/docs/self-hosted-introduction), then proceed to the [Docker/Podman](https://developers.deepgram.com/docs/dockerpodman) deployment path. Complete the series of guides until you have a deployment environment configured and are ready to begin the [Deploy Deepgram Services](https://developers.deepgram.com/docs/deploy-deepgram-services) guide. +1. Read the [Deepgram self-hosted introduction](https://developers.deepgram.com/docs/self-hosted-introduction), then proceed to the [Podman/Podman](https://developers.deepgram.com/docs/podmanpodman) deployment path. Complete the series of guides until you have a deployment environment configured and are ready to begin the [Deploy Deepgram Services](https://developers.deepgram.com/docs/deploy-deepgram-services) guide. 2. Download a copy of your chosen Podman Compose template and copies of the associated Deepgram `toml` configuration files. 3. Replace placeholder paths in your chosen Podman Compose template with the paths to your data and configuration files: * `/path/to/api.toml` @@ -22,3 +22,35 @@ There are several [Podman Compose](https://github.com/containers/podman-compose) $ export DEEPGRAM_API_KEY= ``` 4. Finish the walkthrough documentation by completing the [Deploy Deepgram Services](https://developers.deeps](https://developers.deepgram.com/docs/deploy-deepgram-services) guide. + +## Getting Help + +See the [Getting Help](https://github.com/deepgram/self-hosted-resources#getting-help) section in the root of this repository for a list of resources to help you troubleshoot and resolve issues. + +### Troubleshooting + +If you encounter issues while deploying or using Deepgram, consider the following troubleshooting steps: + +1. Check the pod status and logs: + - Use `podman ps` to check the status of the Deepgram containers. + - Use `podman logs ` to view the logs of a specific container. + - Use `podman inspect ` to view the configuration and status of a specific container. + +2. Verify resource availability: + - Ensure that the host machine has sufficient CPU, memory, and storage resources to accommodate the Deepgram components. + - Check for any resource constraints or limits imposed by your Podman Compose file or `podman run` command. + +3. Check the network connectivity: + - Verify that the Deepgram components can communicate with each other and with the Deepgram license server (license.deepgram.com). + - Check the network policies and firewall rules to ensure that the necessary ports and protocols are allowed. + +4. Collect diagnostic information: + - Gather relevant logs and metrics. + - Collect your existing configuration files: + - `api.toml` + - `engine.toml` + - `podman-compose.yml` + - `license-proxy.toml`, if applicable + - Provide the collected diagnostic information to Deepgram for assistance. + + From 25f320812f2e082ea81b7a0d7252d5aeea168502 Mon Sep 17 00:00:00 2001 From: Brent George Date: Sat, 1 Jun 2024 08:11:37 -0500 Subject: [PATCH 3/5] update recursive links to this repo --- README.md | 2 +- charts/deepgram-self-hosted/README.md | 2 +- charts/deepgram-self-hosted/README.md.gotmpl | 2 +- .../deepgram-self-hosted/samples/aws/license-proxy/values.yaml | 3 +-- .../deepgram-self-hosted/samples/gcp/license-proxy/values.yaml | 3 +-- docker/README.md | 2 +- podman/README.md | 2 +- 7 files changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 417c837..308f93b 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ We love to hear from you so if you have questions, comments or find a bug in thi - If you have a Premium or VIP Support Plan with Deepgram you can find details and links to contact us for support on your [Console dashboard](https://console.deepgram.com). - If you're interested in learning more about self-hosting Deepgram products, [contact us here](https://deepgram.com/contact-us)! -- If you have a specific bug or feature request for these resources, [you can open an issue in this repo](https://github.com/deepgram/helm-charts/issues/new/choose). +- If you have a specific bug or feature request for these resources, [you can open an issue in this repo](https://github.com/deepgram/self-hosted-resources/issues/new/choose). - The [Deepgram documentation](https://developers.deepgram.com) and [Deepgram Help Center](https://deepgram.gitbook.io/help-center) have answers to many common questions. - Deepgram also has a developer community! - [Join the Deepgram Github Discussions Community](https://github.com/orgs/deepgram/discussions) diff --git a/charts/deepgram-self-hosted/README.md b/charts/deepgram-self-hosted/README.md index b28e41c..54905d7 100644 --- a/charts/deepgram-self-hosted/README.md +++ b/charts/deepgram-self-hosted/README.md @@ -100,7 +100,7 @@ Consult the [official Kubernetes documentation](https://kubernetes.io/docs/conce ## Getting Help -See the [Getting Help](https://github.com/deepgram/self-hosted-resources#getting-help) section in the root of this repository for a list of resources to help you troubleshoot and resolve issues. +See the [Getting Help](../../README.md#getting-help) section in the root of this repository for a list of resources to help you troubleshoot and resolve issues. ### Troubleshooting diff --git a/charts/deepgram-self-hosted/README.md.gotmpl b/charts/deepgram-self-hosted/README.md.gotmpl index 518d396..320c29a 100644 --- a/charts/deepgram-self-hosted/README.md.gotmpl +++ b/charts/deepgram-self-hosted/README.md.gotmpl @@ -93,7 +93,7 @@ Consult the [official Kubernetes documentation](https://kubernetes.io/docs/conce ## Getting Help -See the [Getting Help](https://github.com/deepgram/self-hosted-resources#getting-help) section in the root of this repository for a list of resources to help you troubleshoot and resolve issues. +See the [Getting Help](../../README.md#getting-help) section in the root of this repository for a list of resources to help you troubleshoot and resolve issues. ### Troubleshooting diff --git a/charts/deepgram-self-hosted/samples/aws/license-proxy/values.yaml b/charts/deepgram-self-hosted/samples/aws/license-proxy/values.yaml index 7510d3e..0ec4c2f 100644 --- a/charts/deepgram-self-hosted/samples/aws/license-proxy/values.yaml +++ b/charts/deepgram-self-hosted/samples/aws/license-proxy/values.yaml @@ -1,5 +1,4 @@ -# See the Chart [README](https://github.com/deepgram/helm-charts) or -# [`values.yaml`](https://github.com/deepgram/helm-charts/blob/main/values.yaml) +# See the Chart [README](https://github.com/deepgram/self-hosted-resources/blob/main/charts/deepgram-self-hosted#values) # for documentation on all available options. global: diff --git a/charts/deepgram-self-hosted/samples/gcp/license-proxy/values.yaml b/charts/deepgram-self-hosted/samples/gcp/license-proxy/values.yaml index 79d6f16..e9e662d 100644 --- a/charts/deepgram-self-hosted/samples/gcp/license-proxy/values.yaml +++ b/charts/deepgram-self-hosted/samples/gcp/license-proxy/values.yaml @@ -1,5 +1,4 @@ -# See the Chart [README](https://github.com/deepgram/helm-charts) or -# [`values.yaml`](https://github.com/deepgram/helm-charts/blob/main/values.yaml) +# See the Chart [README](https://github.com/deepgram/self-hosted-resources/blob/main/charts/deepgram-self-hosted#values) # for documentation on all available options. global: diff --git a/docker/README.md b/docker/README.md index 5730b06..40a6431 100644 --- a/docker/README.md +++ b/docker/README.md @@ -25,7 +25,7 @@ There are several [Docker Compose](https://docs.docker.com/compose/) templates f ## Getting Help -See the [Getting Help](https://github.com/deepgram/self-hosted-resources#getting-help) section in the root of this repository for a list of resources to help you troubleshoot and resolve issues. +See the [Getting Help](../README.md#getting-help) section in the root of this repository for a list of resources to help you troubleshoot and resolve issues. ### Troubleshooting diff --git a/podman/README.md b/podman/README.md index 3bb5217..c9af384 100644 --- a/podman/README.md +++ b/podman/README.md @@ -25,7 +25,7 @@ There are several [Podman Compose](https://github.com/containers/podman-compose) ## Getting Help -See the [Getting Help](https://github.com/deepgram/self-hosted-resources#getting-help) section in the root of this repository for a list of resources to help you troubleshoot and resolve issues. +See the [Getting Help](../README.md#getting-help) section in the root of this repository for a list of resources to help you troubleshoot and resolve issues. ### Troubleshooting From 627c971112e9a145789b3b14dc201d9d27ee5af4 Mon Sep 17 00:00:00 2001 From: Brent George Date: Mon, 3 Jun 2024 10:08:17 -0400 Subject: [PATCH 4/5] update publish GH Action token --- .github/workflows/publish.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index a5c708a..fa1a203 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -15,7 +15,7 @@ jobs: uses: actions/checkout@v3 with: fetch-depth: 0 - token: "${{ secrets.DGPAT }}" + token: "${{ secrets.GH_SELFHOSTEDRESOURCES_RW }}" - name: Configure Git run: | @@ -26,7 +26,7 @@ jobs: - name: Install Helm uses: azure/setup-helm@v4 env: - GITHUB_TOKEN: "${{ secrets.DGPAT }}" + GITHUB_TOKEN: "${{ secrets.GH_SELFHOSTEDRESOURCES_RW }}" - name: Add NVIDIA Helm chart repository run: | @@ -36,4 +36,4 @@ jobs: - name: Run chart-releaser uses: helm/chart-releaser-action@v1.6.0 env: - CR_TOKEN: "${{ secrets.DGPAT }}" + CR_TOKEN: "${{ secrets.GH_SELFHOSTEDRESOURCES_RW }}" From eab95aa971fd37b17951c219ce36beec68df3e99 Mon Sep 17 00:00:00 2001 From: Brent George Date: Mon, 3 Jun 2024 10:31:29 -0400 Subject: [PATCH 5/5] fix bad replacement of `docker` string --- podman/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/podman/README.md b/podman/README.md index c9af384..7c16621 100644 --- a/podman/README.md +++ b/podman/README.md @@ -10,7 +10,7 @@ There are several [Podman Compose](https://github.com/containers/podman-compose) * [Podman Compose template](./podman-compose.license-proxy.yml) for a deployment with the [Deepgram License Proxy](https://developers.deepgram.com/docs/license-proxy) * [Associated Deepgram configuration files](../common/license_proxy_deploy/) ## Usage -1. Read the [Deepgram self-hosted introduction](https://developers.deepgram.com/docs/self-hosted-introduction), then proceed to the [Podman/Podman](https://developers.deepgram.com/docs/podmanpodman) deployment path. Complete the series of guides until you have a deployment environment configured and are ready to begin the [Deploy Deepgram Services](https://developers.deepgram.com/docs/deploy-deepgram-services) guide. +1. Read the [Deepgram self-hosted introduction](https://developers.deepgram.com/docs/self-hosted-introduction), then proceed to the [Docker/Podman](https://developers.deepgram.com/docs/dockerpodman) deployment path. Complete the series of guides until you have a deployment environment configured and are ready to begin the [Deploy Deepgram Services](https://developers.deepgram.com/docs/deploy-deepgram-services) guide. 2. Download a copy of your chosen Podman Compose template and copies of the associated Deepgram `toml` configuration files. 3. Replace placeholder paths in your chosen Podman Compose template with the paths to your data and configuration files: * `/path/to/api.toml`