Configure deployment settings

Prev Next

Use the provided files to configure and deploy the IVX Private Cloud stack.

Configure deployment files

A zip file is shared to the user that contains essential IVX Private Cloud code and resources.

  1. Download the ivx_code_build and ivx_code_pipeline folders.

  2. Create a zip file named ivx_code_build.zip from the ivx_code_build folder.

  3. Copy ivx_code_build.zip to the ivx_code_pipeline/cdk_code folder, overwriting the existing file.

  4. Add the required configuration in ivx_code_pipeline/config.json or something similar.

  5. Navigate to the ivx_code_pipeline folder.

Mandatory configuration parameters (config.json)

Ensure the following parameters are configured before deployment:

Parameter

Description

Configuration details

ivx_aws_region

The AWS region for deployment

Specify your target region.

ivx_aws_stage

The stage environment (For example,, dev, staging, prod)

Set the desired environment name.

vpc_name, vpc_subnet_id, security_group_name

Networking details

Must match your pre-configured AWS resources.

ivx_ami_config

IVX AMI settings

Includes ivx_ami_id, instance_type (c5.metal), and max_instance_lifetime_hours (value $\ge 24$).

ivx_data_retention_days / ivx_log_retention_days

Retention period in days

Affects artifacts, Opensearch data, and CloudWatch logs.

s3_buckets_to_monitor

S3 bucket assignments

Define monitor, clean, and quarantine bucket names.

webui_config

WebUI portal access

Includes a list of users (with email_address and role: admin, analyst, monitor) and a list of allowed_ips (For example, <ip_address>/<subnet>).

icap_config

ICAP Server configuration

Configure ICAP related settings.

notification_config

Rsyslog server configuration

Optional: Can be provided as an empty JSON object {} if not required.