From 6951345b8d02797779bacec4c32323e1730df5e5 Mon Sep 17 00:00:00 2001 From: GGabi Date: Wed, 25 Sep 2024 16:07:17 +0100 Subject: [PATCH] Adding ../ to all image paths --- 04-prerequisites/index.html | 6 +- 05-terraform/index.html | 2 +- 06-scalinggroupandvolumecreation/index.html | 20 ++--- 07-clustercreation/index.html | 86 ++++++++++----------- 08-createec2/index.html | 34 ++++---- 09-clusterconnectionstring/index.html | 12 +-- 10-setupqStudio/index.html | 12 +-- 11-connectingusingqStudio/index.html | 8 +- 12-runningqueries/index.html | 4 +- 14-takingitdown/index.html | 22 +++--- 10 files changed, 103 insertions(+), 103 deletions(-) diff --git a/04-prerequisites/index.html b/04-prerequisites/index.html index 3780462..b2e7cdd 100644 --- a/04-prerequisites/index.html +++ b/04-prerequisites/index.html @@ -854,19 +854,19 @@

Create a

Choose the same AWS Region as your AWS Finspace KxEnvirnment

Give your bucket a name

- S3 general configurations + S3 general configurations

Unselect the Block all public access box

- S3 Access Settings + S3 Access Settings

Leave all other settings as the default

Edit the access policy

Copy the ARN of your S3 buckets in the console by navigating to your S3 bucket, selecting Properties

- S3 Bucket Arn + S3 Bucket Arn

Edit the Access policy of both S3 buckets with the JSON document:

diff --git a/05-terraform/index.html b/05-terraform/index.html index 87f835f..ab5db44 100644 --- a/05-terraform/index.html +++ b/05-terraform/index.html @@ -929,7 +929,7 @@

Terraform

It is split into two modules, one for the environment and one for the clusters. This makes the directory more organised and cluster deployments easier to manage. The cluster module is still dependent on the environment module as it will import some variables from here that are needed for cluster creation.

- Terraform Module Diagram + Terraform Module Diagram

This Terraform setup is designed to deploy and manage a Managed kdb Insights environment running a TorQ bundle.

diff --git a/06-scalinggroupandvolumecreation/index.html b/06-scalinggroupandvolumecreation/index.html index c0a4783..717fc51 100644 --- a/06-scalinggroupandvolumecreation/index.html +++ b/06-scalinggroupandvolumecreation/index.html @@ -718,10 +718,10 @@

Scaling Groups

To create a scaling group through the AWS Console, select your kdb environment and navigate to the Kdb scaling groups tab:

- Select kdb env + Select kdb env

- Scaling Group Tab + Scaling Group Tab

Click the Create kdb scaling group button

@@ -731,13 +731,13 @@

Scaling Groups

  • Click the Create kdb scaling group button when you are happy with the settings.

    • - Scaling Group Settings + Scaling Group Settings

    Shared Volume

    To create a shared volume through the AWS Console, select your kdb environment and navigate to the Volumes tab:

    - Volumes Tab + Volumes Tab

    Click the Create volume button

    @@ -750,7 +750,7 @@

    Shared Volume

    - Volume Settings + Volume Settings

      @@ -758,7 +758,7 @@

      Shared Volume

    1. Click the Create volume button when you are happy with the settings

    - Volume AZ Settings + Volume AZ Settings

    (Optional) Dataview

    @@ -766,7 +766,7 @@

    (Optional) Dataview

    If you plan to run your HDB cluster on a scaling group this step is required. Otherwise, this step is optional.

    To create a scaling group through the AWS Console, select your kdb environment and navigate to the Databases tab:

    - Database tab + Database tab

    Select the database that has the changesets appropriate for your use case. @@ -775,7 +775,7 @@

    (Optional) Dataview

  • Navigate to the Dataview tab and click the Create dataview button

    • - Dataview tab + Dataview tab

      @@ -783,7 +783,7 @@

      (Optional) Dataview

    1. Choose an Availability Zone. This must match the Availability Zone your kdb scaling group runs on

    - Dataview Settings 1 + Dataview Settings 1

      @@ -795,7 +795,7 @@

      (Optional) Dataview

    1. Under Segment configuration - optional choose the root path for your Database path and the Volume you created in the prior step

    - Dataview Settings 2 + Dataview Settings 2

    Click Create dataview when you are happy with the settings

    diff --git a/07-clustercreation/index.html b/07-clustercreation/index.html index e56037c..2865955 100644 --- a/07-clustercreation/index.html +++ b/07-clustercreation/index.html @@ -825,12 +825,12 @@

    Creating TorQ Clusters

    To create a cluster, first select your kdb environment:

    - Select kdb env + Select kdb env

    Then select the Clusters tab, then either of the Create cluster buttons:

    - Create Cluster Button + Create Cluster Button

    Prerequisites

    @@ -856,25 +856,25 @@

    Discovery Cluster

  • Select the execution role for the IAM user previously created. The user for all 6 clusters should be the same. This is so that each cluster has the correct permissions.

    - Discovery Cluster Details + Discovery Cluster Details

  • Select Run on kdb scaling group for the Cluster running option.

    - Discovery Cluster Running + Discovery Cluster Running

  • Choose your group in the dropdown in the Kdb scaling group details section.

    - Kdb Scaling Group Details + Kdb Scaling Group Details

  • In the Node details section, set the Memory reservation per node to the minimum allowed (6 MiB) and leave the rest blank.

    - Discovery Memory Reservation + Discovery Memory Reservation

  • @@ -886,10 +886,10 @@

    Discovery Cluster

  • Alternatively, you can copy the URL from the codebucket itself.

    • - Select your code bucket + Select your code bucket

    - Select your code file + Select your code file

  • @@ -917,7 +917,7 @@

    Discovery Cluster

    This specified initialization script and the command line arguments will set up the necessary environment for your cluster.

    - Discovery Add Code + Discovery Add Code

  • @@ -926,13 +926,13 @@

    Discovery Cluster

  • Select your previously created VPC ID, Subnets, and Security Groups (we can use the readily available default), then select Next to go to the next page.

    - Discovery VPC Settings + Discovery VPC Settings

  • Leave everything as blank and click Next to move on to the next page.

    - Discovery Config Options + Discovery Config Options

    14. Check the entered information in the review page, then select Create cluster.

    • @@ -948,7 +948,7 @@

    Ticker Plant (TP) Cluster

  • Note: This name must match your process name, procname, added during the next stage of cluster creation - This is due to process connections requiring the cluster name, which is not visible from within the process, but procname is. Our suggestion is to use the process type (proctype) with a number e.g. tp1.

    • - TP Cluster Details + TP Cluster Details

  • @@ -957,13 +957,13 @@

    Ticker Plant (TP) Cluster

  • Select Run on kdb scaling group for the Cluster running option.

    - TP Cluster Running + TP Cluster Running

  • Choose your group in the dropdown in the Kdb scaling group details section.

    - Kdb Scaling Group Details + Kdb Scaling Group Details

  • @@ -975,7 +975,7 @@

    Ticker Plant (TP) Cluster

  • Leave Tags as empty and select Next to go to the next page.

    - TP Node Details + TP Node Details

  • @@ -1009,7 +1009,7 @@

    Ticker Plant (TP) Cluster

    This specified initialization script and the command line arguments will set up the necessary environment for your cluster.

    - TP Add Code + TP Add Code

  • @@ -1021,7 +1021,7 @@

    Ticker Plant (TP) Cluster

  • Select your volume, then select Next to go to the next page.

    - Add volume + Add volume

  • @@ -1039,7 +1039,7 @@

    Real-Time Database (RDB) Cluster

  • Note: This name must match your process name, procname, added during the next stage of cluster creation - This is due to process connections requiring the cluster name, which is not visible from within the process, but procname is. Our suggestion is to use the process type (proctype) with a number e.g. rdb1.

    • - RDB Cluster Details + RDB Cluster Details

  • @@ -1048,13 +1048,13 @@

    Real-Time Database (RDB) Cluster

  • Select Run on kdb scaling group for the Cluster running option.

    - RDB Cluster Running + RDB Cluster Running

  • Choose your group in the dropdown in the Kdb scaling group details section.

    - Kdb Scaling Group Details + Kdb Scaling Group Details

  • @@ -1066,7 +1066,7 @@

    Real-Time Database (RDB) Cluster

  • Leave Tags as empty and select Next to go to the next page.

    - RDB Node Details + RDB Node Details

  • @@ -1100,7 +1100,7 @@

    Real-Time Database (RDB) Cluster

    This specified initialization script and the command line arguments will set up the necessary environment for your cluster.

    - RDB Add Code + RDB Add Code

  • @@ -1124,7 +1124,7 @@

    Real-Time Database (RDB) Cluster

  • Select Next to go to the next page.

    - RDB Config Options + RDB Config Options

  • @@ -1142,7 +1142,7 @@

    Historical Database (HDB) Cluster

  • Note: This name must match your process name, procname, added during the next stage of cluster creation - This is due to process connections requiring the cluster name, which is not visible from within the process, but procname is. Our suggestion is to use the process type (proctype) with a number e.g. hdb1.

    • - HDB Cluster Details + HDB Cluster Details

  • @@ -1151,13 +1151,13 @@

    Historical Database (HDB) Cluster

  • Select Run on kdb scaling group for the Cluster running option.

    - HDB Cluster Running + HDB Cluster Running

  • Choose your group in the dropdown in the Kdb scaling group details section.

    - Kdb Scaling Group Details + Kdb Scaling Group Details

  • @@ -1169,7 +1169,7 @@

    Historical Database (HDB) Cluster

  • Leave Tags as empty and select Next to go to the next page.

    - HDB Node Details + HDB Node Details

  • @@ -1203,7 +1203,7 @@

    Historical Database (HDB) Cluster

    This specified initialization script and the command line arguments will set up the necessary environment for your cluster.

    - HDB Add Code + HDB Add Code

  • @@ -1223,7 +1223,7 @@

    Historical Database (HDB) Cluster

    • - HDB Config Options + HDB Config Options

      @@ -1241,7 +1241,7 @@

      Gateway Cluster

    1. Note: This name must match your process name, procname, added during the next stage of cluster creation - This is due to process connections requiring the cluster name, which is not visible from within the process, but procname is. Our suggestion is to use the process type (proctype) with a number e.g. gateway1.

      2. - Gateway Cluster Details + Gateway Cluster Details

    2. @@ -1250,13 +1250,13 @@

      Gateway Cluster

    3. Select Run on kdb scaling group for the Cluster running option.

      - Gateway Cluster Running + Gateway Cluster Running

    4. Choose your group in the dropdown in the Kdb scaling group details section.

      - Kdb Scaling Group Details + Kdb Scaling Group Details

    5. @@ -1268,7 +1268,7 @@

      Gateway Cluster

    6. Leave Tags as empty and select Next to go to the next page.

      - Gateway Node Details + Gateway Node Details

    7. @@ -1302,7 +1302,7 @@

      Gateway Cluster

      This specified initialization script and the command line arguments will set up the necessary environment for your cluster.

      - Gateway Add Code + Gateway Add Code

    8. @@ -1327,7 +1327,7 @@

      Feed Cluster

    9. Choose a name for your cluster. As this is a sample feed and not a "production" intended process, please name it feed1.

      - Feed Cluster Details + Feed Cluster Details

    10. @@ -1336,19 +1336,19 @@

      Feed Cluster

    11. Select Run on kdb scaling group for the Cluster running option.

      - Feed Cluster Running + Feed Cluster Running

    12. Choose your group in the dropdown in the Kdb scaling group details section.

      - Kdb Scaling Group Details + Kdb Scaling Group Details

    13. In the Node details section, set the Memory reservation per node to the minimum allowed (6 MiB) and leave the rest blank.

      - Feed Memory Reservation + Feed Memory Reservation

    14. @@ -1385,7 +1385,7 @@

      Feed Cluster

      This specified initialization script and the command line arguments will set up the necessary environment for your cluster.

      - Feed Add Code + Feed Add Code

    15. @@ -1397,7 +1397,7 @@

      Feed Cluster

    16. Leave everything as blank and click Next to move on to the next page.

      - Feed Config Options + Feed Config Options

    17. @@ -1413,7 +1413,7 @@

      On Completion

      Errors in cluster creation

      On cluster creation, most errors will result in your cluster going to a Create failed state.

      - Cluster failure + Cluster failure

      If that is the case you should:

      @@ -1421,7 +1421,7 @@

      Errors in cluster creation

    18. Click the cluster name in the Clusters section of your environment.

      - Select Cluster + Select Cluster

    19. @@ -1430,7 +1430,7 @@

      Errors in cluster creation

    20. If you click the LogStream for an individual log it will take you to AWS CloudWatch where you can filter the messages for keywords or for messages in a certain time window.

      - Select Cluster Logs + Select Cluster Logs

      21. diff --git a/08-createec2/index.html b/08-createec2/index.html index 0b13ac3..bfd2497 100644 --- a/08-createec2/index.html +++ b/08-createec2/index.html @@ -764,12 +764,12 @@

      Creating and Connect to an EC2

      Create a Windows EC2 Instance

      Navigate to the EC2 service.

      - Navigate to the EC2 service + Navigate to the EC2 service

      Select Launch instance to create a new EC2 instance.

      - Select launch instance + Select launch instance

      Most options here can be left as their defaults. Here are the ones that need selected/changing:

      @@ -777,88 +777,88 @@

      Create a Windows EC2 Instance

    21. Select "Windows" from the Quick Start options.

      - Select windows quick start + Select windows quick start

    22. We need to create a new key pair: Select Create new key pair.

      - Select create new key pair + Select create new key pair

    23. Enter a name for your key pair, leave the key pair type as RSA and the file format as .pem. This will download a key file to you PC which you will use to connect to the instance.

      - Create new key pair + Create new key pair

    The network should be in the same VPC as your cluster. Select Create security group that allows Remote Desktop Protocol (RDP) connections from anywhere. - This is only for the purposes of the MVP. For customising see this page on security groups.

    - EC2 network + EC2 network

    Adding your new security group to you EC2

    Now we need to add the security group of your cluster to your EC2.

    Navigate to EC2 service.

    - Navigate to EC2 + Navigate to EC2

    Select Instances (running).

    - Select Instance running + Select Instance running

    Open your EC2 Instance.

    - Open EC2 instance + Open EC2 instance

    Select Actions -> Security -> Change security groups.

    - Select change security groups + Select change security groups

    Search and select the security group that is on your clusters, select Add security group then Save.

    - Add security group + Add security group

    You should now have two security groups, one from the launch wizard, and the one you added manually that is also attached to your clusters.

    - Security group example + Security group example

    Connecting to your EC2 Instance

    Open your EC2 Instance.

    - Open EC2 instance + Open EC2 instance

    Select Connect.

    - Select connect + Select connect

    Get your password

    This only needs to be done once. Once you have this password you can skip this step.

    Select Get password.

    - Get password + Get password

    Upload the .pem that was saved to you PC earlier (alternativly you can just paste the contents of this file in the text box).

    - Upload .pem file + Upload .pem file

    This will return the value of your password. Keep a note of this password as you will need it to connect your EC2.

    Connect

    Download the remote desktop file.

    - Dowload remote desktop file + Dowload remote desktop file

    Run this file and enter the password you recieved above when promted. You should now be connected to the Windows remote desktop.

    diff --git a/09-clusterconnectionstring/index.html b/09-clusterconnectionstring/index.html index ccd17b3..a8601b7 100644 --- a/09-clusterconnectionstring/index.html +++ b/09-clusterconnectionstring/index.html @@ -835,23 +835,23 @@

    Role

    Create a user (If manually set up (not useing Terraform))

    In your kdb environment, go to the Users tab and select Add user.

    - Create user button + Create user button

    Give it a name and select the IAM role you created above.

    - Add user + Add user

    Generate Connection String

    On the Users tab, copy the links for IAM role and User ARN for the user.

    - User details + User details

    Navigate to CloudShell.

    - Navigate to CloudShell + Navigate to CloudShell

    Replace <ARN_COPIED_FROM_ABOVE> with the IAM Role copied above and run the following (this will not return anything):

    @@ -865,7 +865,7 @@

    Generate Connection String

    This lets you assume the role that you have just created by taking the values returned from the aws sts assume-role command and setting them in your AWS_ACCESS_KEY_ID, e.t.c. environment variables. NOTE - if you need to switch back to your own user within the CloudShell, you will need to run unset AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_SESSION_TOKEN to unset these environment variables.

    Copy your kdb Environment ID:

    - Get you kdb env ID + Get you kdb env ID

    Replace <YOUR_KDB_ENVIRONMENT_ID> with your kdb environment ID, <USER_ARN_COPIED_ABOVE> with the User ARN, and <NAME_OF_CLUSTER> with the name of the cluster you want to connect to. Run the following:

    @@ -873,7 +873,7 @@

    Generate Connection String

    This will return a large connection string which can be used to connect to your cluster.

    - Connection string example + Connection string example

    diff --git a/10-setupqStudio/index.html b/10-setupqStudio/index.html index 77d2a81..b064a4f 100644 --- a/10-setupqStudio/index.html +++ b/10-setupqStudio/index.html @@ -681,29 +681,29 @@

    Setup qStudio

    Download qStudio

    Navigate to the TimeStored website and download the relavent version (usually x64).

    - Download button on qStudio website + Download button on qStudio website

    Download the Microsoft C++ 2010 service pack (there is a specific DLL from this that you need that is usually installed on Windows machines).

    - Download MSPack + Download MSPack

    Select the relevant version (usually x64).**

    - Download MSPack select version + Download MSPack select version

    Run the file that was just downloaded.

    Search for ‘Edit Environment variables’ and add SSL_VERIFY_SERVER=NO as one of them.

    - Edit Environment Variables 1 + Edit Environment Variables 1

    - Edit Environment Variables 2 + Edit Environment Variables 2

    - Edit Environment Variables 3 + Edit Environment Variables 3

    diff --git a/11-connectingusingqStudio/index.html b/11-connectingusingqStudio/index.html index f93391e..cf47dcc 100644 --- a/11-connectingusingqStudio/index.html +++ b/11-connectingusingqStudio/index.html @@ -623,17 +623,17 @@

    Connecting Using qStudio

    Open qStudio, right-click on Servers in the top left corner and select Add Server.

    - Add Server Connection + Add Server Connection

    You will then see a pop-up showing the server properties. This is where you will add the information from the connection string (details below in the next step).

    - Server Properties + Server Properties

    Follow the step in our Generate Connection String section to get a fresh connection string. The generated connection string provides you with everything you need to fill the boxes above. See the below connection string for an example:

    - Connection String + Connection String

    The required fields in the Server Properties screen are contained within the connection string and are colon separated. Here,

    @@ -643,7 +643,7 @@

    Connecting Using qStudio

    Username: david-finspace

    Password: Host=vpce-063d07d253dde398d-19p5nh4w.vpce-svc-0b408455b16d79292.us-west-2.vpce.amazonaws.com&Port=443&User=david-finspace&Action=finspace%3AConnectKxCluster&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEDUaCXVzLXdlc3QtMiJGMEQCIFOmCCIAE5hyh0obtgV8TeS9jCglbxFPEossH5f4vRhrAiAIaxSHF%2FQhjqACSlmwlLTNJBvx658bQwyiH9LVz20ehSr4AgguEAIaDDc2NjAxMjI4NjAwMyIMl3TMLJjQytFtFLaiKtUCbJrjypNOC5U8GwttcBfln2SV%2FJclct%2FmeDtnUCUcVB3bzcCUOpGQFXUR%2FtonWVO0ZO1SUu%2Bna%2Bs0l0UfMu7K7qDOQhszg1%2Fxdblx0TRi70GVunATeJlpppyQeZNUk9RHSOvGPCN8VKGBJmisbeo3bJb7MvVLak1lgVdLn%2FxUIS0uTfA62PbzU6LPE1nj85bupgLrvAMlSwvZMy3pVXJaN%2BBvk0mulmCvIYfqlqL%2FcjvWbOMQdyXsdAYCO4TRpA7I38Jmfr9h1oee2JVvVMCu41yRQhbAqtqgvNwrhgSyOQASAJSVGiIPHiXyGz5KefntOfq1zADleUrUg0Nvh6EPFj%2FavNsHZyBSapvUVVsx%2FA9aI2aHeg5P%2FtCifq%2Bnxg5vyKSX4GcB7P40pKs3Ymeb3yAUllN2tJ5VXlx7SI3p8jfTB8k72BeOzu%2BLbWs5gtb%2BlZG1cSQwzKSHrwY6wAEpzwyEjjuh50PM6OZgRBNgBEOiqLaTHqjBv7VHcjsF5FnpJqZ2AhBtQXXkFiItA%2FSZ7B0aGbL0sYJ8v7WZZIMtAvg4e0ve9VBYXf4hnl5i82T5EJfAy727E9e25Wwb%2FILZAeOjdTY0IhcgvWlLCeBJNEHEMO8h8yupkLfFQHlNvF14wrH1U8bSd934M8k%2F22%2FDTrZFlVQXe%2FeLYt%2FxOBEHfHWiMH51v2IDv39%2B%2B7%2FGq3XmrcNymPQQ0HcoJEK%2BTjg%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240301T130412Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=ASIA3EWPD4QZXLHMX4GY%2F20240301%2Fus-west-2%2Ffinspace-apricot%2Faws4_request&X-Amz-Signature=c134f0dc1f0cba738c0bf8547c9ca8702593ea9e9b89ee2d17892fd379524d30

    - All Servers + All Servers

    diff --git a/12-runningqueries/index.html b/12-runningqueries/index.html index 4e7cebd..3d6eec3 100644 --- a/12-runningqueries/index.html +++ b/12-runningqueries/index.html @@ -625,12 +625,12 @@

    Running Queries

    For queries to be ran through the gateway, we must update some preferences on qStudio. Go to Settings -> Preferences -> Connections tab.

    We will need to uncheck the box labelled Wrap query sent to server.

    - Preferences + Preferences

    The queries below should then all run successfully!

    - qStudio Queries + qStudio Queries

    Example queries are listed below:

    diff --git a/14-takingitdown/index.html b/14-takingitdown/index.html index 6a6aa8a..9201e05 100644 --- a/14-takingitdown/index.html +++ b/14-takingitdown/index.html @@ -752,12 +752,12 @@

    Taking it Down

    Deleting clusters

    From your Kdb environment select the cluster you want to delete and select Delete.

    - Select delete cluster + Select delete cluster

    On the confirmation dialog box, enter confirm then select Delete.

    - Delete cluster + Delete cluster

    Deleting your dataview

    @@ -766,7 +766,7 @@

    Deleting your dataview

  • Select your kdb environment and navigate to the Databases tab. Then select the database your dataview is associated with:

    • - Database tab + Database tab

      @@ -774,14 +774,14 @@

      Deleting your dataview

    1. Click the Delete button

    - Delete Dataview + Delete Dataview

    1. On the confirmation dialog box, type "confirm" and then click the Delete button.

    - Delete Dataview confirm + Delete Dataview confirm

    Deleting your Shared Volume

    @@ -789,14 +789,14 @@

    Deleting your Shared Volume

  • Select your kdb environment and navigate to the Volumes tab. Then select the volume you like to delete and click Delete

    • - Delete Volume + Delete Volume

    1. On the confirmation dialog box, type "confirm" and then click the Delete button.

    - Delete Volume confirm + Delete Volume confirm

    Deleting your Kdb Scaling Group

    @@ -805,25 +805,25 @@

    Deleting your Kdb Scaling Group

  • Select your kdb environment and navigate to the Kdb scaling groups tab. Then select the scaling group you like to delete and click Delete

    • - Delete Scaling Group + Delete Scaling Group

    1. On the confirmation dialog box, type "confirm" and then click the Delete button.

    - Delete Scaling Group confirm + Delete Scaling Group confirm

    Deleting your database

    From your Kdb environment select the Databases tab, select the database you want to delete and select Delete.

    - Delete cluster + Delete cluster

    On the confirmation dialog box, enter confirm then select Delete.

    - Delete cluster + Delete cluster