Welcome to the VendorN OneDDI product (OneDDI)!
This document details the necessary steps to install, upgrade and uninstall OneDDI.
This document is aimed at product administrators.
OneDDI requires a product license to operate. An evaluation license can be requested by sending an email to VendorN, simply quoting the company name. While the product requires a license there are no restrictions on the number of objects managed.
OneDDI is currently tested on 64bit Red Hat/CentOS 7 and 8 systems. All OneDDI components ship with all dependent software and do not require any software that would not otherwise be installed on a typical system.
OneDDI integrates with the Infoblox DNS, DHCP and IP address management (DDI)
product. OneDDI utilises the Infoblox API, which is versioned (i.e.
/wapi/<version>/...). OneDDI is tested with an API version of at least 2.0,
however, VendorN will attempt to support any version a customer requires.
OneDDI requires modest hardware. The following is a recommended minimum configuration:
Either physical or virtual hardware can be used for production deployments.
The OneDDI installer is named oneddi-<version>-1.x86_64.rpm - where
<version> is the version of OneDDI being installed. This program should be
transferred to a temporary location on the target server. The following steps
can then be used to install OneDDI:
Create the oneddi user - the OneDDI web server will run as this user once
started:
sudo useradd oneddi
Use the following command to install OneDDI:
sudo yum install oneddi-<version>-1.x86_64.rpm
Following installation, the OneDDI web server will be installed as a system service and started, and will listen on TCP port 443. If a local firewall is running it may require an update to permit TCP port 443 connections to the web server. For example, when using firewalld commands similar to the following may be used:
sudo firewall-cmd --add-port=443/tcp --permanent
sudo firewall-cmd --reload
Verify the web user interface can be accessed using the following URL:
https://<ip-address-or-hostname>
Following the installation the default user admin will exist with the default
password of OneDDI!. This user will have full permissions associated to
manage all features of OneDDI and can be used for initial setup of the system,
for example:
Unless otherwise specified all versions of OneDDI are backwards compatible with all previous versions. That is, any newer version can be installed over the top of any older version. No version is forwards compatible though, and an older version cannot be installed over the top of a newer version.
During an upgrade when replication is configured the active and standby peer databases can have different and incompatible schemas. Therefore, to upgrade a replication pair the replication relationship must be broken, i.e. replication must be deconfigured before the upgrade is performed. Once the upgrade is complete on both the active and standby peers replication can then be reconfigured.
Before an upgrade a backup of the application database should be taken by following the steps in the Redundancy / Backup & Restore section in the Admin Guide.
The OneDDI installer is named oneddi-<version>-1.x86_64.rpm - where
<version> is the version of OneDDI being installed. This program should be
transferred to a temporary location on the target server. The following steps
can then be used to upgrade OneDDI:
Use the following command to uninstall the existing OneDDI version -
note that all data and configuration will NOT be removed by this command
and it will remain under the /opt/oneddi directory once removed, this
will then be used by the new version once installed:
sudo yum remove oneddi
Use the following command to install OneDDI:
sudo yum install oneddi-<version>-1.x86_64.rpm
Verify the web user interface can be accessed using the following URL:
https://<ip-address-or-hostname>
If replication was deconfigured to perform the upgrade replication can be reconfigured again if both the active and standby peer have been upgraded.
The following steps can then be used to uninstall OneDDI:
Use the following command to uninstall OneDDI:
sudo yum remove oneddi
During the initial installation of OneDDI the oneddi user will have been
created for the OneDDI web server. If the oneddi user is no longer
required remove the user using the following command:
sudo userdel -r oneddi
If a local firewall is running, and it was updated to permit TCP port 443 connections to the web server, it may require an update to no longer allow TCP port 443 connections. For example, when using firewalld commands similar to the following may be used:
sudo firewall-cmd --remove-port=443/tcp --permanent
sudo firewall-cmd --reload
Following uninstallation all data and configuration files specific to the host
will still be located under the /opt/oneddi directory. If the data and
configuration files are no longer required they can be removed using the
following command:
sudo rm -r /opt/oneddi