| title | services | ms.date | ms.topic | description | keywords | manager |
|---|---|---|---|---|---|---|
Team development on Kubernetes |
azure-dev-spaces |
01/22/2020 |
quickstart |
This quickstart shows you how to do team Kubernetes development with containers and microservices with Azure Dev Spaces |
Docker, Kubernetes, Azure, AKS, Azure Kubernetes Service, containers, Helm, service mesh, service mesh routing, kubectl, k8s |
gwallace |
In this guide, you will learn how to:
- Set up Azure Dev Spaces on a managed Kubernetes cluster in Azure.
- Deploy a large application with multiple microservices to a dev space.
- Test a single microservice in an isolated dev space within the context of the full application.
- An Azure subscription. If you don't have an Azure subscription, you can create a free account.
- Azure CLI installed.
- Helm 3 installed.
You must create an AKS cluster in a supported region. The below commands create a resource group called MyResourceGroup and an AKS cluster called MyAKS.
az group create --name MyResourceGroup --location eastus
az aks create -g MyResourceGroup -n MyAKS --location eastus --generate-ssh-keys
Use the use-dev-spaces command to enable Dev Spaces on your AKS cluster and follow the prompts. The below command enables Dev Spaces on the MyAKS cluster in the MyResourceGroup group and creates a dev space called dev.
Note
The use-dev-spaces command will also install the Azure Dev Spaces CLI if its not already installed. You cannot install the Azure Dev Spaces CLI in the Azure Cloud Shell.
az aks use-dev-spaces -g MyResourceGroup -n MyAKS --space dev --yes
In this article, you use the Azure Dev Spaces Bike Sharing sample application to demonstrate using Azure Dev Spaces.
Clone the application from GitHub and navigate into its directory:
git clone https://github.com/Azure/dev-spaces
cd dev-spaces/samples/BikeSharingApp/Use the azds show-context command to show the HostSuffix for dev.
$ azds show-context
Name ResourceGroup DevSpace HostSuffix
------------------ ---------------- -------- -----------------------
MyAKS MyResourceGroup dev fedcab0987.eus.azds.ioOpen charts/values.yaml and replace all instances of <REPLACE_ME_WITH_HOST_SUFFIX> with the HostSuffix value you retrieved earlier. Save your changes and close the file.
The commands for running the sample application on Kubernetes are part of an existing process and have no dependency on Azure Dev Spaces tooling. In this case, Helm is the tooling used to run this sample application but other tooling could be used to run your entire application in a namespace within a cluster. The Helm commands are targeting the dev space named dev you created earlier, but this dev space is also a Kubernetes namespace. As a result, dev spaces can be targeted by other tooling the same as other namespaces.
You can use Azure Dev Spaces for team development after an application is running in a cluster regardless of the tooling used to deploy it.
Use the helm install command to set up and install the sample application on your cluster.
cd charts/
helm install bikesharingsampleappsampleapp . --dependency-update --namespace dev --atomicThe helm install command may take several minutes to complete. After the sample application is installed on your cluster and since you have Dev Spaces enabled on your cluster, use the azds list-uris command to display the URLs for the sample application in dev that is currently selected.
$ azds list-uris
Uri Status
-------------------------------------------------- ---------
http://dev.bikesharingweb.fedcab0987.eus.azds.io/ Available
http://dev.gateway.fedcab0987.eus.azds.io/ AvailableNavigate to the bikesharingweb service by opening the public URL from the azds list-uris command. In the above example, the public URL for the bikesharingweb service is http://dev.bikesharingweb.fedcab0987.eus.azds.io/. Select Aurelia Briggs (customer) as the user. Verify you see the text Hi Aurelia Briggs | Sign Out at the top.
Use the azds space select command to create two child spaces under dev:
azds space select -n dev/azureuser1 -y
azds space select -n dev/azureuser2 -yThe above commands create two child spaces under dev named azureuser1 and azureuser2. These two child spaces represent distinct dev spaces for developers azureuser1 and azureuser2 to use for making changes to the sample application.
Use the azds space list command to list all the dev spaces and confirm dev/azureuser2 is selected.
$ azds space list
Name DevSpacesEnabled
- -------------- ----------------
default False
dev True
dev/azureuser1 True
* dev/azureuser2 TrueUse the azds list-uris to display the URLs for the sample application in the currently selected space that is dev/azureuser2.
$ azds list-uris
Uri Status
-------------------------------------------------- ---------
http://azureuser2.s.dev.bikesharingweb.fedcab0987.eus.azds.io/ Available
http://azureuser2.s.dev.gateway.fedcab0987.eus.azds.io/ AvailableConfirm that the URLs displayed by the azds list-uris command have the azureuser2.s.dev prefix. This prefix confirms that the current space selected is azureuser2, which is a child of dev.
Navigate to the bikesharingweb service for the dev/azureuser2 dev space by opening the public URL from the azds list-uris command. In the above example, the public URL for the bikesharingweb service is http://azureuser2.s.dev.bikesharingweb.fedcab0987.eus.azds.io/. Select Aurelia Briggs (customer) as the user. Verify you see the text Hi Aurelia Briggs | Sign out at the top.
Open BikeSharingWeb/components/Header.js with a text editor and change the text in the span element with the userSignOut className.
<span className="userSignOut">
<Link href="/devsignin"><span tabIndex="0">Welcome {props.userName} | Sign out</span></Link>
</span>Save your changes and close the file.
Navigate to the BikeSharingWeb/ directory and run the azds up command.
$ cd ../BikeSharingWeb/
$ azds up
Using dev space 'dev/azureuser2' with target 'MyAKS'
Synchronizing files...2s
...
Service 'bikesharingweb' port 'http' is available at http://azureuser2.s.dev.bikesharingweb.fedcab0987.eus.azds.io/
Service 'bikesharingweb' port 80 (http) is available at http://localhost:54256
...This command builds and runs the bikesharingweb service in the dev/azureuser2 dev space. This service runs in addition to the bikesharingweb service running in dev and is only used for requests with the azureuser2.s URL prefix. For more information on how routing works between parent and child dev spaces, see How Azure Dev Spaces works and is configured.
Navigate to the bikesharingweb service for the dev/azureuser2 dev space by opening the public URL displayed in the output of the azds up command. Select Aurelia Briggs (customer) as the user. Verify you see the updated text in the upper right corner. You may need to refresh the page or clear your browser's cache if you do not immediately see this change.
Note
When you navigate to your service while running azds up, the HTTP request traces are also displayed in the output of the azds up command. These traces can help you troubleshoot and debug your service. You can disable these traces using --disable-http-traces when running azds up.
If the azds up command is still running, press Ctrl+c.
$ azds list-uris --all
Uri Status
-------------------------------------------------- ---------
http://azureuser1.s.dev.bikesharingweb.fedcab0987.eus.azds.io/ Available
http://azureuser1.s.dev.gateway.fedcab0987.eus.azds.io/ Available
http://azureuser2.s.dev.bikesharingweb.fedcab0987.eus.azds.io/ Available
http://azureuser2.s.dev.gateway.fedcab0987.eus.azds.io/ Available
http://dev.bikesharingweb.fedcab0987.eus.azds.io/ Available
http://dev.gateway.fedcab0987.eus.azds.io/ AvailableNavigate to the dev version of bikesharingweb in your browser, choose Aurelia Briggs (customer) as the user, and verify you see the original text in the upper right corner. Repeat these steps with the dev/azureuser1 URL. Notice the changes are only applied to the dev/azureuser2 version of bikesharingweb. This isolation of changes to dev/azureuser2 allows for azureuser2 to make changes without affecting azureuser1.
To have these changes reflected in dev and dev/azureuser1, you should follow your team's existing workflow or CI/CD pipeline. For example, this workflow may involve committing your change to your version control system and deploying the update using a CI/CD pipeline or tooling such as Helm.
az group delete --name MyResourceGroup --yes --no-wait
Learn how Azure Dev Spaces helps you develop more complex apps across multiple containers, and how you can simplify collaborative development by working with different versions or branches of your code in different spaces.
[!div class="nextstepaction"] Working with multiple containers and team development