Skip to content

Commit 524b953

Browse files
authored
Merge pull request #102524 from zr-msft/ds-faq-existing-assets
add FAQ entry for existing Dockerfile and Helm charts
2 parents b4d1d4c + 3b4a38b commit 524b953

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

articles/dev-spaces/faq.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Frequently asked questions about Azure Dev Spaces"
33
services: azure-dev-spaces
4-
ms.date: 09/25/2019
4+
ms.date: 01/28/2020
55
ms.topic: "conceptual"
66
description: "Find answers to some of the common questions about Azure Dev Spaces"
77
keywords: "Docker, Kubernetes, Azure, AKS, Azure Kubernetes Service, containers, Helm, service mesh, service mesh routing, kubectl, k8s "
@@ -15,17 +15,34 @@ This addresses frequently asked questions about Azure Dev Spaces.
1515

1616
See [supported regions][supported-regions] for a complete list of available regions.
1717

18+
## Can I use Azure Dev Spaces with existing Dockerfiles or Helm charts?
19+
20+
Yes, if your project already has a Dockerfile or a Helm chart, you can use those files with Azure Dev Spaces. When you run `azds prep`, use the `--chart` parameter and specify the location of the chart. Azure Dev Spaces will still generate an *azds.yaml* and *Dockerfile.develop* file, but it will not replace or modify an existing Dockerfile or a Helm chart. You may need to modify the *azds.yaml* and *Dockerfile.develop* files in order for everything to work correctly with your existing application when running `azds up`.
21+
22+
When using your own Dockerfile or Helm chart, there are the following limitations:
23+
* If using only one Dockerfile, it must include everything you need to enable development scenarios, such as the language SDK not just the runtime. If using a separate Dockerfile for Azure Dev Spaces, such as a Dockerfile.develop, everything you need to enable development scenarios must be included in that Dockerfile.
24+
* Your Helm chart must support passing part of or the entire image tag as a value from *values.yaml*.
25+
* If you are modifying anything with ingress, you can also update your Helm chart to use the ingress solution provided by Azure Dev Spaces.
26+
* If you want to use the [routing capabilities provided by Azure Dev Spaces][dev-spaces-routing], all services for an individual project must fit within a single Kubernetes namespace and must be deployed with simple naming, for example *service-a*. In standard Helm charts, this naming update can be done by specifying a value for the *fullnameOverride* property.
27+
28+
To compare your own Dockerfile or Helm chart to an existing version that works with Azure Dev Spaces, review the files generated in the [quickstart][quickstart-cli].
29+
30+
31+
## Can I modify the files generated by Azure Dev Spaces?
32+
33+
Yes, you can modify the *azds.yaml* file, Dockerfile, and Helm chart [generated by Azure Dev Spaces when preparing your project][dev-spaces-prep]. Modifying these files changes how the project is built and run.
34+
1835
## Can I use Azure Dev Spaces without a public IP address?
1936

2037
No, you can't provision Azure Dev Spaces on an AKS Cluster without a public IP. A public IP is [needed by Azure Dev Spaces for routing][dev-spaces-routing].
2138

2239
## Can I use my own ingress with Azure Dev Spaces?
2340

24-
Yes, you can configure your own ingress along side the one Azure Dev Spaces creates. For example, you can use [traefik][ingress-traefik].
41+
Yes, you can configure your own ingress along side the ingress Azure Dev Spaces creates. For example, you can use [traefik][ingress-traefik] or [NGINX][ingress-nginx].
2542

2643
## Can I use HTTPS with Azure Dev Spaces?
2744

28-
Yes, you can configure your own ingress with HTTPS using [traefik][ingress-https-traefik].
45+
Yes, you can configure your own ingress with HTTPS using [traefik][ingress-https-traefik] or [NGINX][ingress-https-nginx].
2946

3047
## Can I use Azure Dev Spaces on a cluster that uses CNI rather than kubenet?
3148

@@ -39,7 +56,7 @@ Currently, Azure Dev Spaces is intended to run on Linux pods and nodes only, but
3956

4057
Yes, you can use Azure Dev Spaces on AKS clusters with [API server authorized IP address ranges][aks-auth-range] enabled. More information on using an AKS clusters with API server authorized IP address ranges enabled with Azure Dev Spaces is available [here](configure-networking.md#using-api-server-authorized-ip-ranges).
4158

42-
### Can I use Azure Dev Spaces on AKS clusters with restricted egress traffic for cluster nodes?
59+
## Can I use Azure Dev Spaces on AKS clusters with restricted egress traffic for cluster nodes?
4360

4461
Yes, you can use Azure Dev Spaces on AKS clusters with [restricted egress traffic for cluster nodes][aks-restrict-egress-traffic] enabled once the correct FQDNs have been allowed. More information on using an AKS clusters with restricted egress traffic for cluster nodes enabled with Azure Dev Spaces is available [here](configure-networking.md#ingress-and-egress-network-traffic-requirements).
4562

@@ -48,8 +65,12 @@ Yes, you can use Azure Dev Spaces on AKS clusters with [restricted egress traffi
4865
[aks-auth-range-ranges]: https://github.com/Azure/dev-spaces/tree/master/public-ips
4966
[aks-auth-range-update]: ../aks/api-server-authorized-ip-ranges.md#update-a-clusters-api-server-authorized-ip-ranges
5067
[aks-restrict-egress-traffic]: ../aks/limit-egress-traffic.md
68+
[dev-spaces-prep]: how-dev-spaces-works.md#prepare-your-code
5169
[dev-spaces-routing]: how-dev-spaces-works.md#how-routing-works
70+
[ingress-nginx]: how-to/ingress-https-nginx.md#configure-a-custom-nginx-ingress-controller
5271
[ingress-traefik]: how-to/ingress-https-traefik.md#configure-a-custom-traefik-ingress-controller
72+
[ingress-https-nginx]: how-to/ingress-https-nginx.md#configure-the-nginx-ingress-controller-to-use-https
5373
[ingress-https-traefik]: how-to/ingress-https-traefik.md#configure-the-traefik-ingress-controller-to-use-https
74+
[quickstart-cli]: quickstart-cli.md
5475
[supported-regions]: https://azure.microsoft.com/global-infrastructure/services/?products=kubernetes-service
5576
[windows-containers]: how-to/run-dev-spaces-windows-containers.md

0 commit comments

Comments
 (0)