Skip to content

Commit 288bb7f

Browse files
review and edit (#2114)
1 parent 4e82c40 commit 288bb7f

File tree

17 files changed

+44
-41
lines changed

17 files changed

+44
-41
lines changed

docs-source/content/faq/resource-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ Note that some Kubernetes environments may not allow changing the CPU management
166166
#### Measuring JVM heap, Pod CPU, and Pod memory
167167
You can monitor JVM heap, Pod CPU, and Pod memory using Prometheus and Grafana. Also, see [Tools for Monitoring Resources](https://kubernetes.io/docs/tasks/debug-application-cluster/resource-usage-monitoring/) in the Kubernetes documentation.
168168

169-
#### References:
169+
#### References
170170
1. [Managing Resources for Containers](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) in the Kubernetes documentation.
171171
1. [Assign Memory Resources to Containers and Pods](https://kubernetes.io/docs/tasks/configure-pod-container/assign-memory-resource) in the Kubernetes documentation.
172172
1. [Assign CPU Resources to Containers and Pods](https://kubernetes.io/docs/tasks/configure-pod-container/assign-cpu-resource/) in the Kubernetes documentation.

docs-source/content/quickstart/install.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@ Create a namespace for the ingress controller.
2222
$ kubectl create namespace traefik
2323
```
2424

25-
Use the [values.yaml](http://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/charts/traefik/values.yaml) in the sample but set `kubernetes.namespaces` specifically.
25+
Use the [values.yaml](http://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/charts/traefik/values.yaml) file in the sample but set `kubernetes.namespaces` specifically.
2626

2727

2828
```bash
2929
$ helm install traefik-operator traefik/traefik \
3030
--namespace traefik \
3131
--values kubernetes/samples/charts/traefik/values.yaml \
32-
--set "kubernetes.namespaces={traefik}"
32+
--set "kubernetes.namespaces={traefik}"
3333
```
3434

3535
#### Install the operator.
@@ -58,9 +58,9 @@ $ helm install traefik-operator traefik/traefik \
5858
--set "domainNamespaceLabelSelector=weblogic-operator\=enabled" \
5959
--wait
6060
```
61-
61+
6262
This Helm release deploys the operator and configures it to manage Domains in any Kubernetes namespace with the label, "weblogic-operator=enabled". Because of the "enableClusterRoleBinding" option, the operator will have privilege in all Kubernetes namespaces. This simplifies adding and removing managed namespaces as you will only have to adjust labels on those namespaces. If you want to limit the operator's privilege to just the set of namespaces that it will manage, then remove this option, but this will mean that the operator only has privilege in the set of namespaces that match the selection strategy at the time the Helm release was installed or upgraded.
63-
63+
6464
**Note:** Prior to version 3.1.0, the operator's Helm chart only supported configuring the namespaces that the operator would manage using a list of namespaces. The chart now supports specifying namespaces using a label selector, regular expression, or list. Review the available [Helm configuration values]({{< relref "/userguide/managing-operators/using-the-operator/using-helm#operator-helm-configuration-values" >}}).
6565
6666
4. Verify that the operator's pod is running, by listing the pods in the operator's namespace. You should see one

docs-source/content/samples/simple/azure-kubernetes-service/_index.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ AKS is a managed Kubernetes Service that lets you quickly deploy and manage Kube
2424

2525
#### Prerequisites
2626

27-
This sample assumes the following prerequisite environment setup.
27+
This sample assumes the following prerequisite environment setup:
2828

2929
* Operating System: GNU/Linux, macOS or [WSL for Windows 10](https://docs.microsoft.com/windows/wsl/install-win10).
3030
* [Git](https://git-scm.com/downloads), use `git --version` to test if `git` works. This document was tested with version 2.17.1.
@@ -66,7 +66,7 @@ Found an existing application instance of "5pn2s201-nq4q-43n1-z942-p9r9571qr3rp"
6666
Insufficient privileges to complete the operation.
6767
```
6868

69-
The problem may be a pre-existing service principal with the same name. Either delete the other Service Principal or pick a different name.
69+
The problem may be a pre-existing service principal with the same name. Either delete the other service principal or pick a different name.
7070

7171
Successful output will look like the following:
7272

@@ -846,11 +846,11 @@ Now that you have WLS running in AKS, you can test the cluster by deploying the
846846

847847
Next you will need to start the application:
848848

849-
1. Go to Deployments
850-
1. Select Control
851-
1. Select testwebapp
852-
1. Select Start
853-
1. Select Servicing all requests
849+
1. Go to Deployments.
850+
1. Select Control.
851+
1. Select `testwebapp`.
852+
1. Select Start.
853+
1. Select Servicing all requests.
854854
1. Select Yes.
855855

856856
After the successful deployment, go to the application through the domain1-cluster-1-lb external IP.
@@ -867,16 +867,17 @@ The test application will list the server host and server IP on the page.
867867

868868
#### Access WebLogic Server logs
869869

870-
The logs are stored in the Azure file share. Follow these steps to access the log:
870+
The logs are stored in the Azure file share. Follow these steps to access the logs:
871871

872872
1. Go to the [Azure Portal](https://ms.portal.azure.com).
873873
1. Go to your resource group.
874874
1. Open the storage account.
875875
1. In the "File service" section of the left panel, select File shares.
876-
1. Select the file share name (e.g. weblogic in this example).
876+
1. Select the file share name (for example, `weblogic` in this example).
877877
1. Select logs.
878878
1. Select domain1.
879-
1. WebLogic Server logs are listed in the folder.
879+
880+
WebLogic Server logs are listed in the folder.
880881

881882
![WebLogic Server Logs](screenshot-logs.png)
882883

@@ -996,9 +997,9 @@ The logs are stored in the Azure file share. Follow these steps to access the lo
996997
997998
Some suggestions for debugging problems with Model in Image after your Domain YAML file is deployed are found in the section on [debugging](/weblogic-kubernetes-operator/userguide/managing-domains/model-in-image/debugging/).
998999
999-
#### Clean Up Resources
1000+
#### Clean up resources
10001001
1001-
The output from the `create-domain-on-aks.sh` script includes a statement about the Azure resources created by the script. To delete the cluster and free all related resources, simply delete the resource groups. The output will list the resource groups, such as.
1002+
The output from the `create-domain-on-aks.sh` script includes a statement about the Azure resources created by the script. To delete the cluster and free all the related resources, simply delete the resource groups. The output will list the resource groups, such as:
10021003
10031004
```bash
10041005
The following Azure Resouces have been created:

docs-source/content/samples/simple/domains/manually-create-domain/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ In some circumstances you may wish to manually create your domain custom resourc
1010
Docker image containing your domain and the specific patches that it requires, then this approach will probably
1111
be the most suitable for your needs.
1212

13-
To create the domain custom resource, just make a copy of the sample [domain.yaml](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/scripts/create-weblogic-domain/manually-create-domain/domain.yaml), and then edit
13+
To create the domain custom resource, just make a copy of the sample [domain.yaml](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/scripts/create-weblogic-domain/manually-create-domain/domain.yaml) file, and then edit
1414
it using the instructions provided in the comments in that file.
1515
When it is ready, you can create the domain in your Kubernetes cluster using the command:
1616

docs-source/content/samples/simple/tanzu-kubernetes-service/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ TKG is a managed Kubernetes Service that lets you quickly deploy and manage Kube
2323

2424
#### Prerequisites
2525

26-
This sample assumes the following prerequisite environment setup.
26+
This sample assumes the following prerequisite environment setup:
2727

2828
* WebLogic Server Kubernetes Operator: This document was tested with version v3.1.0.
2929
* Operating System: GNU/Linux.

docs-source/content/userguide/cicd/how-to-copy-domains.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 5
66
description: "How to copy domains."
77
---
88

9-
The recommended approach to save a copy of a Domain in Image or Domain in PV
9+
The recommended approach to save a copy of a Domain in Image or Domain in PV
1010
domain is to simply ZIP (or tar)
1111
the domain directory. However, there is a very important caveat with this
1212
recommendation - when you unzip the domain, it must go back into exactly
@@ -17,7 +17,7 @@ The best practice/recommended approach is to create a "primordial domain"
1717
which does not contain any applications or resources,
1818
and to create a ZIP file of this domain before starting any servers.
1919

20-
> **The domain ZIP must be created before starting servers.**
20+
> **The domain ZIP file must be created before starting servers.**
2121
2222
When servers are started the first time, they will encrypt various other data.
2323
Make sure that you create the ZIP file before starting servers for the first time.

docs-source/content/userguide/cicd/tools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ that you supply a domain home.
3030
Other than the tools themselves, there are three components to the WDT tools:
3131

3232
- *The Domain Model* - Metadata model describing the desired domain.
33-
The metadata domain model can be written in YAML or JSON and is documented [here](https://github.com/oracle/weblogic-deploy-tooling#the-metadata-model).
33+
The metadata domain model can be written in YAML or JSON and is documented [here](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/model.md).
3434
- *The Archive ZIP* - Binaries to supplement the model.
3535
All binaries needed to supplement the model must be specified in an archive
3636
file, which is just a ZIP file with a specific directory structure. Optionally,

docs-source/content/userguide/introduction/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ It is worth providing some background information on why this approach was adopt
7878

7979
The external state approach allows the operator to treat the Docker images as essentially immutable, read-only, binary images. This means that the image needs to be pulled only once, and that many domains can share the same image. This helps to minimize the amount of bandwidth and storage needed for WebLogic Server Docker images.
8080

81-
This approach also eliminates the need to manage any state created in a running container, because all of the state that needs to be preserved is written into either the persistent volume or a database back end. The containers and pods are completely throwaway and can be replaced with new containers and pods, as necessary. This makes handling failures and rolling restarts much simpler because there is no need to preserve any state inside a running container.
81+
This approach also eliminates the need to manage any state created in a running container, because all of the state that needs to be preserved is written into either the persistent volume or a database backend. The containers and pods are completely throwaway and can be replaced with new containers and pods, as necessary. This makes handling failures and rolling restarts much simpler because there is no need to preserve any state inside a running container.
8282

8383
When users wish to apply a binary patch to WebLogic Server, it is necessary to create only a single new, patched Docker image. If desired, any domains that are running may be updated to this new patched image with a rolling restart, because there is no state in the containers.
8484

docs-source/content/userguide/managing-domains/_index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -88,20 +88,20 @@ The following features are **not** certified or supported in this release:
8888
For up-to-date information about the features of WebLogic Server that are supported in Kubernetes environments, see My Oracle Support Doc ID 2349228.1.
8989

9090
### Meet Kubernetes resource name restrictions
91-
91+
9292
Kubernetes requires that the names of some resource types follow the DNS label standard as defined in [DNS Label Names](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names) and [RFC 1123](https://tools.ietf.org/html/rfc1123). This requirement restricts the characters that are allowed in the names of these resources, and also limits the length of these names to no more than 63 characters.
9393

9494
The following is a list of such Kubernetes resources that the operator generates when a domain resource is deployed, including how their names are constructed.
95-
95+
9696
* A domain introspector job named `<domainUID>-<introspectorJobNameSuffix>`. The default suffix is `-introspector`, which can be overridden using the operator's Helm configuration `introspectorJobNameSuffix` (see [WebLogic domain management]({{< relref "/userguide/managing-operators/using-the-operator/using-helm#weblogic-domain-management" >}})).
9797
* A ClusterIP type service and a pod for each WebLogic Server named `<domainUID>-<serverName>`.
9898
* A ClusterIP type service for each WebLogic cluster named `<domainUID>-cluster-<clusterName>`.
9999
* An optional NodePort type service, also known as an external service, for the WebLogic Administration Server named `<domainUID>-<adminServerName>-<externalServiceNameSuffix>`. The default suffix is `-ext`, which can be overridden using the operator's Helm configuration `externalServiceNameSuffix` (see [WebLogic domain management]({{< relref "/userguide/managing-operators/using-the-operator/using-helm#weblogic-domain-management" >}})).
100100

101101
The operator puts in place certain validation checks and conversions to prevent these resources from violating Kubernetes restrictions.
102102
* All the names previously described can contain only the characters `A-Z`, `a-z`, `0-9`, `-`, or `_`, and must start and end with an alphanumeric character. Note that when generating pod and service names, the operator will convert configured names to lower case and substitute a hyphen (`-`) for each underscore (`_`).
103-
* A `domainUID` is required to be no more than 45 characters.
104-
* WebLogic domain configuration names, such as the cluster names, Administration Server name, and Managed Server names must be kept to a legal length so that the resultant resource names do not exceed Kubernetes' limits.
103+
* A `domainUID` is required to be no more than 45 characters.
104+
* WebLogic domain configuration names, such as the cluster names, Administration Server name, and Managed Server names must be kept to a legal length so that the resultant resource names do not exceed Kubernetes' limits.
105105

106106
When a domain resource or WebLogic domain configuration violates the limits, the domain startup will fail, and actual validation errors are reported in the domain resource's status.
107107

@@ -148,7 +148,7 @@ See [Starting and stopping]({{< relref "/userguide/managing-domains/domain-lifec
148148

149149
The operator let's you initiate scaling of clusters in various ways:
150150

151-
* [Using kubectl to edit the Domain resource]({{< relref "/userguide/managing-domains/domain-lifecycle/scaling#on-demand-updating-the-domain-resource-directly" >}})
151+
* [Using kubectl to edit the Domain resource]({{< relref "/userguide/managing-domains/domain-lifecycle/scaling#on-demand-updating-the-domain-directly" >}})
152152
* [Using the operator's REST APIs]({{< relref "/userguide/managing-domains/domain-lifecycle/scaling#calling-the-operators-rest-scale-api" >}})
153153
* [Using WLDF policies]({{< relref "/userguide/managing-domains/domain-lifecycle/scaling#using-a-wldf-policy-rule-and-script-action-to-call-the-operators-rest-scale-api" >}})
154154
* [Using a Prometheus action]({{< relref "/userguide/managing-domains/domain-lifecycle/scaling#using-a-prometheus-alert-action-to-call-the-operators-rest-scale-api" >}})

docs-source/content/userguide/managing-domains/configoverrides/_index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title = "Configuration overrides"
33
date = 2019-02-23T16:45:16-05:00
44
weight = 5
55
pre = "<b> </b>"
6-
+++
6+
+++
77

88
#### Contents
99

@@ -208,7 +208,9 @@ Two types of macros are supported, environment variable macros and secret macros
208208

209209
The secret macro `SECRETNAME` field must reference the name of a Kubernetes Secret, and the `SECRETKEY` field must reference a key within that Secret. For example, if you have created a Secret named `dbuser` with a key named `username` that contains the value `scott`, then the macro `${secret:dbuser.username}` will be replaced with the word `scott` before the template is copied into its WebLogic Server instance Pod.
210210

211-
**SECURITY NOTE: Use the `:encrypt` suffix in a secret macro to encrypt its replacement value with the WebLogic WLST `encrypt` command (instead of leaving it at its plain text value). This is useful for overriding MBean attributes that expect encrypted values, such as the `password-encrypted` field of a data source, and is also useful for ensuring that a custom overrides configuration file the operator places in the domain home does not expose passwords in plain-text.**
211+
{{% notice warning %}}
212+
**SECURITY NOTE**: Use the `:encrypt` suffix in a secret macro to encrypt its replacement value with the WebLogic WLST `encrypt` command (instead of leaving it at its plain text value). This is useful for overriding MBean attributes that expect encrypted values, such as the `password-encrypted` field of a data source, and is also useful for ensuring that a custom overrides configuration file the operator places in the domain home does not expose passwords in plain-text.
213+
{{% /notice %}}
212214

213215
#### Override template syntax special requirements
214216

@@ -469,5 +471,5 @@ when `spec.logHome` is configured and `spec.logHomeEnabled` is true.
469471
* WebLogic Server instances monitor the files in `optconfig` and dynamically update the active configuration based on the current contents of the configuration overrides files.
470472
* Otherwise, if the `overridesDistributionStrategy` is ON_RESTART, then the updated files at the ConfigMap's mount point are not copied to `optconfig` while the WebLogic Server instance is running and, therefore, don't affect the active configuration.
471473
472-
{{% notice note %}} Changes to configuration overrides distributed to running WebLogic Server instances can only take effect if the corresponding WebLogic configuration MBean attribute is "dynamic". For instance, the Data Source "passwordEncrypted" attribute is dynamic while the "Url" attribute is non-dynamic.
474+
{{% notice note %}} Changes to configuration overrides distributed to running WebLogic Server instances can only take effect if the corresponding WebLogic configuration MBean attribute is "dynamic". For instance, the Data Source `passwordEncrypted` attribute is dynamic while the `Url` attribute is non-dynamic.
473475
{{% /notice %}}

0 commit comments

Comments
 (0)