Deploy the Red Hat Offline Knowledge Portal for use on a single system

You can deploy the Red Hat Offline Knowledge Portal for use on a single system to use as you move in and out of environments that do not have access to the internet, or to decide to share the Red Hat Offline Knowledge Portal with your organization. This is the simplest way to deploy the Red Hat Offline Knowledge Portal.

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

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. 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.
  3. To launch the Red Hat Offline Knowledge Portal with https using the self-signed certificate Podman generates, enter the following command: 
    $ podman run --rm -p 8080:8080 -p 8443:8443 \
--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.

Results

Wait 30 seconds for the container to load and then navigate to http://localhost:8080 or https://localhost:8443 and accept the self-signed certificate. The Red Hat Offline Knowledge Portal opens in a browser window.