IAP Planning (Variables & Settings)

Updated on 22 May 2023

Dark

Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Network

	Environment Variable	Sample Value
Hostname	`HOSTNAME`	`itential01`
FQDN	`FQDN`	`itential01.pronghorn.io`
Management interface	`MGMT_INTERFACE`	`enp0s3`
Management IP Address	`MGMT_IP_ADDRESS`
Service Interface	`SVC_INTERFACE`	`enp0s8`
Service IP Address	`SVC_IP_ADDRESS`
DNS Server 1	`DNS1`	`8.8.8.8`
DNS Server 2	`DNS2`	`8.8.4.4`
DNS Server 3	`DNS3`
Timezone	`TZ`	`America/New_York`
NTP Server 1	`NTP1`	`0.pool.ntp.org`
NTP Server 2	`NTP2`	`1.pool.ntp.org`
NTP Server 3	`NTP3`	`2.pool.ntp.org`

Security Certificate

Gather the network IP and hostname assignments into this table. At least three DNS and NTP servers are recommended for high-availability.

	Environment Variable	Sample Value	DB-01	DB-02	DB-03
Organization
Organizational Unit
Country
State
Location
Contact
Private Key Password
Certificate Request Password

Itential Registry

A connection to the Itential registry is recommended to enable dynamic build environments.

	Environment Variable	Sample Value	ITENTIAL-01	ITENTIAL-02	ITENTIAL-03
Itential Registry URL	`ITENTIAL_URL`
Itential Registry CA File	`ITENTIAL_CA_FILE`
Itential Registry Username	`ITENTIAL_USERNAME`
Itential Registry Password	N/A

Itential Automation Platform Configuration

Use the following values to configure IAP.

	Environment Variable	Sample Value
Install Directory	`ITENTIAL_HOME`
Logs Directory	`ITENTIAL_LOGS`
HTTPS Port	`ITENTIAL_HTTPS_PORT`
Admin Group	`ITENTIAL_ADMIN_GROUP`
MongoDB Server 1	`MDB_HOST1`	`db01.pronghorn.io`
MongoDB Server 2	`MDB_HOST2`	`db02.pronghorn.io`
MongoDB Server 3	`MDB_HOST3`	`db03.pronghorn.io`
MongoDB Port	`MDB_PORT`	`27017`
MongoDB CA File	`MDB_CA_FILE`
MongoDB Username	`MDB_USERNAME`	`itential`
MongoDB Password	n/a	****
Proxy Server (Optional)	`HTTP_PROXY` `HTTPS_PROXY`	Refer to the Proxy Settings for Pre-builts section below.

LDAP

This table will help track the required LDAP configuration values.

	Environment Variable	Sample Value
LDAP User Filter	`LDAP_USER_FILTER`
LDAP Port	`LDAP_PORT`	`389`
LDAP Membership Attribute	`LDAP_MEMBERSHIP_ATTR`
LDAP Group Filter	`LDAP_GROUP_FILTER`
LDAP FQDN	`LDAP_FQDN\|ldap.pronghorn.io`
LDAP Bind Username	`LDAP_BIND_USERNAME`
LDAP Bind Password	N/A
Additional LDAP Info
Active Directory	`LDAP_IS_AD`	`false`

Email

This table will help track any required email server configuration values.

	Environment Variable	Sample Value
Email FQDN	`EMAIL_FQDN`	`mail.pronghorn.io`
Email Port	`EMAIL_PORT`
Email Protocol	`EMAIL_PROTOCOL`
Email Username	`EMAIL_USERNAME`
Email Password	`EMAIL_PASSWORD`

Browser

Presently, IAP is compatible with the most current version of the following browsers.

Chrome
Firefox
Microsoft Edge
IE11

Proxy Settings for Pre-builts

Some network enviroments are set up to have a proxy between the IAP server and the Internet. For those environments, Itential provides proxy support for both HTTP and HTTPS.

To fetch available Pre-builts from the Itential OpenSource Registry with a proxy server:

Set the HTTP_PROXY environment variable in the session where IAP is started.

Example

export HTTP_PROXY=http://insecure-proxy.uat.domain.io:3128

Example

export HTTPS_PROXY=https://internal-proxy.uat.domain.io:3128

Optionally, set the username:password for authentication. If an authenticated proxy is not required, skip this setting.

Example
```
export HTTPS_PROXY=https://username:password@proxy.uat.itential.io:3128
```
Restart IAP to accept the settings.

Was this article helpful?

What's Next

Kernel Parameters

Table of contents

Network
Security Certificate
Itential Registry
Itential Automation Platform Configuration
LDAP
Email
Browser
Proxy Settings for Pre-builts