Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
711090f
Created initial 2025.1 Doc
cortex-lp Dec 10, 2024
98ced0a
Updated CIP deployment document to include deployment of web.config w…
cortex-sr Dec 10, 2024
e6e0e97
Merge pull request #187 from CortexIntelligentAutomation/feature/2426…
cortex-sr Dec 11, 2024
ea5c5ec
Feature/32544 simplify installation process and unblock required inst…
Cortex-DMS Jan 22, 2025
0f91ecd
Feature/create 2024.11 to 2025.1 upgrade guide (#189)
Cortex-DMS Jan 29, 2025
2dd7608
Initial structure for new documentation
Feb 6, 2025
4cb3b95
Merge branch 'main' of https://github.com/CortexIntelligentAutomation…
Feb 24, 2025
6800b3a
Merge branch 'main' of https://github.com/CortexIntelligentAutomation…
Feb 24, 2025
b7fde8e
Added initial content for Package Management
Feb 27, 2025
0bbf8db
modified links
Feb 27, 2025
5acfdee
Changes following 2nd PO review
Mar 3, 2025
5428334
modifications following 2nd PO Review
Mar 3, 2025
c955db4
Moved Upgrade Guides into new structure from 2025.1
Mar 3, 2025
2fb3fe4
Further refinements and removal of old tutorials that are being replaced
Mar 3, 2025
39df133
Modified screen shots for consistency
Mar 5, 2025
bc32a11
Added initial Operations Overview documentation
Mar 5, 2025
2d6ce20
Added Links
Mar 5, 2025
feddfde
Modified image labels
Mar 5, 2025
422cd5d
added title to Package Management Tutorials
Mar 5, 2025
59c52e8
added initial anatomy for What is a Package?
Mar 5, 2025
07aebc0
Merge branch 'feature/new-documentation-structure-for-guides' of http…
Mar 5, 2025
7f2fc00
Made images clearer
Mar 6, 2025
8ae1dbd
Merge branch 'feature/new-documentation-structure-for-guides' of http…
Mar 6, 2025
d201696
Resized Image
Mar 6, 2025
871bfbd
Created 2025.3 Release Branch
Mar 18, 2025
9d6db87
Updated Supported Versions
Mar 18, 2025
fc32114
Merge branch 'main' of https://github.com/CortexIntelligentAutomation…
Mar 19, 2025
1539bea
Merge branch '2025.3' of https://github.com/CortexIntelligentAutomati…
Mar 19, 2025
878a977
Moved into 2025.3
Mar 19, 2025
796dbec
Excluded .Net download link from HTML Check due to 403 errors
Mar 19, 2025
77b2822
Excluded 2024.1 from HTML check
Mar 19, 2025
f148560
Added initial Upgrade Guide for 2025.1 to 2025.3 (#206)
Cortex-DMS Mar 20, 2025
e055c82
Modified following review
Mar 31, 2025
56e30f0
Added initial import client certificate FAQ
Mar 31, 2025
6b5c417
continued refactoring the check application services
Apr 2, 2025
44079ff
Merge branch '2025.3' of https://github.com/CortexIntelligentAutomati…
Apr 3, 2025
67b5535
Add 2024.9.25161 to 2025.3 upgrade guide (#207)
Cortex-DMS Apr 3, 2025
c49827c
Feature/add upgrade guide for 2024.9.25161 to 2025.3 (#208)
Cortex-DMS Apr 7, 2025
b748e82
added additional upgrade instructions (#209)
Cortex-DMS Apr 9, 2025
858b4e6
Merge branch '2025.3' of https://github.com/CortexIntelligentAutomati…
Apr 9, 2025
1e40132
Merge branch 'main' of https://github.com/CortexIntelligentAutomation…
Apr 10, 2025
1076844
Merge branch 'main' of https://github.com/CortexIntelligentAutomation…
Apr 14, 2025
2686528
Made changes to include FAQs
Apr 15, 2025
dce1994
added missing link to operations overview
Apr 15, 2025
428fb23
modified wording
Apr 15, 2025
722f4ae
Modified Import Client Cert FAQs following PO review
Apr 16, 2025
4f6ed82
Final changes following PO review
Apr 23, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions content/en/docs/2025.3/FAQs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,3 @@ linkTitle: "FAQs"
description: "Answers to our most frequently asked questions."
weight: 10000
---

{{< workinprogress >}}
6 changes: 6 additions & 0 deletions content/en/docs/2025.3/FAQs/check-cluster-health/_index.md
Original file line number Diff line number Diff line change
@@ -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
---
Original file line number Diff line number Diff line change
@@ -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" >}}
Original file line number Diff line number Diff line change
@@ -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" >}}
Original file line number Diff line number Diff line change
@@ -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
---
Original file line number Diff line number Diff line change
@@ -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" >}}
Original file line number Diff line number Diff line change
@@ -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" >}}
Original file line number Diff line number Diff line change
@@ -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
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Ops"
linkTitle: "Ops"
description: "This section includes user guides related to the Operations section in {{% ctx %}} Gateway."
weight: 5
---
Original file line number Diff line number Diff line change
@@ -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" >}}
8 changes: 8 additions & 0 deletions content/en/docs/2025.3/Reference/Glossary/p-t.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -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" >}}
7 changes: 7 additions & 0 deletions content/en/docs/2025.3/Tutorials/Operations/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Operations"
linkTitle: "Operations"
description: "This section includes tutorials about Operations on the {{% ctx %}} platform. - TODO"
weight: 40
---

12 changes: 12 additions & 0 deletions content/en/docs/2025.3/Tutorials/Operations/overview.md
Original file line number Diff line number Diff line change
@@ -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" >}}
2 changes: 1 addition & 1 deletion content/en/docs/2025.3/Whats New/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" >}}
[removal of "7.2" and "Innovation" from documentation]: {{< url path="Cortex.Blogs.Releases.2025.3.RemovalOf7.2AndInnovationFromDocumentation" version="2025.3" >}}
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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.
Loading