Skip to content

Commit 6da61f8

Browse files
first pass at most of the VZ content (#157)
1 parent d6deb0c commit 6da61f8

File tree

9 files changed

+68
-148
lines changed

9 files changed

+68
-148
lines changed

documentation/staging/1.3/content/navigate/image.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The `Image` section helps you build container images for deploying WebLogic-base
2323
in a Kubernetes environment using the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/).
2424

2525
### Design View
26-
The `Design View` helps you specify the necessary data needed to run the WebLogic Image Tool to build an image for
26+
`Design View` helps you specify the necessary data needed to run the WebLogic Image Tool to build an image for
2727
running the WebLogic domain.
2828

2929
Use the `Design View` page to specify whether to create a new or use an existing (the default) `Primary Image` and

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ When editing a route:
8888
- All requests in the defined rules are routed to the service specified by the `Target Service` field that resides in the namespace specified by the read-only
8989
`Target Service Namespace` field and the port specified by the `Target Port` field. After the domain has been deployed, you can select the `Target Service`
9090
value from the drop-down list of available services in the WebLogic Kubernetes Operator domain's namespace. After the `Target Service` is selected,
91-
you can select the `Target Port` from the list of available ports in the selected target service.
91+
you can select the `Target Port` from the list of available ports in the selected target service.
9292
- Specify the `Transport Option` for the ingress route:
9393
* Select `Plain HTTP` for unencrypted traffic from the client through the ingress controller to the target service.
9494
* Select `SSL terminate at ingress controller` for SSL
@@ -97,14 +97,14 @@ When editing a route:
9797
* Enable `Is target service WebLogic Console?` if the target service is the `WebLogic Console` service.
9898
* Select `SSL pass through` for SSL traffic to pass through the ingress
9999
controller and then terminate at the target service.
100-
* If you select this option, you must also specify a valid DNS value in 'Virtual Host', and all SSL traffic from
100+
* If you select this option, you must also specify a valid DNS value in 'Virtual Host', and all SSL traffic from
101101
the`Virtual Host` will be routed to the target service.
102102
* Make sure that the `Target Port` supports SSL.
103103
- Use the `Ingress Route Annotations` table to
104104
add annotations to the ingress route, as needed. Do not remove any pre-populated annotations.
105105

106106
### Code View
107-
The `Code View` displays shell scripts for installing an ingress controller and for updating ingress routes. It also
107+
`Code View` displays shell scripts for installing an ingress controller and for updating ingress routes. It also
108108
displays the YAML definitions of the routes to be added, if applicable.
109109

110110
If it is not already selected, then use the `Script Language` drop-down menu to choose the desired scripting language. Note

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ description: "Create and deploy the Kubernetes custom resource for the WebLogic
1717
- [Runtime Encryption Secret](#runtime-encryption-secret)
1818
- [WebLogic Kubernetes Operator Introspection Configuration](#weblogic-kubernetes-operator-introspection-configuration)
1919
- [Domain-Wide Server Settings](#domain-wide-server-settings)
20+
- [Domain-Wide Node Selector](#domain-wide-node-selector)
2021
- [Code View](#code-view)
2122
- [Prepare Model](#prepare-model)
2223
- [Deploy Domain](#deploy-domain)
@@ -30,7 +31,7 @@ defined by the WebLogic Kubernetes Operator. For more information, see
3031
in the WebLogic Kubernetes Operator documentation.
3132

3233
### Design View
33-
The `Design View` helps you specify the necessary data needed to generate the Domain resource definition and deploy
34+
`Design View` helps you specify the necessary data needed to generate the Domain resource definition and deploy
3435
that resource into a Kubernetes cluster.
3536

3637
The `Domain UID` field defines the name of the Kubernetes Domain custom resource object. This name must be unique
@@ -78,6 +79,7 @@ The following sections describe the other panes that support configuring the gen
7879
- [Runtime Encryption Secret](#runtime-encryption-secret)
7980
- [WebLogic Kubernetes Operator Introspection Configuration](#weblogic-kubernetes-operator-introspection-configuration)
8081
- [Domain-Wide Server Settings](#domain-wide-server-settings)
82+
- [Domain-Wide Node Selector](#domain-wide-node-selector)
8183

8284
#### Primary Image to Use for the Domain
8385
This pane focuses on the container primary image to use to run the WebLogic Server domain in a container. If you select `Create a New Primary Image`,
@@ -218,8 +220,11 @@ to use this section to configure the Administration Server and use the `Clusters
218220
The fields in this pane have similar meaning to the equivalent fields previously described in
219221
[Clusters](#clusters); refer to that section for more information.
220222

223+
#### Domain-Wide Node Selector
224+
This pane lets you specify the nodes on which to run.
225+
221226
### Code View
222-
The `Code View` displays a shell script for deploying the domain and creating its dependent resources as well as
227+
`Code View` displays a shell script for deploying the domain and creating its dependent resources as well as
223228
the YAML definition for the Kubernetes custom resource (that is, the Domain resource) and the Model Variables Overrides
224229
ConfigMap, if applicable.
225230

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ For detailed information about the operator, see the
2929
[WebLogic Kubernetes Operator](https://oracle.github.io/weblogic-kubernetes-operator/) documentation.
3030

3131
### Design View
32-
The `Design View` helps you specify the necessary data needed to install the WebLogic Kubernetes Operator to manage
32+
`Design View` helps you specify the necessary data needed to install the WebLogic Kubernetes Operator to manage
3333
WebLogic domains in one or more Kubernetes namespaces. To install the operator using the default settings, simply
3434
provide values for the following three fields:
3535

documentation/staging/1.3/content/navigate/model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ icon beside a field, a dialog appears with the option of setting the field to a
4545
The variable will show up in both the model and the variables editor on the `Code View` page. Likewise, when adding an application, you supply the path to the EAR,
4646
WAR, or JAR file (or directory); that path will be put in the archive editor on the `Code View` page.
4747

48-
Note that if you create a new model using the `Design View` pages, the `Design View` will insert the `AdminUserName` and `AdminPassword` fields
48+
Note that if you create a new model using the `Design View` pages, then the `Design View` will insert the `AdminUserName` and `AdminPassword` fields
4949
into the `domainInfo` section of the model with their values set to variables whose values you will need to provide.
5050
This is intended to help you create a domain with all of the required fields.
5151

documentation/staging/1.3/content/navigate/verrazzano/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ to help you:
1111

1212
1. [Configure]({{< relref "/navigate/verrazzano/vz-client-config#client-configuration" >}}) your Kubernetes client (`kubectl`) to connect to the Kubernetes cluster.
1313
2. [Install]({{< relref "/navigate/verrazzano/vz-install.md" >}}) Verrazzano.
14-
3. [Define]({{< relref "/navigate/verrazzano/vz-component.md" >}}) the Verrazzano component for the WebLogic domain.
15-
4. [Deploy]({{< relref "/navigate/verrazzano/vz-application.md" >}}) the application to Verrazzano.
14+
3. [Create and deploy]({{< relref "/navigate/verrazzano/vz-component#verrazzano-component" >}}) the Verrazzano component for the WebLogic domain.
15+
4. [Deploy]({{< relref "/navigate/verrazzano/vz-application.md" >}}) an application to Verrazzano.
1616

1717
{{% children style="h4" description="true" %}}

documentation/staging/1.3/content/navigate/verrazzano/vz-application.md

Lines changed: 27 additions & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -3,108 +3,37 @@ title: "Application"
33
date: 2019-02-22T15:44:42-05:00
44
draft: false
55
weight: 4
6-
description: "Install and configure an ingress controller."
6+
description: "Define and deploy a Verrazzano application."
77
---
88

99
### Contents
10-
- [Ingress Controller](#ingress-controller)
1110
- [Design View](#design-view)
12-
- [Ingress Controller Configuration](#ingress-controller-configuration)
13-
- [TLS Secret for Ingress Routes](#tls-secret-for-ingress-routes)
14-
- [Ingress Routes Configuration](#ingress-routes-configuration)
11+
- [Components](#components)
1512
- [Code View](#code-view)
16-
- [Install Ingress Controller](#install-ingress-controller)
17-
- [Update Ingress Routes](#update-ingress-routes)
18-
- [Uninstall Ingress Controller](#uninstall-ingress-controller)
13+
- [Deploy Application](#deploy-application)
14+
- [Undeploy Application](#undeploy-application)
1915

20-
### Ingress Controller
21-
This section supports two distinct functions related to an ingress controller. First, it supports installing an ingress
22-
controller to a Kubernetes cluster. Second, it supports adding the necessary routes to an ingress controller to make
23-
a deployed WebLogic domain's endpoints accessible.
2416

2517
### Design View
26-
`Design View` helps you specify the data needed to install an ingress controller, if desired, and
27-
specify the data needed to expose one or more endpoints for a deployed WebLogic domain. This page contains three panes:
18+
`Design View` lets you specify the data used to define the Verrazzano application.
19+
Simply provide values for the following fields:
2820

29-
- [Ingress Controller Configuration](#ingress-controller-configuration)
30-
- [TLS Secret for Ingress Routes](#tls-secret-for-ingress-routes)
31-
- [Ingress Routes Configuration](#ingress-routes-configuration)
21+
- `Application Name` - The name of the Verrazzano application.
22+
- `Application Namespace` - The Kubernetes namespace to which the application will be deployed.
23+
- `Application Version` - The version annotation value to add to the Verrazzano application.
24+
- `Application Description` - The description annotation value to add to the Verrazzano application.
25+
- `Verrazzano Version` - Provide the installed Verrazzano version. Click the icon to retrieve the value from the environment.
26+
- `Use Multicluster Application` - Select whether to make this a multicluster application.
27+
- `Create Verrazzano Project` - To deploy a multicluster application, a Verrazzano Project that includes the current application's namespace must exist. Select whether to create
28+
a new Verrazzano Project.
29+
- `Secret Names` - The secret names in the current namespace to associate with the application. To edit this field, click `Choose Secrets`.
30+
- `Verrazzano Clusters for Application Placement` - The Verrazzano cluster names where the application should be placed. To edit this field, click `Choose Verrazzano Clusters`.
3231

33-
#### Ingress Controller Configuration
34-
The most important field in this pane is the `Ingress Provider` field. This fields tells the WKT UI application with which of the
35-
supported ingress controllers it will need to work. The current release supports two ingress
36-
controllers:
32+
#### Components
3733

38-
- NGINX
39-
- Traefik
40-
41-
To install the ingress controller, enable `Install Ingress Controller`.
42-
- To set the release name used by the Helm install process, use the `Helm Release Name to Use` field.
43-
- Set the Kubernetes namespace to which the ingress controller should be installed with the `Ingress Controller Namespace` field.
44-
45-
The container image for the Traefik ingress controller resides in Docker Hub. Due to changes made
46-
to Docker Hub, anonymous pull requests are throttled. This can result in pull requests being denied when the Kubernetes
47-
cluster attempts to pull the image and start the container.
48-
- To work around this limitation, enable the `Use Docker Hub Secret` field to provide login credentials for Docker Hub.
49-
- The `Docker Registry Secret Name` field specifies the name of the Kubernetes pull secret to use when pulling the image.
50-
To create this secret, enable `Create Docker Hub Secret` and fill in the pull secret data in the `Docker Hub Username`, `Docker Hub Password`,
51-
and `Docker Hub Email Address` fields.
52-
- For the NGINX ingress controller, if you want to have SSL pass through the ingress route, enable `Allow SSL pass through to target service`.
53-
54-
#### TLS Secret for Ingress Routes
55-
Use this pane to configure the Transport Layer Security (TLS) secret containing the certificate and private key data that will be used by the
56-
ingress controller when establishing HTTPS connections from clients to the ingress controller. The TLS connection will be
57-
terminated at the ingress controller, so traffic between the ingress controller and services/pods will not be encrypted.
58-
In the current release, only a single TLS certificate is supported for the routes being defined.
59-
60-
- To use TLS-enabled routes, enable `Use Ingress TLS Secret` and provide the secret name using the
61-
`Ingress TLS Secret Name` field.
62-
- To have the application create this secret, enable `Create Ingress TLS Secret`.
63-
- If you already have a certificate file and its corresponding private key file, then use the `TLS Certificate File`
64-
and `TLS Private Key File` fields to provide them.
65-
- To create these files automatically, enable `Generate a TLS Certificate and Private Key`.
66-
- Provide the path to the OpenSSL executable using the
67-
`OpenSSL Executable to Use` field.
68-
- Use the `Subject to Use for the Generated TLS Certificate` field to specify the data
69-
to put into the subject of the certificate.
70-
- For example, if your ingress route will use the virtual host name
71-
`www.myapp.com`, you might specify the subject contents as `/CN=www.myapp.com`.
72-
- The subject data will support multiple
73-
key/value pairs using a comma-separated syntax, like `/key1=value1,/key2=value2,/key3=value3`.
74-
75-
#### Ingress Routes Configuration
76-
Use the table in this section to define the ingress routes to be added by the application. _Note that this table does
77-
not currently display existing routes already defined._ Any routes defined in or removed from the table will happen in
78-
the WKT Project object. When applying or updating the routes, only the fields currently in the table will be considered.
79-
If the routes do not exist, then they will be added. If one or more of the routes already exists, then the application will warn
80-
you to confirm whether you want to update the existing route or routes before performing the operation.
81-
82-
To add a new route, click the plus (`+`) button in the table header. To edit a route, use the edit button on the corresponding
83-
route row. To remove a route, use the delete icon on the corresponding route row.
84-
85-
When editing a route:
86-
- Use the `Name` field to set the route name.
87-
- Use the `Virtual Host` and `Path Expression` fields to define the matching rules that determine which requests match this route.
88-
- All requests in the defined rules are routed to the service specified by the `Target Service` field that resides in the namespace specified by the read-only
89-
`Target Service Namespace` field and the port specified by the `Target Port` field. After the domain has been deployed, you can select the `Target Service`
90-
value from the drop-down list of available services in the WebLogic Kubernetes Operator domain's namespace. After the `Target Service` is selected,
91-
you can select the `Target Port` from the list of available ports in the selected target service.
92-
- Specify the `Transport Option` for the ingress route:
93-
* Select `Plain HTTP` for unencrypted traffic from the client through the ingress controller to the target service.
94-
* Select `SSL terminate at ingress controller` for SSL
95-
terminating
96-
at the ingress controller and then unencrypted traffic from the ingress controller to the target service.
97-
* Enable `Is target service WebLogic Console?` if the target service is the `WebLogic Console` service.
98-
* Select `SSL pass through` for SSL traffic to pass through the ingress
99-
controller and then terminate at the target service.
100-
* If you select this option, you must also specify a valid DNS value in 'Virtual Host', and all SSL traffic from
101-
the`Virtual Host` will be routed to the target service.
102-
* Make sure that the `Target Port` supports SSL.
103-
- Use the `Ingress Route Annotations` table to
104-
add annotations to the ingress route, as needed. Do not remove any pre-populated annotations.
10534

10635
### Code View
107-
The `Code View` displays shell scripts for installing an ingress controller and for updating ingress routes. It also
36+
`Code View` displays shell scripts for installing an ingress controller and for updating ingress routes. It also
10837
displays the YAML definitions of the routes to be added, if applicable.
10938

11039
If it is not already selected, then use the `Script Language` drop-down menu to choose the desired scripting language. Note
@@ -115,18 +44,13 @@ set environment variables to specify any credentials required by the script to e
11544
the script itself. This change is left as an exercise for you because different environments typically will have
11645
existing standards for securely handling such credentials.
11746

118-
### Install Ingress Controller
119-
`Install Ingress Controller` creates any namespace and secret specified and runs the ingress controller's Helm
120-
chart to install the ingress controller. You access this action by using the `Install Ingress Controller` button on the
121-
`Ingress Controller` page or the `Go` > `Install Ingress Controller` menu item.
122-
123-
### Update Ingress Routes
124-
`Update Ingress Routes` creates the TLS secret, if needed, and adds or updates the specified ingress routes. You access this action
125-
by using the `Update Ingress Routes` button on the `Ingress Controller` page or
126-
the `Go` > `Update Ingress Routes to Domain` menu item.
47+
### Deploy Application
48+
`Deploy Application` creates the Domain custom resource object and any of its dependent objects (for example,
49+
namespace, secrets, ConfigMap) in Kubernetes. You access this action by using the `Deploy Domain` button on the
50+
`WebLogic Domain` page or the `Go` > `Deploy WebLogic Domain to Kubernetes` menu item.
12751

128-
### Uninstall Ingress Controller
129-
`Uninstall Ingress Controller` uses the `helm uninstall` command to remove all the ingress resources
130-
and uninstall the ingress controller. In addition, you can choose whether to also delete the corresponding namespace.
131-
You access these actions by using the `Uninstall Ingress Controller` button on the
132-
`Ingress Controller` page or the `Go` > `Uninstall Ingress Controller` menu item.
52+
### Undeploy Application
53+
`Undeploy Application` removes the Kubernetes custom resource for the WebLogic domain and its
54+
dependent objects in Kubernetes. In addition, you can choose whether to also delete the corresponding namespace.
55+
You access these actions by using the `Undeploy Domain` button on the
56+
`WebLogic Domain` page or the `Go` > `Undeploy WebLogic Domain to Kubernetes` menu item.

0 commit comments

Comments
 (0)