Skip to content

Commit b8ba0a3

Browse files
doc updates (#78)
1 parent 568ed2c commit b8ba0a3

File tree

8 files changed

+38
-26
lines changed

8 files changed

+38
-26
lines changed

documentation/staging/content/concepts/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ desktop application. It uses native operating system features, such as:
3030
have the application start and open the selected project.
3131
- Recent files integration - As you work with `.wktproj` files, the application adds those files to the OS-maintained
3232
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
33+
opening the file with the application. For example, on macOS, right-clicking on the application icon in the dock will
3434
display the recently used `.wktproj` files and selecting one will open an application window and load the contents
3535
of the `.wktproj` file.
3636

@@ -76,8 +76,8 @@ examples are:
7676

7777
{{% notice note %}}
7878
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
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
8181
when the application doesn't behave as you expect.
8282
{{% /notice %}}
8383

documentation/staging/content/developer/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The WebLogic Kubernetes Toolkit UI is a desktop application designed to help Web
2727
git config --global user.email "<your-oracle-email-address>"
2828
git config --global core.ignoreCase false
2929
```
30-
**This last command is critical if you are developing on either Windows or MacOS. Yes, the MacOS file system
30+
**This last command is critical if you are developing on either Windows or macOS. Yes, the macOS file system
3131
is, by default, case-insensitive!**
3232

3333
5. Clone the git repository on GitHub at [https://github.com/oracle/weblogic-toolkit-ui](https://github.com/oracle/weblogic-toolkit-ui).
@@ -36,7 +36,7 @@ The WebLogic Kubernetes Toolkit UI is a desktop application designed to help Web
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`.
3838

39-
### Building a Windows or MacOS installer
39+
### Building a Windows or macOS installer
4040
0. Set up your development environment and verify that the application is working properly from it.
4141
1. Open a command line in the `weblogic-toolkit-ui/electron` directory and run `npm run build`.
4242
2. Find the executable and installer(s) in the `weblogic-toolkit-ui/dist` directory.

documentation/staging/content/navigate/image.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,8 @@ latest capabilities, many of which are exposed by this application. As such, us
115115
recommended.
116116

117117
{{% notice note %}} For "Model in Image" or "Domain in Image" [domain locations]({{< relref "/navigate/project-settings#choosing-a-domain-location" >}}),
118-
when building your primary or auxiliary image, we highly recommend using WDT 2.0 to take advantage of enhanced capabilities that reduce the chance of deploy-time errors created due to a bad model.
118+
when building your primary or auxiliary image, Oracle strongly recommends using [WDT 2.0](https://github.com/oracle/weblogic-deploy-tooling/releases).
119+
Certain WKT UI actions, such as `Prepare Model`, may rewrite the model into a format that earlier WDT versions cannot parse.
119120
{{% /notice %}}
120121

121122

documentation/staging/content/navigate/kubernetes/k8s-client-config.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -68,18 +68,6 @@ To learn more about this feature, consult the documentation available at:
6868
https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins.
6969
```
7070

71-
When running the application on Windows or Linux, add the appropriate directory to the `PATH` environment variable and make sure to
72-
run the application with that environment. On MacOS, things are a bit more complicated.
73-
74-
When running the WKT UI application on MacOS, the application inherits the environment of a daemon process called `launchd` instead
75-
of your environment. By default, the `launchd` environment contains only a few core directories on the `PATH`
76-
(that is, `/usr/bin`, `/bin`, `/usr/sbin`, and `/sbin`). This will cause `kubectl` invocations requiring access to one of
77-
the cloud providers' command-line tooling to fail if the tool is not found in one of those locations. While it is
78-
possible for an administrative user to change the environment that `launchd` uses to address this issue, the application
79-
provides the `Extra Kubernetes Client Path Directories` field to explicitly add the directory where the cloud providers'
80-
command-line tooling is installed, to the `PATH` that the application uses to invoke `kubectl`. Note that this field
81-
is only visible when running the application on MacOS.
82-
8371
#### Verify Connectivity
8472
To verify the application configuration for connecting to the specified Kubernetes cluster,
8573
use the `Verify Connectivity` button on the `Client Configuration` page or

documentation/staging/content/navigate/model.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ weight: 2
1313
- [Model Editor](#model-editor)
1414
- [Variables Editor](#variables-editor)
1515
- [Archive Editor](#archive-editor)
16+
- [Validate Model](#validate-model)
1617
- [Prepare Model](#prepare-model)
1718

1819

@@ -133,6 +134,12 @@ appDeployments:
133134
To remove content from the archive file, select the content to remove in the archive editor pane and click the minus (`-`)
134135
button in the archive editor title bar. _Don't forget to remove any reference to this content from the model file._
135136

137+
#### Validate Model
138+
`Validate Model` invokes the WDT [Validate Model Tool](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/validate/),
139+
which validates that the model and its related artifacts are well-formed and provides help on the valid attributes and subfolders
140+
for a particular model location. This action is available by using the `Validate Model` button on the `Model` page and by selecting
141+
`Go` > `Validate Model Files`.
142+
136143
#### Prepare Model
137144
`Prepare Model` invokes the WDT [Prepare Model Tool](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/prepare/)
138145
to modify the model to work in a Kubernetes cluster with WebLogic Kubernetes Operator or Verrazzano installed. This

documentation/staging/content/navigate/project-settings.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,22 @@ input for the project on:
1414
- [JDK and WebLogic Server Installation Directories](#choosing-the-java-and-oracle-installation-directories)
1515
- [Image Build Tool Type and Executable Location](#choosing-the-image-build-tool)
1616

17+
When running the WKT UI application on Windows or Linux, the application inherits its environment from the user. For example,
18+
adding a directory to the PATH used by the application is just a matter of changing your
19+
PATH environment variable and restarting the application. On macOS, things are a bit more complicated.
20+
21+
When running the application on macOS, the application inherits the environment of a daemon process called `launchd` instead
22+
of your environment. By default, the `launchd` environment contains only a few core directories on the `PATH`
23+
(that is, `/usr/bin`, `/bin`, `/usr/sbin`, and `/sbin`). This will cause `kubectl` invocations requiring access to one of
24+
the cloud providers' command-line tooling to fail if the tool is not found in one of those locations. While it is
25+
possible for an administrative user to change the environment that `launchd` uses to address this issue, the WKT UI application
26+
provides the `Extra Path Directories` field to explicitly add the directory where the cloud providers'
27+
command-line tooling is installed, to the `PATH` that the application uses to invoke `kubectl`. Also, use the
28+
`Extra Environment Variable Names/Extra Environment Variable Values` fields to define extra environment variables as
29+
needed. Note that this extra environment configuration is used _only_ when invoking Docker/Podman, kubectl, and Helm.
30+
This section is visible only when running the application on macOS.
31+
32+
1733
#### Choosing a Credential Storage Scheme
1834
The WKT UI application can securely store credentials for your project or not store them at all. The three choices
1935
are:
@@ -22,7 +38,7 @@ are:
2238
- Store Encrypted Credentials in the WKT Project File
2339
- Not Store Credentials
2440

25-
If you choose `Store in Native OS Credential Store`, then you will be using the Windows Credential Manager, the MacOS Keychain,
41+
If you choose `Store in Native OS Credential Store`, then you will be using the Windows Credential Manager, the macOS Keychain,
2642
or the Linux `libsecret` library's credential store. These credential stores offer a well-known, secure mechanism for
2743
storing credentials that most users already understand. The only downside to this scheme is that the credentials are
2844
stored only on the local machine. Anyone trying to share their project with others users will have to have the other users
@@ -32,7 +48,7 @@ re-enter the credentials so that they get saved to their local machine's credent
3248
The WKT UI application can require storing a dozen or more credentials, depending on your WebLogic Server
3349
domain configuration. Upon first access by the WKT UI to load credentials from the credential store, the OS will prompt
3450
whether you want to allow the application access to each credential, prompting you once for each credential. This
35-
can get annoying, but on some platforms (for example, MacOS), you have the option of telling the OS to always allow access to
51+
can get annoying, but on some platforms (for example, macOS), you have the option of telling the OS to always allow access to
3652
the credential by the WKT UI application.
3753
{{% /notice %}}
3854

documentation/staging/content/release notes/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,15 @@ pre = "<b> </b>"
99

1010
- For "Model in Image" domains, added the ability to configure, push, and use an auxiliary image.
1111
- Added these actions:
12+
- Validate WDT model files
13+
- Create and push an auxiliary image
1214
- Update and uninstall the WebLogic Kubernetes Operator
13-
- Uninstall the ingress controller
1415
- Undeploy the WebLogic domain
16+
- Uninstall the ingress controller
1517

1618
### Known Issues
1719

18-
- When running the WKT UI application on Windows, the image builder tool (docker or podman) also must be directly executable in Windows. For example, there is currently no support for running the WKT UI application in Windows and running podman under the Windows Subsystem for Linux (WSL2). However, running Docker Desktop for Windows with a WSL2 backend _is_ fully supported because the `docker` command is executable directly in Windows (without having to call WSL2). If you need to use podman on Windows, then refer to the podman blog entries at https://podman.io/blogs/2021/09/06/podman-on-macs.html and https://podman.io/blogs/2020/09/02/running_windows_or_mac.html for more information about downloading, installing, and configuring the Windows Remote Client.
20+
- When running the WKT UI application on Windows, the image builder tool (Docker or Podman) also must be directly executable in Windows. For example, there is currently no support for running the WKT UI application in Windows and running Podman under the Windows Subsystem for Linux (WSL2). However, running Docker Desktop for Windows with a WSL2 backend _is_ fully supported because the `docker` command is executable directly in Windows (without having to call WSL2). If you need to use Podman on Windows, then refer to the Podman blog entries at https://podman.io/blogs/2021/09/06/podman-on-macs.html and https://podman.io/blogs/2020/09/02/running_windows_or_mac.html for more information about downloading, installing, and configuring the Windows Remote Client.
1921

2022
- On Linux, the application depends on libGL being installed. libGL is not currently listed in the dependencies list for the `rpm` (or `deb`) installers. Therefore, you will need to install libGL using your package manager. For example:
2123
```
@@ -25,5 +27,3 @@ pre = "<b> </b>"
2527
- When trying to run the application on a Linux machine and display it on a Windows machine, do not use the Xming X server. There appears to be a bug (presumably with their OpenGL support) that prevents applications using Electron 13.x or later from working (for example, Microsoft VS Code doesn't work either).
2628

2729
- The application is limited to working with archive files whose size is less than 2 GB.
28-
29-
- On MacOS, after editing a model in the Model Code View's model editor pane, you must click outside the editor pane prior to using the Menu to save or perform other actions that need the latest model content. This is due to Electron bug [31915](https://github.com/electron/electron/issues/31915) that fails to generate the proper events when the Menu is selected on MacOS.

documentation/staging/content/setup/install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Alternatively, you can download the `AppImage` file, copy it to your local file
2828
2929
- Use your file manager, right click on the file, edit the properties, and change the permissions to make it executable.
3030
31-
If you download and run the `AppImage` file, you get the added benefits of 1.) Not requiring an installation or root access and 2.) Being able to participate in the auto-update functionality, like MacOS and Windows.
31+
If you download and run the `AppImage` file, you get the added benefits of 1.) Not requiring an installation or root access and 2.) Being able to participate in the auto-update functionality, like macOS and Windows.
3232
3333
#### Helpful Hints
3434
@@ -66,7 +66,7 @@ Upon application startup, if a more recent version exists, an Application Update
6666
- `Install Now`
6767
- `Install on Exit`
6868
- Downloads the application and installs it after you exit.
69-
- Not available on MacOS.
69+
- Not available on macOS.
7070
- `Ignore Update`
7171
7272
At any time, you can check for application updates using `Help > Check for WKT UI Updates`.

0 commit comments

Comments
 (0)