Skip to content

Commit 48548a3

Browse files
authored
Merge pull request #88721 from Ja-Dunn/five-iot-accelerators-articles
edit pass: five-iot-accelerators-articles
2 parents 0b0e9ff + 6b15c33 commit 48548a3

File tree

5 files changed

+316
-401
lines changed

5 files changed

+316
-401
lines changed

articles/iot-accelerators/howto-opc-vault-deploy.md

Lines changed: 49 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -15,44 +15,43 @@ manager: philmea
1515
This article explains how to deploy the OPC Vault certificate management service in Azure.
1616

1717
> [!NOTE]
18-
> For more information on deployment details and instructions, see the GitHub [OPC Vault repository](https://github.com/Azure/azure-iiot-opc-vault-service).
18+
> For more information, see the GitHub [OPC Vault repository](https://github.com/Azure/azure-iiot-opc-vault-service).
1919
2020
## Prerequisites
2121

2222
### Install required software
2323

2424
Currently the build and deploy operation is limited to Windows.
25-
The samples are all written for C# .Net Standard, which is needed to build the service and samples for deployment.
26-
All the tools you need for .Net Standard come with the .Net Core tools. See [here](https://docs.microsoft.com/dotnet/articles/core/getting-started) for what you need.
25+
The samples are all written for C# .NET Standard, which you need to build the service and samples for deployment.
26+
All the tools you need for .NET Standard come with the .NET Core tools. See [Get started with .NET Core](https://docs.microsoft.com/dotnet/articles/core/getting-started).
2727

2828
1. [Install .NET Core 2.1+][dotnet-install].
29-
2. [Install Docker][docker-url] (optional, only if the local docker build is required).
30-
4. Install the [Azure Command-line tools for PowerShell][powershell-install].
31-
5. Sign up for an [Azure Subscription][azure-free].
29+
2. [Install Docker][docker-url] (optional, only if the local Docker build is required).
30+
4. Install the [Azure command-line tools for PowerShell][powershell-install].
31+
5. Sign up for an [Azure subscription][azure-free].
3232

3333
### Clone the repository
3434

35-
If you have not done so yet, clone this GitHub repository. Open a command prompt or terminal and run:
35+
If you haven't done so yet, clone this GitHub repository. Open a command prompt or terminal, and run the following:
3636

3737
```bash
3838
git clone https://github.com/Azure/azure-iiot-opc-vault-service
3939
cd azure-iiot-opc-vault-service
4040
```
4141

42-
or clone the repo directly in Visual Studio 2017.
42+
Alternatively, you can clone the repo directly in Visual Studio 2017.
4343

4444
### Build and deploy the Azure service on Windows
4545

46-
A Powershell script provides an easy way to deploy the OPC Vault microservice and the application.<br>
46+
A PowerShell script provides an easy way to deploy the OPC Vault microservice and the application.
4747

48-
1. Open a Powershell window at the repo root.
49-
3. Go to the deploy folder `cd deploy`
50-
3. Choose a name for `myResourceGroup` that's unlikely to cause a conflict with other deployed webpages. See [below](#website-name-already-in-use) how webpage names are chosen based on the name of the resource group.
51-
5. Start the deployment with `.\deploy.ps1` for interactive installation<br>
52-
or enter a full command line:
48+
1. Open a PowerShell window at the repo root.
49+
3. Go to the deploy folder `cd deploy`.
50+
3. Choose a name for `myResourceGroup` that's unlikely to cause a conflict with other deployed webpages. See the "Website name already in use" section later in this article.
51+
5. Start the deployment with `.\deploy.ps1` for interactive installation, or enter a full command line:
5352
`.\deploy.ps1 -subscriptionName "MySubscriptionName" -resourceGroupLocation "East US" -tenantId "myTenantId" -resourceGroupName "myResourceGroup"`
54-
7. If you plan to develop with this deployment, add `-development 1` to enable the Swagger UI and to deploy debug builds.
55-
6. Follow the instructions in the script to sign in to your subscription and to provide additional information.
53+
7. If you plan to develop with this deployment, add `-development 1` to enable the Swagger UI, and to deploy debug builds.
54+
6. Follow the instructions in the script to sign in to your subscription, and to provide additional information.
5655
9. After a successful build and deploy operation, you should see the following message:
5756
```
5857
To access the web client go to:
@@ -68,49 +67,51 @@ or enter a full command line:
6867
.\myResourceGroup-gds.cmd
6968
```
7069

71-
In case you run into issues follow the steps [below](#troubleshooting-deployment-failures).
70+
> [!NOTE]
71+
> In case of problems, see the "Troubleshooting deployment failures" section later in the article.
7272
73-
8. Open your favorite browser and open the application page: `https://myResourceGroup.azurewebsites.net`
74-
8. Give the web app and the OPC Vault microservice a few minutes to warm up after deployment. The web home page may hang on first use for up to a minute until you get the first responses.
75-
11. To take a look at the Swagger Api open: `https://myResourceGroup-service.azurewebsites.net`
76-
13. To start a local GDS server with dotnet start `.\myResourceGroup-gds.cmd` or with docker start `.\myResourceGroup-dockergds.cmd`.
73+
8. Open your favorite browser, and open the application page: `https://myResourceGroup.azurewebsites.net`
74+
8. Give the web app and the OPC Vault microservice a few minutes to warm up after deployment. The web home page might hang on first use, for up to a minute, until you get the first responses.
75+
11. To take a look at the Swagger API, open: `https://myResourceGroup-service.azurewebsites.net`
76+
13. To start a local GDS server with dotnet, start `.\myResourceGroup-gds.cmd`. With Docker, start `.\myResourceGroup-dockergds.cmd`.
7777

78-
As a sidenote, it is possible to redeploy a build with exactly the same settings. Be aware that such an operation renews all application secrets and may reset some settings in the Azure Active Directory (Azure AD) application registrations.
78+
It's possible to redeploy a build with exactly the same settings. Be aware that such an operation renews all application secrets, and might reset some settings in the Azure Active Directory (Azure AD) application registrations.
7979

80-
It is also possible to redeploy just the web app binaries. With the parameter `-onlyBuild 1` new zip packages of the service and the app are deployed to the web applications.
80+
It's also possible to redeploy just the web app binaries. With the parameter `-onlyBuild 1`, new zip packages of the service and the app are deployed to the web applications.
8181

82-
After successful deployment, feel free to start using the services: [How to manage the OPC Vault Certificate Management Service](howto-opc-vault-manage.md)
82+
After successful deployment, you can start using the services. See [Manage the OPC Vault certificate management service](howto-opc-vault-manage.md).
8383

8484
## Delete the services from the subscription
8585

86-
1. Sign in to the Azure portal: `https://portal.azure.com`.
86+
Here's how:
87+
88+
1. Sign in to the [Azure portal](https://portal.azure.com).
8789
2. Go to the resource group in which the service was deployed.
88-
3. Select `Delete resource group` and confirm.
89-
4. After a short while all deployed service components are deleted.
90-
5. Now go to `Azure Active Directory/App registrations`.
91-
6. There should be three registrations listed for each deployed resource group with the following names:
92-
`resourcegroup-client`, `resourcegroup-module`, `resourcegroup-service`.
93-
Each registration needs to be deleted separately.
94-
7. Now all deployed components are removed.
90+
3. Select **Delete resource group**, and confirm.
91+
4. After a short while, all deployed service components are deleted.
92+
5. Go to **Azure Active Directory** > **App registrations**.
93+
6. There should be three registrations listed for each deployed resource group. The registrations have the following names:
94+
`resourcegroup-client`, `resourcegroup-module`, `resourcegroup-service`. Delete each registration separately.
95+
96+
Now all deployed components are removed.
9597

9698
## Troubleshooting deployment failures
9799

98100
### Resource group name
99101

100-
Ensure you use a short and simple resource group name. The name is used also to name resources and the service url prefix and as such, it must comply with resource naming requirements.
102+
Use a short and simple resource group name. The name is also used to name resources and the service URL prefix. As such, it must comply with resource naming requirements.
101103

102104
### Website name already in use
103105

104-
It is possible that the name of the website is already in use. If you run into this error, you need to use a different resource group name. The hostnames in use by the deployment script are: https://resourcegroupname.azurewebsites.net and https://resourgroupname-service.azurewebsites.net.
105-
Other names of services are built by the combination of short name hashes and are unlikely to conflict with other services.
106+
It's possible that the name of the website is already in use. You need to use a different resource group name. The hostnames in use by the deployment script are: https://resourcegroupname.azurewebsites.net and https://resourgroupname-service.azurewebsites.net.
107+
Other names of services are built by the combination of short name hashes, and are unlikely to conflict with other services.
106108

107-
### Azure Active Directory (Azure AD) registration
109+
### Azure AD registration
108110

109-
The deployment script tries to register three Azure AD applications in Azure Active Directory.
110-
Depending on your permissions in the selected Azure AD tenant, this operation might fail. There are two options:
111+
The deployment script tries to register three Azure AD applications in Azure AD. Depending on your permissions in the selected Azure AD tenant, this operation might fail. There are two options:
111112

112-
1. If you chose an Azure AD tenant from a list of tenants, restart the script and choose a different one from the list.
113-
2. Alternatively, deploy a private Azure AD tenant in another subscription, restart the script and select to use it.
113+
- If you chose an Azure AD tenant from a list of tenants, restart the script and choose a different one from the list.
114+
- Alternatively, deploy a private Azure AD tenant in another subscription. Restart the script, and select to use it.
114115

115116
## Deployment script options
116117

@@ -121,48 +122,48 @@ The script takes the following parameters:
121122
-resourceGroupName
122123
```
123124

124-
Can be the name of an existing or a new resource group.
125+
This can be the name of an existing or a new resource group.
125126

126127
```
127128
-subscriptionId
128129
```
129130

130131

131-
Optional, the subscription ID where resources will be deployed.
132+
This is the subscription ID where resources will be deployed. It's optional.
132133

133134
```
134135
-subscriptionName
135136
```
136137

137138

138-
Or alternatively the subscription name.
139+
Alternatively, you can use the subscription name.
139140

140141
```
141142
-resourceGroupLocation
142143
```
143144

144145

145-
Optional, a resource group location. If specified, will try to create a new resource group in this location.
146+
This is a resource group location. If specified, this parameter tries to create a new resource group in this location. This parameter is also optional.
146147

147148

148149
```
149150
-tenantId
150151
```
151152

152153

153-
Azure AD tenant to use.
154+
This is the Azure AD tenant to use.
154155

155156
```
156157
-development 0|1
157158
```
158159

159-
Optional, to deploy for development. Use debug build and set the ASP.Net Environment to Development. Create '.publishsettings' for import in Visual Studio 2017 to allow it to deploy the app and the service directly.
160+
This is to deploy for development. Use debug build, and set the ASP.NET environment to Development. Create `.publishsettings` for import in Visual Studio 2017, to allow it to deploy the app and the service directly. This parameter is also optional.
160161

161162
```
162163
-onlyBuild 0|1
163164
```
164165

165-
Optional, to rebuild and to redeploy only the web apps and to rebuild the docker containers.
166+
This is to rebuild and to redeploy only the web apps, and to rebuild the Docker containers. This parameter is also optional.
166167

167168
[azure-free]:https://azure.microsoft.com/free/
168169
[powershell-install]:https://azure.microsoft.com/downloads/#powershell
@@ -171,7 +172,7 @@ Optional, to rebuild and to redeploy only the web apps and to rebuild the docker
171172

172173
## Next steps
173174

174-
Now that you have learned how to deploy OPC Vault from scratch, here is the suggested next step:
175+
Now that you have learned how to deploy OPC Vault from scratch, you can:
175176

176177
> [!div class="nextstepaction"]
177178
> [Manage OPC Vault](howto-opc-vault-manage.md)

0 commit comments

Comments
 (0)