Initial configuration steps - v. 2.x on Documentation - V2

Initial login to Keycloak and configure a redirect - v. 2.x

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: this page explains how to login to Keycloak for the first time and configure a redirect URI to ensure Console front-end can be accessed from wherever required.

The Console authentication providerhas been totally restructured in ≥ 2.x and uses the open-source OAuth2 compatible **Keycloak**system. Keycloak provides local authentication, and can also interact with other enterprise authentication systems such as LDAP and SAML. Before you start using Console, you should configure a redirect in Keycloak to allow access to Console using the Console host name or IP address in addition to localhost (which is pre-configured). If you do not, users will not be able to login to Console correctly. To do so, connect to Keycloak from any machine on the local network:

Configure authentication and roles using Keycloak - v. 2.x

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: this page explains how to login to Keycloak and configure your authentication method and user roles.

Introduction

Before you start using Console, you will need to configure your authentication method and assign roles to users. To do so, connect to Keycloak which manages authentication:

http://localhost:8086
or
http://<ip_address>:8086
or
http://<host_name>:8086

Click the Administration Console option:

The default login credentials are admin/adminunless these have been modified as part of the deployment process. When logged in, you now have a choice depending on your how you want to authenticate as listed below.

Ensure Nodes are running - v. 2.x

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: describes how to ensure that all Nodes are running.

Ensure all the Node back-end packages you have installed on dedicated Nodes are running. This should be done regardless of whether you are using a single or a **multi-node deployment scenario.**To start the Node back-end package, you can do any of the actions listed below. You will need to do this on EACH Node where you have installed the Node package.

Initial login to AIP Console - v. 2.x

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: this page explains how to login to Console for the first time and check that all is functioning as expected.

Introduction

You should now check that Console is running: you may wish to check that access is possible from an unrelated machine on the internal network:

http://<aip_console_server_host_name>:8081/
http://<aip_console_ip_address>:8081/

If the setup has been completed successfully, you will see the following:

Login with a user that has the ADMIN role as defined in Keycloak. The startup wizard will be displayed (see Complete start-up wizard - v. 2.x).

Complete start-up wizard - v. 2.x

Mon, 01 Jan 0001 00:00:00 +0000

Introduction

The start-up wizard is displayed the first time you login to Console. The wizard provides a user-friendly method to configure various mandatory settings and options, such as:

Entering a license key
Configuring access to CAST Extend / use of a proxy caching server

Each step in the wizard is explained in detail below.

Info

Note that if you do not see the start-up wizard when you first log in to Console, you have not yet installed and configured at least one Node instance (see AIP Node package - back-end installation). When this is complete, the start-up wizard will be displayed on login.

Ensure at least one AIP Node is registered - v 2.x

Mon, 01 Jan 0001 00:00:00 +0000

You should now ensure that your first Node has been successfully registered in Console. To do so, switch to the Admin Center:

Click the Nodes tab (1) and check that your node is present with a green icon to its left showing that it is connected and “up”:

Configure AIP Node storage folder locations - optional - v. 2.x

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: this page describes how to configure the Node storage folder locations. This is an optional but recommended step in the installation configuration process.

Introduction

Each Node that is managed by Console requires a set of storage folders that are used to store items related to each Application onboarded and analyzed via Console. Currently the following storage folders are required by each Node and they will be set to a default location as listed below.

Configure your PostgreSQL instances - v. 2.x

Mon, 01 Jan 0001 00:00:00 +0000

Introduction

Before creating any applications, you should ensure that you configure your PostgreSQL instances that will be used for your analysis/snapshot schema storage and for your Measurement schema. To do so, switch to the Admin Center:

Then click the Global Configurations tab:

Then expand the CSS and Measurement Settings section - see Administration Center - Settings - CSS and Measurement settings:

Focus on the Settings section:

Determine Extension strategy - v. 2.x

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: before commencing Application analyses, CAST highly recommends determining your Extension Strategy.

Introduction

CAST publishes a variety of extensions to provide additional analysis and measurement capabilities (see What are extensions for more information) and in turn, Console provides an integrated GUI to manage the use of these extensions in each Application analysis. Out-of-the-box, Console contains few restrictions or settings with regard to extensions. While this provides flexibility for Application Owners or Analysis Managers, it can sometimes be problematic if specific extensions need to be avoided for whatever reason. To counter this, Console provides a set of Extension Strategy settings that can be used to control the extensions that can be installed both automatically and manually in the integrated GUI. For example, admins can choose to do any of the following: