Skip to content

Commit c969aaa

Browse files
committed
Add instructions on installing WebMKS on containers
1 parent 7a6501b commit c969aaa

File tree

5 files changed

+71
-16
lines changed

5 files changed

+71
-16
lines changed
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
### Installing VMware WebMKS on containers
2+
3+
VMware vSphere Virtual Machine Remote console access requires the installation of the VMware WebMKS SDK.
4+
Due to license restrictions this SDK cannot be built in to {{ site.data.product.title_short }}
5+
6+
To install the WebMKS SDK on containers we can take an existing container and create another layer on top of it. Once built, this image will need to be pushed to a registry and the CR updated to reflect that.
7+
8+
1. Download the latest WebMKS version (e.g. `WebMKS_SDK_{version}.zip`) from the VMware website.
9+
10+
2. Set up a temporary directory where we will build the image
11+
12+
```bash
13+
$ mkdir -p /tmp/webmks_container/container-assets
14+
```
15+
16+
3. Copy the tar file into the container-assets directory. For example,
17+
18+
```bash
19+
$ unzip ~/Downloads/WebMKS_SDK_*.zip -d /tmp/webmks_container/container-assets
20+
```
21+
22+
4. Add the following Dockerfile as `/tmp/webmks_container/Dockerfile` and substitute the second `FROM` based on the image and version that you're running.
23+
24+
```dockerfile
25+
FROM registry.access.redhat.com/ubi8/ubi as webmks
26+
27+
COPY container-assets/ /webmks/
28+
29+
################################################################################
30+
31+
### IMPORTANT: Modify the following image and tag as necessary to reflect the version that you're running
32+
FROM your_registry.example.com/namespace/manageiq-ui-worker:latest
33+
34+
COPY --from=webmks /webmks/ /var/www/miq/vmdb/public/webmks
35+
```
36+
37+
5. Build the image and tag it appropriately for your registry, then push it to the registry.
38+
39+
```bash
40+
$ cd /tmp/webmks_container/
41+
$ docker build . -t your_registry.example.com/namespace/manageiq-ui-worker:latest_webmks
42+
$ docker push your_registry.example.com/namespace/manageiq-ui-worker:latest_webmks
43+
```
44+
45+
6. Update the CR to use the UI worker image you just pushed to the registry.
46+
47+
```yaml
48+
uiWorkerImage: your_registry.example.com/namespace/manageiq-ui-worker:latest_webmks
49+
```
50+
51+
The operator will now update the orchestrator and worker deployments to reflect this change.

_includes/installing-vmware-webmks.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Installing VMware WebMKS on appliances
2+
3+
VMware vSphere Virtual Machine Remote console access requires the installation of the VMware WebMKS SDK.
4+
Due to license restrictions this SDK cannot be built in to {{ site.data.product.title_short }}
5+
6+
1. Log in to the {{ site.data.product.title_short }} user interface appliance
7+
console as the root user.
8+
9+
2. On the {{ site.data.product.title_short }} user interface appliances, create a
10+
folder titled `webmks` in the `/var/www/miq/vmdb/public/` directory.
11+
12+
/var/www/miq/vmdb/public/webmks
13+
14+
3. Download and extract the contents of [VMware WebMKS
15+
SDK](https://www.vmware.com/support/developer/html-console/) into
16+
the `webmks` folder.

installing_on_kubernetes/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@
3131

3232
{% include installing-vmware-vddk-containers.md %}
3333

34+
{% include installing-vmware-webmks-containers.md %}
35+
3436
# Uninstalling
3537

3638
{% include_relative _topics/uninstalling.md %}

installing_on_vmware_vsphere/_topics/additional_configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
## Additional Configuration for Appliances on VMware vSphere
22

33
{% include installing-vmware-vddk.md %}
4+
{% include installing-vmware-webmks.md %}
45

56
### Tuning Appliance Performance
67

managing_infrastructure_and_inventory/_topics/vnc_and_spice_consoles.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -129,22 +129,7 @@ machines that will be accessed through the HTML5 or VNC console on the
129129

130130
7. Click **OK**.
131131

132-
## Configuring VMware WebMKS Support
133-
134-
Complete the following steps to enable WebMKS support in
135-
{{ site.data.product.title_short }}.
136-
137-
1. Log in to the {{ site.data.product.title_short }} user interface appliance
138-
console as the root user.
139-
140-
2. On the {{ site.data.product.title_short }} user interface appliances, create a
141-
folder titled `webmks` in the `/var/www/miq/vmdb/public/` directory.
142-
143-
/var/www/miq/vmdb/public/webmks
144-
145-
3. Download and extract the contents of [VMware WebMKS
146-
SDK](https://www.vmware.com/support/developer/html-console/) into
147-
the `webmks` folder.
132+
{% include installing-vmware-webmks.md %}
148133

149134
## Opening a Console for a Virtual Machine
150135

0 commit comments

Comments
 (0)