diff --git a/content/en/docs/2025.3/FAQs/_index.md b/content/en/docs/2025.3/FAQs/_index.md index 654613e9b..936fa46c6 100644 --- a/content/en/docs/2025.3/FAQs/_index.md +++ b/content/en/docs/2025.3/FAQs/_index.md @@ -4,5 +4,3 @@ linkTitle: "FAQs" description: "Answers to our most frequently asked questions." weight: 10000 --- - -{{< workinprogress >}} diff --git a/content/en/docs/2025.3/FAQs/check-cluster-health/_index.md b/content/en/docs/2025.3/FAQs/check-cluster-health/_index.md new file mode 100644 index 000000000..9c462d343 --- /dev/null +++ b/content/en/docs/2025.3/FAQs/check-cluster-health/_index.md @@ -0,0 +1,6 @@ +--- +title: "How do I check cluster health?" +linkTitle: "How do I check cluster health?" +description: "Instructions on how to check the health of your cluster." +weight: 100 +--- diff --git a/content/en/docs/2025.3/FAQs/check-cluster-health/multi-server-with-ha.md b/content/en/docs/2025.3/FAQs/check-cluster-health/multi-server-with-ha.md new file mode 100644 index 000000000..c2bd40ffa --- /dev/null +++ b/content/en/docs/2025.3/FAQs/check-cluster-health/multi-server-with-ha.md @@ -0,0 +1,23 @@ +--- +title: "Multiple Server with HA" +linkTitle: "Multiple Server with HA" +description: "Instructions on how to check the health of your multiple server cluster." +weight: 1 +--- + +# Check Cluster Health + +## Import Client Certificate + +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. + +Instructions on how to do this can be found [here][Import Client Certificate]. + +## View Cluster Health + +1. Open a web browser. +1. {{< section "/install-application-server/multi-server/check-application-services.md">}} + +[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" >}} +[Import Client Certificate]: {{< url path="Cortex.Faqs.ImportClientCertificate.MultiServer" >}} +[Service Fabric Explorer]: {{< url path="Cortex.Reference.Glossary.P-T.ServiceFabricExplorer" >}} diff --git a/content/en/docs/2025.3/FAQs/check-cluster-health/single-server-without-ha.md b/content/en/docs/2025.3/FAQs/check-cluster-health/single-server-without-ha.md new file mode 100644 index 000000000..89ac2d99a --- /dev/null +++ b/content/en/docs/2025.3/FAQs/check-cluster-health/single-server-without-ha.md @@ -0,0 +1,23 @@ +--- +title: "Single Server without HA" +linkTitle: "Single Server without HA" +description: "Instructions on how to check the health of your single server cluster." +weight: 2 +--- + +# Check Cluster Health + +## Import Client Certificate + +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. + +Instructions on how to do this can be found [here][Import Client Certificate]. + +## View Cluster Health + +1. Open a web browser. +1. {{< section "/install-application-server/single-server/check-application-services.md">}} + +[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScriptNew" >}} +[Import Client Certificate]: {{< url path="Cortex.Faqs.ImportClientCertificate.SingleServer" >}} +[Service Fabric Explorer]: {{< url path="Cortex.Reference.Glossary.P-T.ServiceFabricExplorer" >}} diff --git a/content/en/docs/2025.3/FAQs/import-client-certificate/_index.md b/content/en/docs/2025.3/FAQs/import-client-certificate/_index.md new file mode 100644 index 000000000..732186a62 --- /dev/null +++ b/content/en/docs/2025.3/FAQs/import-client-certificate/_index.md @@ -0,0 +1,6 @@ +--- +title: "How do I import the client certificate used to check cluster health?" +linkTitle: "How do I import the client certificate used to check cluster health?" +description: "Instructions on how to import the client certificate used to check the cluster health." +weight: 100 +--- diff --git a/content/en/docs/2025.3/FAQs/import-client-certificate/multi-server-with-ha.md b/content/en/docs/2025.3/FAQs/import-client-certificate/multi-server-with-ha.md new file mode 100644 index 000000000..22b2544d8 --- /dev/null +++ b/content/en/docs/2025.3/FAQs/import-client-certificate/multi-server-with-ha.md @@ -0,0 +1,23 @@ +--- +title: "Multiple Server with HA" +linkTitle: "Multiple Server with HA" +description: "Instructions on how to import the client certificate used to check your multiple server cluster health." +weight: 1 +--- + +# Import Client Certificate + +## Using CA Certificates + +In order to check the cluster health in Service Fabric Explorer and RabbitMQ, the certificate specified for `ClientCertificatePath` during [installation of the Application Servers][Configure Application Server Installation Script], or `ServerCertificatePath` during [installation of the Flow Debugger][Configure Flow Debugger Installation Script] will need to be imported to the local certificate store on the machine that is being used to browse from: + +{{< section "/faqs/import-ca-client-certificate.md">}} + +## Using Self Signed Certificates + +In order to check the cluster health in Service Fabric Explorer and RabbitMQ, the certificate generated when specifying `UseSelfSignedCertificates` during [installation of the Application Servers][Configure Application Server Installation Script], or during [installation of the Flow Debugger][Configure Flow Debugger Installation Script] will need to be imported to the local certificate store on the machine that is being used to browse from: + +{{< section "/faqs/import-selfsigned-client-certificate.md">}} + +[Configure Application Server Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" >}} +[Configure Flow Debugger Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureDebuggerInstallationScript" >}} diff --git a/content/en/docs/2025.3/FAQs/import-client-certificate/single-server-without-ha.md b/content/en/docs/2025.3/FAQs/import-client-certificate/single-server-without-ha.md new file mode 100644 index 000000000..5df26d5d1 --- /dev/null +++ b/content/en/docs/2025.3/FAQs/import-client-certificate/single-server-without-ha.md @@ -0,0 +1,22 @@ +--- +title: "Single Server without HA" +linkTitle: "Single Server without HA" +description: "Instructions on how to import the client certificate used to check your single server cluster health." +weight: 1 +--- + +# Import Client Certificate + +## Using CA Certificates + +In order to check the cluster health in Service Fabric Explorer and RabbitMQ, the certificate specified for `ServerCertificatePath` during [installation of the Application Servers][Configure Application Server Installation Script] will need to be imported to the local certificate store on the machine that is being used to browse from: + +{{< section "/faqs/import-ca-client-certificate.md">}} + +## Using Self Signed Certificates + +In order to check the cluster health in Service Fabric Explorer and RabbitMQ, the certificate generated when specifying `UseSelfSignedCertificates` during [installation of the Application Servers][Configure Application Server Installation Script] will need to be imported to the local certificate store on the machine that is being used to browse from: + +{{< section "/faqs/import-selfsigned-client-certificate.md">}} + +[Configure Application Server Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScriptNew" >}} diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/packages/_index.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/packages/_index.md index 6ac52ff9f..92fae8af2 100644 --- a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/packages/_index.md +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/packages/_index.md @@ -1,6 +1,6 @@ --- title: "Packages" linkTitle: "Packages" -description: "This section includes user guides related to Package Management in {{% ctx %}} Gateway." +description: "Create and manage packages in {{% ctx %}} Gateway." weight: 10 --- diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/ops/_index.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/ops/_index.md new file mode 100644 index 000000000..c3090c527 --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/ops/_index.md @@ -0,0 +1,6 @@ +--- +title: "Ops" +linkTitle: "Ops" +description: "This section includes user guides related to the Operations section in {{% ctx %}} Gateway." +weight: 5 +--- diff --git a/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/ops/overview.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/ops/overview.md new file mode 100644 index 000000000..494f3f69f --- /dev/null +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/ops/overview.md @@ -0,0 +1,140 @@ +--- +title: "Overview" +linkTitle: "Overview" +description: "The current platform status and flow execution statistics." +weight: 10 +--- + +# {{% param title %}} + +## Summary + +The Operations Overview shows a synopsis of the current platform status, and a graphical display of the flow execution statistics. + +## Anatomy + +{{< figure src="/images/Operations Overview.png" title="Operations Overview" >}} + +### Current Status + +#### License Consumption + +This tile displays the current License Consumption. The {{< image src="/images/GoTo.png" >}} icon navigates to the License Consumption feature, to provide visibility of the license consumption by group and by flow. + +#### Cluster Health + +This tile displays the current Cluster Health. The {{< image src="/images/GoTo.png" >}} icon opens a new browser tab and navigates to the [Service Fabric Explorer][], which allows [inspection and management][Check Cluster Health] of the cluster. + +{{% alert title="Note" %}} +To view Service Fabric Explorer, the Service Fabric client certificate must be {{< ahref path="Cortex.Faqs.ImportClientCertificate.MainDoc" title="imported" >}} on the machine from which you are browsing. +{{% /alert %}} + +#### Running Executions + +This tile displays the current number of [Running Executions][]. The {{< image src="/images/GoTo.png" >}} icon navigates to the [Package Management][Package Management] feature, to provide a breakdown of running executions by package version and flow. + +### Filters + +#### Package Names + +This filter displays the packages that have executions during the [Time Period][] selected. One or more packages can be selected, the default is `All`. + +If a Package Name is selected that does not contain a previously selected Package Version, then all Package Versions for the selected Package Name will be automatically selected. + +#### Package Versions + +This filter displays the package versions that have executions during the [Time Period][] selected. One or more package versions can be selected, the default is `All`. This filter will only include package versions for the packages selected in the [Package Names][] filter. + +If a Package Version is selected that does not contain a previously selected flow, then all flows for the selected Package Version will be automatically selected. + +#### Flows + +This filter displays the flows that have executions during the [Time Period][] selected. One or more flows can be selected, the default is `All`. This filter will only include flows for the package versions and packages selected in the [Package Versions][] and [Package Names][] filters. + +{{% alert title="Note" %}} +When any of the above filters are changed, a `Refresh Data` button will appear that must be clicked to apply the filters. +{{% /alert %}} + +#### Time Period + +This filter displays a set of pre-defined periods to filter the data by: + +| Time Period | Start of Period | End of Period | Interval | +|---------------------|------------------------------|-----------------------|----------| +| Today (so far) | Today at 00:00:00 | Now | 1 hour | +| Yesterday | Yesterday at 00:00:00 | Yesterday at 23:59:59 | 1 hour | +| This week (so far) | Monday at 00:00:00 | Now | 1 hour | +| Last day | Now - 24 hours | Now | 1 hour | +| Last 2 days | Now - 48 hours | Now | 1 hour | +| Last 3 days | Now - 72 hours | Now | 1 hour | +| Last 5 days | Now - 120 hours | Now | 1 hour | +| Last 7 days | Now - 168 hours | Now | 1 hour | +| This month (so far) | 1st day of month at 00:00:00 | Now | 1 day | +| Last month | Now - 1 month | Now | 1 day | +| Last 3 months | Now - 3 months | Now | 1 day | +| Last 6 months | Now - 6 months | Now | 1 day | +| Last 12 months | Now - 12 months | Now | 1 day | + +#### Refresh + +This button, located next to the [Time Period][] filter, refreshes the filters and then the data displayed. + +### Flows + +#### Success Rate + +Success Rate represents the percentage of flow executions that completed successfully. + +The value displayed is the average success rate for the selected time period, rounded down to the nearest whole percentage point. + +The graph displays the trend of flow execution success rate during the selected time period. + +#### Completed + +Completed represents the number of flow executions that completed successfully or errored. + +The value displayed is the total number of flow executions that completed during the selected time period. + +The graph displays the trend of completed flow executions during the selected time period. + +#### Errored + +Errored represents the number of flow executions that errored; this includes executions that have been stopped in the [Running Executions] tab of the [Package Management][] feature. + +The value displayed is the total number of flow executions that errored during the selected time period. + +The graph displays the trend of errored flow executions during the selected time period. + +#### Duration + +Duration represents the time taken in seconds for flow executions to have completed successfully or errored. + +The value displayed is the average flow execution duration during the selected time period. + +The graph displays the trend of average flow execution duration during the selected time period. + +## Remarks + +### Known Limitations + +None + +## See Also + +### Related Concepts + +None + +### Related Tutorials + +* [Using the Operations Overview][Using the Operations Overview tutorial] + +[Package Names]: {{< ref "#package-names" >}} +[Package Versions]: {{< ref "#package-versions" >}} +[Time Period]: {{< ref "#time-period" >}} + +[Check Cluster Health]: {{< url path="Cortex.Faqs.CheckClusterHealth">}} +[Package Management]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.Overview.MainDoc" >}} +[Running Executions]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageVersionEditor.RunningExecutions" >}} +[Service Fabric Explorer]: {{< url path="Cortex.Reference.Glossary.P-T.ServiceFabricExplorer" >}} +[Using the Operations Overview tutorial]: {{< url path="Cortex.Tutorials.Operations.Overview.UseOperationsOverview" >}} diff --git a/content/en/docs/2025.3/Reference/Glossary/p-t.md b/content/en/docs/2025.3/Reference/Glossary/p-t.md index fde521c1e..89cd4e566 100644 --- a/content/en/docs/2025.3/Reference/Glossary/p-t.md +++ b/content/en/docs/2025.3/Reference/Glossary/p-t.md @@ -105,6 +105,12 @@ Service Fabric is an open source project developed by Microsoft used to deliver For more information see [What is Service Fabric?][] +### Service Fabric Explorer + +Service Fabric Explorer is an open source tool developed by Microsoft used to inspect and manage service fabric clusters. + +For more information see [Visualise your cluster with Service Fabric Explorer][]. + ### Single A [data type][] that represents a fractional, or very large or small number from `-3.402823e+38` through `3.402823e+38`. @@ -205,6 +211,8 @@ Typeahead is a language prediction tool that is used to provide suggestions base [Property Expressions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.PropertyExpressions" >}} +[Visualise your cluster with Service Fabric Explorer]: {{< url path="MSDocs.ServiceFabric.Explorer" >}} + [What is PowerShell?]: {{< url path="MSDocs.PowerShell.WhatIsPowerShell" >}} [What is Service Fabric?]: {{< url path="MSDocs.ServiceFabric.MainDoc" >}} diff --git a/content/en/docs/2025.3/Tutorials/Operations/_index.md b/content/en/docs/2025.3/Tutorials/Operations/_index.md new file mode 100644 index 000000000..535738606 --- /dev/null +++ b/content/en/docs/2025.3/Tutorials/Operations/_index.md @@ -0,0 +1,7 @@ +--- +title: "Operations" +linkTitle: "Operations" +description: "This section includes tutorials about Operations on the {{% ctx %}} platform. - TODO" +weight: 40 +--- + diff --git a/content/en/docs/2025.3/Tutorials/Operations/overview.md b/content/en/docs/2025.3/Tutorials/Operations/overview.md new file mode 100644 index 000000000..8b52cff9c --- /dev/null +++ b/content/en/docs/2025.3/Tutorials/Operations/overview.md @@ -0,0 +1,12 @@ +--- +title: "Overview" +linkTitle: "Overview" +description: "This section includes tutorials about the Operations Overview on the {{% ctx %}} platform." +weight: 1 +--- + +# {{% param title %}} + +## Using the Operations Overview + +{{< scribe title="How_to_use_the_Operations_Overview" id="7i-SNYQ4QqK7h-9MjfEiKw" >}} diff --git a/content/en/docs/2025.3/Whats New/_index.md b/content/en/docs/2025.3/Whats New/_index.md index f4ea8317d..c1f5efbf0 100644 --- a/content/en/docs/2025.3/Whats New/_index.md +++ b/content/en/docs/2025.3/Whats New/_index.md @@ -78,4 +78,4 @@ For a full list of what has been introduced in this release, please see the [202 [RabbitMQ and Erlang have been upgraded]: {{< url path="Cortex.Blogs.Releases.2025.3.RabbitMqAndErlangHaveBeenUpgraded" version="2025.3" >}} [Package Management]: {{< url path="Cortex.Blogs.Releases.2025.3.PackageManagement" version="2025.3" >}} -[removal of "7.2" and "Innovation" from documentation]: {{< url path="Cortex.Blogs.Releases.2025.3.RemovalOf7.2AndInnovationFromDocumentation" version="2025.3" >}} \ No newline at end of file +[removal of "7.2" and "Innovation" from documentation]: {{< url path="Cortex.Blogs.Releases.2025.3.RemovalOf7.2AndInnovationFromDocumentation" version="2025.3" >}} diff --git a/content/en/docs/2025.3/_shared/faqs/import-ca-client-certificate.md b/content/en/docs/2025.3/_shared/faqs/import-ca-client-certificate.md new file mode 100644 index 000000000..6829e47c5 --- /dev/null +++ b/content/en/docs/2025.3/_shared/faqs/import-ca-client-certificate.md @@ -0,0 +1,8 @@ +1. If the .PFX file is available: + 1. Copy it to the machine it is to be imported on. +1. Otherwise, export it from the Application Server certificate store: + 1. Using the `Manage Computer Certificates` tool in Windows on the Application Server, export the certificate used from the `Personal` store as a pfx file. + 1. Copy it to the machine it is to be imported on. +1. Import it to the `Current User` store by double-clicking on it, selecting the `Current User` Store Location and continue following the wizard. +1. If the certificate was generated from a CA that is not a trusted root authority (e.g. OpenSSL), then it will also need importing to the Trusted Root Certification Authorities in the Local Computer store: + 1. Import it to the `Trusted Root Certification Authorities` in the `Local Computer` store by double-clicking on it, selecting the `Local Computer` Store Location and continue following the wizard, selecting `Trusted Root Certification Authorities` on the `Certificate Store` page. diff --git a/content/en/docs/2025.3/_shared/faqs/import-selfsigned-client-certificate.md b/content/en/docs/2025.3/_shared/faqs/import-selfsigned-client-certificate.md new file mode 100644 index 000000000..20635eac5 --- /dev/null +++ b/content/en/docs/2025.3/_shared/faqs/import-selfsigned-client-certificate.md @@ -0,0 +1,4 @@ +1. Using the `Manage Computer Certificates` tool in Windows on the Application Server export the `CortexServerCertificate` from the `Personal` store as a pfx file. +1. Copy the file to the machine that it needs to be imported on. +1. Import it to the `Current User` store by double-clicking on it, selecting the `Current User` Store Location and continue following the wizard. +1. Import it to the `Trusted Root Certification Authorities` in the `Local Computer` store by double-clicking on it, selecting the `Local Computer` Store Location and continue following the wizard, selecting `Trusted Root Certification Authorities` on the `Certificate Store` page. diff --git a/content/en/docs/2025.3/_shared/install-application-server/multi-server/check-application-services.md b/content/en/docs/2025.3/_shared/install-application-server/multi-server/check-application-services.md index 5bd78e8c6..688a4ddae 100644 --- a/content/en/docs/2025.3/_shared/install-application-server/multi-server/check-application-services.md +++ b/content/en/docs/2025.3/_shared/install-application-server/multi-server/check-application-services.md @@ -1,37 +1,31 @@ -1. Log on to one of the Application Servers. -1. Import the client certificate, used in the `ClientCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. This can be achieved by double-clicking on the client certificate .PFX file and following the wizard. +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. - If using self-signed certificates, the certificate can be retrieved by using the `Manage Computer Certificates` tool in Windows to export the `CortexServerCertificate` 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. -1. Open a web browser. -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. +The screen should resemble that in the following figure: +{{< figure src="/images/Service Fabric Explorer.png" >}} - The screen should resemble that in the following figure: - {{< figure src="/images/Service Fabric Explorer.png" >}} +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. - 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. +After expanding the application, clicking on any of the services should display a green circle and `Status = Active`: - After expanding the application, clicking on any of the services should display a green circle and `Status = Active`: +{{< figure src="/images/Service Fabric Explorer - Service.png" >}} - {{< figure src="/images/Service Fabric Explorer - Service.png" >}} +After expanding either of the services, clicking on any of the instances/partitions should display a green circle and `Status = Ready`: - After expanding either of the services, clicking on any of the instances/partitions should display a green circle and `Status = Ready`: +{{< figure src="/images/Service Fabric Explorer - Instance.png" >}} - {{< figure src="/images/Service Fabric Explorer - Instance.png" >}} +Clicking on any of the nodes at the bottom of the leftmost pane should display a green circle and `Status = Up`: - Clicking on any of the nodes at the bottom of the leftmost pane should display a green circle and `Status = Up`: +{{< figure src="/images/Service Fabric Explorer - Node.png" >}} - {{< figure src="/images/Service Fabric Explorer - Node.png" >}} +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. - 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. +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. - 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. +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: - 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: +* `%ProgramData%/Cortex/API Gateway Service/Logs` +* `%ProgramData%/Cortex/Execution Service/Logs` - * `%ProgramData%/Cortex/API Gateway Service/Logs` - * `%ProgramData%/Cortex/Execution Service/Logs` +If no solution can be found, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for further assistance. - If no solution can be found, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for further assistance. - -[Configure Installation Script]: {{< ref "#configure-installation-script" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} \ No newline at end of file diff --git a/content/en/docs/2025.3/_shared/install-application-server/single-server/add-innovation-only/configure-installation-script.md b/content/en/docs/2025.3/_shared/install-application-server/single-server/add-innovation-only/configure-installation-script.md index 464c5dbae..cb6dc6096 100644 --- a/content/en/docs/2025.3/_shared/install-application-server/single-server/add-innovation-only/configure-installation-script.md +++ b/content/en/docs/2025.3/_shared/install-application-server/single-server/add-innovation-only/configure-installation-script.md @@ -2,7 +2,7 @@ 1. Choose the tab below that matches the configuration for this installation, then update the script to match, changing the parameters according to the details given below: {{< tabpane lang="powershell" >}} - {{< tab header="CA Certs" >}} + {{< tab header="CA Certificates" >}} .\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` @@ -23,7 +23,7 @@ -AcceptEULA:$AcceptEula ` *>&1 | Tee-Object -FilePath "cortex-app-install-log.txt" {{< /tab >}} - {{< tab header="Self-Signed Certs" >}} + {{< tab header="Self-Signed Certificates" >}} .\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` diff --git a/content/en/docs/2025.3/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md b/content/en/docs/2025.3/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md index 7a039b654..4eb3e8be0 100644 --- a/content/en/docs/2025.3/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md +++ b/content/en/docs/2025.3/_shared/install-application-server/single-server/add-innovation-to-7.2/configure-installation-script.md @@ -2,7 +2,7 @@ 1. Choose the tab below that matches the configuration for this installation, then update the script to match, changing the parameters according to the details given below: {{< tabpane lang="powershell" >}} - {{< tab header="CA Certs" >}} + {{< tab header="CA Certificates" >}} .\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` @@ -23,7 +23,7 @@ -AcceptEULA:$AcceptEula ` *>&1 | Tee-Object -FilePath "cortex-app-install-log.txt" {{< /tab >}} - {{< tab header="Self-Signed Certs" >}} + {{< tab header="Self-Signed Certificates" >}} .\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` diff --git a/content/en/docs/2025.3/_shared/install-application-server/single-server/check-application-services.md b/content/en/docs/2025.3/_shared/install-application-server/single-server/check-application-services.md index 855a61a8f..a5ef96dd9 100644 --- a/content/en/docs/2025.3/_shared/install-application-server/single-server/check-application-services.md +++ b/content/en/docs/2025.3/_shared/install-application-server/single-server/check-application-services.md @@ -1,37 +1,31 @@ -1. Log on to the server. -1. Import the certificate, used in the `ServerCertificatePath` parameter of the [Configure Installation Script][] section, to your `Current User` certificate store. This can be achieved by double-clicking on the certificate .PFX file and following the wizard. +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. - If using self-signed certificates, the certificate can be retrieved by using the `Manage Computer Certificates` tool in Windows to export the `CortexServerCertificate` 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. -1. Open a web browser. -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. +The screen should resemble that in the following figure: +{{< figure src="/images/Service Fabric Explorer - Single.png" >}} - The screen should resemble that in the following figure: - {{< figure src="/images/Service Fabric Explorer - Single.png" >}} +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. - 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. +After expanding the application, clicking on any of the services should display a green circle and `Status = Active`: - After expanding the application, clicking on any of the services should display a green circle and `Status = Active`: +{{< figure src="/images/Service Fabric Explorer - Service - Single.png" >}} - {{< figure src="/images/Service Fabric Explorer - Service - Single.png" >}} +After expanding either of the services, clicking on any of the instances/partitions should display a green circle and `Status = Ready`: - After expanding either of the services, clicking on any of the instances/partitions should display a green circle and `Status = Ready`: +{{< figure src="/images/Service Fabric Explorer - Instance - Single.png" >}} - {{< figure src="/images/Service Fabric Explorer - Instance - Single.png" >}} +Clicking on any of the nodes at the bottom of the leftmost pane should display a green circle and `Status = Up`: - Clicking on any of the nodes at the bottom of the leftmost pane should display a green circle and `Status = Up`: +{{< figure src="/images/Service Fabric Explorer - Node - Single.png" >}} - {{< figure src="/images/Service Fabric Explorer - Node - Single.png" >}} +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. - 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. +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. - 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. +If no useful message can be seen here, the service log files may contain more information. These can be found on the server at: - If no useful message can be seen here, the service log files may contain more information. These can be found on the server at: +* `%ProgramData%/Cortex/API Gateway Service/Logs` +* `%ProgramData%/Cortex/Execution Service/Logs` - * `%ProgramData%/Cortex/API Gateway Service/Logs` - * `%ProgramData%/Cortex/Execution Service/Logs` +If no solution can be found, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for further assistance. - If no solution can be found, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for further assistance. - -[Configure Installation Script]: {{< ref "#configure-installation-script" >}} -[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} \ No newline at end of file +[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} diff --git a/content/en/docs/2025.3/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md b/content/en/docs/2025.3/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md index bec61bc74..d9bb1025e 100644 --- a/content/en/docs/2025.3/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md +++ b/content/en/docs/2025.3/_shared/install-web-application-server/add-innovation-only/configure-debugger-installation-script.md @@ -2,7 +2,7 @@ 1. Choose the tab below that matches the configuration for this installation, then update the script to match, changing the parameters according to the details given below: {{< tabpane lang="powershell" >}} - {{< tab header="CA Certs" >}} + {{< tab header="CA Certificates" >}} .\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` @@ -23,7 +23,7 @@ -AcceptEULA:$AcceptEula ` *>&1 | Tee-Object -FilePath "cortex-app-install-log.txt" {{< /tab >}} - {{< tab header="Self-Signed Certs" >}} + {{< tab header="Self-Signed Certificates" >}} .\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` diff --git a/content/en/docs/2025.3/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md b/content/en/docs/2025.3/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md index f288ba84d..8629b88f9 100644 --- a/content/en/docs/2025.3/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md +++ b/content/en/docs/2025.3/_shared/install-web-application-server/add-innovation-to-7.2/configure-debugger-installation-script.md @@ -2,7 +2,7 @@ 1. Choose the tab below that matches the configuration for this installation, then update the script to match, changing the parameters according to the details given below: {{< tabpane lang="powershell" >}} - {{< tab header="CA Certs" >}} + {{< tab header="CA Certificates" >}} .\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` @@ -23,7 +23,7 @@ -AcceptEULA:$AcceptEula ` *>&1 | Tee-Object -FilePath "cortex-app-install-log.txt" {{< /tab >}} - {{< tab header="Self-Signed Certs" >}} + {{< tab header="Self-Signed Certificates" >}} .\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` diff --git a/content/en/docs/2025.3/_shared/upgrade/upgrade-application-server/multi-server/check-application-services.md b/content/en/docs/2025.3/_shared/upgrade/upgrade-application-server/multi-server/check-application-services.md index b91e3adcd..6fe5abf4e 100644 --- a/content/en/docs/2025.3/_shared/upgrade/upgrade-application-server/multi-server/check-application-services.md +++ b/content/en/docs/2025.3/_shared/upgrade/upgrade-application-server/multi-server/check-application-services.md @@ -9,35 +9,6 @@ * Find the certificate by using the `Manage Computer Certificates` tool in Windows. In the `Personal` store, the certificate will have an `Issued To` similar to `applicationServerCertificateSubject` and to confirm it is the right certificate double-click the certificate, select the `Details` tab and locate the `Thumbprint` property to compare the value to that in `applicationServerCertificateThumbprint`. * Export the certificate as a pfx file and then import it to the `Current User` store by double-clicking on it and following the wizard. 1. Open a web browser. -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 of the original installation. - - The screen should resemble that in the following figure: - {{< figure src="/images/Service Fabric Explorer.png" >}} - - 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. - - After expanding the application, clicking on any of the services should display a green circle and `Status = Active`: - - {{< figure src="/images/Service Fabric Explorer - Service.png" >}} - - After expanding either of the services, clicking on any of the instances/partitions should display a green circle and `Status = Ready`: - - {{< figure src="/images/Service Fabric Explorer - Instance.png" >}} - - Clicking on any of the nodes at the bottom of the leftmost pane should display a green circle and `Status = Up`: - - {{< figure src="/images/Service Fabric Explorer - Node.png" >}} - - 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. - - 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. - - 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: - - * `%ProgramData%/Cortex/API Gateway Service/Logs` - * `%ProgramData%/Cortex/Execution Service/Logs` - - If no solution can be found, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for further assistance. +1. {{< section "/install-application-server/multi-server/check-application-services.md">}} [Configure Installation Script]: {{< ref "#configure-installation-script" >}} -[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} diff --git a/content/en/docs/2025.3/_shared/upgrade/upgrade-application-server/single-server/check-application-services.md b/content/en/docs/2025.3/_shared/upgrade/upgrade-application-server/single-server/check-application-services.md index 287bb3909..06e5efa6f 100644 --- a/content/en/docs/2025.3/_shared/upgrade/upgrade-application-server/single-server/check-application-services.md +++ b/content/en/docs/2025.3/_shared/upgrade/upgrade-application-server/single-server/check-application-services.md @@ -9,35 +9,6 @@ * Find the certificate by using the `Manage Computer Certificates` tool in Windows. In the `Personal` store, the certificate will have an `Issued To` similar to `applicationServerCertificateSubject` and to confirm it is the right certificate double-click the certificate, select the `Details` tab and locate the `Thumbprint` property to compare the value to that in `applicationServerCertificateThumbprint`. * Export the certificate as a pfx file and then import it to the `Current User` store by double-clicking on it and following the wizard. 1. Open a web browser. -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 of the original installation. - - The screen should resemble that in the following figure: - {{< figure src="/images/Service Fabric Explorer - Single.png" >}} - - 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. - - After expanding the application, clicking on any of the services should display a green circle and `Status = Active`: - - {{< figure src="/images/Service Fabric Explorer - Service - Single.png" >}} - - After expanding either of the services, clicking on any of the instances/partitions should display a green circle and `Status = Ready`: - - {{< figure src="/images/Service Fabric Explorer - Instance - Single.png" >}} - - Clicking on any of the nodes at the bottom of the leftmost pane should display a green circle and `Status = Up`: - - {{< figure src="/images/Service Fabric Explorer - Node - Single.png" >}} - - 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. - - 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. - - If no useful message can be seen here, the service log files may contain more information. These can be found on the server at: - - * `%ProgramData%/Cortex/API Gateway Service/Logs` - * `%ProgramData%/Cortex/Execution Service/Logs` - - If no solution can be found, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for further assistance. +1. {{< section "/install-application-server/single-server/check-application-services.md">}} [Configure Installation Script]: {{< ref "#configure-installation-script" >}} -[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} \ No newline at end of file diff --git a/content/en/docs/2025.3/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md b/content/en/docs/2025.3/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md index a93d17696..0f8752b85 100644 --- a/content/en/docs/2025.3/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2025.3/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md @@ -119,7 +119,7 @@ To check all necessary ports are free, follow these steps: 1. Choose the tab below that matches the configuration for this installation, then update the script to match, changing the parameters according to the details given below: {{< tabpane lang="powershell" >}} - {{< tab header="CA Certs, Built-in Load Balancer">}} + {{< tab header="CA Certificates, Built-in Load Balancer">}} .\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` @@ -142,7 +142,7 @@ To check all necessary ports are free, follow these steps: -AcceptEULA:$AcceptEula ` *>&1 | Tee-Object -FilePath "cortex-ha-install-log.txt" {{< /tab >}} - {{< tab header="Self-Signed Certs, Built-in Load Balancer" >}} + {{< tab header="Self-Signed Certificates, Built-in Load Balancer" >}} .\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` @@ -162,7 +162,7 @@ To check all necessary ports are free, follow these steps: -AcceptEULA:$AcceptEula ` *>&1 | Tee-Object -FilePath "cortex-ha-install-log.txt" {{< /tab >}} - {{< tab header="CA Certs, Alternative Load Balancer" >}} + {{< tab header="CA Certificates, Alternative Load Balancer" >}} .\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` @@ -185,7 +185,7 @@ To check all necessary ports are free, follow these steps: -AcceptEULA:$AcceptEula ` *>&1 | Tee-Object -FilePath "cortex-ha-install-log.txt" {{< /tab >}} - {{< tab header="Self-Signed Certs, Alternative Load Balancer" >}} + {{< tab header="Self-Signed Certificates, Alternative Load Balancer" >}} .\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` @@ -300,7 +300,10 @@ More advanced configuration (such as changing ports) can be undertaken by modify ## Check Application Services -{{< section "/install-application-server/multi-server/check-application-services.md">}} +1. Log on to the Application Server. +1. Import the client certificate, used in the `ClientCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. Instructions on how to do this can be found [here][Import Client Certificate]. +1. Open a web browser. +1. {{< section "/install-application-server/multi-server/check-application-services.md">}} ## Preserve installation files @@ -318,6 +321,7 @@ More advanced configuration (such as changing ports) can be undertaken by modify [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} [Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.EncryptionRequirementsNew" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} +[Import Client Certificate]: {{< url path="Cortex.Faqs.ImportClientCertificate.MultiServer" >}} [NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}} [Pre-Installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.PreInstallation" >}} [SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}} diff --git a/content/en/docs/2025.3/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md b/content/en/docs/2025.3/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md index a7ebdd1a3..9f23745d2 100644 --- a/content/en/docs/2025.3/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md +++ b/content/en/docs/2025.3/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md @@ -45,7 +45,10 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc ## Check Application Services -{{< section "/install-application-server/single-server/check-application-services.md">}} +1. Log on to the Web Application Server. +1. Import the client certificate, used in the `ClientCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. Instructions on how to do this can be found [here][Import Client Certificate]. +1. Open a web browser. +1. {{< section "/install-application-server/single-server/check-application-services.md">}} # Preserve installation files @@ -56,5 +59,7 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc 1. [Upgrade Gateway][] [Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.AntivirusExclusionsNew" >}} +[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.ConfigureDebuggerInstallationScript" >}} +[Import Client Certificate]: {{< url path="Cortex.Faqs.ImportClientCertificate.MultiServer" >}} [Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.GatewayInstallationNew" >}} [web application server prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.WebApplicationServerPrerequisitesNew" >}} diff --git a/content/en/docs/2025.3/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-application-server.md b/content/en/docs/2025.3/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-application-server.md index 32dda2ab4..bfe994f6c 100644 --- a/content/en/docs/2025.3/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-application-server.md +++ b/content/en/docs/2025.3/getting-started/on-premise/add-innovation-to-72/single-server-without-ha/installation/install-application-server.md @@ -45,7 +45,10 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc ## Check Application Services -{{< section "/install-application-server/single-server/check-application-services.md">}} +1. Log on to the Application Server. +1. Import the client certificate, used in the `ClientCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. Instructions on how to do this can be found [here][Import Client Certificate]. +1. Open a web browser. +1. {{< section "/install-application-server/single-server/check-application-services.md">}} ## Preserve installation files @@ -56,5 +59,7 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc 1. [Upgrade {{% ctx %}} 7 Gateway to Include {{% ctx %}}][Upgrade Gateway] [Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.AntivirusExclusionsNew" >}} +[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.ConfigureInstallationScriptNew" >}} +[Import Client Certificate]: {{< url path="Cortex.Faqs.ImportClientCertificate.SingleServer" >}} [Pre-Installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.PreInstallation" >}} [Upgrade Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.AddInnovationTo72WebApplicationServerNew" >}} diff --git a/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md b/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md index 91497df50..b27238442 100644 --- a/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md @@ -119,7 +119,7 @@ To check all necessary ports are free, follow these steps: 1. Choose the tab below that matches the configuration for this installation, then update the script to match, changing the parameters according to the details given below: {{< tabpane lang="powershell" >}} - {{< tab header="CA Certs, Built-in Load Balancer">}} + {{< tab header="CA Certificates, Built-in Load Balancer">}} .\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` @@ -142,7 +142,7 @@ To check all necessary ports are free, follow these steps: -AcceptEULA:$AcceptEula ` *>&1 | Tee-Object -FilePath "cortex-ha-install-log.txt" {{< /tab >}} - {{< tab header="Self-Signed Certs, Built-in Load Balancer" >}} + {{< tab header="Self-Signed Certificates, Built-in Load Balancer" >}} .\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` @@ -162,7 +162,7 @@ To check all necessary ports are free, follow these steps: -AcceptEULA:$AcceptEula ` *>&1 | Tee-Object -FilePath "cortex-ha-install-log.txt" {{< /tab >}} - {{< tab header="CA Certs, Alternative Load Balancer" >}} + {{< tab header="CA Certificates, Alternative Load Balancer" >}} .\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` @@ -185,7 +185,7 @@ To check all necessary ports are free, follow these steps: -AcceptEULA:$AcceptEula ` *>&1 | Tee-Object -FilePath "cortex-ha-install-log.txt" {{< /tab >}} - {{< tab header="Self-Signed Certs, Alternative Load Balancer" >}} + {{< tab header="Self-Signed Certificates, Alternative Load Balancer" >}} .\Cortex.Install.ps1 -ConfigFileName Cortex.Innovation.Install.Config.json ` -AppServicesPath "C:\Install\Cortex Innovation {{< version >}} - App Services.zip" ` -BlockPackagesPath "C:\Install\Cortex Innovation {{< version >}} - Block Packages.zip" ` @@ -300,7 +300,10 @@ More advanced configuration (such as changing ports) can be undertaken by modify ## Check Application Services -{{< section "/install-application-server/multi-server/check-application-services.md">}} +1. Log on to one of the Application Servers. +1. Import the client certificate, used in the `ClientCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. Instructions on how to do this can be found [here][Import Client Certificate]. +1. Open a web browser. +1. {{< section "/install-application-server/multi-server/check-application-services.md">}} ## Preserve installation files @@ -313,10 +316,12 @@ More advanced configuration (such as changing ports) can be undertaken by modify [alternative load balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AltLoadBalancerNew" >}} [Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AntivirusExclusionsNew" >}} [Certificate Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.CertificateRequirementsNew" >}} +[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" >}} [CORTEX Encrypted]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" >}} [CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} [Encryption Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.EncryptionRequirementsNew" >}} [Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} +[Import Client Certificate]: {{< url path="Cortex.Faqs.ImportClientCertificate.MultiServer" >}} [Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew2" >}} [Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallWebApplicationServerNew" >}} [NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}} diff --git a/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md b/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md index abfdc791e..d7fcef1e4 100644 --- a/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md +++ b/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation.md @@ -45,7 +45,10 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc ## Check Application Services -{{< section "/install-application-server/single-server/check-application-services.md">}} +1. Log on to the Web Application Server. +1. Import the client certificate, used in the `ClientCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. Instructions on how to do this can be found [here][Import Client Certificate]. +1. Open a web browser. +1. {{< section "/install-application-server/single-server/check-application-services.md">}} # Preserve installation files @@ -56,6 +59,8 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc 1. [Install Gateway][] [Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AntivirusExclusionsNew" >}} +[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureDebuggerInstallationScript" >}} +[Import Client Certificate]: {{< url path="Cortex.Faqs.ImportClientCertificate.MultiServer" >}} [Import Root Certificate]: {{< ref path="#import-root-certificate" >}} [Install Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.GatewayInstallationNew" >}} [web application server prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.WebApplicationServerPrerequisitesNew" >}} diff --git a/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server.md b/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server.md index 3e9fe6c95..a407ec1be 100644 --- a/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server.md +++ b/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/single-server-without-ha/installation/install-application-server.md @@ -45,7 +45,10 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc ## Check Application Services -{{< section "/install-application-server/single-server/check-application-services.md">}} +1. Log on to the Application Server. +1. Import the client certificate, used in the `ClientCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. Instructions on how to do this can be found [here][Import Client Certificate]. +1. Open a web browser. +1. {{< section "/install-application-server/single-server/check-application-services.md">}} ## Preserve installation files @@ -56,6 +59,8 @@ If Windows Defender is not running on the server, ensure that the [Antivirus Exc 1. [Install Web Application Server][] [Antivirus Exclusions]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.AntivirusExclusionsNew" >}} +[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScriptNew" >}} +[Import Client Certificate]: {{< url path="Cortex.Faqs.ImportClientCertificate.SingleServer" >}} [Install Web Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallWebApplicationServerNew" >}} [Pre-Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.PreInstallation" >}} [Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.Requirements" >}} diff --git a/content/static/2025.3/images/GoTo.png b/content/static/2025.3/images/GoTo.png new file mode 100644 index 000000000..33f06460e Binary files /dev/null and b/content/static/2025.3/images/GoTo.png differ diff --git a/content/static/2025.3/images/Operations Overview.png b/content/static/2025.3/images/Operations Overview.png new file mode 100644 index 000000000..2c66cb6b3 Binary files /dev/null and b/content/static/2025.3/images/Operations Overview.png differ diff --git a/data/urls.toml b/data/urls.toml index 094440cc5..bf67b6fc6 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -243,6 +243,11 @@ ProductPortal = "/blog/2022/10/27/2022.9/#product-portal" [Cortex.Faqs] MainDoc = "/docs/faqs/" + CheckClusterHealth = "/docs/faqs/check-cluster-health/" + [Cortex.Faqs.ImportClientCertificate] + MainDoc = "/docs/faqs/import-client-certificate/" + MultiServer = "/docs/faqs/import-client-certificate/multi-server-with-ha" + SingleServer = "/docs/faqs/import-client-certificate/single-server-without-ha" [Cortex.GettingStarted] MainDoc = "/docs/getting-started/" [Cortex.GettingStarted.OnPremise] @@ -276,6 +281,7 @@ ConfigureCortexGatewayInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/#configure-cortex-gateway-installation-script" ConfigureCortexGatewayInstallationScriptNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-gateway-installation/#configure-cortex-gateway-installation-script" ConfigureCortexGatewayInstallationScriptNew2 = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation/#configure-cortex-gateway-installation-script" + ConfigureDebuggerInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation/#configure-installation-script" ConfigureInstallationScript = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-application-and-loadbalancer-servers#configure-installation-script" ConfigureInstallationScriptNew = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers#configure-installation-script" DebuggerInstallation = "/docs/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/perform-debugger-installation" @@ -380,6 +386,7 @@ ConfigureCortexGatewayInstallationScript = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/#configure-cortex-gateway-installation-script" ConfigureCortexGatewayInstallationScriptNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-gateway-installation/#configure-cortex-gateway-installation-script" ConfigureCortexGatewayInstallationScriptNew2 = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-gateway-installation/#configure-cortex-gateway-installation-script" + ConfigureDebuggerInstallationScript = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-web-application-server/perform-debugger-installation/#configure-installation-script" ConfigureInstallationScript = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-application-and-loadbalancer-servers#configure-installation-script" ConfigureInstallationScriptNew = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers#configure-installation-script" DebuggerInstallation = "/docs/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/install-web-application-server/perform-debugger-installation" @@ -2728,6 +2735,7 @@ Request = "/docs/reference/glossary/p-t/#request" SDK = "/docs/reference/glossary/p-t/#sdk" ServiceFabric = "/docs/reference/glossary/p-t/#service-fabric" + ServiceFabricExplorer = "/docs/reference/glossary/p-t/#service-fabric-explorer" Single = "/docs/reference/glossary/p-t/#single" SASL = "/docs/reference/glossary/p-t/#sasl" SMTP = "/docs/reference/glossary/p-t/#smtp" @@ -2770,6 +2778,11 @@ SetDefaultPackageVersion = "/docs/tutorials/administration/package-management/#set-the-default-package-version" Triggers = "/docs/tutorials/administration/package-management/#create-a-trigger-on-a-package-version" UnpublishPackage = "/docs/tutorials/administration/package-management/#unpublish-a-package-version" + [Cortex.Tutorials.Operations] + MainDoc = "/docs/tutorials/Operations" + [Cortex.Tutorials.Operations.Overview] + MainDoc = "/docs/tutorials/Operations/overview" + UseOperationsOverview = "/docs/tutorials/operations/overview/#using-the-operations-overview" [Cortex.Website] [Cortex.Website.EngageWithUs]