Skip to content

Red Hat OpenShift Local Extension for integration of OpenShift Local clusters with Podman Desktop

License

Notifications You must be signed in to change notification settings

crc-org/crc-extension

Repository files navigation

Red Hat OpenShift Local extension

Integration for Red Hat OpenShift Local clusters. It will help you install and set up the environment. and allows you to control the lifecycle and configuration from Podman Desktop.

Usage

Once installed you can configure parameters used to create OpenShift Local Cluster in extension's settings page.

1

To create new OpenShift Local Cluster switch to Resources Settings page and press Create new ... button.

2

When new cluser has created there should be new connection visible in OpenShift Local section.

3

There is also system tray menu for OpenShift Local where you can run cluster related commands.

4

To deploy your first application to OpenShift Local pull httpd-24 image from public Red Hat image registry using Pull an Image page. Open Images page using activity bar and press Pull button in upper right corner.

5

Paste registry.access.redhat.com/ubi8/httpd-24 into Image to pull field and press Pull Image button.

6

After the image sucessfully pulled from the registry press Done button to navigate back to Images page.

7

Request context menu for httpd-24 image you just pulled by clicking on right most button in the row. Then select Push image to OpenShift Local cluster menu item.

8

Th progress for Push command it available in Podman Desktop Tasks View.

9

When Push command is done the image is ready to be deployed to OpenShift Local cluster. First start a local container from the image using Run button.

10

On Run Image form leave default values and press Start Container button.

11

After local container is up and running it can be deployed to OpenShift Local cluster using Deploy to Kubernetes command in upper right corner of Container Details page.

12

On Deploy to Kubernetes form make sure the Kubernetes Context field is crc-admin and press Deploy button.

13

The bottom part of the page shows the status of deployment. When Container statuses contains Ready (Running) it means httpd server is running in OpenShift Local cluster. There is also a link to open OpenShift Developer Console where you manage your local cluster.

14

Clicking on the link below 'Container statusesopenshttpd` server index page.

14

You have deployed your application to OpenShift!

Requirements

You are required to have a working Podman Desktop installation. Each preset of OpenShift Local has their own requirements, please check the documentation for more information.

Preset types

  • Microshift (experimental)
    provides a lightweight and optimized environment with a limited set of services.
  • OpenShift
    provides a single node OpenShift cluster with a fuller set of services, including a web console (requires more resources).

Pull-secret

To pull container images from the registry, a pull secret is necessary. You can get a pull secret by navigating to the dashboard and clicking the "Obtain pull-secret" or opening the Red Hat OpenShift Local download page in your browser.

Installation

Prerequisites

  • The extension is not already installed.

Procedure

  1. Open Podman Desktop dashboard.
  2. Go to the Extensions page. 16
  3. Swithch to Catalog tab and click on Install icon in Red Hat OpenShift Local extension item. 17

Features

  • Start/Stop/Delete OpenShift Local presets
  • Change the OpenShift Local preset
  • Change basic configuration

Extension Settings

  • Memory, in MiB
  • CPUs, number of cores
  • Preset, Microshift or OpenShift
  • Disksize, in GiB
  • Pull secret file, pull secret for OpenShift

Known limitation

Currently, we do not support the Podman preset of OpenShift Local. Please use preferences to change this:

Settings > Preferences > Red Hat OpenShift Local > Preset