Deploy the Red Hat Offline Knowledge Portal on your network

Deploy the Red Hat Offline Knowledge Portal on your on-premise private network or offline network so that you can share the Red Hat information library with multiple users.

Before you begin

  • An x86_64 or aarch64 hardware platform.
  • Your Customer Portal, Red Hat Developer, or registry service account credentials. These credentials are required to pull the Red Hat Offline Knowledge Portal container image from registry.redhat.io. To create a registry service account, go to the Registry Service Account page.
  • Internet access to download the Red Hat Offline Knowledge Portal image. Internet access is not needed to access the Red Hat Offline Knowledge Portal after it is deployed.
  • An open container initiative (OCI) runtime tool to deploy the Red Hat Offline Knowledge Portal. Podman is the OCI tool developed by Red Hat engineers and used in this procedure. For information about installing Podman, see the Podman website.
  • One or more pods that meet the minimum requirements:
    Resources per pod CPU Memory Disk

    Minimum

    1 core

    1 GB

    50 GB

    Recommended

    2 core

    2 GB

    75 GB

About this task

You must connect to the internet to download the Red Hat Offline Knowledge Portal container image. Then, if you are deploying the Red Hat Offline Knowledge Portal on an offline network, you can transfer the image to your disconnected environment by using the secure methods specified by your organization.

Procedure

  1. Use Podman to download the Red Hat Offline Knowledge Portal:
    1. Enter the following command in a terminal and use your Customer Portal, Red Hat Developer, or registry service account credentials to log in to registry.redhat.io: 
      $ podman login registry.redhat.io
username: <username>
Password: <password>

      where:

      <username>
      Specifies your Customer Portal, Red Hat Developer, or registry service account user name.
      <password>
      Specifies your Customer Portal, Red Hat Developer, or registry service account password.
    2. Download the Red Hat Offline Knowledge Portal image: 
      $ podman pull registry.redhat.io/offline-knowledge-portal/rhokp-rhel9:latest
  2. If you are deploying the Red Hat Offline Knowledge Portal on an offline network, complete the following steps:
    1. To convert the image to a file that you can transfer to your offline environment, save the image to a TAR file: 
      podman save --format oci-archive -o rhokp.tar rhokp-rhel9:latest
    2. Use a method approved by your organization to transfer the rhokp.tar file to your offline environment.
    3. To load the image in your offline environment, enter the following command: 
      podman load -i rhokp.tar
  3. Optional: To use your own SSL/TLS certificates, you must create a local httpd-ssl/ directory to store your certificates:
    Important
    The Red Hat Offline Knowledge Portal reverts to the default SSL/TLS key pair if it cannot detect the certificate files. 
    httpd-ssl/
├── certs
│   └── <cert_filename>.pem
└── private
   └── <key_filename>.pem

    where:

    <cert_filename>
    Specifies the name of your SSL/TLS certificate.
    <key_filename>

    Specifies the SSL/TLS key.

    The httpd-ssl directory name must be exact. Your cert and key filenames must have a .pem extension.

    For more information about using SSL certificates, see the Appache httpd 2.4 page in the RedHat catalog.

  4. Optional: Get your Red Hat Offline Knowledge Portal access key:

    The access key unlocks the knowledgebase content and search index. Without an access key, you can still launch the Red Hat Offline Knowledge Portal with limited functionality. For more information, see Launch the Red Hat Offline Knowledge Portal without an access key.

    Note
    A Red Hat Satellite subscription is required to generate the access key, however, you do not need to install Red Hat Satellite.
    1. Navigate to the Red Hat Offline Knowledge Portal Access Key Generator page, click Generate key, and then copy the key to your clipboard. After you generate your access key, the key is stored in your Red Hat account.
    2. Optional: If you need the key again, click Generate Key to display the previously generated key.
    3. Optional: If your access key is compromised, report a bug to unbind your access key so you can generate a new one.
  5. To launch the Red Hat Offline Knowledge Portal with Podman, enter the following command: 
    $ podman run --rm -p 8080:8080 -p 8443:8443 \
-v ./httpd-ssl:/opt/app-root/httpd-ssl:Z \
--env "ACCESS_KEY=<your_personal_access_key>" \
-d registry.redhat.io/offline-knowledge-portal/rhokp-rhel9:latest

    where:

    <your_personal_access_key>

    Specifies the access key that you generated in the previous step. Without the correct access key, you cannot view encrypted content or use certain features, such as search.

    If you are using your own SSL/TLS certificates instead of the default, -v ./httpd-ssl:/opt/app-root/httpd-ssl:Z \ mounts a volume for the SSL/TLS certificates in your local httpd-ssl/ directory.

    The container should start after 30 seconds.