Merge pull request #86320 from zr-msft/ds-helm-external-repo

[Dev Spaces] accessing private helm repo

Author: ktoliver

articles/dev-spaces/how-to/use-private-helm-repo.md

@@ -0,0 +1,80 @@
+---
+title: "How to use a private Helm repository in Azure Dev Spaces"
+titleSuffix: Azure Dev Spaces
+services: azure-dev-spaces
+ms.service: azure-dev-spaces
+author: "zr-msft"
+ms.author: "zarhoads"
+ms.date: "08/22/2019"
+ms.topic: "conceptual"
+description: "Use a private Helm repository in an Azure Dev Space."
+keywords: "Docker, Kubernetes, Azure, AKS, Azure Container Service, containers, Helm"
+manager: gwallace
+---
+# Use a private Helm repository in Azure Dev Spaces
+
+[Helm][helm] is a package manager for Kuberentes. Helm uses a [chart][helm-chart] format to package dependencies. Helm charts are stored in a repository, which can be public or private. Azure Dev Spaces only retrieves Helm charts from public repositories when running your application. In cases where the Helm repository is private or Azure Dev Spaces can't access it, you can add a chart from that repository directly to your application. Adding the chart directly lets Azure Dev Spaces run your application without having to access the private Helm repository.
+
+## Add the private Helm repository to your local machine
+
+Use [helm repo add][helm-repo-add] and [helm repo update][helm-repo-update] to access the private Helm repository from your local machine.
+
+```cmd
+helm repo add privateRepoName http://example.com/helm/v1/repo --username user --password 5tr0ng_P@ssw0rd!
+helm repo update
+```
+
+## Add the chart to your application
+
+Navigate to your project's directory and run `azds prep`.
+
+```cmd
+azds prep --public
+```
+
+Create a [requirements.yaml][helm-requirements] file with your chart in your application's chart directory. For example, if your application is named *app1*, you would create *charts/app1/requirements.yaml*.
+
+```yaml
+dependencies:
+    - name: mychart
+      version: 0.1.0
+      repository:  http://example.com/helm/v1/repo
+```
+
+Navigate to your application's chart directory and use [helm dependency update][helm-dependency-update] to update the Helm dependencies for your application and download the chart from the private repository.
+
+```cmd
+helm dependency update
+```
+
+Verify a *charts* subdirectory with a *tgz* file has been added to your application's chart directory. For example, *charts/app1/charts/mychart-0.1.0.tgz*.
+
+The chart from your private Helm repository has been downloaded and added to your project. Remove the *requirements.yaml* file so that Dev Spaces won't try to update this dependency.
+
+## Run your application
+
+Navigate to the root directory of your project and run `azds up` to verify your application successfully runs in your dev space.
+
+```cmd
+$ azds up
+Using dev space 'default' with target 'MyAKS'
+Synchronizing files...2s
+Installing Helm chart...2s
+Waiting for container image build...2m 25s
+Building container image...
+...
+Service 'app1' port 'http' is available at http://app1.1234567890abcdef1234.eus.azds.io/
+Service 'app1' port 80 (http) is available at http://localhost:54256
+...
+```
+
+## Next steps
+
+Learn more about [Helm and how it works][helm].
+
+[helm]: https://docs.helm.sh
+[helm-chart]: https://helm.sh/docs/developing_charts/
+[helm-dependency-update]: https://helm.sh/docs/helm/#helm-dependency-update
+[helm-repo-add]: https://helm.sh/docs/helm/#helm-repo-add
+[helm-repo-update]: https://helm.sh/docs/helm/#helm-repo-update
+[helm-requirements]: https://helm.sh/docs/developing_charts/#chart-dependencies

articles/dev-spaces/toc.yml

@@ -73,6 +73,8 @@
       href: how-to/manage-secrets.md
     - name: Use a custom NuGet feed
       href: how-to/use-custom-nuget-feed.md
+    - name: Use a private Helm repository
+      href: how-to/use-private-helm-repo.md
     - name: Use kubectl with Azure Dev Spaces
       href: how-to/use-kubectl-with-azure-dev-spaces.md
     - name: Upgrade Azure Dev Spaces tools