Skip to content

Home



IVAAP
2025.1



Welcome to IVAAP

This documentation aims to cover everything needed to deploy and configure IVAAP. Here you'll find everything from prerequisites, deployment types and diagrams, installation guides, configuration breakdown, peformance tuning guidelines, and other commonly asked questions.

IVAAP is a modular, scalable platform built for accessing, processing, and visualizing subsurface data. It provides a flexible architecture that supports custom data connectors, real-time services, and interactive web-based visualization.

What is this guide for?

Use this guide to:

  • Understand the high-level architecture of the IVAAP platform
  • Determine system requirements that best match your usecase
  • Which software prerequisites are required and assumed
  • Get the IVAAP installation kit up and running in:
    • K3s
    • AKS
    • EKS
    • OpenShift
  • Configure IVAAP for specific usecases
  • Performance tuning for deployment-specific workflows

Getting Started

IVAAP Helm Template

Helm Chart Release Notes

If you've already deployed IVAAP before, welcome back! Take a look at the latest release notes to see what has changed.

For those who are new, IVAAP Documentation is split across four main sections. Each of these sections will contain multiple guides.

For initial deployment setup, start with the Getting Started section. The Technical Data Sheet will give you all the information you need regarding deployment requirments, specs, and prerequesites. Once those are met for your environment, proceed to the installation guides for your deployment method:

Once you make it through the installation guide, you should have a working deployment with the basic configuration. This will be the starting point for advanced configuration.

General Information:

  • Technical Data Sheet: Specifications of IVAAP's capabilities and system requirements
  • IVAAP Architecture: Diagrams and documentation which will help you gain a general understanding of IVAAP as a platform and its components, deploymet landscape, etc.

Deployment Operations Guides:

  • OSDU Prerequisite Checklist: If connecting IVAAP to an OSDU instance, use this checklist to ensure everything needed is ready to be configured in the next step. If not using OSDU this can be skipped.
  • IVAAP Helm Template: IVAAP is delivered as a set of helm chart templates, this document serves as a starting point for preparing environment prerequisites (K3s/AKS/EKS/OpenShift), filling in needed configuration, deployment and first start of IVAAP. From there, environment specific sections take over to prepare the appropriate values yaml file for your target deployment type. It also dives deeper into optional performance tuning and additional configuration options.
  • Database Administration Guide: When setting up a separate Postgres instance for IVAAP to utilize, this document can guide setting up on commonly used services such as Azure managed Postgres, AWS RDS, etc. This also has additional information on postgres management if using the local postgres operator on k3s.
  • IVAAP Operations: If you are new to IVAAP, or even new to kubernetes, this guide will contain helpful information to get you started. Here you can learn basic operations for working with IVAAP in kubernetes environments.
  • IVAAP Helpers: IVAAP Helpers is a public repository that includes many helpful aliases, functions, shortcuts and notes for managing IVAAP deployments! The “ivaap-helpers” repository also contains an “examples” directory containing sample configuration for a prometheus.yaml file and a .json Grafana dashboard for monitoring IVAAP cluster metrics.

Additional Configuration

Once IVAAP is up and running, the following sections expand on additional configuration options needed for other customized environments with unique authentication or tuning requirements.

  • IVAAP Backend Environment Variables: Detailed guide on environment variables for the IVAAP backend.
  • IVAAP Configuration: This section of IVAAP documentation will go into in-depth configuration details regarding IVAAP components.
  • IVAAP Authentication: A look into the various different authentication methods IVAAP can use, along with configuration details and refences to other guides with additional configuration details.

Other Information

  • Troubleshooting: A troubleshooting guide for commonly encountered issues with IVAAP deployments.
  • OSDU Supplemental: A Supplemental guide for OSDU deployments. Details on OSDU data, OSDU connector configuration, and OSDU authentication can be found here.
  • IVAAP Scalability Supplemental: IVAAP includes an optional feature of using Infinispan for backend cacheing when monitoring real-time witsml data. Information on how Infinispan works and how to configure it can be found here.
  • IVAAP Helm Chart Release Notes: Release notes for Helm chart template changes.