Skip to content

Commit 17cc086

Browse files
committed
merge doc updated from 2.0-rc1
1 parent 56ec466 commit 17cc086

File tree

5 files changed

+195
-197
lines changed

5 files changed

+195
-197
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,21 +21,21 @@ Oracle is finding ways for organizations using WebLogic Server to run important
2121
The fastest way to experience the operator is to follow the [Quick start guide](site/quickstart.md), or you can peruse our [documentation](site), read our [blogs](https://blogs.oracle.com/weblogicserver/how-to-weblogic-server-on-kubernetes), or try out the [samples](kubernetes/samples/README.md).
2222

2323
```diff
24-
+ The current release of the operator is 2.0-rc1, a release candidate for our 2.0 release.
25-
+ This release candidate was published on Dec 20, 2018.
24+
+ The current release of the operator is 2.0-rc1, a release candidate for our 2.0 release.
25+
+ This release candidate was published on Dec 20, 2018.
2626
+ We expect to publish the final 2.0 release in January 2019.
27-
+ We expect that there will be some minor changes to documentation and samples in the final 2.0 release,
28-
+ however, this release candidate is suitable for testing and early adopters.
27+
+ We expect that there will be some minor changes to documentation and samples in the final 2.0 release.
28+
+ However, this release candidate is suitable for testing and early adopters.
2929
```
3030

31-
# Backward Compatibility Guidelines
31+
# Backward compatibility guidelines
3232

3333
The 2.0 release introduces some breaking changes and does not maintain compatibility with previous releases.
3434

35-
Starting with the 2.0 release, future operator releases are intended to be backwards-compatible with respect to the Domain
36-
resource schema, operator Helm chart input values, configuration overrides template, Kubernetes resources created
37-
by the operator Helm chart, Kubernetes resources created by the operator, and the operator REST interface. We intend to
38-
maintain compatibility for three releases, excepting a clearly communicated deprecated feature, which will be
35+
Starting with the 2.0 release, future operator releases are intended to be backward compatible with respect to the domain
36+
resource schema, operator Helm chart input values, configuration overrides template, Kubernetes resources created
37+
by the operator Helm chart, Kubernetes resources created by the operator, and the operator REST interface. We intend to
38+
maintain compatibility for three releases, except in the case of a clearly communicated deprecated feature, which will be
3939
maintained for one release after a replacement is available.
4040

4141
# About this documentation
@@ -46,7 +46,7 @@ please consult this table of contents:
4646
* The [Quick start guide](site/quickstart.md) explains how to just get the operator running quickly, using all the defaults, nothing special.
4747
* The [User guide](site/user-guide.md) contains detailed information for users of the operator, including how to install and configure it,
4848
and how to use it to create and manage WebLogic domains.
49-
* Our [samples](kubernetes/samples/README.md) provide detailed example code and instructions that show you how to perform
49+
* Our [Samples](kubernetes/samples/README.md) provide detailed example code and instructions that show you how to perform
5050
various tasks related to the operator.
5151
* The [Developer guide](site/developer.md) provides details for people who want to understand how the operator is built, tested, and so on. Those who wish to contribute to the operator code will find useful information here. This section also includes
5252
API documentation (Javadoc) and Swagger/OpenAPI documentation for the REST APIs.

site/domains.md

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,54 @@
11
## Create and manage WebLogic domains
22

33
In this version of the operator, a WebLogic domain can be located either in a persistent volume (PV) or in a Docker image.
4-
There are advantages to both approaches, and there are sometimes technical limitations of various
4+
There are advantages to both approaches, and there are sometimes technical limitations of various
55
cloud providers that may make one approach better suited to your needs.
66
You can also mix and match on a domain by domain basis.
77

88
| Domain on a persistent volume | Domain in a Docker image |
99
| --- | --- |
10-
| Allows you to use the same standard read-only Docker image for every server in every domain. | Requires a different image for each domain, but all servers in that domain use the same image. |
11-
| No state is kept in Docker images making them completely throw away (cattle not pets). | Runtime state should not be kept in the images, but applications and confguration are. |
12-
| The domain is long-lived, so you can mutate the configuration or deploy new applications using standard methods (admin console, WLST, etc.) | If you want to mutate the domain configuration or deploy application updates, you must create a new image. |
13-
| Logs are automatically placed on persistent storage. | Logs are kept in the images, and sent to the Pod's log (stdout) unless you manually place them on persistent storage. |
14-
| Patches can be applied by simply changing the image and rolling the domain. | To apply patches, you must create a new domain-specific image and then roll the domain. |
15-
| Many cloud providers do not provide persistent volumes that are shared across availability zones, so you may not be able to use a single persistent volume. You may need to use some kind of volume replication technology or a clustered file system. | You do not have to worry about volume replication across availability zones since each Pod has its own copy of the domain. WebLogic replication will handle propagation of any online configuration changes. |
16-
| CI/CD pipelines may be more complicated because you would probably need to run WLST against the live domain directory to effect changes. | CI/CD pipelines are simpler because you can create the whole domain in the image and don't have to worry about a persistent copy of the domain. |
10+
| Let's you use the same standard read-only Docker image for every server in every domain. | Requires a different image for each domain, but all servers in that domain use the same image. |
11+
| No state is kept in Docker images making them completely throw away (cattle not pets). | Runtime state should not be kept in the images, but applications and configuration are. |
12+
| The domain is long-lived, so you can mutate the configuration or deploy new applications using standard methods (administration console, WLST, etc.) | If you want to mutate the domain configuration or deploy application updates, you must create a new image. |
13+
| Logs are automatically placed on persistent storage. | Logs are kept in the images, and sent to the pod's log (stdout) unless you manually place them on persistent storage. |
14+
| Patches can be applied by simply changing the image and rolling the domain. | To apply patches, you must create a new domain-specific image and then roll the domain. |
15+
| Many cloud providers do not provide persistent volumes that are shared across availability zones, so you may not be able to use a single persistent volume. You may need to use some kind of volume replication technology or a clustered file system. | You do not have to worry about volume replication across availability zones since each pod has its own copy of the domain. WebLogic replication will handle propagation of any online configuration changes. |
16+
| CI/CD pipelines may be more complicated because you would probably need to run WLST against the live domain directory to effect changes. | CI/CD pipelines are simpler because you can create the whole domain in the image and don't have to worry about a persistent copy of the domain. |
1717
| There are less images to manage and store, which could provide significant storage and network savings. | There are more images to manage and store in this approach. |
18-
| You may be able to use standard Oracle-provided images or at least a very small number of self-built images, e.g. with patches installed. | You may need to do more work to set up processes to build and maintain your images. |
18+
| You may be able to use standard Oracle-provided images or at least a very small number of self-built images, for example, with patches installed. | You may need to do more work to set up processes to build and maintain your images. |
1919

2020
### Preparing the Kubernetes cluster to run WebLogic domains
2121

2222
Perform these steps to prepare your Kubernetes cluster to run a WebLogic domain:
2323

2424
1. Create the domain namespace(s). One or more domains can share a namespace. A single instance of the operator can manage multiple namespaces.
2525

26-
```
27-
kubectl create namespace domain-namespace-1
26+
```
27+
$ kubectl create namespace domain-namespace-1
2828
```
2929

30-
Replace `domain-namespace-1` with name you want to use. The name must follow standard Kubernetes naming conventions, i.e. lower case,
30+
Replace `domain-namespace-1` with name you want to use. The name must follow standard Kubernetes naming conventions, that is, lower case,
3131
numbers and hyphens.
3232

33-
1. Create a Kubernetes secret containing the Administration Server boot credentials. You can do this manually or using
33+
1. Create a Kubernetes secret containing the Administration Server boot credentials. You can do this manually or using
3434
[the provided sample](/kubernetes/samples/scripts/create-weblogic-domain-credentials/README.md). To create
35-
the secret manually, use this command:
36-
37-
```
38-
kubectl -n domain-namespace-1 \
35+
the secret manually, use this command:
36+
37+
```
38+
$ kubectl -n domain-namespace-1 \
3939
create secret generic domain1-weblogic-credentials \
4040
--from-literal=username=weblogic \
4141
--from-literal=password=welcome1
4242
```
43-
43+
4444
Replace `domain-namespace-1` with the namespace that the domain will be in.
4545
Replace `domain1-weblogic-credentials` with the name of the secret. The operator expects the secret name to be
46-
the `domainUID` followed by the literal string `-weblogic-credentials` and many of the samples assume this name.
47-
Replace the string `weblogic` in the third line with the username for the administrative user.
46+
the `domainUID` followed by the literal string `-weblogic-credentials` and many of the samples assume this name.
47+
Replace the string `weblogic` in the third line with the user name for the administrative user.
4848
Replace the string `welcome1` in the fourth line with the password.
49-
49+
5050
1. Optionally, [create a PV & persistent volume claim (PVC)](kubernetes/samples/scripts/create-weblogic-domain-pv-pvc/README.md) which can hold the domain home, logs, and application binaries.
51-
Even if you put your domain in a Docker image, you may wish to put the logs on a persistent volume so that they are avilable after the Pods terminate.
51+
Even if you put your domain in a Docker image, you may wish to put the logs on a persistent volume so that they are avilable after the pods terminate.
5252
This may be instead of, or as well as, other approaches like streaming logs into Elasticsearch.
5353
1. [Configure load balancer(s)](kubernetes/samples/charts/README.md) to manage access to any WebLogic clusters.
5454

@@ -57,23 +57,23 @@ Perform these steps to prepare your Kubernetes cluster to run a WebLogic domain:
5757
Please be aware of the following important considerations for WebLogic domains
5858
running in Kubernetes.
5959

60-
* Channel Listen Addresses in a configuration must either be left completely unset (e.g. not set to anything), or must be set to the exact required value, which will be in the form of the `domainUID`
60+
* Channel listen addresses in a configuration either must be left completely unset (for example, not set to anything), or must be set to the exact required value, which will be in the form of the `domainUID`
6161
followed by a hyphen and then the server name (with all lower case, underscores converted to dashes). For example `domain1-admin-server`. This includes default, SSL, admin, and custom channels.
62-
* If you choose to expose any WebLogic channels outside the Kubernetes cluster, e.g. the administration port or a T3 channel to
63-
allow WLST access, you need to ensure that you allocate each channel a unique port number across the entire
64-
Kubernetes cluster. If you expose the administration port in each WebLogic domain in the Kubernetes cluster, then each one must
62+
* If you choose to expose any WebLogic channels outside the Kubernetes cluster, for example, the administration port or a T3 channel to
63+
allow WLST access, you need to ensure that you allocate each channel a unique port number across the entire
64+
Kubernetes cluster. If you expose the administration port in each WebLogic domain in the Kubernetes cluster, then each one must
6565
have a different port. This is required because `NodePorts` are used to expose channels outside the Kubernetes cluster.
66-
* If using a `hostPath` persistent volume, then it must be available on all worker nodes in the cluster and have read/write/many permissions for all container/pods in the WebLogic Server deployment. Be aware
67-
that many cloud provider's volume providers may no support volumes across availability zones. You may want to use NFS or a clustered file system to work around this limitation.
66+
* If using a `hostPath` persistent volume, then it must be available on all worker nodes in the cluster and have read/write/many permissions for all container/pods in the WebLogic Server deployment. Be aware
67+
that many cloud provider's volume providers may not support volumes across availability zones. You may want to use NFS or a clustered file system to work around this limitation.
6868

6969
The following features are not certified or supported in this release:
7070

71-
* Whole Server Migration,
72-
* Consensus Leasing,
73-
* Node Manager (although it is used internally for the liveness probe and to start WebLogic Server instances),
74-
* Multicast,
75-
* Multitenancy, and
76-
* Production redeployment.
71+
* Whole Server Migration
72+
* Consensus Leasing
73+
* Node Manager (although it is used internally for the liveness probe and to start WebLogic Server instances)
74+
* Multicast
75+
* Multitenancy
76+
* Production redeployment
7777

7878
Please consult My Oracle Support Doc ID 2349228.1 for up-to-date information about the features of WebLogic Server that are supported in Kubernetes environments.
7979

@@ -86,10 +86,10 @@ Please see [this page](creating-domain.md) for information about creating and ma
8686

8787
You can modify the WebLogic domain configuration for both the "domain in persistent volume" and the "domain in image" options before deploying a domain resource:
8888

89-
* When the domain is in a persistent volume, you can use WLST or WDT to change the configuration, or
89+
* When the domain is in a persistent volume, you can use WLST or WDT to change the configuration.
9090
* For either case you can use [configuration overrides](config-overrides.md).
9191

92-
Configuration overrides allow changing a configuration without modifying its original `config.xml` or system resource xml files, and also support parameterizing overrides so that you can inject values into them from Kubernetes secrets. For example, you can inject database usernames, passwords, and URLs that are stored in a secret.
92+
Configuration overrides allow changing a configuration without modifying its original `config.xml` or system resource XML files, and also support parameterizing overrides so that you can inject values into them from Kubernetes secrets. For example, you can inject database user names, passwords, and URLs that are stored in a secret.
9393

9494
### Managing lifecycle operations including shutting down and deleting domains
9595

@@ -98,10 +98,9 @@ See [Starting, stopping and restarting servers](server-lifecycle.md).
9898

9999
### Scaling clusters
100100

101-
The operator allows you to initiate scaling of clusters in various ways:
101+
The operator let's you initiate scaling of clusters in various ways:
102102

103103
* [Using kubectl to edit the domain resource](scaling.md#on-demand-updating-the-domain-resource-directly)
104104
* [Using the operator's REST APIs](scaling.md#calling-the-operators-rest-scale-api)
105105
* [Using WLDF policies](scaling.md#using-a-wldf-policy-rule-and-script-action-to-call-the-operators-rest-scale-api)
106106
* [Using a Prometheus action](scaling.md#using-a-prometheus-alert-action-to-call-the-operators-rest-scale-api)
107-

0 commit comments

Comments
 (0)