Skip to content

Commit 37a04bc

Browse files
authored
Merge pull request #49844 from rwike77/standalone
Update standalone cluster creation article, remove redundant article
2 parents 08436bd + 649e6f5 commit 37a04bc

File tree

6 files changed

+47
-112
lines changed

6 files changed

+47
-112
lines changed

.openpublishing.redirection.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12868,6 +12868,11 @@
1286812868
"redirect_url": "./end-user/microsoft-authenticator-app-how-to",
1286912869
"redirect_document_id": false
1287012870
},
12871+
{
12872+
"source_path": "articles/service-fabric/service-fabric-get-started-standalone-cluster.md",
12873+
"redirect_url": "/azure/service-fabric/service-fabric-cluster-creation-for-windows-server",
12874+
"redirect_document_id": false
12875+
},
1287112876
{
1287212877
"source_path": "articles/service-fabric/service-fabric-update-vmss-sku.md",
1287312878
"redirect_url": "/azure/service-fabric/service-fabric-cluster-upgrade",

articles/service-fabric/service-fabric-cluster-creation-for-windows-server.md

Lines changed: 40 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,15 @@ Find Standalone Cluster Configuration samples at: <br>
5353
<a id="createcluster"></a>
5454

5555
## Create the cluster
56-
Service Fabric can be deployed to a one-machine development cluster by using the *ClusterConfig.Unsecure.DevCluster.json* file included in [Samples](https://github.com/Azure-Samples/service-fabric-dotnet-standalone-cluster-configuration/tree/master/Samples).
56+
Several sample cluster configuration files are installed with the setup package. *ClusterConfig.Unsecure.DevCluster.json* is the simplest cluster configuration: an unsecure, three-node cluster running on a single computer. Other config files describe single or multi-machine clusters secured with X.509 certificates or Windows security. You don't need to modify any of the default config settings for this tutorial, but look through the config file and get familiar with the settings. The **nodes** section describes the three nodes in the cluster: name, IP address, [node type, fault domain, and upgrade domain](service-fabric-cluster-manifest.md#nodes-on-the-cluster). The **properties** section defines the [security, reliability level, diagnostics collection, and types of nodes](service-fabric-cluster-manifest.md#cluster-properties) for the cluster.
57+
58+
The cluster created in this article is unsecure. Anyone can connect anonymously and perform management operations, so production clusters should always be secured using X.509 certificates or Windows security. Security is only configured at cluster creation time and it is not possible to enable security after the cluster is created. Update the config file enable [certificate security](service-fabric-windows-cluster-x509-security.md) or [Windows security](service-fabric-windows-cluster-windows-security.md). Read [Secure a cluster](service-fabric-cluster-security.md) to learn more about Service Fabric cluster security.
5759

58-
Unpack the standalone package to your machine, copy the sample config file to the local machine, then run the *CreateServiceFabricCluster.ps1* script through an administrator PowerShell session, from the standalone package folder:
5960
### Step 1A: Create an unsecured local development cluster
61+
Service Fabric can be deployed to a one-machine development cluster by using the *ClusterConfig.Unsecure.DevCluster.json* file included in [Samples](https://github.com/Azure-Samples/service-fabric-dotnet-standalone-cluster-configuration/tree/master/Samples).
62+
63+
Unpack the standalone package to your machine, copy the sample config file to the local machine, then run the *CreateServiceFabricCluster.ps1* script through an administrator PowerShell session, from the standalone package folder.
64+
6065
```powershell
6166
.\CreateServiceFabricCluster.ps1 -ClusterConfigFilePath .\ClusterConfig.Unsecure.DevCluster.json -AcceptEULA
6267
```
@@ -66,18 +71,19 @@ See the Environment Setup section at [Plan and prepare your cluster deployment](
6671
If you're finished running development scenarios, you can remove the Service Fabric cluster from the machine by referring to steps in section "[Remove a cluster](#removecluster_anchor)".
6772

6873
### Step 1B: Create a multi-machine cluster
69-
After you have gone through the planning and preparation steps detailed at the below link, you are ready to create your production cluster using your cluster configuration file. <br>
70-
[Plan and prepare your cluster deployment](service-fabric-cluster-standalone-deployment-preparation.md)
74+
After you have gone through the planning and preparation steps detailed at [Plan and prepare your cluster deployment](service-fabric-cluster-standalone-deployment-preparation.md), you are ready to create your production cluster using your cluster configuration file.
75+
76+
The cluster administrator deploying and configuring the cluster must have administrator privileges on the computer. You cannot install Service Fabric on a domain controller.
7177

72-
1. Validate the configuration file you have written by running the *TestConfiguration.ps1* script from the standalone package folder:
78+
1. The *TestConfiguration.ps1* script in the standalone package is used as a best practices analyzer to validate whether a cluster can be deployed on a given environment. [Deployment preparation](service-fabric-cluster-standalone-deployment-preparation.md) lists the pre-requisites and environment requirements. Run the script to verify if you can create the development cluster:
7379

7480
```powershell
7581
.\TestConfiguration.ps1 -ClusterConfigFilePath .\ClusterConfig.json
7682
```
7783
78-
You should see output like below. If the bottom field "Passed" is returned as "True", sanity checks have passed and the cluster looks to be deployable based on the input configuration.
84+
You should see output similiar to the following. If the bottom field "Passed" is returned as "True", sanity checks have passed and the cluster looks to be deployable based on the input configuration.
7985
80-
```
86+
```powershell
8187
Trace folder already exists. Traces will be written to existing trace folder: C:\temp\Microsoft.Azure.ServiceFabric.WindowsServer\DeploymentTraces
8288
Running Best Practices Analyzer...
8389
Best Practices Analyzer completed successfully.
@@ -107,28 +113,46 @@ After you have gone through the planning and preparation steps detailed at the b
107113
108114
### Step 1C: Create an offline (internet-disconnected) cluster
109115
The Service Fabric runtime package is automatically downloaded at cluster creation. When deploying a cluster to machines not connected to the internet, you will need to download the Service Fabric runtime package separately, and provide the path to it at cluster creation.
110-
The runtime package can be downloaded separately, from another machine connected to the internet, at [Download Link - Service Fabric Runtime - Windows Server](https://go.microsoft.com/fwlink/?linkid=839354). Copy the runtime package to where you are deploying the offline cluster from, and create the cluster by running `CreateServiceFabricCluster.ps1` with the `-FabricRuntimePackagePath` parameter included, as shown below:
116+
The runtime package can be downloaded separately, from another machine connected to the internet, at [Download Link - Service Fabric Runtime - Windows Server](https://go.microsoft.com/fwlink/?linkid=839354). Copy the runtime package to where you are deploying the offline cluster from, and create the cluster by running `CreateServiceFabricCluster.ps1` with the `-FabricRuntimePackagePath` parameter included, as shown in this example:
111117
112118
```powershell
113119
.\CreateServiceFabricCluster.ps1 -ClusterConfigFilePath .\ClusterConfig.json -FabricRuntimePackagePath .\MicrosoftAzureServiceFabric.cab
114120
```
115-
where `.\ClusterConfig.json` and `.\MicrosoftAzureServiceFabric.cab` are the paths to the cluster configuration and the runtime .cab file respectively.
116121

122+
*.\ClusterConfig.json* and *.\MicrosoftAzureServiceFabric.cab* are the paths to the cluster configuration and the runtime .cab file respectively.
117123

118124
### Step 2: Connect to the cluster
119-
To connect to a secure cluster, see [Service fabric connect to secure cluster](service-fabric-connect-to-secure-cluster.md).
125+
Connect to the cluster to verify the cluster is running and available. The ServiceFabric PowerShell module is installed with the runtime. You can connect to the cluster from one of the cluster nodes or from a remote computer with the Service Fabric runtime. The [Connect-ServiceFabricCluster](/powershell/module/servicefabric/connect-servicefabriccluster?view=azureservicefabricps) cmdlet establishes a connection to the cluster.
120126

121127
To connect to an unsecure cluster, run the following PowerShell command:
122128

123129
```powershell
124130
Connect-ServiceFabricCluster -ConnectionEndpoint <*IPAddressofaMachine*>:<Client connection end point port>
125131
```
126-
Example:
132+
133+
For example:
127134
```powershell
128135
Connect-ServiceFabricCluster -ConnectionEndpoint 192.13.123.2345:19000
129136
```
130-
### Step 3: Bring up Service Fabric Explorer
131-
Now you can connect to the cluster with Service Fabric Explorer either directly from one of the machines with http://localhost:19080/Explorer/index.html or remotely with http://<*IPAddressofaMachine*>:19080/Explorer/index.html.
137+
138+
See [Connect to a secure cluster](service-fabric-connect-to-secure-cluster.md) for other examples of connecting to a cluster. After connecting to the cluster, use the [Get-ServiceFabricNode](/powershell/module/servicefabric/get-servicefabricnode?view=azureservicefabricps) cmdlet to display a list of nodes in the cluster and status information for each node. **HealthState** should be *OK* for each node.
139+
140+
```powershell
141+
PS C:\temp\Microsoft.Azure.ServiceFabric.WindowsServer> Get-ServiceFabricNode |Format-Table
142+
143+
NodeDeactivationInfo NodeName IpAddressOrFQDN NodeType CodeVersion ConfigVersion NodeStatus NodeUpTime NodeDownTime HealthState
144+
-------------------- -------- --------------- -------- ----------- ------------- ---------- ---------- ------------ -----------
145+
vm2 localhost NodeType2 5.6.220.9494 0 Up 00:03:38 00:00:00 OK
146+
vm1 localhost NodeType1 5.6.220.9494 0 Up 00:03:38 00:00:00 OK
147+
vm0 localhost NodeType0 5.6.220.9494 0 Up 00:02:43 00:00:00 OK
148+
```
149+
150+
### Step 3: Visualize the cluster using Service Fabric explorer
151+
[Service Fabric Explorer](service-fabric-visualizing-your-cluster.md) is a good tool for visualizing your cluster and managing applications. Service Fabric Explorer is a service that runs in the cluster, which you access using a browser by navigating to [http://localhost:19080/Explorer](http://localhost:19080/Explorer).
152+
153+
The cluster dashboard provides an overview of your cluster, including a summary of application and node health. The node view shows the physical layout of the cluster. For a given node, you can inspect which applications have code deployed on that node.
154+
155+
![Service Fabric Explorer][service-fabric-explorer]
132156

133157
## Add and remove nodes
134158
You can add or remove nodes to your standalone Service Fabric cluster as your business needs change. See [Add or Remove nodes to a Service Fabric standalone cluster](service-fabric-cluster-windows-server-add-remove-nodes.md) for detailed steps.
@@ -139,12 +163,12 @@ To remove a cluster, run the *RemoveServiceFabricCluster.ps1* PowerShell script
139163

140164
This script can be run on any machine that has administrator access to all the machines that are listed as nodes in the cluster configuration file. The machine that this script is run on does not have to be part of the cluster.
141165

142-
```
166+
```powershell
143167
# Removes Service Fabric from each machine in the configuration
144168
.\RemoveServiceFabricCluster.ps1 -ClusterConfigFilePath .\ClusterConfig.json -Force
145169
```
146170

147-
```
171+
```powershell
148172
# Removes Service Fabric from the current machine
149173
.\CleanFabric.ps1
150174
```
@@ -202,3 +226,4 @@ None.
202226

203227
<!--Image references-->
204228
[Trusted Zone]: ./media/service-fabric-cluster-creation-for-windows-server/TrustedZone.png
229+
[service-fabric-explorer]: ./media/service-fabric-cluster-creation-for-windows-server/sfx.png

articles/service-fabric/service-fabric-content-roadmap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ There are some features that are supported on Windows, but not on Linux. To lear
144144
### Standalone clusters
145145
Service Fabric provides an installation package for you to create standalone Service Fabric clusters on-premises or on any cloud provider. Standalone clusters give you the freedom to host a cluster wherever you want. If your data is subject to compliance or regulatory constraints, or you want to keep your data local, you can host your own cluster and applications. Service Fabric applications can run in multiple hosting environments with no changes, so your knowledge of building applications carries over from one hosting environment to another.
146146

147-
[Create your first Service Fabric standalone cluster](service-fabric-get-started-standalone-cluster.md)
147+
[Create your first Service Fabric standalone cluster](service-fabric-cluster-creation-for-windows-server.md)
148148

149149
Linux standalone clusters are not yet supported.
150150

articles/service-fabric/service-fabric-get-started-standalone-cluster.md

Lines changed: 0 additions & 93 deletions
This file was deleted.

0 commit comments

Comments
 (0)