Skip to content

Commit 5c91b5d

Browse files
committed
Resolved merge conflict by removing name-changes.md
2 parents abd9843 + d296e0e commit 5c91b5d

File tree

9 files changed

+133
-84
lines changed

9 files changed

+133
-84
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ Please refer to [Shutting down a domain](site/shutdown-domain.md) for informatio
161161

162162
## Load balancing with an Ingress controller or a web server
163163

164-
You can choose a load balancer provider for your WebLogic domains running in a Kubernetes cluster. Please refer to Load balancing with Voyager Ingress Controller, [Load balancing with Traefik Ingress Controller](site/traefik.md), and [Load balancing with Apache Web Server](site/apache.md) for information about the current capabilities and setup instructions for each of the supported load balancers.
164+
You can choose a load balancer provider for your WebLogic domains running in a Kubernetes cluster. Please refer to Load balancing with Voyager Ingress Controller, [Load balancing with Traefik Ingress Controller](site/traefik.md), and [Load balancing with Apache HTTP Server](site/apache.md) for information about the current capabilities and setup instructions for each of the supported load balancers.
165165

166166

167167
[comment]: # (Exporting operator logs to ELK. The operator provides an option to export its log files to the ELK stack. Please refer to [ELK integration]site/elk.md for information about this capability.)

site/apache.md

Lines changed: 28 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11

2-
# Load Balancing with Apache Web Server
2+
# Load balancing with the Apache HTTP Server
33

4-
This page describes how to setup and start a Apache Web Server for load balancing inside a Kubernets cluster. The configuration and startup can either be automatic when you create a domain using the WebLogic Operator's `create-weblogic-domain.sh` script, or manually if you have an existing WebLogic domain configuration.
4+
This document describes how to set up and start an Apache HTTP Server for load balancing inside a Kubernets cluster. The configuration and startup can be either automatic, when you create a domain using the WebLogic Operator's `create-weblogic-domain.sh` script, or manual, if you have an existing WebLogic domain configuration.
55

6-
## Build Docker Image for Apache Web Server
6+
## Build the Docker image for the Apache HTTP Server
77

8-
You need to build the Docker image for Apache Web Server that enbeds Oracle WebLogic Server Proxy Plugin.
8+
You need to build the Docker image for the Apache HTTP Server that embeds the Oracle WebLogic Server Proxy Plugin.
99

10-
1. Download and build the Docker image for the Apache Web Server with 12.2.1.3.0 Oracle WebLogic Server Proxy Plugin. See the instructions in [Apache Web Server with Oracle WebLogic Server Proxy Plugin on Docker](https://github.com/oracle/docker-images/tree/master/OracleWebLogic/samples/12213-webtier-apache).
10+
1. Download and build the Docker image for the Apache HTTP Server with the 12.2.1.3.0 Oracle WebLogic Server Proxy Plugin. See the instructions in [Apache HTTP Server with Oracle WebLogic Server Proxy Plugin on Docker](https://github.com/oracle/docker-images/tree/master/OracleWebLogic/samples/12213-webtier-apache).
1111

12-
2. tag your Docker image to `store/oracle/apache:12.2.1.3` using `docker tag` command.
12+
2. Tag your Docker image, `store/oracle/apache:12.2.1.3`, using the `docker tag` command.
1313

1414
```
1515
1616
$ docker tag 12213-apache:latest store/oracle/apache:12.2.1.3
1717
1818
```
1919

20-
More information about the Apache plugin can be found at: [Apache Web Server with Oracle WebLogic Server Proxy Plugin on Docker](https://docs.oracle.com/middleware/1213/webtier/develop-plugin/apache.htm#PLGWL395).
20+
For more information about the Apache plugin, see [Apache HTTP Server with Oracle WebLogic Server Proxy Plugin on Docker](https://docs.oracle.com/middleware/1213/webtier/develop-plugin/apache.htm#PLGWL395).
2121

22-
Once you have access to the Docker image of the Apache Web Server, you can go ahead follow the instructions below to setup and start Kubernetes artifacts for Apache Web Server.
22+
After you have access to the Docker image of the Apache HTTP Server, you can follow the instructions below to set up and start the Kubernetes artifacts for the Apache HTTP Server.
2323

2424

25-
## Use Apache load balancer with a WebLogic domain created with the WebLogic Operator
25+
## Use the Apache load balancer with a WebLogic domain created with the WebLogic Operator
2626

27-
Please refer to [Creating a domain using the WebLogic Operator](creating-domain.md) for how to create a domain with the WebLogic Operator.
27+
For how to create a domain with the WebLogic Operator, please refer to [Creating a domain using the WebLogic Operator](creating-domain.md).
2828

29-
You need to configure Apache Web Server as your load balancer for a WebLogic domain by setting the `loadBalancer` option to `APACHE` in `create-weblogic-domain-inputs.yaml` (as shown below) when running the `create-weblogic-domain.sh` script to create a domain.
29+
You need to configure the Apache HTTP Server as your load balancer for a WebLogic domain by setting the `loadBalancer` option to `APACHE` in the `create-weblogic-domain-inputs.yaml` (as shown below) when running the `create-weblogic-domain.sh` script to create a domain.
3030

3131
```
3232
@@ -36,9 +36,9 @@ loadBalancer: APACHE
3636
3737
```
3838

39-
The `create-weblogic-domain.sh` script installs the Apache Web Server with Oracle WebLogic Server Proxy Plugin into the Kubernetes *cluster* in the same namespace as the *domain*.
39+
The `create-weblogic-domain.sh` script installs the Apache HTTP Server with the Oracle WebLogic Server Proxy Plugin into the Kubernetes *cluster* in the same namespace as the *domain*.
4040

41-
The Apache Web Server will expose a `NodePort` that allows access to the load balancer from outside of the Kubernetes cluster. The port is configured by setting 'loadBalancerWebPort' in `create-weblogic-domain-inputs.yaml` file.
41+
The Apache HTTP Server will expose a `NodePort` that allows access to the load balancer from outside of the Kubernetes cluster. The port is configured by setting `loadBalancerWebPort` in the `create-weblogic-domain-inputs.yaml` file.
4242

4343
```
4444
@@ -48,11 +48,11 @@ loadBalancerWebPort: 30305
4848
4949
```
5050

51-
The user can access an application from outside of the Kubernetes cluster via http://<host>:30305/<application-url>.
51+
Users can access an application from outside of the Kubernetes cluster by using `http://<host>:30305/<application-url>`.
5252

5353
### Use the default plugin WL module configuration
5454

55-
By default, the Apache Docker image supports a simple WebLogic server proxy plugin configuration for a single WebLogic domain with an admin server and a cluster. The `create-weblogic-domain.sh` script automatically customizes the default behavior based on your domain configuration. The default setting only supports the type of load balancing that uses the root path ("/"). You can further customize the root path of the load balancer with `loadBalancerAppPrepath` property in the `create-weblogic-domain-inputs.yaml` file.
55+
By default, the Apache Docker image supports a simple WebLogic Server proxy plugin configuration for a single WebLogic domain with an Administration Server and a cluster. The `create-weblogic-domain.sh` script automatically customizes the default behavior based on your domain configuration. The default setting supports only the type of load balancing that uses the root path ("/"). You can further customize the root path of the load balancer with the `loadBalancerAppPrepath` property in the `create-weblogic-domain-inputs.yaml` file.
5656

5757
```
5858
@@ -62,11 +62,11 @@ loadBalancerAppPrepath: /weblogic
6262
6363
```
6464

65-
The user can then access an application from utsidie of the Kubernetes cluster via `http://<host>:30305/weblogic/<application-url>,` and the admin can access the admin console via `http://<host>:30305/console`.
65+
Users can then access an application from outside of the Kubernetes cluster by using `http://<host>:30305/weblogic/<application-url>,` and the administrator can access the Administration Console by using `http://<host>:30305/console`.
6666

67-
The generated Kubernetes yaml files look like the following given the domainUID "domain1".
67+
The generated Kubernetes YAML files look like the following, given the `domainUID`, "`domain1`".
6868

69-
`weblogic-domain-apache.yaml` for Apache web server deployment
69+
Sample `weblogic-domain-apache.yaml` file for Apache HTTP Server deployment.
7070

7171
```
7272
@@ -254,7 +254,7 @@ spec:
254254
255255
```
256256

257-
`weblogic-domain-apache-security.yaml` for associated RBAC roles and role bindings
257+
Sample `weblogic-domain-apache-security.yaml` file for associated RBAC roles and role bindings.
258258

259259
```
260260
@@ -394,7 +394,7 @@ domain1-apache-webtier 2h
394394
### Use your own plugin WL module configuration
395395

396396

397-
You can fine tune the behavior of the Apache plugin by providing your own Apache plugin configuration. You put your custom_mod_wl_apache.conf file in a local directory, for example `<host-config-dir>` , and specify this location in the `create-weblogic-domain-inputs.yaml` file as follows.
397+
You can fine tune the behavior of the Apache plugin by providing your own Apache plugin configuration. You put your `custom_mod_wl_apache.conf` file in a local directory, for example, `<host-config-dir>` , and specify this location in the `create-weblogic-domain-inputs.yaml` file as follows:
398398

399399
```
400400
@@ -406,9 +406,9 @@ loadBalancerVolumePath: <host-config-dir>
406406
407407
```
408408

409-
After the `loadBalancerVolumePath` property is specified, the `create-weblogic-domain.sh` script will use the custom_mod_wl_apache.config file in `<host-config-dir>` directory to replace what is in the Docker image.
409+
After the `loadBalancerVolumePath` property is specified, the `create-weblogic-domain.sh` script will use the `custom_mod_wl_apache.config` file in the `<host-config-dir>` directory to replace what is in the Docker image.
410410

411-
The generated yaml files will look similar except with un-commented entries like bellow.
411+
The generated YAML files will look similar except with un-commented entries like below:
412412

413413
```
414414
@@ -418,7 +418,7 @@ The generated yaml files will look similar except with un-commented entries like
418418
419419
hostPath:
420420
421-
path: <host-config-dir>
421+
path: <host-config-dir>
422422
423423
containers:
424424
@@ -440,21 +440,13 @@ The generated yaml files will look similar except with un-commented entries like
440440

441441
## Use the Apache load balancer with a manually created WebLogic Domain
442442

443-
If your WebLogic domain is not created by the WebLogic Operator, you need to manually create and start all Kubernetes' artifacts for Apache Web Server.
444-
445-
446-
1. Create your own custom_mod_wl_apache.conf file, and put it in a local dir, say `<host-conf-dir>`. See the instructions in [Apache Web Server with Oracle WebLogic Server Proxy Plugin on Docker](https://docs.oracle.com/middleware/1213/webtier/develop-plugin/apache.htm#PLGWL395).
447-
448-
2. Create the Apache deployment yaml file. See the example above. Note that you need to use the **volumes** and **volumeMounts** to mount `<host-config-dir>` in to `/config` directory inside the pod that runs Apache web tier. Note that the Apache Web Server needs to be in the same Kubernetes namespace as the WebLogic domains that it needs to access.
449-
450-
3. Create a RBAC yaml file. See the example above
451-
452-
Note that you can choose to run one Apache Web Server to load balance to multiple domains/clusters inside the same Kubernetes cluster as long as the Apache Web Server and the domains are all in the same namespace.
453-
454-
455-
443+
If your WebLogic domain is not created by the WebLogic Operator, you need to manually create and start all Kubernetes' artifacts for the Apache HTTP Server.
456444

457445

446+
1. Create your own `custom_mod_wl_apache.conf` file, and put it in a local directory, for example, `<host-conf-dir>`. See the instructions in [Apache Web Server with Oracle WebLogic Server Proxy Plugin on Docker](https://docs.oracle.com/middleware/1213/webtier/develop-plugin/apache.htm#PLGWL395).
458447

448+
2. Create the Apache deployment YAML file. See the example above. Note that you need to use the **volumes** and **volumeMounts** to mount `<host-config-dir>` into the `/config` directory inside the pod that runs the Apache web tier. Note that the Apache HTTP Server needs to be in the same Kubernetes namespace as the WebLogic domain that it needs to access.
459449

450+
3. Create a RBAC YAML file. See the example above.
460451

452+
Note that you can choose to run one Apache HTTP Server to balance the loads from multiple domains/clusters inside the same Kubernetes cluster, as long as the Apache HTTP Server and the domains are all in the same namespace.

site/developer.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,24 @@ To clone the repository from GitHub, issue this command:
2525
git clone https://github.com/oracle/weblogic-kubernetes-operator.git
2626
```
2727

28+
## Operator branching model
29+
30+
The ```master``` branch is protected and will always contain source for the latest, generally available (GA)
31+
release of the operator, including any critical hot fixes. No general pull requests will be merged to this branch.
32+
33+
Active work will be performed on the ```develop``` branch. This branch is also protected. Please submit pull
34+
requests to this branch unless you are collaborating on a feature and have another target branch.
35+
Please see details on the Oracle Contributor Agreement (OCA) and guidelines for pull requests on the [README] (README.md).
36+
37+
Longer running feature work will be performed on specific branches, such as ```feature/dynamic-clusters```. Since we want
38+
to balance separating destabilizing work into feature branches against the possibility of later difficult merges, we
39+
encourage developers working on features to pull out any necessary refactoring or improvements that are general purpose into
40+
their own shorter-lived branches and create pull requests to ```develop``` when these smaller work items are complete.
41+
42+
When it is time for a release, we will branch off ```develop``` to create a per-release branch. Here, we will update version
43+
numbers, rebuild javadoc, if necessary, and perform any other pre-release updates. Finally, this release branch will be merged
44+
to ```master```.
45+
2846
## Building the operator
2947

3048
The operator is built using [Apache Maven](http://maven.apache.org). The build machine will also need to have Docker installed.

site/installation.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,46 @@ Note that there is a short video demonstration of the installation process avail
1111
[comment]: # ( Note that you *must* create the `docker-registry` secret in the `weblogic-operator` namespace, so you will need to create the namespace first. )
1212
[comment]: # ( In this command, replace the uppercase items with the appropriate values. The `SECRET_NAME` will be needed in later parameter files. The `NAMESPACE` must match the namespace where the operator will be deployed. )
1313

14-
## Build the Docker image for the operator
14+
## Build the Docker image for the operator using Wercker
15+
16+
You can build, test, and publish the Docker image for the operator directly from Wercker using the ```wercker.yml``` from this repository.
17+
18+
If you haven't done so already, navigate to [wercker.com](https://www.wercker.com) and create an account. Once you are logged in,
19+
on the [app.wercker.com] (https://app.wercker.com) page press, "Create your first application."
20+
21+
Select GitHub (the default, if you are new to Wercker). If you haven't done so already, press the "Connect" button within the
22+
larger GitHub button and follow the prompts to provide a login for GitHub. This connects your Wercker and GitHub accounts so
23+
that Wercker pipelines will later be able to clone this repository. Press, "Next."
24+
25+
Select the repository from GitHub. This will be "oracle / weblogic-kubernetes-operator" or a different value if you
26+
forked this repository. Press, "Next."
27+
28+
Configure Wercker's access to the GitHub repository. The default choice, "wercker will check out the code without using an SSH key",
29+
is typically sufficient. Press, "Next."
30+
31+
Verify the settings so far on the review page and press, "Create."
32+
33+
Since this GitHub repository already has a ```wercker.yml``` file, you can skip directly to the "Environment" tab.
34+
35+
Please provide the following key/value pairs on the environment page. Remember that these values will be
36+
visible to anyone to whom you give access to the Wercker application, therefore, select "Protected" for any
37+
values that should remain hidden, including all passwords.
38+
39+
| Key | Value | OCIR Sample |
40+
| --- | --- | --- |
41+
| DOCKER_USERNAME | Username for the Docker store for pulling serverjre image | |
42+
| DOCKER_PASSWORD | Password for the Docker store | |
43+
| REPO_REGISTRY| Registry address | https://phx.ocir.io/v2 |
44+
| REPO_REPOSITORY | Repository value | phx.ocir.io/<your tenancy>/weblogic-kubernetes-operator |
45+
| REPO_USERNAME | Username for registry | <your tenancy>/<your username> |
46+
| REPO_PASSWORD | Password for registry | Use generated SWIFT password |
47+
| IMAGE_TAG_OPERATOR | Image tag, such as 0.2 or latest | |
48+
49+
Select the "Runs" tab. Skip to the bottom and press, "Trigger your first build now."
50+
51+
When the run completes successfully, the Docker image for the operator will be built and published to your repository.
52+
53+
## Build the Docker image for the operator locally
1554

1655
The following software are required to obtain and build the operator:
1756

0 commit comments

Comments
 (0)