Skip to content

Commit f14e5f8

Browse files
Merge pull request #56 from oracle/doc-updates
doc new button actions
2 parents b860456 + e3b0599 commit f14e5f8

File tree

5 files changed

+48
-14
lines changed

5 files changed

+48
-14
lines changed

documentation/staging/content/navigate/image.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -194,8 +194,8 @@ the script itself. This change is left as an exercise for you because different
194194
existing standards for securely handling such credentials.
195195

196196
### Create Images
197-
The `Create Primary Image` and `Create Auxiliary Image` actions invoke the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) to
198-
create a new container image for running a WebLogic domain in a Kubernetes environment. You can access these actions using
197+
`Create Primary Image` and `Create Auxiliary Image` invoke the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) to
198+
create a new container image for running a WebLogic domain in a Kubernetes environment. You access these actions using
199199
the `Create Primary Image` or `Create Auxiliary Image` button on the `Image` page or from the `Go` menu.
200200

201201
At a high level, the action performs the following steps:
@@ -208,8 +208,8 @@ At a high level, the action performs the following steps:
208208
[Create](https://oracle.github.io/weblogic-image-tool/userguide/tools/create-image/) command.
209209

210210
### Push Images
211-
The `Push Primary Image` and `Push Auxiliary Image` actions use the specified Image Builder program to upload (that is, push) the newly-built image
212-
to the image registry specified by its image tag. You can access these actions by using the `Push Primary Image` or `Push Auxiliary Image` button on the `Image`
211+
`Push Primary Image` and `Push Auxiliary Image` use the specified Image Builder program to upload (that is, push) the newly-built image
212+
to the image registry specified by its image tag. You access these actions by using the `Push Primary Image` or `Push Auxiliary Image` button on the `Image`
213213
page or from the `Go` menu.
214214

215215
At a high level, the action performs the following steps:

documentation/staging/content/navigate/kubernetes/k8s-ingress-controller.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ description: "Install and configure an ingress controller."
1515
- [Code View](#code-view)
1616
- [Install Ingress Controller](#install-ingress-controller)
1717
- [Update Ingress Routes](#update-ingress-routes)
18+
- [Uninstall Ingress Controller](#uninstall-ingress-controller)
1819

1920
### Ingress Controller
2021
This section supports two distinct functions related to an ingress controller. First, it supports installing an ingress
@@ -105,10 +106,15 @@ existing standards for securely handling such credentials.
105106

106107
### Install Ingress Controller
107108
`Install Ingress Controller` creates any namespace and secret specified and runs the ingress controller's Helm
108-
chart to install the ingress controller. You can access it by using the `Install Ingress Controller` button on the
109-
`Ingress Controller` page or `Go` > `Install Ingress Controller`.
109+
chart to install the ingress controller. You access this action by using the `Install Ingress Controller` button on the
110+
`Ingress Controller` page or the `Go` > `Install Ingress Controller` menu item.
110111

111112
### Update Ingress Routes
112-
`Update Ingress Routes` creates the TLS secret, if needed, and adds or updates the specified ingress routes. You can access it
113+
`Update Ingress Routes` creates the TLS secret, if needed, and adds or updates the specified ingress routes. You access this action
113114
by using the `Update Ingress Routes` button on the `Ingress Controller` page or
114-
`Go` > `Update Ingress Routes to Domain`.
115+
the `Go` > `Update Ingress Routes to Domain` menu item.
116+
117+
### Uninstall Ingress Controller
118+
`Uninstall Ingress Controller` uses the `helm uninstall` command to remove all the ingress resources and uninstall the ingress controller.
119+
You access this action by using the `Uninstall Ingress Controller` button on the
120+
`Ingress Controller` page or the `Go` > `Uninstall Ingress Controller` menu item.

documentation/staging/content/navigate/kubernetes/k8s-weblogic-domain.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ description: "Create and deploy the Kubernetes custom resource for the WebLogic
2121
- [Prepare Model](#prepare-model)
2222
- [Deploy Domain](#deploy-domain)
2323
- [Get Domain Status](#get-domain-status)
24+
- [Undeploy Domain](#undeploy-domain)
2425

2526
### WebLogic Domain
2627
The `WebLogic Domain` section provides support for creating and deploying the Kubernetes custom resource for the WebLogic domain as
@@ -230,8 +231,8 @@ surfaced here because the `Clusters` pane of the `Design View` is populated only
230231

231232
### Deploy Domain
232233
`Deploy Domain` creates the Domain custom resource object and any of its dependent objects (for example,
233-
namespace, secrets, ConfigMap) in Kubernetes. You can access it by using the `Deploy Domain` button on the
234-
`WebLogic Domain` page or `Go` > `Deploy WebLogic Domain to Kubernetes`. As previously
234+
namespace, secrets, ConfigMap) in Kubernetes. You access this action by using the `Deploy Domain` button on the
235+
`WebLogic Domain` page or the `Go` > `Deploy WebLogic Domain to Kubernetes` menu item. As previously
235236
mentioned, this action also updates the operator configuration, if needed, and reruns the operator Helm chart to ensure
236237
that the new namespace is manageable by the WebLogic Kubernetes Operator configured for this project.
237238

@@ -244,3 +245,8 @@ provides the current status of the last `Deploy Domain` action.
244245
To view the current status of the last domain deployment, use the `Get Domain Status` button or the
245246
`Go` > `Get WebLogic Domain Status`. This action retrieves and displays the domain deployment
246247
status, as provided by the WebLogic Kubernetes Operator.
248+
249+
### Undeploy Domain
250+
`Undeploy Domain` removes the Kubernetes custom resource for the WebLogic domain and its dependent objects in Kubernetes.
251+
You access this action by using the `Undeploy Domain` button on the
252+
`WebLogic Domain` page or the `Go` > `Undeploy WebLogic Domain to Kubernetes` menu item.

documentation/staging/content/navigate/kubernetes/k8s-wko.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ description: "Install the WebLogic Kubernetes Operator in the target Kubernetes
2020
- [Java Logging](#java-logging)
2121
- [Code View](#code-view)
2222
- [Install Operator](#install-operator)
23+
- [Update Operator](#update-operator)
24+
- [Uninstall Operator](#uninstall-operator)
2325

2426
### WebLogic Kubernetes Operator
2527
This section provides support for installing the WebLogic Kubernetes Operator (the "operator") in the target Kubernetes cluster.
@@ -164,9 +166,9 @@ the script itself. This change is left as an exercise for you because different
164166
existing standards for securely handling such credentials.
165167

166168
### Install Operator
167-
The `Install Operator` action installs the WebLogic Kubernetes Operator in the target Kubernetes cluster.
168-
You can access it by using the `Install Operator` button on the
169-
`WebLogic Operator` page or `Go` > `Install WebLogic Kubernetes Operator`.
169+
`Install Operator` installs the WebLogic Kubernetes Operator in the target Kubernetes cluster.
170+
You access this action by using the `Install Operator` button on the
171+
`WebLogic Operator` page or the `Go` > `Install WebLogic Kubernetes Operator` menu item.
170172

171173
At a high level, `Install Operator` performs the following steps:
172174

@@ -177,3 +179,23 @@ At a high level, `Install Operator` performs the following steps:
177179
5. Creates the operator image pull secret, if needed.
178180
6. Adds the latest operator Helm chart to the local Helm repository.
179181
7. Runs Helm to install the operator using the specified configuration.
182+
183+
### Update Operator
184+
185+
`Update Operator` updates the settings on a running WebLogic Kubernetes Operator by using the `helm upgrade` command.
186+
You access this action by using the `Update Operator` button on the
187+
`WebLogic Operator` page or the `Go` > `Update WebLogic Kubernetes Operator` menu item.
188+
189+
`Update Operator` applies all the changes to the operator that you have specified on the page. For example,
190+
you can change the operator image version, the domain namespace selection strategy, Java logging level,
191+
or the value of any field in the WebLogic Kubernetes Operator section.
192+
193+
### Uninstall Operator
194+
195+
`Uninstall Operator` uses the `helm uninstall` command to remove the WebLogic Kubernetes Operator and its associated
196+
resources from the Kubernetes cluster. You access this action by using the `Uninstall Operator` button on the
197+
`WebLogic Operator` page or the `Go` > `Uninstall WebLogic Kubernetes Operator` menu item.
198+
199+
Note that if you uninstall an operator, then any domains that it is managing will continue running; however,
200+
any changes to a domain resource that was managed by the operator will not be detected or automatically handled,
201+
and, if you want to clean up such a domain, then you will need to manually delete all of the domain's resources (domain, pods, services, and such).

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ pre = "<b> </b>"
1616

1717
- 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).
1818

19-
- On Linux when running the application that was installed using the `rpm` or `deb` installers, the following error messages will appear in the log. These are expected and can safely be ignored. The errors are due to the fact that the electron-updater package being used to perform application updates only supports upgrading Linux applications when run using an `AppImage` binary.
19+
- On Linux, when running the application that was installed using the `rpm` or `deb` installers, the following error messages will appear in the log. These are expected and can safely be ignored. The errors are due to the fact that the electron-updater package being used to perform application updates supports only upgrading Linux applications when run using an `AppImage` binary.
2020
```
2121
info: Checking for update
2222
error: Error: Error: ENOENT: no such file or directory, open '/opt/WebLogic Kubernetes Toolkit UI/resources/app-update.yml'

0 commit comments

Comments
 (0)