Skip to content

Commit ac2a287

Browse files
authored
feat: update readme (#217)
Signed-off-by: Denis Golovin <[email protected]>
1 parent a2a650e commit ac2a287

File tree

1 file changed

+70
-13
lines changed

1 file changed

+70
-13
lines changed

README.md

+70-13
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,73 @@
1-
![](icon.png)
2-
31
# Red Hat OpenShift Local extension
42

5-
## About
6-
73
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].
84

5+
## Usage
6+
7+
Once installed you can configure parameters used to create OpenShift Local Cluster in extension's settings page.
8+
9+
![1](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/1-crc-ext-settings.png)
10+
11+
To create new OpenShift Local Cluster switch to `Resources` Settings page and press `Create new ...` button.
12+
13+
![2](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/2-crc-ext-create-new-resource.png)
14+
15+
When new cluser has created there should be new connection visible in **OpenShift Local** section.
16+
17+
![3](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/3-crc-ext-connection.png)
18+
19+
There is also system tray menu for OpenShift Local where you can run cluster related commands.
20+
21+
![4](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/4-crc-ext-tray-menu.png)
22+
23+
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.
24+
25+
![5](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/5-crc-ext-open-pull-page.png)
26+
27+
Paste `registry.access.redhat.com/ubi8/httpd-24` into `Image to pull` field and press `Pull Image` button.
28+
29+
![6](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/6-crc-ext-pull-image-form.png)
30+
31+
After the image sucessfully pulled from the registry press `Done` button to navigate back to **Images** page.
32+
33+
![7](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/7-crc-ext-pull-image-result.png)
34+
35+
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.
36+
37+
![8](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/8-crc-ext-push-image-to-cluster.png)
38+
39+
Th progress for `Push` command it available in Podman Desktop **Tasks** View.
40+
41+
![9](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/9-crc-ext-push-image-progress.png)
42+
43+
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.
44+
45+
![10](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/10-crc-ext-run-container-button.png)
46+
47+
On **Run Image** form leave default values and press `Start Container` button.
48+
49+
![11](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/11-crc-ext-run-container-form.png)
50+
51+
After local container is up and running it can be deployed to OpenShift Local cluster using `Deploy to Kubernetes` command in upper right corner
52+
of **Container Details** page.
53+
54+
![12](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/12-crc-ext-open-deploy-to-kube-form.png)
55+
56+
On **Deploy to Kubernetes** form make sure the `Kubernetes Context` field is `crc-admin` and press `Deploy` button.
57+
58+
![13](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/13-crc-ext-deploy-to-kube-form.png)
59+
60+
The bottom part of the page shows the status of deployment. When `Container statuses` contains `Ready (Running)` it means `httpd` server is running in
61+
OpenShift Local cluster. There is also a link to open OpenShift Developer Console where you manage your local cluster.
62+
63+
![14](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/14-crc-ext-deploy-to-kube-form-result.png)
64+
65+
Clicking on the link below 'Container statuses` opens `httpd` server index page.
66+
67+
![14](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/15-crc-ext-browser-view.png)
68+
69+
You have deployed your application to OpenShift!
70+
971
## Requirements
1072

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

3496
1. Open Podman Desktop dashboard.
35-
1. Go to the **Settings > Extensions > Install a new extension from OCI Image**.
36-
1. **Name of the image**: Enter
37-
38-
```
39-
quay.io/redhat-developer/openshift-local-extension:latest
40-
```
41-
42-
1. Click on the **Install extension from the OCI image** button.
43-
97+
1. Go to the **Extensions** page.
98+
![16](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/16-crc-ext-extensions.png)
99+
1. Swithch to **Catalog** tab and click on `Install` icon in `Red Hat OpenShift Local` extension item.
100+
![17](https://raw.githubusercontent.com/containers/podman-desktop-media/openshift-local/readme/17-crc-ext-install.png)
44101

45102
## Features
46103

0 commit comments

Comments
 (0)