Skip to content

Commit 2686528

Browse files
author
Donna-Marie Smith
committed
Made changes to include FAQs
1 parent 1076844 commit 2686528

File tree

21 files changed

+137
-171
lines changed

21 files changed

+137
-171
lines changed

content/en/docs/2025.3/FAQs/check-cluster-health/multi-server-with-ha.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,17 @@ weight: 1
77

88
# Check Cluster Health
99

10-
{{< section "/install-application-server/multi-server/check-application-services.md">}}
10+
## Import Client Certificate
11+
12+
In order to access the [Service Fabric Explorer][] to check the health of the cluster, it is necessary for the client certificate specified during the [installation of {{% ctx %}}][Configure Installation Script] to be imported in to the current user store on the machine it is being accessed from.
13+
14+
Instructions on how to do this can be found [here][Import Client Certificate].
15+
16+
## View Cluster Health
17+
18+
1. Open a web browser.
19+
1. {{< section "/install-application-server/multi-server/check-application-services.md">}}
20+
21+
[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" >}}
22+
[Import Client Certificate]: {{< url path="Cortex.Faqs.ImportClientCertificate.MainDoc" >}}
23+
[Service Fabric Explorer]: {{< url path="Cortex.Reference.Glossary.P-T.ServiceFabricExplorer" >}}

content/en/docs/2025.3/FAQs/check-cluster-health/single-server-without-ha.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,17 @@ weight: 2
77

88
# Check Cluster Health
99

10-
{{< section "/install-application-server/single-server/check-application-services.md">}}
10+
## Import Client Certificate
11+
12+
In order to access the [Service Fabric Explorer][] to check the health of the cluster, it is necessary for the client certificate specified during the [installation of {{% ctx %}}][Configure Installation Script] to be imported in to the current user store on the machine it is being accessed from.
13+
14+
Instructions on how to do this can be found [here][Import Client Certificate].
15+
16+
## View Cluster Health
17+
18+
1. Open a web browser.
19+
1. {{< section "/install-application-server/single-server/check-application-services.md">}}
20+
21+
[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScriptNew" >}}
22+
[Import Client Certificate]: {{< url path="Cortex.Faqs.ImportClientCertificate.MainDoc" >}}
23+
[Service Fabric Explorer]: {{< url path="Cortex.Reference.Glossary.P-T.ServiceFabricExplorer" >}}

content/en/docs/2025.3/FAQs/import-client-certificate/_index.md renamed to content/en/docs/2025.3/FAQs/import-client-certificate.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,9 @@
22
title: "How do I import the client certificate used to check cluster health?"
33
linkTitle: "How do I import the client certificate used to check cluster health?"
44
description: "Instructions on how to import the client certificate used to check the cluster health."
5-
weight: 150
5+
weight: 1
66
---
7+
8+
# Import Client Certificate
9+
10+
{{< section "/faqs/import-client-certificate.md">}}

content/en/docs/2025.3/FAQs/import-client-certificate/multi-server-with-ha.md

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

content/en/docs/2025.3/FAQs/import-client-certificate/single-server-without-ha.md

Lines changed: 0 additions & 10 deletions
This file was deleted.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Importing the client certificate can be achieved by double-clicking on the .PFX file and following the wizard.
2+
3+
If the .PFX file is not available on the machine, it will need to be copied to the machine it is to be imported on, exporting it from the certificate store if necessary; the certificate can be retrieved by using the `Manage Computer Certificates` tool in Windows to export the certificate used (`CortexServerCertificate` if using self signed certificates) from the `Personal` store as a pfx file and then importing it to the `Current User` store by double-clicking on it and following the wizard. The certificate must also be imported to `Trusted Root Certification Authorities` in the `Local Computer` store.
Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,31 @@
1-
1. Log on to one of the Application Servers.
2-
1. Import the client certificate, used in the `ClientCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store.
3-
{{< section "/install-application-server/multi-server/import-client-certificate.md">}}
4-
1. Open a web browser.
5-
1. {{< section "/install-application-server/multi-server/service-fabric-explorer.md">}}
1+
Navigate to `https://app-server.domain.com:9080/Explorer`, where `app-server.domain.com` is the fully qualified domain name of any Application Server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration.
62

7-
[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" >}}
3+
The screen should resemble that in the following figure:
4+
{{< figure src="/images/Service Fabric Explorer.png" >}}
5+
6+
The status circles should be entirely green - this indicates that all nodes, services and instances are healthy. Other status pages can be accessed by expanding items in the leftmost pane. Issues can be tracked down to the failing component by expanding items with warning triangles or error icons on. The next few diagrams show the status pages for a healthy system.
7+
8+
After expanding the application, clicking on any of the services should display a green circle and `Status = Active`:
9+
10+
{{< figure src="/images/Service Fabric Explorer - Service.png" >}}
11+
12+
After expanding either of the services, clicking on any of the instances/partitions should display a green circle and `Status = Ready`:
13+
14+
{{< figure src="/images/Service Fabric Explorer - Instance.png" >}}
15+
16+
Clicking on any of the nodes at the bottom of the leftmost pane should display a green circle and `Status = Up`:
17+
18+
{{< figure src="/images/Service Fabric Explorer - Node.png" >}}
19+
20+
If any warning triangles appear, wait for 5 minutes or so as the cluster may still be starting up. If the cluster looks OK, go to the next section.
21+
22+
If the warnings persist or anything on the screen goes red, expand the items to find the individual services and instances which have errors or warnings. Warnings should not be ignored as they can indicate that the service can’t start but is still in the retry phase. Error and warning messages should be displayed on the status screens and should indicate what is wrong.
23+
24+
If no useful message can be seen here, the service log files may contain more information. These can be found on each Application Server at:
25+
26+
* `%ProgramData%/Cortex/API Gateway Service/Logs`
27+
* `%ProgramData%/Cortex/Execution Service/Logs`
28+
29+
If no solution can be found, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for further assistance.
30+
31+
[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}

content/en/docs/2025.3/_shared/install-application-server/multi-server/import-client-certificate.md

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

content/en/docs/2025.3/_shared/install-application-server/multi-server/service-fabric-explorer.md

Lines changed: 0 additions & 31 deletions
This file was deleted.
Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,31 @@
1-
1. Log on to the server.
2-
1. Import the client certificate, used in the `ClientCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store.
3-
{{< section "/install-application-server/single-server/import-client-certificate.md">}}
4-
1. Open a web browser.
5-
1. {{< section "/install-application-server/single-server/service-fabric-explorer.md">}}
1+
Navigate to `https://server.domain.com:9080/Explorer`, where `server.domain.com` is the fully qualified domain name of the server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration.
62

7-
[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScriptNew" >}}
3+
The screen should resemble that in the following figure:
4+
{{< figure src="/images/Service Fabric Explorer - Single.png" >}}
5+
6+
The status circles should be entirely green - this indicates that the node and all services and instances are healthy. Other status pages can be accessed by expanding items in the leftmost pane. Issues can be tracked down to the failing component by expanding items with warning triangles or error icons on. The next few diagrams show the status pages for a healthy system.
7+
8+
After expanding the application, clicking on any of the services should display a green circle and `Status = Active`:
9+
10+
{{< figure src="/images/Service Fabric Explorer - Service - Single.png" >}}
11+
12+
After expanding either of the services, clicking on any of the instances/partitions should display a green circle and `Status = Ready`:
13+
14+
{{< figure src="/images/Service Fabric Explorer - Instance - Single.png" >}}
15+
16+
Clicking on any of the nodes at the bottom of the leftmost pane should display a green circle and `Status = Up`:
17+
18+
{{< figure src="/images/Service Fabric Explorer - Node - Single.png" >}}
19+
20+
If any warning triangles appear, wait for 5 minutes or so as the cluster may still be starting up. If the cluster looks OK, go to the next section.
21+
22+
If the warnings persist or anything on the screen goes red, expand the items to find the individual services and instances which have errors or warnings. Warnings should not be ignored as they can indicate that the service can’t start but is still in the retry phase. Error and warning messages should be displayed on the status screens and should indicate what is wrong.
23+
24+
If no useful message can be seen here, the service log files may contain more information. These can be found on the server at:
25+
26+
* `%ProgramData%/Cortex/API Gateway Service/Logs`
27+
* `%ProgramData%/Cortex/Execution Service/Logs`
28+
29+
If no solution can be found, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for further assistance.
30+
31+
[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}

0 commit comments

Comments
 (0)