Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Add Configuration Portal to CORTEX"
linkTitle: "Add Configuration Portal to CORTEX"
description: "Information about pre-installation steps and installation instructions for the {{% ctx %}} Configuration Portal for {{% ctx %}}."
weight: 50
---

{{< alert title="Important" color="warning" >}}
This guide currently only describe how to add the {{% ctx %}} Configuration Portal to an existing Web Application Server with {{% ctx %}} Gateway installed. For any other installation scenario, please contact {{< ahref path="Cortex.ServicePortal.MainDoc" title="CORTEX Service Portal" >}}.
{{% /alert %}}

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Post-Installation"
linkTitle: "Post-Installation"
description: "Information about the steps required to be completed after the installation has finished."
weight: 50
---

This guide describes how to perform the steps to verify the installation of the {{% ctx %}} Configuration Portal. Please ensure that the [Installation][] has been completed before starting this section.

[Installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddConfigurationPortalToCortex.Installation.MainDoc" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
title: "Try it out"
linkTitle: "Try it out"
description: "Information about trying out {{% ctx %}} for the first time."
weight: 10
---

# {{% param title %}}

This guide describes how to try out a new {{% ctx %}} Configuration Portal installation to make sure it is working. Please ensure that [Setup Gateway][] has been completed before taking these steps.

## Test Access to Configuration Portal

1. Open a web browser and navigate to the URL of the Configuration Portal. This is typically in the format `http://<server-name>/ConfigurationPortal`.
1. Log in using your Active Directory credentials. Ensure that the account you are using is part of one of the Active Directory groups specified during installation.

## Test adding a new Configuration Container and Data

1. Once logged in, you should be able to add a container by doing as follows:
1. Click on the `+ Add Container` button.
1. Fill in the `Name` field with the value `TestContainer`.
1. Click `Confirm` to create the container.
1. Click the container you just created.
1. Using the values of the table below, add a some data to the created container as follows:
| Name | Value | Type |
|---------------|------------------------|---------|
| `TestText` | `This is a test value` | Text |
| `TestInteger` | `22` | Integer |
| `TestBool` | `true` | Bool |
| `TestObject` | `{"test":22}` | Object |

1. Click on the `+ Add Parameter/Value Pair` button.
1. Fill in the `Name` and the `Value`.
1. Select the `Type`.
1. Click `CONFIRM` to add the parameter/value pair.

## Test reading data from Configuration Portal

1. Open a web browser and navigate to the URL of {{% ctx %}} Gateway. This is typically in the format `http://<server-name>/gateway`.
1. Log in using your Active Directory credentials.
1. Click on the `Dev` charms, then search for `CM-Get-Config`.
1. Click on the flow `CM-Get-Config`.
1. Once the flow opened, in the Settings tab, set the `ContainersNames` field to `["TestContainer"]`.
1. Add a breakpoint to the `End Flow` block.
1. Click on the `Run` button to execute the flow.
1. When the flow hits the breakpoint, click on the `Variables` tab.
1. Select the variable `ConfigItems`.
1. Verify that the variable contains the data you added in the previous section, it should look like the following:

``` json
{
"Parameters": [
{
"ParamID": "e440c1ee-29ee-4b70-9660-60f518a10339",
"ParamName": "TestInteger",
"ParamValue": 22
},
{
"ParamID": "b0cedd5c-e832-4fd2-8292-462be9b0ab71",
"ParamName": "TestText",
"ParamValue": "This is a test value"
},
{
"ParamID": "5f760269-41e4-4f99-8b82-96ac1ccfbb49",
"ParamName": "TestBool",
"ParamValue": true
},
{
"ParamID": "e967217d-4ca0-4a77-b357-2b3ccf1335d7",
"ParamName": "TestObject",
"ParamValue": {
"test": 22
}
}
]
}
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "Pre-Installation"
linkTitle: "Pre-Installation"
description: "Information about the steps required to be completed prior to starting the installation."
weight: 20
---

# {{% param title %}}

This guide describes how to perform the steps required before starting the installation of the {{% ctx %}} Configuration Portal.

## Make Installation Artefacts Available

1. Copy the following artefacts to a folder on the Web Application Server:
* Cortex Innovation {{< version >}} - Configuration Portal.zip

{{< alert title="Important" color="warning" >}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in this folder or a subfolder.{{% /alert %}}

1. Extract the `Cortex Innovation {{< version >}} - Configuration Portal.zip` file to a folder with the same name.

## Next Steps?

1. [Installation][]

[Installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddConfigurationPortalToCortex.Installation.MainDoc" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
title: "Requirements"
linkTitle: "Requirements"
description: "Information about the requirements required."
weight: 10
---

# {{% param title %}}

The requirements for a server installation of the {{% ctx %}} Configuration Portal are laid out in this guide. These must be considered before undertaking installation.

{{< alert color="warning" title="Important" >}}
The Configuration Portal must be installed on the Web Application Server where {{% ctx %}} Gateway is installed.For any other installation scenario, please contact {{< ahref path="Cortex.ServicePortal.MainDoc" title="CORTEX Service Portal" >}}.
{{< /alert >}}

## Domain Requirements

The server must be on a domain and cannot be a domain controller.

## Active Directory Requirements

For Gateway, only Windows domains with an Active Directory domain controller running Active Directory Domain Services are supported.

Supported versions of Active Directory are listed below:

| Version | Verified? | Supported From | Supported Until |
|------------------------|-----------|---------------------|-----------------|
| Windows Server 2016 | | {{% ctx %}} v2025.3 | To be evaluated |
| Windows Server 2019 | ✓ | {{% ctx %}} v2025.3 | To be evaluated |
| Windows Server 2022 | | {{% ctx %}} v2025.3 | To be evaluated |

## DNS Requirements

The installation requires IP to hostname resolution to be available. Please ensure that you have the appropriate pointer (PTR) records configured on the DNS server for the server.

## Web Browser Requirements

Gateway supports the latest versions of the following browsers:

* Chrome
* Edge
* Firefox

## Security Requirements

### Installation User

A domain user with the necessary administrative permissions to log on to the Configuration Portal host server via Remote Desktop and execute PowerShell scripts.

### PowerShell User

A service user with the necessary permissions to execute PowerShell scripts on the Configuration Portal host server, and has right to query Active Directory.

### Domain Groups

The Active Directory groups to which access to the Configuration Portal should be granted must be known prior to installation.

## Next Steps?

1. [Pre-Installation][]

[Pre-Installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddConfigurationPortalToCortex.PreInstallation" >}}
6 changes: 6 additions & 0 deletions data/urls.toml
Original file line number Diff line number Diff line change
Expand Up @@ -539,6 +539,12 @@
ConfigureAlloy = "/docs/getting-started/on-premise/add-observability-to-innovation/grafana/install-alloy/configure-alloy"
[Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallAlloy.InstallAlloy]
MainDoc = "/docs/getting-started/on-premise/add-observability-to-innovation/grafana/install-alloy/install-alloy"
[Cortex.GettingStarted.OnPremise.AddConfigurationPortalToCortex]
PreInstallation = "/docs/getting-started/on-premise/add-configuration-portal-to-cortex/pre-installation"
[Cortex.GettingStarted.OnPremise.AddConfigurationPortalToCortex.Installation]
MainDoc = "/docs/getting-started/on-premise/add-configuration-portal-to-cortex/installation"
[Cortex.GettingStarted.OnPremise.AddConfigurationPortalToCortex.PostInstallation]
TryItOut = "/docs/getting-started/on-premise/add-configuration-portal-to-cortex/post-installation/try-it-out"
[Cortex.GettingStarted.Cloud]
MainDoc = "/docs/getting-started/cloud"
[Cortex.GettingStarted.Cloud.AddObservabilityToInnovation]
Expand Down