Skip to content

Commit

Permalink
feat: update readme (#217)
Browse files Browse the repository at this point in the history
Signed-off-by: Denis Golovin <dgolovin@redhat.com>
  • Loading branch information
dgolovin committed May 15, 2024
1 parent a2a650e commit ac2a287
Showing 1 changed file with 70 additions and 13 deletions.
83 changes: 70 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,73 @@
![](icon.png)

# Red Hat OpenShift Local extension

## About

Integration for [Red Hat OpenShift Local][product page] clusters. It will help you install and set up the environment. and allows you to control the lifecycle and configuration from [Podman Desktop][podman-desktop].

## Usage

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

![1](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/1-crc-ext-settings.png)

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

![2](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/2-crc-ext-create-new-resource.png)

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

![3](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/3-crc-ext-connection.png)

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

![4](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/4-crc-ext-tray-menu.png)

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](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/5-crc-ext-open-pull-page.png)

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

![6](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/6-crc-ext-pull-image-form.png)

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

![7](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/7-crc-ext-pull-image-result.png)

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

![8](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/8-crc-ext-push-image-to-cluster.png)

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

![9](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/9-crc-ext-push-image-progress.png)

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](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/10-crc-ext-run-container-button.png)

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

![11](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/11-crc-ext-run-container-form.png)

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](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/12-crc-ext-open-deploy-to-kube-form.png)

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

![13](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/13-crc-ext-deploy-to-kube-form.png)

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](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/14-crc-ext-deploy-to-kube-form-result.png)

Clicking on the link below 'Container statuses` opens `httpd` server index page.

![14](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/15-crc-ext-browser-view.png)

You have deployed your application to OpenShift!

## Requirements

You are required to have a working [Podman Desktop][podman-desktop] installation.
Expand All @@ -32,15 +94,10 @@ To pull container images from the registry, a pull secret is necessary. You can
#### Procedure

1. Open Podman Desktop dashboard.
1. Go to the **Settings > Extensions > Install a new extension from OCI Image**.
1. **Name of the image**: Enter

```
quay.io/redhat-developer/openshift-local-extension:latest
```

1. Click on the **Install extension from the OCI image** button.

1. Go to the **Extensions** page.
![16](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/16-crc-ext-extensions.png)
1. Swithch to **Catalog** tab and click on `Install` icon in `Red Hat OpenShift Local` extension item.
![17](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/17-crc-ext-install.png)

## Features

Expand Down

0 comments on commit ac2a287

Please sign in to comment.