Skip to content

Commit 5c39771

Browse files
add new field info for 1.4 (#177)
* add new field info for 1.4 * incorporate edits from Robert
1 parent 63a9a6d commit 5c39771

File tree

271 files changed

+12842
-0
lines changed

Some content is hidden

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

271 files changed

+12842
-0
lines changed

documentation/staging/1.4/.gitkeep

Whitespace-only changes.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "{{ replace .Name "-" " " | title }}"
3+
date: {{ .Date }}
4+
draft: false
5+
---
6+

documentation/staging/1.4/config.toml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# analytics
2+
googleAnalytics = "UA-129126578-2"
3+
4+
baseURL = '/weblogic-toolikit-ui'
5+
languageCode = 'en-us'
6+
title = 'WebLogic Kubernetes Toolkit UI'
7+
8+
# Change the default theme to be use when building the site with Hugo
9+
theme = 'learn'
10+
11+
publishDir = "docs"
12+
13+
# For search functionality
14+
[outputs]
15+
home = [ "HTML", "RSS", "JSON"]
16+
17+
[params]
18+
# disable the copy to clipboard links
19+
disableInlineCopyToClipBoard = true
20+
custom_css = [ "css/theme-wktui.css" ]
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
## WebLogic Kubernetes Toolkit UI Documentation
2+
3+
The WebLogic Kubernetes Toolkit (WKT) is a collection of open source tools that help you provision WebLogic-based
4+
applications to run in Linux containers on a Kubernetes cluster. WKT includes the following tools:
5+
6+
- [WebLogic Deploy Tooling (WDT)](https://github.com/oracle/weblogic-deploy-tooling) - A set of single-purpose,
7+
lifecycle tools that operate off of a single metadata model representation of a WebLogic domain.
8+
- [WebLogic Image Tool (WIT)](https://github.com/oracle/weblogic-image-tool) - A tool for creating Linux container
9+
images for running WebLogic domains.
10+
- [WebLogic Kubernetes Operator (WKO)](https://github.com/oracle/weblogic-kubernetes-operator) - A Kubernetes operator
11+
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.
14+
15+
The WKT UI provides a graphical user interface that wraps the WKT tools, Docker, Helm, and the Kubernetes client
16+
(`kubectl`) and helps guide you through the process of creating and modifying a model of your WebLogic domain, creating
17+
a Linux container image to use to run the domain, and setting up and deploying the software and configuration
18+
necessary to deploy and access the domain in your Kubernetes cluster.
19+
20+
### Current release
21+
22+
WebLogic Kubernetes Toolkit UI version and release information can be found [here](https://github.com/oracle/weblogic-toolkit-ui/releases).
23+
24+
### About the Documentation
25+
For detailed user information, read the following:
26+
27+
- [About the WKT UI Application]({{< relref "/concepts/_index.md" >}})
28+
- WebLogic Kubernetes Toolkit UI [Prerequisites]({{< relref "/setup/prerequisites.md" >}}) and [Installation]({{< relref "/setup/install.md" >}})
29+
- [Navigate the WKT UI]({{< relref "/navigate/_index.md" >}})
30+
- [Model]({{< relref "/navigate/model.md" >}})
31+
- [Image]({{< relref "/navigate/image.md" >}})
32+
- [Kubernetes]({{< relref "/navigate/kubernetes/_index.md" >}})
33+
- [Verrazzano]({{< relref "/navigate/verrazzano/_index.md" >}})
34+
35+
For developer information, see [WebLogic Kubernetes Toolkit UI Project]({{< relref "/developer/_index.md" >}}).
36+
37+
### Get Help
38+
39+
We have a closely monitored public Slack channel where you can get in touch with us to ask questions about using the
40+
WebLogic Toolkit UI or give us feedback or suggestions about what features and improvements you would like to see.
41+
We would love to hear from you.
42+
43+
To join our public channel, please visit this [site](https://weblogic-slack-inviter.herokuapp.com/) to get an invitation. The invitation email will include details of how to access our Slack workspace. After you are logged in, please come to `#weblogic-kubernetes-toolkit` and say, “hello!”
44+
45+
### Related Projects
46+
For detailed documentation and access to WebLogic Toolkit-related projects, see:
47+
48+
- [WebLogic Kubernetes Operator](https://oracle.github.io/weblogic-kubernetes-operator/)
49+
- [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/)
50+
- [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/)
51+
- [Verrazzano](https://verrazzano.io/latest/docs/)
Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
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+
+++
7+
8+
9+
10+
### Contents
11+
12+
- [WKT Project File](#wkt-project-file)
13+
- [Settings Outside the WKT Project File](#settings-outside-the-wkt-project-file)
14+
- [Environment Variables](#environment-variables)
15+
- [User Preferences](#user-preferences)
16+
- [Proxy Configuration](#proxy-configuration)
17+
- [Logging Configuration](#logging-configuration)
18+
- [WebLogic Kubernetes Toolkit UI Introduction Configuration](#weblogic-kubernetes-toolkit-ui-introduction-configuration)
19+
- [External Applications](#external-applications)
20+
- [Bundled WKT Applications](#bundled-wkt-applications)
21+
22+
23+
24+
Before giving you the whirlwind tour of the WKT UI application, it is important to know that the application is a native,
25+
desktop application. It uses native operating system features, such as:
26+
27+
- Native menus - Some of the application's functionality is available _only_ by using the menus.
28+
- Registering file extensions - The application installer registers the `.wktproj` extension and associates itself
29+
with that extension. For example, this lets you double-click on the file in the native file browser and
30+
have the application start and open the selected project.
31+
- Recent files integration - As you work with `.wktproj` files, the application adds those files to the OS-maintained
32+
list of recently used files. This causes these files to show up in OS-specific locations to provide shortcuts for
33+
opening the file with the application. For example, on macOS, right-clicking on the application icon in the dock will
34+
display the recently used `.wktproj` files and selecting one will open an application window and load the contents
35+
of the `.wktproj` file.
36+
37+
### WKT Project File
38+
What is a `.wktproj` file? Simply put, it is the application's equivalent of an Integrated Development Environment
39+
(IDE) project file. It stores:
40+
41+
- Metadata about the UI project.
42+
- Pointers to WDT model-related files used by the project.
43+
- Form field data that you enter into the application.
44+
45+
There are two ways to create a new project:
46+
- Explicitly - Use `File` > `New Project` and select the file location and name.
47+
- Implicitly - Use the application to start working. After you trigger an action that needs a project file, you are
48+
prompted to select the file location and name.
49+
50+
_Note that the file extension for project files must be `.wktproj`. Otherwise, the application will not recognize the
51+
file as a project and will not allow it to be opened as a project file._
52+
53+
The WKT UI application uses a one project per window paradigm and most everything you do in the window is
54+
affected by the project data, either stored directly in the project file or in the WDT model-related files referenced
55+
by the project. However, there are a few exceptions that are covered in [Settings Outside the WKT Project File](#settings-outside-the-wkt-project-file).
56+
57+
### Settings Outside the WKT Project File
58+
59+
Multiple factors influence the behavior of the WKT UI application in a particular environment. Other than the WKT Project file,
60+
those include:
61+
62+
- [Environment Variables](#environment-variables) - The application uses the environment it inherits when it is started.
63+
- [User Preferences](#user-preferences) - The application's user preferences file stores shared, user-level settings that
64+
transcend project boundaries.
65+
- [External Applications](#external-applications) - The application or its components depend on an application being available and properly configured.
66+
- [Bundled WKT Applications](#bundled-wkt-applications) - The application bundles its own copies of WebLogic Deploy Tooling and WebLogic Image Tool.
67+
68+
#### Environment Variables
69+
Some of the application's behavior is influenced by environment variables it inherits when it is started. Environment
70+
variables affect the behavior of the WKT UI application when computing default values for application form fields. Some
71+
examples are:
72+
73+
- `PATH` - Used to locate executables like `docker`, `helm`, and `kubectl`.
74+
- `JAVA_HOME` - Used as one way to find the directory where the Java Development Kit (JDK) is installed.
75+
- `ORACLE_HOME` and `MW_HOME` - Used to find the Oracle Fusion Middleware installation directory.
76+
77+
{{% notice note %}}
78+
On Windows and Linux platforms, this tends to be the user's environment that they have configured to be used when
79+
they log in. On macOS, native applications do not inherit the user's login environment. Instead, the application
80+
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" >}}).
82+
{{% /notice %}}
83+
84+
#### User Preferences
85+
86+
The `Preferences` menu lets you configure settings that affect the behavior of the WKT UI application for the user
87+
across all instances of the application on the machine. These user-visible settings include the following categories:
88+
89+
- [Proxy Configuration](#proxy-configuration)
90+
- [Logging Configuration](#logging-configuration)
91+
- WebLogic Kubernetes Toolkit UI [Introduction Configuration](#weblogic-kubernetes-toolkit-ui-introduction-configuration)
92+
93+
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
95+
such appearance-related settings will likely grow over time.
96+
97+
##### Proxy Configuration
98+
99+
If the WKT UI application is to be run from an environment where a proxy server is required to access the Internet, then you
100+
must configure the proxy server settings to allow Internet access. Currently, the UI depends on access to
101+
`github.com` to access release information and download new releases of the WKT tools and the UI itself. This connectivity
102+
is used in various places to determine default values for input data (for example, the default image tag to use for installing the
103+
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
106+
download sites, and cloud-provider sites for authenticating to and accessing remote Kubernetes clusters.
107+
108+
To configure the proxy environment, use the `Preferences` menu to add or update the
109+
following fields, as needed:
110+
111+
- `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.
113+
For example, a value of `.us.mycompany.com,.emea.mycompany.com,.apac.mycompany.com` will skip the proxy for any
114+
DNS name that ends in one of the three domain names.
115+
116+
##### Logging Configuration
117+
118+
Using this section, you can configure the logging output level and control the log file directory. The defaults are:
119+
120+
- `File Transport Log Level` - The logging level below which log messages will be discarded. For example, `Debug` messages
121+
will be discarded if the level is set to `Info`. The default value is `Info`.
122+
- `Log File Directory` - The directory to which log files are written. The default is the user's temporary directory, as
123+
defined by the operating system.
124+
125+
##### WebLogic Kubernetes Toolkit UI Introduction Configuration
126+
127+
This setting lets you turn on or off the in-application introductory information being displayed at startup. `Show Introduction` is always
128+
accessible from the `Help` menu.
129+
130+
#### External Applications
131+
132+
The WKT UI application depends on several external applications for its functionality. As such, it is important to install and
133+
configure these external applications properly on the local machine on which the application is running.
134+
135+
- `docker` (or `podman`) - Used to create new images and inspect the contents of
136+
custom base images. The WebLogic Image Tool depends on `docker` (or `podman`) for this functionality. `docker`
137+
(or `podman`) is also used to log in to and interact with image registries.
138+
- `kubectl` - Used to get, create, and update configuration objects in your Kubernetes cluster.
139+
It is critical that the `kubectl` configuration file is properly set up to allow `kubectl` to authenticate to the cluster.
140+
- `helm` - Used to install the WebLogic Kubernetes Operator and ingress controllers.
141+
- `openssl` - Used to generate X.509 TLS certificates, should you ask the application to
142+
generate one for your ingress route(s), only if you ask the application to generate it for you.
143+
144+
#### Bundled WKT Applications
145+
146+
[WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) (WDT) and [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) (WIT) are bundled with the WKT UI application. These tools are:
147+
148+
- WDT - Used to support discovering a model from an existing domain, prepare the model for a
149+
particular Kubernetes target type, and is used by the WebLogic Image Tool when creating the domain inside the image.
150+
- WIT - Used to create a new image for your WebLogic Server domain. It is also used to inspect any
151+
custom base image that you might specify be used for creating the new image.
152+
153+
Use `Help` > `Check For Updates` periodically to make sure you are using the latest versions of these
154+
bundled tools.
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
+++
2+
title = "Developer Guide"
3+
date = 2019-02-22T15:27:38-05:00
4+
weight = 4
5+
pre = "<b> </b>"
6+
+++
7+
8+
The WebLogic Kubernetes Toolkit UI is a desktop application designed to help WebLogic users move their applications to run in a Kubernetes environment.
9+
10+
### Setting up your development environment
11+
1. Download and install the latest LTS version of `node.js` from [https://nodejs.org/en/download/](https://nodejs.org/en/download/).
12+
2. If you rely on a proxy server to reach the Internet, set these five environment variables to configure the proxy correctly:
13+
```
14+
ELECTRON_GET_USE_PROXY=true
15+
GLOBAL_AGENT_HTTPS_PROXY=<proxy-url>
16+
WKTUI_DEV_PROXY=<proxy-url>
17+
HTTPS_PROXY=<proxy-url>
18+
NO_PROXY=<list-of-no-proxy-hosts>
19+
```
20+
3. Open a command line and run the following command to update the version of `npm` to the latest:
21+
```bash
22+
sudo npm install --global npm
23+
```
24+
4. Set up your global git configuration by running the following commands:
25+
```bash
26+
git config --global user.name "<your real name>"
27+
git config --global user.email "<your-oracle-email-address>"
28+
git config --global core.ignoreCase false
29+
```
30+
**This last command is critical if you are developing on either Windows or macOS. Yes, the macOS file system
31+
is, by default, case-insensitive!**
32+
33+
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.
35+
7. Open a command line in the `weblogic-toolkit-ui/electron` directory and run `npm run install-tools`.
36+
8. Open a command line in the `weblogic-toolkit-ui/webui` directory and run `npm start`.
37+
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`.
38+
39+
### Building a Windows or macOS installer
40+
0. Set up your development environment and verify that the application is working properly from it.
41+
1. Open a command line in the `weblogic-toolkit-ui/electron` directory and run `npm run build`.
42+
2. Find the executable and installer(s) in the `weblogic-toolkit-ui/dist` directory.
43+
44+
### Building a Linux installer
45+
0. Set up your development environment and verify that the application is working properly from it.
46+
1. Open a command line in the `weblogic-toolkit-ui/webui` directory and run `npm run build:release`.
47+
2. From the command line in the `weblogic-toolkit-ui/scripts` directory, run `./devBuildLinuxInstallers.sh`.
48+
3. Find the executable and installer(s) in the `weblogic-toolkit-ui/dist` directory.
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
+++
2+
title = "Navigate the UI"
3+
date = 2019-02-22T15:27:38-05:00
4+
weight = 3
5+
pre = "<b> </b>"
6+
+++
7+
8+
### Before you begin
9+
10+
Make sure you have read [About the WKT UI Application]({{< relref "/concepts/_index.md" >}}).
11+
12+
### About the UI
13+
14+
To help you understand how to use the WKT UI, we will step you through it, section by section,
15+
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.
18+
19+
The UI sections are:
20+
21+
- [Project Settings]({{< relref "/navigate/project-settings.md" >}})
22+
- [Model]({{< relref "/navigate/model.md" >}})
23+
- [Image]({{< relref "/navigate/image.md" >}})
24+
- [Kubernetes]({{< relref "/navigate/kubernetes/_index.md" >}})
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]({{< relref "/navigate/verrazzano/_index.md" >}})
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+
35+
36+
At the bottom of the page, the collapsed `Console` panel automatically appears and displays the `stdout` and `stderr`
37+
streams when running certain actions, such as `Prepare Model`.

0 commit comments

Comments
 (0)