Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/12524 minor documentation fixes #67

Merged
merged 10 commits into from
Oct 19, 2023
331 changes: 331 additions & 0 deletions content/en/blog/releases/2023.X/2023.9.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ description: "This section includes tutorials about administering the {{% ctx %}
weight: 40
---

# {{< param title >}}

{{< param description >}}

## Managing role-based access control

Shows how to manage role-based access control within Gateway, including assigning access and flow permissions.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ description: "This section includes tutorials about developing automation using
weight: 30
---

# {{< param title >}}

{{< param description >}}

## Signing in and out of Gateway

Shows how to sign in and out of {{% ctx %}} Gateway.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ description: "This section includes tutorials about troubleshooting the {{% ctx
weight: 50
---

# {{< param title >}}

{{< param description >}}

## Errors when starting published flows

When making requests to start published flows, you may encounter errors. The videos below will show you how to fix them.
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/2023.11/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "2023.9"
linkTitle: "2023.9"
title: "2023.11"
linkTitle: "2023.11"
description: "Product documentation for the {{% ctx %}} automation platform, including guides, tutorials and reference documentation."
weight: 998
weight: 995
---
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ To do this, follow these steps for all default {{% ctx %}} Innovation dashboards
1. [Try it Out][]

[configured]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupLoki.MainDoc" >}}
[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.2.0.0.GrafanaDashboardsZip" >}}
[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.2.0.1.GrafanaDashboardsZip" >}}
[Grafana]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupGrafana.MainDoc" >}}
[Loki]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupLoki.MainDoc" >}}
[Try it Out]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.TryItOut.MainDoc" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ This archive contains the `promtail-local-config.yaml` configuration file, [NSSM
[NSSM]: {{< url path="NSSM.MainDoc" >}}
[Prerequisites]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.Prerequisites.MainDoc" >}}
[Promtail 2.5.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.PromtailInstallZip" >}}
[Promtail Install.zip]: {{< url path="GitHub.Cortex.Observability.2.0.0.PromtailInstallZip" >}}
[Promtail Install.zip]: {{< url path="GitHub.Cortex.Observability.2.0.1.PromtailInstallZip" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The application servers must have internet access in order to communicate with t

| Server Role | Windows Server[^1] | Other Software |
|--------------------|------------------------------------------------|--------------------|
| Application Server | [2019 (x64)][] *Recommended*<br>[2016 (x64)][] | [Promtail 2.5.0][] |
| Application Server | [2022 (x64)][] *Recommended*<br>[2019 (x64)][] | [Promtail 2.5.0][] |

[^1]: Windows Server Standard and Datacenter editions are supported. Filesystem **must be NTFS** and networking **must use IPv4**. Linux is not supported, but may be in the future.

Expand Down Expand Up @@ -52,8 +52,8 @@ A domain user which is a member of the Local Administrators group on all Applica

1. [Set up Grafana][]

[2016 (x64)]: {{< url path="Microsoft.Downloads.Windows.Server2016" >}}
[2019 (x64)]: {{< url path="Microsoft.Downloads.Windows.Server2019" >}}
[2022 (x64)]: {{< url path="Microsoft.Downloads.Windows.Server2022" >}}
[Architecture]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.Architecture.MainDoc" >}}
[Set up Grafana]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupGrafana.MainDoc" >}}
[Promtail 2.5.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.PromtailInstallZip" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ This guide describes how to install the Application Servers and Load Balancer Se
## Make Installation Artefacts Available

1. Choose one of the Application Servers to be used for installation, and copy the following artefacts to a folder on it:
* Cortex Innovation {{< version >}} - Block Packages.zip
* Cortex Innovation {{< version >}} - App Services.zip
* Cortex Innovation {{< version >}} - App Server Install Scripts.zip
* Cortex Innovation {{< version >}} - App Services.zip
* Cortex Innovation {{< version >}} - Block Packages.zip

1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,33 @@ We recommend that the single-node Service Fabric instance, used by {{% ctx %}} G

Ensure that a valid {{% ctx %}} licence file named `Cortex.lic` exists on the Web Application server, in the location `%ProgramData%\Cortex\Licences`. If it does not, follow the instructions located at [Licensing Requirements][].

### Grant folder permissions to the {{% ctx %}} Gateway Application Pool User

The following folders require `Modify` permission to allow creating the `NuGet` folders and its `NuGet.Config` file within:

* `C:\Windows\System32\config\systemprofile\AppData\Roaming`
* `C:\Windows\SysWOW64\config\systemprofile\AppData\Roaming`

For each folder, perform the following steps:

1. Navigate to the `AppData` folder.
1. Right-click on the `Roaming` folder and click `Properties`.
1. In the dialog, click the `Security` tab.
1. Check the `Application Pool` user for Gateway is listed in the `Group or user names` and has `Modify` permissions.
1. If the `Application Pool` user for Gateway is not listed:
1. Click the `Edit...` button.
1. Click the `Add...` button.
1. Enter the username of the application pool user and click `OK`.
1. In the `Permissions` section at the bottom, check `Modify`.
1. Click `OK`.
1. Click `Yes` to change the permission to the folder.
1. If the `Application Pool` user for Gateway is listed but does not have permissions:
1. Click the `Edit...` button.
1. Select the `Application Pool` user.
1. Check `Modify`.
1. Click `OK`.
1. Click `Yes` to change the permission to the folder.

### Certificate Requirements

In order to ensure that the correct certificate is used during the upgrade of {{% ctx %}} Gateway, it is necessary to [assign a friendly name][Assign Certificate Friendly Name] to the certificate that is currently being used for {{% ctx %}} Gateway. It is important to set the `ImportCertificate` parameter to `$false` when [configuring the {{% ctx %}} Gateway installation script][Configure CORTEX Gateway Installation Script].
Expand Down Expand Up @@ -148,7 +175,59 @@ To install the components required for debugging, perform the steps detailed in
If the errors do not give any instructions on how to rectify, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for further assistance.

1. Once the PowerShell script execution has completed, a prompt will appear to restart the machine. You can choose to restart now (`N`) or later (`L`).
1. The {{% ctx %}} Gateway website will now be available on `<protocol>://<host>:<port>/<webapplicationname>`, e.g. `https://localhost/gateway`.
1. In a browser, navigate to the {{% ctx %}} Gateway website, available at `<protocol>://<host>:<port>/<webapplicationname>`, e.g. `https://localhost/gateway` and wait for the login page to load.

### Grant additional folder permissions to the {{% ctx %}} Gateway Application Pool User

#### Cortex Blocks Provider Host folder

Check that the {{% ctx %}} Gateway `Application Pool` user has rights to the `Cortex Blocks Provider Host folder` folder using the following steps:

1. Navigate to `C:\ProgramData\Cortex`
1. Right-click on the `Cortex Blocks Provider Host` folder and click `Properties`.
1. In the dialog, click the `Security` tab.
1. Check the `Application Pool` user for Gateway is listed in the `Group or user names` and has `Modify` permissions.
1. If the `Application Pool` user for Gateway is not listed:
1. Click the `Edit...` button.
1. Click the `Add...` button.
1. Enter the username of the application pool user and click `OK`.
1. In the `Permissions` section at the bottom, check `Modify`.
1. Click `OK`.
1. If the `Application Pool` user for Gateway is listed but does not have permissions:
1. Click the `Edit...` button.
1. Select the `Application Pool` user.
1. Check `Modify`.
1. Click `OK`.

#### Repo folder

Check that the {{% ctx %}} Gateway `Application Pool` user has rights to the `Repo` folder using the following steps:

1. Check where the `Repo` folder is located
1. Navigate to the `gateway` IIS folder (usually `%SystemDrive%\inetpub\wwwroot\Cortex\gateway`, e.g. `C:\inetpub\wwwroot\Cortex\gateway`)
1. Open the `web.config` file.
1. Find the value of the `connectionString` named `CortexRepositories`
1. Navigate to the `Repo` folder, not opening it.
1. Right-click on the `Repo` folder and click `Properties`.
1. In the dialog, click the `Security` tab.
1. Check the `Application Pool` user for Gateway is listed in the `Group or user names` and has `Modify` permissions.
1. If the `Application Pool` user for Gateway is not listed:
1. Click the `Edit...` button.
1. Click the `Add...` button.
1. Enter the username of the application pool user and click `OK`.
1. In the `Permissions` section at the bottom, check `Modify`.
1. Click `OK`.
1. If the `Application Pool` user for Gateway is listed but does not have permissions:
1. Click the `Edit...` button.
1. Select the `Application Pool` user.
1. Check `Modify`.
1. Click `OK`.

#### Perform an IIS reset

1. Open a Windows PowerShell (x64) window as administrator.
1. Run the following command: `iisreset`.
1. Wait for the action to complete.

## Preserve installation files

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -172,9 +172,9 @@ To enable Network Discovery and File Sharing:

On the Web Application Server and each Application Server, the following Windows Services must be running:

* Performance Logs & Alerts
* Remote Registry
* Windows Event Log
* Performance Logs & Alerts

## Security Requirements

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ This guide describes how to install the Application Server components on the ser
## Make Installation Artefacts Available

1. Copy the following artefacts to a folder on the server:
* Cortex Innovation {{< version >}} - Block Packages.zip
* Cortex Innovation {{< version >}} - App Services.zip
* Cortex Innovation {{< version >}} - App Server Install Scripts.zip
* Cortex Innovation {{< version >}} - App Services.zip
* Cortex Innovation {{< version >}} - Block Packages.zip

1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name.

Expand Down Expand Up @@ -253,10 +253,6 @@ More advanced configuration (such as changing ports) can be undertaken by modify

If the errors do not give any instructions on how to rectify, see [Troubleshooting During Installation][] for further information; if this does not help then please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for assistance.

## Check Application Services

{{< section "/install-application-server/check-application-services/single-server.md">}}

## Add Read and Execute access to Windows Crypto folder

Service Fabric requires access to the `C:\ProgramData\Microsoft\Crypto\` folder for the `Network Service` users.
Expand All @@ -274,6 +270,10 @@ icacls "C:\ProgramData\Microsoft\Crypto\*" /grant *S-1-5-20:RX /t
Some files might fail to be processed with `Access is denied`. This can be ignored.
{{% /alert %}}

## Check Application Services

{{< section "/install-application-server/check-application-services/single-server.md">}}

## Preserve installation files

Ensure that the installation files are backed up or kept on the server, especially the scripts and config files that have been modified. This will make it easier to perform further actions in future, such as troubleshooting, certificate rollover, uninstallation, reinstallation and updates.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,33 @@ The steps to add Innovation functionality to 7.2 are:

Ensure that a valid {{% ctx %}} licence file named `Cortex.lic` exists on the server, in the location `%ProgramData%\Cortex\Licences`. If it does not, follow the instructions located at [Licensing Requirements][].

### Grant folder permissions to the {{% ctx %}} Gateway Application Pool User

The following folders require `Modify` permission to allow creating the `NuGet` folders and its `NuGet.Config` file within:

* `C:\Windows\System32\config\systemprofile\AppData\Roaming`
* `C:\Windows\SysWOW64\config\systemprofile\AppData\Roaming`

For each folder, perform the following steps:

1. Navigate to the `AppData` folder.
1. Right-click on the `Roaming` folder and click `Properties`.
1. In the dialog, click the `Security` tab.
1. Check the `Application Pool` user for Gateway is listed in the `Group or user names` and has `Modify` permissions.
1. If the `Application Pool` user for Gateway is not listed:
1. Click the `Edit...` button.
1. Click the `Add...` button.
1. Enter the username of the application pool user and click `OK`.
1. In the `Permissions` section at the bottom, check `Modify`.
1. Click `OK`.
1. Click `Yes` to change the permission to the folder.
1. If the `Application Pool` user for Gateway is listed but does not have permissions:
1. Click the `Edit...` button.
1. Select the `Application Pool` user.
1. Check `Modify`.
1. Click `OK`.
1. Click `Yes` to change the permission to the folder.

### Certificate Requirements

In order to ensure that the correct certificate is used during the upgrade of {{% ctx %}} Gateway, it is necessary to [assign a friendly name][Assign Certificate Friendly Name] to the certificate that is currently being used for {{% ctx %}} Gateway. It is important to set the `ImportCertificate` parameter to `$false` when [configuring the {{% ctx %}} Gateway installation script][Configure CORTEX Gateway Installation Script].
Expand Down Expand Up @@ -134,7 +161,59 @@ A Friendly Name should be assigned to the certificate being used for the Cortex
If the errors do not give any instructions on how to rectify, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for further assistance.

1. Once the PowerShell script execution has completed, a prompt will appear to restart the machine. You can choose to restart now (`N`) or later (`L`).
1. The {{% ctx %}} Gateway website will now be available on `<protocol>://<host>:<port>/<webapplicationname>`, e.g. `https://localhost/gateway`.
1. In a browser, navigate to the {{% ctx %}} Gateway website, available at `<protocol>://<host>:<port>/<webapplicationname>`, e.g. `https://localhost/gateway` and wait for the login page to load.

### Grant additional folder permissions to the {{% ctx %}} Gateway Application Pool User

#### Cortex Blocks Provider Host folder

Check that the {{% ctx %}} Gateway `Application Pool` user has rights to the `Cortex Blocks Provider Host folder` folder using the following steps:

1. Navigate to `C:\ProgramData\Cortex`
1. Right-click on the `Cortex Blocks Provider Host` folder and click `Properties`.
1. In the dialog, click the `Security` tab.
1. Check the `Application Pool` user for Gateway is listed in the `Group or user names` and has `Modify` permissions.
1. If the `Application Pool` user for Gateway is not listed:
1. Click the `Edit...` button.
1. Click the `Add...` button.
1. Enter the username of the application pool user and click `OK`.
1. In the `Permissions` section at the bottom, check `Modify`.
1. Click `OK`.
1. If the `Application Pool` user for Gateway is listed but does not have permissions:
1. Click the `Edit...` button.
1. Select the `Application Pool` user.
1. Check `Modify`.
1. Click `OK`.

#### Repo folder

Check that the {{% ctx %}} Gateway `Application Pool` user has rights to the `Repo` folder using the following steps:

1. Check where the `Repo` folder is located
1. Navigate to the `gateway` IIS folder (usually `%SystemDrive%\inetpub\wwwroot\Cortex\gateway`, e.g. `C:\inetpub\wwwroot\Cortex\gateway`)
1. Open the `web.config` file.
1. Find the value of the `connectionString` named `CortexRepositories`
1. Navigate to the `Repo` folder, not opening it.
1. Right-click on the `Repo` folder and click `Properties`.
1. In the dialog, click the `Security` tab.
1. Check the `Application Pool` user for Gateway is listed in the `Group or user names` and has `Modify` permissions.
1. If the `Application Pool` user for Gateway is not listed:
1. Click the `Edit...` button.
1. Click the `Add...` button.
1. Enter the username of the application pool user and click `OK`.
1. In the `Permissions` section at the bottom, check `Modify`.
1. Click `OK`.
1. If the `Application Pool` user for Gateway is listed but does not have permissions:
1. Click the `Edit...` button.
1. Select the `Application Pool` user.
1. Check `Modify`.
1. Click `OK`.

#### Perform an IIS reset

1. Open a Windows PowerShell (x64) window as administrator.
1. Run the following command: `iisreset`.
1. Wait for the action to complete.

## Preserve installation files

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,9 @@ The server must use an NTFS filesystem.

The following Windows Services must be running on the server:

* Performance Logs & Alerts
* Remote Registry
* Windows Event Log
* Performance Logs & Alerts

## Security Requirements

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This archive contains the `loki-local-config.yaml` configuration file, [NSSM][]

[Configure Loki]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.ConfigureLoki" >}}
[Grafana Loki 2.5.0]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.GrafanaLokiInstallZip" >}}
[Grafana Loki Install.zip]: {{< url path="GitHub.Cortex.Observability.2.0.0.GrafanaLokiInstallZip" >}}
[Grafana Loki Install.zip]: {{< url path="GitHub.Cortex.Observability.2.0.1.GrafanaLokiInstallZip" >}}
[NSSM]: {{< url path="NSSM.MainDoc" >}}
[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}}
[Software Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.SoftwareRequirements" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,5 @@ This archive contains the `promtail-local-config.yaml` configuration file, [NSSM
[NSSM]: {{< url path="NSSM.MainDoc" >}}
[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}}
[Promtail 2.5.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.PromtailInstallZip" >}}
[Promtail Install.zip]: {{< url path="GitHub.Cortex.Observability.2.0.0.PromtailInstallZip" >}}
[Promtail Install.zip]: {{< url path="GitHub.Cortex.Observability.2.0.1.PromtailInstallZip" >}}
[Software Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.SoftwareRequirements" >}}
Loading
Loading