You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/iot-accelerators/howto-opc-vault-deploy.md
+49-48Lines changed: 49 additions & 48 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,44 +15,43 @@ manager: philmea
15
15
This article explains how to deploy the OPC Vault certificate management service in Azure.
16
16
17
17
> [!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).
19
19
20
20
## Prerequisites
21
21
22
22
### Install required software
23
23
24
24
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).
27
27
28
28
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].
32
32
33
33
### Clone the repository
34
34
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:
Alternatively, you can clone the repo directly in Visual Studio 2017.
43
43
44
44
### Build and deploy the Azure service on Windows
45
45
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.
47
47
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:
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.
56
55
9. After a successful build and deploy operation, you should see the following message:
57
56
```
58
57
To access the web client go to:
@@ -68,49 +67,51 @@ or enter a full command line:
68
67
.\myResourceGroup-gds.cmd
69
68
```
70
69
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.
72
72
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`.
77
77
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.
79
79
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.
81
81
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).
83
83
84
84
## Delete the services from the subscription
85
85
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).
87
89
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:
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.
95
97
96
98
## Troubleshooting deployment failures
97
99
98
100
### Resource group name
99
101
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.
101
103
102
104
### Website name already in use
103
105
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.
106
108
107
-
### Azure Active Directory (Azure AD) registration
109
+
### Azure AD registration
108
110
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:
111
112
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.
114
115
115
116
## Deployment script options
116
117
@@ -121,48 +122,48 @@ The script takes the following parameters:
121
122
-resourceGroupName
122
123
```
123
124
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.
125
126
126
127
```
127
128
-subscriptionId
128
129
```
129
130
130
131
131
-
Optional, the subscription ID where resources will be deployed.
132
+
This is the subscription ID where resources will be deployed. It's optional.
132
133
133
134
```
134
135
-subscriptionName
135
136
```
136
137
137
138
138
-
Or alternatively the subscription name.
139
+
Alternatively, you can use the subscription name.
139
140
140
141
```
141
142
-resourceGroupLocation
142
143
```
143
144
144
145
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.
146
147
147
148
148
149
```
149
150
-tenantId
150
151
```
151
152
152
153
153
-
Azure AD tenant to use.
154
+
This is the Azure AD tenant to use.
154
155
155
156
```
156
157
-development 0|1
157
158
```
158
159
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.
160
161
161
162
```
162
163
-onlyBuild 0|1
163
164
```
164
165
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.
0 commit comments