Step 1: Deploy Omnia Core Container

Deploy the Omnia core container on the Omnia Infrastructure Manager (OIM) where the BuildStreaM container and playbook watcher service will be installed during the BuildStreaM setup. BuildStreaM container and playbook watcher service are required to execute the pipelines to create, discover, and deploy images on the cluster nodes. The Omnia core container is deployed on the Omnia Infrastructure Manager (OIM) and it is managed as a Systemd service (omnia_core.service). The Omnia core container contains the following:

The open-source code to deploy and manage Omnia clusters. The source code is available at https://github.com/dell/omnia.

Python and Ansible preinstalled.

Use the omnia.sh script to install, uninstall, and view help on the actions that you can perform on the Omnia core container.

Prerequisites

Before you begin, ensure the following:

The OIM has internet access to download necessary packages for cluster deployment and configuration.
The OIM must have two active Network Interface Cards (NICs):
- One connected to the public network.
- One dedicated to internal cluster communication.
Ensure that Podman container engine is installed on your OIM.
If you want to use a NFS share for the omnia shared path, ensure the following:
- The NFS share has 755 permissions and no_root_squash is enabled on the mounted NFS share.
- Edit the /etc/exports file on the NFS server to include the no_root_squash option for the exported path.
```
/<your_exported_path>  *(rw,sync,no_root_squash,no_subtree_check)
```
Ensure that the following OIM hostname prerequisites are met.
- Hostname should not contain the following characters: , (comma), . (period), _ (underscore).
- Hostname cannot start or end with a hyphen (-).
- No upper case characters are allowed in the hostname.
- Hostname cannot start with a number.
- Hostname and domain name (hostname00000x.domain.xxx) cumulatively cannot exceed 64 characters.

Deploy the Omnia Core Container from Omnia Artifactory

To deploy the container images from any Omnia branch, available at Omnia Artifactory Repository, do the following:

Clone the Omnia artifacts repository and build the omnia_core container images. Run the following commands:

git clone https://github.com/dell/omnia-artifactory.git -b omnia-container-v2.2.0.0
cd omnia-artifactory
./build_images.sh core omnia_branch=v2.2.0.0 core_tag=2.2

For detailed build instructions, refer to the Omnia Artifacts README.

For core_tag=<version>, use first two digits of the Omnia version. For example, for v2.2.0.0, use core_tag=2.2.

For omnia_branch=<tag|branch>, use the branch name or tag name.

For <tag>, example: v2.1.0.0

For <branch>, example: main, pub/q1_dev, staging

For <default>, example: main

Download the omnia.sh script using the following commands:
- To use the tagged version of Omnia, run the following command:
```
wget https://raw.githubusercontent.com/dell/omnia/refs/tags/${OMNIA_VERSION}/omnia.sh
```
- To use the specific branch of Omnia, run the following command:
```
wget https://raw.githubusercontent.com/dell/omnia/refs/heads/${OMNIA_VERSION}/omnia.sh
```
Example:
- Specifc verion: wget https://raw.githubusercontent.com/dell/omnia/refs/heads/main/omnia.sh
- Tagged version: wget https://raw.githubusercontent.com/dell/omnia/refs/tags/v2.1.0.0-rc2/omnia.sh
Run the following command to make the script executable:
```
chmod +x omnia.sh
```
On the OIM, to deploy the omnia_core container and configure passwordless SSH, run the following command:
```
./omnia.sh --install
```
When prompted for the shared path, enter the path for the Omnia shared directory. This can be a local file path or an NFS share path.
When prompted for the password, enter a secure alphanumeric password for accessing the Omnia core container.
To view the Omnia version, run the following command:
```
./omnia.sh --version
```

Caution

The password must not contain special characters such as , | , & , ; , ` , < > , * , ? , ! , $ , ( ) , { } , [ ] .

Tasks Performed by `omnia.sh`

The omnia.sh script performs the following tasks:

Deploys and starts the omnia_core container as a Systemd service.
Generates an SSH key pair and stores them in the /root/.ssh folder in the core container.
Initializes the Podman container engine.
Creates the following directories within the Omnia Core Container:

/opt/omnia: Shared directory that is mapped to the Omnia shared path used by OIM.

/opt/omnia/input/project_default: Contains the input files for the playbooks.

/omnia: Contains the Omnia source code.

/opt/omnia/log/core/playbooks: Contains the playbook execution logs.

Note

Provide any file paths (for example, mapping file) that are mentioned in input files in the /opt/omnia directory.

Caution

Do not delete any key pairs generated by Omnia from /root/.ssh because this will lead to omnia_core.service execution failure.
Do not manually delete any files from the OMNIA shared directory. Use the following command to safely remove the entire OMNIA shared directory:
```
./omnia.sh --uninstall
```

Access the Omnia Core Container

You can access the Omnia core container using either of the following methods:

Podman: To access the Omnia core container using Podman, run the following command:
```
podman exec -it -u root omnia_core bash
```
SSH: To access the Omnia core container using SSH, run the following command:
```
ssh omnia_core
```

Uninstall Omnia Core Container

The omnia.sh --uninstall command removes the omnia_core container and its associated Systemd service (omnia_core.service). It also cleans up the Omnia shared directory and generated files, while preserving user-generated files such as inventory and mapping files.

Note

Before you uninstall the omnia_core container, ensure that no other containers are running on the OIM except omnia_core. If other containers are present, log in to the omnia_core container and run the following Ansible playbook to remove the containers:

cd /omnia/utils
ansible-playbook oim_cleanup.yml

To uninstall the Omnia core container, on the OIM, run the following script:

./omnia.sh --uninstall

View Usage Instructions for Omnia Core Container

The omnia.sh --help command provides usage instructions for managing the Omnia core container. The help menu lists the supported actions you can perform, such as installing and uninstalling the Omnia Core Container.

To view the usage instructions, on the OIM, run the following command:

 ./omnia.sh --help

  Usage: ./omnia.sh [--install | --uninstall | --upgrade | --rollback | --version | --help]
-i, --install     Install and start the Omnia core container
-u, --uninstall   Uninstall the Omnia core container and clean up configuration
    --upgrade     Upgrade the Omnia core container to newer version
    --rollback    Rollback the Omnia core container to previous version
-v, --version     Display Omnia version information
-h, --help        More information about usage

The help menu includes:

--install: Deploys the omnia_core container and configures it as a Systemd service.

--uninstall: Stops and removes the omnia_core container and its associated service.

--upgrade: Upgrade the Omnia core container to newer version.

--rollback: Rollback the Omnia core container to previous version.

--version: Display Omnia version information

--help: Display usage information.

Verification

Ensure that the omnia_core container is running and the Systemd service is active.

Next Steps

After installing the Omnia core container, create the PXE mapping file with the information of the nodes to be provisioned. For more information, see Create Mapping File.

If you have any feedback about Omnia documentation, please reach out at omnia.readme@dell.com.