|
1 | 1 | # Red Hat OpenShift Local extension |
2 | 2 |
|
3 | | -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]. |
| 3 | +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]. Some of the features available in the extension include: |
| 4 | + * Start/Stop/Restart/Delete OpenShift Local clusters |
| 5 | + * Change the OpenShift Local cluster preset |
| 6 | + * Update the OpenShift Local version |
| 7 | + |
| 8 | +## Index |
| 9 | +- [Installation](#installation) |
| 10 | + - [Requirements](#requirements) |
| 11 | + - [Extension installation](#extension-installation) |
| 12 | + - [OpenShift Local installation](#openshift-local-installation) |
| 13 | +- [Usage](#usage) |
| 14 | +- [Deployment to OpenShift Local](#deployment-to-openshift-local) |
4 | 15 |
|
5 | | -## Usage |
| 16 | +## Installation |
6 | 17 |
|
7 | | -Once installed you can configure parameters used to create OpenShift Local Cluster in extension's settings page. |
| 18 | +### Requirements |
| 19 | + |
| 20 | +You need to have a working [Podman Desktop][podman-desktop] installation. |
| 21 | +Each preset of OpenShift Local has their own requirements, please check the [documentation][documentation page] for more information. |
8 | 22 |
|
9 | | - |
10 | 23 |
|
11 | | -To create new OpenShift Local Cluster switch to `Resources` Settings page and press `Create new ...` button. |
| 24 | +#### Preset types |
| 25 | + * **Microshift (experimental)** |
| 26 | + Provides a lightweight and optimized environment with a limited set of services. |
| 27 | + * **OpenShift** |
| 28 | + Provides a single node OpenShift cluster with a fuller set of services, including a web console (requires more resources). |
12 | 29 |
|
13 | | - |
14 | 30 |
|
15 | | -When new cluser has created there should be new connection visible in **OpenShift Local** section. |
| 31 | +#### Pull-secret |
| 32 | +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][download page] in your browser. |
16 | 33 |
|
17 | | - |
| 34 | +### Extension installation |
18 | 35 |
|
19 | | -There is also system tray menu for OpenShift Local where you can run cluster related commands. |
| 36 | +1. Open Podman Desktop. |
| 37 | +2. Go to the **Extensions** page: |
| 38 | +  |
| 39 | +3. Now you have two options: |
| 40 | + 1. Switch to the **Catalog** tab and click on the `Install` icon in the `Red Hat OpenShift Local` extension item: |
| 41 | +  |
| 42 | + 2. Or click on the `Install custom...` button on the upper right corner, enter `ghcr.io/crc-org/crc-extension` in the `OCI Image` field, and click on `Install`: |
20 | 43 |
|
21 | | - |
| 44 | +  |
22 | 45 |
|
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. |
| 46 | + This second approach is useful to get older versions or development releases. |
24 | 47 |
|
25 | | - |
| 48 | +### OpenShift Local installation |
| 49 | +If you don't have OpenShift Local installed in your system already, Podman Desktop can handle it for you. |
26 | 50 |
|
27 | | -Paste `registry.access.redhat.com/ubi8/httpd-24` into `Image to pull` field and press `Pull Image` button. |
| 51 | +Go to the `Dashboard` page, and in the `OpenShift Local` section you will find the `NOT-INSTALLED` label. Click on the `Install` button: |
28 | 52 |
|
29 | | - |
| 53 | + |
30 | 54 |
|
31 | | -After the image sucessfully pulled from the registry press `Done` button to navigate back to **Images** page. |
| 55 | +A dialog will appear, click on the `Yes` button: |
32 | 56 |
|
33 | | - |
| 57 | + |
34 | 58 |
|
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 OpenShift Local cluster` menu item. |
| 59 | +Follow the OpenShift Local installation wizard, picking the options that suit your needs: |
36 | 60 |
|
37 | | - |
| 61 | + |
38 | 62 |
|
39 | | -Th progress for `Push` command it available in Podman Desktop **Tasks** View. |
| 63 | +You can check the progress on the download of the binaries on the bottom of the interface: |
40 | 64 |
|
41 | | - |
| 65 | + |
42 | 66 |
|
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. |
| 67 | +## Usage |
44 | 68 |
|
45 | | - |
| 69 | +Once installed, you can configure the default `Preset` parameter used to create the OpenShift Local Cluster in the extension's **Settings** page: |
46 | 70 |
|
47 | | -On **Run Image** form leave default values and press `Start Container` button. |
| 71 | + |
48 | 72 |
|
49 | | - |
| 73 | +To create a new OpenShift Local cluster, you have three options: |
| 74 | +1. Switch to the **Resources** tab on the **Settings** page and press the `Create new ...` button: |
50 | 75 |
|
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. |
| 76 | +  |
53 | 77 |
|
54 | | - |
| 78 | + Then, in the newly opened dialog, configure the cluster to your needs and click on the `Create` button: |
| 79 | +  |
55 | 80 |
|
56 | | -On **Deploy to Kubernetes** form make sure the `Kubernetes Context` field is `crc-admin` and press `Deploy` button. |
| 81 | +2. From the **Dashboard**, in the `OpenShift Local` section, click on the `Initialize and start` button: |
57 | 82 |
|
58 | | - |
| 83 | +  |
59 | 84 |
|
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. |
| 85 | +3. From the **Dashboard**, in the `OpenShift Local` section, click on the dropdown button next to `Initialize and start` and select `Initialize OpenShift Local`: |
62 | 86 |
|
63 | | - |
| 87 | +  |
64 | 88 |
|
65 | | -Clicking on the link below 'Container statuses` opens `httpd` server index page. |
| 89 | + And then click on the `Initialize` button: |
| 90 | +  |
66 | 91 |
|
67 | | - |
| 92 | +When a new cluster has been created there should be a new connection visible in the **Resources** page, under the **OpenShift Local** section: |
68 | 93 |
|
69 | | -You have deployed your application to OpenShift! |
| 94 | + |
70 | 95 |
|
71 | | -## Requirements |
| 96 | +## Deployment to OpenShift Local |
72 | 97 |
|
73 | | -You are required to have a working [Podman Desktop][podman-desktop] installation. |
74 | | -Each preset of OpenShift Local has their own requirements, please check the [documentation][documentation page] for more information. |
| 98 | +To deploy your first application to OpenShift Local, pull the `httpd-24` image from the public Red Hat image registry using the **Pull an Image** page. To do so, open the **Images** page using the activity bar and press `Pull` button in upper right corner: |
75 | 99 |
|
| 100 | + |
76 | 101 |
|
77 | | -### Preset types |
78 | | - * Microshift (experimental) |
79 | | - provides a lightweight and optimized environment with a limited set of services. |
80 | | - * OpenShift |
81 | | - provides a single node OpenShift cluster with a fuller set of services, including a web console (requires more resources). |
| 102 | +Paste `registry.access.redhat.com/ubi8/httpd-24` into the `Image to pull` field and press the `Pull Image` button: |
82 | 103 |
|
| 104 | + |
83 | 105 |
|
84 | | -### Pull-secret |
85 | | -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][download page] in your browser. |
| 106 | +After the image was sucessfully pulled from the registry press the `Done` button to navigate back to the **Images** page: |
86 | 107 |
|
| 108 | + |
87 | 109 |
|
88 | | -## Installation |
| 110 | +Request the context menu for the `httpd-24` image you just pulled by clicking on the right most button in the row. Then select the `Push image to OpenShift Local cluster`* menu item: |
89 | 111 |
|
90 | | -#### Prerequisites |
| 112 | + |
91 | 113 |
|
92 | | -* The extension is not already installed. |
| 114 | +*Note: if the option does not appear on the context menu, try to restart Podman Desktop with `Exit On Close` preference enabled (this is a known issue). |
93 | 115 |
|
94 | | -#### Procedure |
| 116 | +The progress for the `Push` command is available in the Podman Desktop **Tasks** View: |
95 | 117 |
|
96 | | -1. Open Podman Desktop dashboard. |
97 | | -1. Go to the **Extensions** page. |
98 | | -  |
99 | | -1. Swithch to **Catalog** tab and click on `Install` icon in `Red Hat OpenShift Local` extension item. |
100 | | -  |
| 118 | + |
101 | 119 |
|
102 | | -## Features |
| 120 | +When the `Push` command is done, the image is ready to be deployed to the OpenShift Local cluster. First start a local container from the image using the `Run` button: |
103 | 121 |
|
104 | | - * Start/Stop/Delete OpenShift Local presets |
105 | | - * Change the OpenShift Local preset |
106 | | - * Change basic configuration |
| 122 | + |
107 | 123 |
|
| 124 | +On the **Run Image** form leave the default values and press `Start Container` button: |
108 | 125 |
|
109 | | -## Extension Settings |
| 126 | + |
110 | 127 |
|
111 | | - * Memory, in MiB |
112 | | - * CPUs, number of cores |
113 | | - * Preset, Microshift or OpenShift |
114 | | - * Disksize, in GiB |
115 | | - * Pull secret file, pull secret for OpenShift |
| 128 | +After the local container is up and running, it can be deployed to OpenShift Local cluster using the `Deploy to Kubernetes` button in the upper right corner |
| 129 | +of **Container Details** page: |
116 | 130 |
|
| 131 | + |
117 | 132 |
|
118 | | -## Known limitation |
119 | | -Currently, we do not support the Podman preset of OpenShift Local. Please use preferences to change this: |
| 133 | +On the **Deploy to Kubernetes** form make sure the `Kubernetes Context` field is `crc-admin` and press the `Deploy` button: |
| 134 | + |
| 135 | + |
| 136 | + |
| 137 | +The bottom part of the page shows the status of deployment. When **Container statuses** contains `Ready (Running)` it means the `httpd` server is running in the |
| 138 | +OpenShift Local cluster. There is also a link to open the OpenShift Developer Console where you can manage your local cluster: |
| 139 | + |
| 140 | + |
| 141 | + |
| 142 | +Clicking on the link below **Container statuses** opens the `httpd` server index page: |
| 143 | + |
| 144 | + |
| 145 | + |
| 146 | +You have deployed your application to OpenShift! |
120 | 147 |
|
121 | | -Settings > Preferences > Red Hat OpenShift Local > Preset |
122 | 148 |
|
123 | 149 |
|
124 | | -[product page]: https://developers.redhat.com/products/openshift/local |
| 150 | +[product page]: https://developers.redhat.com/products/openshift-local/overview |
125 | 151 | [download page]: https://cloud.redhat.com/openshift/create/local |
126 | 152 | [documentation page]: https://cloud.redhat.com/openshift/local/documentation |
127 | 153 | [podman-desktop]: https://podman-desktop.io/ |
0 commit comments