Skip to content

Commit c2ad03e

Browse files
committed
Merge branch 'wktui-2.0-docs' into 'main'
WKT UI 2.0 docs See merge request weblogic-cloud/weblogic-toolkit-ui!447
2 parents 7f4a2f7 + 395ec0e commit c2ad03e

File tree

1,754 files changed

+72228
-12503
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,754 files changed

+72228
-12503
lines changed

.github/workflows/publish-github-pages.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ jobs:
4141

4242
- name: Build and publish site
4343
run: |
44-
curl -fL -o hugo.tar.gz "https://github.com/gohugoio/hugo/releases/download/v0.88.1/hugo_0.88.1_Linux-64bit.tar.gz"
44+
curl -fL -o hugo.tar.gz "https://github.com/gohugoio/hugo/releases/download/v0.152.2/hugo_0.152.2_Linux-64bit.tar.gz"
4545
tar -zxf hugo.tar.gz
4646
export PATH="$PWD:$PATH"
4747
mkdir $GITHUB_WORKSPACE/WORK

.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,16 @@ samples/quickstart/app/target/generated-sources
2323
samples/quickstart/app/target/maven-archiver
2424
samples/quickstart/app/target/maven-status
2525
samples/quickstart/app/target/todo
26+
# Quickstart Maven target directory except for WAR file
27+
samples/quickstart/app-jakarta/target/classes
28+
samples/quickstart/app-jakarta/target/generated-sources
29+
samples/quickstart/app-jakarta/target/maven-archiver
30+
samples/quickstart/app-jakarta/target/maven-status
31+
samples/quickstart/app-jakarta/target/todo
2632
# Quickstart local domain directory
2733
samples/quickstart/todolist_domain
2834
# Quickstart local domain generated variables file
35+
samples/quickstart/scripts/local-domain/archive.zip
2936
samples/quickstart/scripts/local-domain/variables.properties
3037
# Quickstart developer env file
3138
samples/quickstart/setQuickstartDevEnv.sh

documentation/2.0/config.toml

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,28 @@ languageCode = 'en-us'
66
title = 'WebLogic Kubernetes Toolkit UI'
77

88
# Change the default theme to be use when building the site with Hugo
9-
theme = 'learn'
9+
theme = 'hugo-theme-relearn-8.3.0'
1010

1111
publishDir = "docs"
1212

1313
# For search functionality
1414
[outputs]
1515
home = [ "HTML", "RSS", "JSON"]
1616

17+
[markup]
18+
defaultMarkdownHandler = 'goldmark'
19+
[markup.goldmark]
20+
[markup.goldmark.extensions]
21+
footnote = true
22+
[markup.goldmark.extensions.extras]
23+
[markup.goldmark.extensions.extras.superscript]
24+
enable = true
25+
[markup.goldmark.renderer]
26+
unsafe = true
27+
1728
[params]
29+
hideAuthorDate = true
1830
# disable the copy to clipboard links
1931
disableInlineCopyToClipBoard = true
32+
themeVariant = "learn"
2033
custom_css = [ "css/theme-wktui.css" ]

documentation/2.0/content/_index.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
weight: 1
3+
pre: "<b> </b>"
4+
hideHeader: true
5+
---
6+
17
## WebLogic Kubernetes Toolkit UI Documentation
28

39
The WebLogic Kubernetes Toolkit (WKT) is a collection of open source tools that help you provision WebLogic-based
@@ -9,15 +15,14 @@ applications to run in Linux containers on a Kubernetes cluster. WKT includes t
915
images for running WebLogic domains.
1016
- [WebLogic Kubernetes Operator (WKO)](https://github.com/oracle/weblogic-kubernetes-operator) - A Kubernetes operator
1117
that allows WebLogic domains to run natively in a Kubernetes cluster.
12-
- [WebLogic Remote Console](https://github.com/oracle/weblogic-remote-console) - A lightweight console for managing
13-
WebLogic Server domains running anywhere.
1418

15-
The WKT UI provides a graphical user interface that wraps the WKT tools, Docker, Helm, and the Kubernetes client
19+
The WKT User Interface (WKT UI) provides a graphical user interface that wraps the WKT tools, Docker, Helm, and the Kubernetes client
1620
(`kubectl`) and helps guide you through the process of creating and modifying a model of your WebLogic domain, creating
1721
a Linux container image to use to run the domain, and setting up and deploying the software and configuration
1822
necessary to deploy and access the domain in your Kubernetes cluster.
1923

20-
Be sure to check out the [Quick Start]({{< relref "/setup/quickstart/" >}}) guide for a tutorial, which will step you through WebLogic Kubernetes Toolkit UI (WKTUI) functionality and familiarize you with its capabilities.
24+
Be sure to check out the [Quick Start]({{% relref "/setup/quickstart/" %}}) guide for a tutorial, which will step you
25+
through WKT UI functionality and familiarize you with its capabilities.
2126

2227
### Current release
2328

@@ -26,15 +31,14 @@ WebLogic Kubernetes Toolkit UI version and release information can be found [her
2631
### About the Documentation
2732
For detailed user information, read the following:
2833

29-
- [About the WKT UI Application]({{< relref "/concepts/" >}})
30-
- WebLogic Kubernetes Toolkit UI [Prerequisites]({{< relref "/setup/prerequisites.md" >}}) and [Installation]({{< relref "/setup/install.md" >}})
31-
- [Navigate the WKT UI]({{< relref "/navigate/" >}})
32-
- [Model]({{< relref "/navigate/model.md" >}})
33-
- [Image]({{< relref "/navigate/image.md" >}})
34-
- [Kubernetes]({{< relref "/navigate/kubernetes/" >}})
35-
- [Verrazzano]({{< relref "/navigate/verrazzano/" >}})
34+
- [About the WKT UI Application]({{% relref "/concepts/" %}})
35+
- WKT UI [Prerequisites]({{% relref "/setup/prerequisites.md" %}}) and [Installation]({{% relref "/setup/install.md" %}})
36+
- [Navigate the WKT UI]({{% relref "/navigate/" %}})
37+
- [Model]({{% relref "/navigate/model.md" %}})
38+
- [Image]({{% relref "/navigate/image.md" %}})
39+
- [Kubernetes]({{% relref "/navigate/kubernetes/" %}})
3640

37-
For developer information, see [WebLogic Kubernetes Toolkit UI Project]({{< relref "/developer/" >}}).
41+
For developer information, see [WebLogic Kubernetes Toolkit UI Project]({{% relref "/developer/" %}}).
3842

3943
### Get Help
4044

@@ -50,4 +54,3 @@ For detailed documentation and access to WebLogic Toolkit-related projects, see:
5054
- [WebLogic Kubernetes Operator](https://oracle.github.io/weblogic-kubernetes-operator/)
5155
- [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/)
5256
- [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/)
53-
- [Verrazzano](https://verrazzano.io/latest/docs/)

documentation/2.0/content/concepts/_index.md

Lines changed: 50 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
+++
2-
title = "About the WKT UI Application"
3-
date = 2019-02-22T15:27:38-05:00
4-
weight = 1
5-
pre = "<b> </b>"
6-
+++
1+
---
2+
title: "About the WKT UI Application"
3+
weight: 1
4+
pre: "<b> </b>"
5+
---
76

87

98

@@ -14,7 +13,11 @@ pre = "<b> </b>"
1413
- [Environment Variables](#environment-variables)
1514
- [User Preferences](#user-preferences)
1615
- [Proxy Configuration](#proxy-configuration)
16+
- [GitHub API Credentials](#github-api-credentials)
17+
- [Linux Disable Hardware Acceleration](#linux-disable-hardware-acceleration)
18+
- [AppImage WKT Tools Configuration](#appimage-wkt-tools-configuration)
1719
- [Logging Configuration](#logging-configuration)
20+
- [Startup Internet Connectivity Test Configuration](#startup-internet-connectivity-test-configuration)
1821
- [WebLogic Kubernetes Toolkit UI Introduction Configuration](#weblogic-kubernetes-toolkit-ui-introduction-configuration)
1922
- [External Applications](#external-applications)
2023
- [Bundled WKT Applications](#bundled-wkt-applications)
@@ -78,20 +81,24 @@ examples are:
7881
On Windows and Linux platforms, this tends to be the user's environment that they have configured to be used when
7982
they log in. On macOS, native applications do not inherit the user's login environment. Instead, the application
8083
inherits the environment configured by the `launchd` daemon process. If you are running on macOS, then you should keep this in mind
81-
when the application doesn't behave as you expect. For more information, see [Project Settings]({{< relref "/navigate/project-settings.md" >}}).
84+
when the application doesn't behave as you expect. For more information, see [Project Settings]({{% relref "/navigate/project-settings.md" %}}).
8285
{{% /notice %}}
8386

8487
#### User Preferences
8588

86-
The `Preferences` menu lets you configure settings that affect the behavior of the WKT UI application for the user
89+
The `File` > `Preferences` menu lets you configure settings that affect the behavior of the WKT UI application for the user
8790
across all instances of the application on the machine. These user-visible settings include the following categories:
8891

8992
- [Proxy Configuration](#proxy-configuration)
93+
- [GitHub API Credentials](#github-api-credentials)
94+
- [Linux Disable Hardware Acceleration](#linux-disable-hardware-acceleration)
95+
- [AppImage WKT Tools Configuration](#appimage-wkt-tools-configuration)
9096
- [Logging Configuration](#logging-configuration)
91-
- WebLogic Kubernetes Toolkit UI [Introduction Configuration](#weblogic-kubernetes-toolkit-ui-introduction-configuration)
97+
- [Startup Internet Connectivity Test Configuration](#startup-internet-connectivity-test-configuration)
98+
- [WebLogic Kubernetes Toolkit UI Introduction Configuration](#weblogic-kubernetes-toolkit-ui-introduction-configuration)
9299

93100
Settings are also used to store internally used values that impact the appearance of the application. For example, the
94-
Window size is stored so that the application will open the window with your last known window size. The list of
101+
window size is stored so that the application will open the window with your last known window size. The list of
95102
such appearance-related settings will likely grow over time.
96103

97104
##### Proxy Configuration
@@ -101,18 +108,38 @@ must configure the proxy server settings to allow Internet access. Currently, t
101108
`github.com` to access release information and download new releases of the WKT tools and the UI itself. This connectivity
102109
is used in various places to determine default values for input data (for example, the default image tag to use for installing the
103110
WebLogic Kubernetes Operator) and providing updated features for the WKT tools bundled with the application, as
104-
well as updating the WKT UI application itself when a new release becomes available. Depending on the project configuration,
105-
the application may also require access to other sites, such as Docker Hub and other container registries, Helm chart
111+
well as updating the WKT UI application itself when a new release becomes available.
112+
113+
Depending on the project configuration,
114+
the application may also require access to other sites, such as Docker Hub (or other container registries), Helm chart
106115
download sites, and cloud-provider sites for authenticating to and accessing remote Kubernetes clusters.
107116

108-
To configure the proxy environment, use the `Preferences` menu to add or update the
117+
To configure the proxy environment, use the `File` > `Preferences` menu to add or update the
109118
following fields, as needed:
110119

111120
- `HTTPS Proxy URL` - The full URL to the proxy server (for example, http://my-proxy-server.mycompany.com:80).
112-
- `Bypass Proxy Hosts` - The comma-separated list of DNS or IP patterns that should not go through the proxy.
121+
- `Bypass Proxy Hosts` - A comma-separated list of DNS or IP patterns that should not go through the proxy.
113122
For example, a value of `.us.mycompany.com,.emea.mycompany.com,.apac.mycompany.com` will skip the proxy for any
114123
DNS name that ends in one of the three domain names.
115124

125+
##### GitHub API Credentials
126+
127+
GitHub rate limits anonymous API requests, which can negatively impact WKT UI functionality. You can bypass the anonymous API rate limits by creating a personal access token on your GitHub account and then providing the token value in the `GitHub Token` field. WKT UI will
128+
use this token for all API calls. Note that this token does not require
129+
any permissions on your own projects, it is simply attached to the API requests so that GitHub knows who is making them.
130+
131+
##### Linux Disable Hardware Acceleration
132+
133+
This section is only visible when running WKT UI on Linux. The `Disable Hardware Acceleration` switch allows you to
134+
tell Electron's embedded Chromium browser to disable hardware acceleration, in case hardware acceleration is causing
135+
problems.
136+
137+
##### AppImage WKT Tools Configuration
138+
139+
This section is only visible when running the Linux AppImage executable. Since WKT UI cannot update the executable,
140+
the `WKT Tools External Staging Directory` allows you to specify a location where updated versions of the embedded WKT
141+
tools should be stored. This directory must be writable by the user running WKT UI.
142+
116143
##### Logging Configuration
117144

118145
Using this section, you can configure the logging output level and control the log file directory. The defaults are:
@@ -122,6 +149,14 @@ Using this section, you can configure the logging output level and control the l
122149
- `Log File Directory` - The directory to which log files are written. The default is the user's temporary directory, as
123150
defined by the operating system.
124151

152+
##### Startup Internet Connectivity Test Configuration
153+
154+
WKT UI depends on Internet access for its functionality and, as such, tests connectivity to `https://github.com` on
155+
startup. The `Request Timeout Seconds` default value of 5 seconds should generally be enough but you can increase or
156+
decrease the value using this parameter. Oracle recommends that you not decrease this value below 5 seconds, since that
157+
may increase the number of false positive error screens that you see when starting the application and the Internet
158+
connectivity test times out.
159+
125160
##### WebLogic Kubernetes Toolkit UI Introduction Configuration
126161

127162
This setting lets you turn on or off the in-application introductory information being displayed at startup. `Show Introduction` is always
@@ -150,5 +185,5 @@ configure these external applications properly on the local machine on which the
150185
- WIT - Used to create a new image for your WebLogic Server domain. It is also used to inspect any
151186
custom base image that you might specify be used for creating the new image.
152187

153-
Use `Help` > `Check For Updates` periodically to make sure you are using the latest versions of these
188+
Use `Help` > `Check For WKT Tools Updates` periodically to make sure you are using the latest versions of these
154189
bundled tools.

documentation/2.0/content/developer/_index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
+++
2-
title = "Developer Guide"
3-
date = 2019-02-22T15:27:38-05:00
4-
weight = 4
5-
pre = "<b> </b>"
6-
+++
1+
---
2+
title: "Developer Guide"
3+
weight: 4
4+
pre: "<b> </b>"
5+
---
76

87
The WebLogic Kubernetes Toolkit UI is a desktop application designed to help WebLogic users move their applications to run in a Kubernetes environment.
98

@@ -31,7 +30,8 @@ The WebLogic Kubernetes Toolkit UI is a desktop application designed to help Web
3130
is, by default, case-insensitive!**
3231

3332
5. Clone the git repository on GitHub at [https://github.com/oracle/weblogic-toolkit-ui](https://github.com/oracle/weblogic-toolkit-ui).
34-
6. Open a command line in the `weblogic-toolkit-ui` directory and run `npm install` to download and install the JavaScript dependencies required by the project.
33+
6. Open a command line in the `weblogic-toolkit-ui` directory and run `npm install` to download and install the
34+
JavaScript dependencies required by the project.
3535
7. Open a command line in the `weblogic-toolkit-ui/electron` directory and run `npm run install-tools`.
3636
8. Open a command line in the `weblogic-toolkit-ui/webui` directory and run `npm start`.
3737
9. After the server from the previous step is fully running, open a command line in the `weblogic-toolkit-ui/electron` directory and run `npm start`.
Lines changed: 14 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,29 @@
1-
+++
2-
title = "Navigate the UI"
3-
date = 2019-02-22T15:27:38-05:00
4-
weight = 3
5-
pre = "<b> </b>"
6-
+++
1+
---
2+
title: "Navigate the UI"
3+
weight: 3
4+
pre: "<b> </b>"
5+
---
76

87
### Before you begin
98

10-
Make sure you have read [About the WKT UI Application]({{< relref "/concepts/" >}}).
9+
Make sure you have read [About the WKT UI Application]({{% relref "/concepts/" %}}).
1110

1211
### About the UI
1312

1413
To help you understand how to use the WKT UI, we will step you through it, section by section,
1514
describing the important decisions to make and fields to populate. The sections are listed in
16-
the left side navigation pane. Depending on the `Kubernetes Environment Target Type` field
17-
on the `Project Settings` page, you will see either the `Kubernetes` or `Verrazzano` section.
15+
the left side navigation pane.
1816

1917
The UI sections are:
2018

21-
- [Project Settings]({{< relref "/navigate/project-settings.md" >}})
22-
- [Model]({{< relref "/navigate/model.md" >}})
23-
- [Image]({{< relref "/navigate/image.md" >}})
19+
- [Project Settings]({{% relref "/navigate/project-settings.md" %}})
20+
- [Model]({{% relref "/navigate/model.md" %}})
21+
- [Image]({{% relref "/navigate/image.md" %}})
2422
- Kubernetes
25-
- [Client Configuration]({{< relref "/navigate/kubernetes/k8s-client-config.md" >}})
26-
- [WebLogic Operator]({{< relref "/navigate/kubernetes/k8s-wko.md" >}})
27-
- [WebLogic Domain]({{< relref "/navigate/kubernetes/k8s-weblogic-domain.md" >}})
28-
- [Ingress Controller]({{< relref "/navigate/kubernetes/k8s-ingress-controller.md" >}})
29-
- Verrazzano
30-
- [Client Configuration]({{< relref "/navigate/verrazzano/vz-client-config.md" >}})
31-
- [Installation]({{< relref "/navigate/verrazzano/vz-install.md" >}})
32-
- [Component]({{< relref "/navigate/verrazzano/vz-component.md" >}})
33-
- [Application]({{< relref "/navigate/verrazzano/vz-application.md" >}})
34-
23+
- [Client Configuration]({{% relref "/navigate/kubernetes/k8s-client-config.md" %}})
24+
- [WebLogic Operator]({{% relref "/navigate/kubernetes/k8s-wko.md" %}})
25+
- [WebLogic Domain]({{% relref "/navigate/kubernetes/k8s-weblogic-domain.md" %}})
26+
- [Ingress Controller]({{% relref "/navigate/kubernetes/k8s-ingress-controller.md" %}})
3527

3628
At the bottom of the page, the collapsed `Console` panel automatically appears and displays the `stdout` and `stderr`
3729
streams when running certain actions, such as `Prepare Model`.

0 commit comments

Comments
 (0)