Skip to content

Commit fcc2a82

Browse files
committed
Merge branch 'develop' into sitconfigtests2
2 parents d681bc6 + 0b05f28 commit fcc2a82

File tree

35 files changed

+120
-178
lines changed

35 files changed

+120
-178
lines changed

docs-source/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Oracle WebLogic Server Kubernetes Operator Documentation
2+
3+
***
4+
For information on updating and contributing to the operator
5+
documentation, see the _Documentation_ section of the
6+
[Developer Guide](https://oracle.github.io/weblogic-kubernetes-operator/developerguide/documentation)
7+
***

docs-source/content/developerguide/documentation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ update to the documentation, follow this process:
2424
2525
3. Make your documentation updates by editing the source files in
2626
`docs-source/content`.
27+
{{% notice note %}}
28+
Make sure you only check in the changes from the `docs-source/content` area;
29+
do not build the site and check in the static files.
30+
{{% /notice %}}
2731
2832
4. If you wish to view your changes you can run the site locally using
2933
these commands; the site will be available on the URL shown here:
@@ -38,7 +42,3 @@ and submit a pull request. Remember to follow the guidelines in the
3842
[CONTRIBUTING](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/CONTRIBUTING.md)
3943
document.
4044
41-
{{% notice note %}}
42-
Make sure you only check in your source code changes in `docs-source`; do
43-
not build the site and check in the static files.
44-
{{% /notice %}}

docs-source/content/quickstart/cleanup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ weight: 7
1313
```bash
1414
$ helm delete --purge sample-domain1-ingress
1515
```
16-
1. Remove the domain resources by using the sample [`delete-weblogic-domain-resources`](http://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/scripts/delete-domain/delete-weblogic-domain-resources.sh) script.
16+
1. Remove the domain resources by using the sample [`delete-weblogic-domain-resources`](http://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/scripts/delete-domain/delete-weblogic-domain-resources.sh) script:
1717

1818
```bash
1919
$ kubernetes/samples/scripts/delete-domain/delete-weblogic-domain-resources.sh -d sample-domain1

docs-source/content/samples/simple/domains/domain-home-in-image/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ The script will perform the following steps:
5959
* Build a Docker image based on the Docker sample, [Example Image with a WebLogic Server Domain using the Oracle WebLogic Scripting Tooling (WLST)](https://github.com/oracle/docker-images/tree/master/OracleWebLogic/samples/12213-domain-home-in-image) or [Example Image with a WebLogic Server Domain using the Oracle WebLogic Deploy Tooling (WDT)](https://github.com/oracle/docker-images/tree/master/OracleWebLogic/samples/12213-domain-home-in-image-wdt). It will create a sample WebLogic Server domain in the Docker image.
6060
{{% notice warning %}}
6161
Oracle strongly recommends storing the image containing the domain home as private
62-
in the registry (e.g. Oracle Cloud Infrastructure Registry, Docker Hub, etc.) as
62+
in the registry (for example, Oracle Cloud Infrastructure Registry, Docker Hub, and such) as
6363
this image contains sensitive information about the domain including keys and
64-
credentials that are used to access external resources (e.g. datasource password).
64+
credentials that are used to access external resources (for example, data source password).
6565
For more information about
6666
[domain home in image protection]({{<relref "/security/domain-security/image-protection.md#weblogic-domain-in-docker-image-protection">}}),
6767
see the ***Security*** section.

docs-source/content/samples/simple/domains/domain-home-on-pv/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,8 @@ The following parameters can be provided in the inputs file.
103103
| `productionModeEnabled` | Boolean indicating if production mode is enabled for the domain. | `true` |
104104
| `serverStartPolicy` | Determines which WebLogic Servers will be started up. Legal values are `NEVER`, `IF_NEEDED`, `ADMIN_ONLY`. | `IF_NEEDED` |
105105
| `t3ChannelPort` | Port for the T3 channel of the NetworkAccessPoint. | `30012` |
106-
| `t3PublicAddress` | Public address for the T3 channel. This should be set to the public address of the Kubernetes cluster. This would normally be a load balancer address. <p/>For development environments only: In a single server (all-in-one) Kubernetes deployment, this may be set to the address of the master, or at the very least, it must be set to the address of one of the worker nodes. | If not provided, the script will attempt to set it to the IP address of the kubernetes cluster |
107-
| `weblogicCredentialsSecretName` | Name of the Kubernetes secret for the Administration Server's username and password. If not specified, the value is derived from the `domainUID` as `<domainUID>-weblogic-credentials`. | `domain1-weblogic-credentials` |
106+
| `t3PublicAddress` | Public address for the T3 channel. This should be set to the public address of the Kubernetes cluster. This would normally be a load balancer address. <p/>For development environments only: In a single server (all-in-one) Kubernetes deployment, this may be set to the address of the master, or at the very least, it must be set to the address of one of the worker nodes. | If not provided, the script will attempt to set it to the IP address of the Kubernetes cluster |
107+
| `weblogicCredentialsSecretName` | Name of the Kubernetes secret for the Administration Server's user name and password. If not specified, the value is derived from the `domainUID` as `<domainUID>-weblogic-credentials`. | `domain1-weblogic-credentials` |
108108
| `weblogicImagePullSecretName` | Name of the Kubernetes secret for the Docker Store, used to pull the WebLogic Server image. | `docker-store-secret` |
109109

110110
Note that the names of the Kubernetes resources in the generated YAML files may be formed with the value of some of the properties specified in the `create-inputs.yaml` file. Those properties include the `adminServerName`, `clusterName` and `managedServerNameBase`. If those values contain any characters that are invalid in a Kubernetes service name, those characters are converted to valid values in the generated YAML files. For example, an uppercase letter is converted to a lowercase letter and an underscore `("_")` is converted to a hyphen `("-")`.

docs-source/content/samples/simple/storage/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ A PV and PVC can be shared by multiple WebLogic domains or dedicated to a partic
1414

1515
#### Prerequisites
1616

17-
Please read the [Persistent storage]({{< relref "/userguide/managing-domains/persistent-storage/_index.md" >}}) document before proceeding.
17+
Before you begin, read this document, [Persistent storage]({{< relref "/userguide/managing-domains/persistent-storage/_index.md" >}}).
1818

1919
#### Using the scripts to create a PV and PVC
2020

@@ -60,7 +60,7 @@ The PV and PVC creation inputs can be customized by editing the `create-pv-pvc-i
6060
| `domainUID` | ID of the domain resource to which the generated PV and PVC will be dedicated. Leave it empty if the PV and PVC are going to be shared by multiple domains. | no default |
6161
| `namespace` | Kubernetes namespace to create the PVC. | `default` |
6262
| `baseName` | Base name of the PV and PVC. The generated PV and PVC will be `<baseName>-pv` and `<baseName>-pvc` respectively. | `weblogic-sample` |
63-
| `weblogicDomainStoragePath` | Physical path of the storage for the PV. When `weblogicDomainStorageType` is set to `HOST_PATH`, this value should be set the to path to the domain storage on the Kubernetes host. When `weblogicDomainStorageType` is set to NFS, then `weblogicDomainStorageNFSServer` should be set to the IP address or name of the DNS server, and this value should be set to the exported path on that server. Note that the path where the domain is mounted in the WebLogic containers is not affected by this setting, that is determined when you create your domain. | no default |
63+
| `weblogicDomainStoragePath` | Physical path of the storage for the PV. When `weblogicDomainStorageType` is set to `HOST_PATH`, this value should be set the to path to the domain storage on the Kubernetes host. When `weblogicDomainStorageType` is set to NFS, then `weblogicDomainStorageNFSServer` should be set to the IP address or name of the DNS server, and this value should be set to the exported path on that server. Note that the path where the domain is mounted in the WebLogic containers is not affected by this setting; that is determined when you create your domain. | no default |
6464
| `weblogicDomainStorageReclaimPolicy` | Kubernetes PVC policy for the persistent storage. The valid values are: `Retain`, `Delete`, and `Recycle`. | `Retain` |
6565
| `weblogicDomainStorageSize` | Total storage allocated for the PVC. | `10Gi` |
6666
| `weblogicDomainStorageType` | Type of storage. Legal values are `NFS` and `HOST_PATH`. If using `NFS`, `weblogicDomainStorageNFSServer` must be specified. | `HOST_PATH` |
@@ -180,7 +180,7 @@ spec:
180180

181181
#### Verify the PV and PVC objects
182182

183-
You can use this command to verify the persistent volume was created, note that the `Status` field
183+
You can use this command to verify the persistent volume was created. Note that the `Status` field
184184
should have the value `Bound`, indicating the that persistent volume has been claimed:
185185

186186
```

docs-source/content/security/secrets.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,24 @@ description: "Kubernetes secrets for the WebLogic operator"
88
#### Contents
99
* [WebLogic domain credentials secret](#weblogic-domain-credentials-secret)
1010
* [WebLogic domain image pull secret](#weblogic-domain-image-pull-secret)
11+
* [WebLogic operator configuration override secrets](#weblogic-operator-configuration-override-secrets)
1112
* [WebLogic operator external REST interface secret](#weblogic-operator-external-rest-interface-secret)
1213
* [WebLogic operator internal REST interface secret](#weblogic-operator-internal-rest-interface-secret)
1314

1415
#### WebLogic domain credentials secret
1516

16-
The credential for the WebLogic domain is kept in a Kubernetes `Secret` that
17-
follows the pattern `<domainUID>-weblogic-credentials`, where `<domainUID>` is
17+
The credentials for the WebLogic domain are kept in a Kubernetes `Secret` where the name of
18+
the secret is specified using `webLogicCredentialsSecret` in the WebLogic `Domain` resource.
19+
Also, the domain credentials secret must be created in the namespace where the `Domain` will be running.
20+
21+
{{% notice note %}}
22+
For an example of a WebLogic domain resource using `webLogicCredentialsSecret`,
23+
see [Docker Image Protection]({{<relref "/security/domain-security/image-protection.md#1-use-imagepullsecrets-with-the-domain-resource">}}).
24+
{{% /notice %}}
25+
26+
The samples supplied with the WebLogic operator use a naming convention that follows
27+
the pattern `<domainUID>-weblogic-credentials`, where `<domainUID>` is
1828
the unique identifier of the domain, for example, `domain1-weblogic-credentials`.
19-
The `Secret` is created in the namespace where the `Domain` will be running.
2029

2130
If the WebLogic domain will be started in `domain1-ns` and the `<domainUID>` is `domain1`,
2231
an example of creating a Kubernetes `generic secret` is as follows:
@@ -67,7 +76,20 @@ Kubernetes `Secret` that holds the registry credentials.
6776

6877
{{% notice info %}}
6978
For more information, see [Docker Image Protection]({{<relref "/security/domain-security/image-protection.md#weblogic-domain-in-docker-image-protection">}})
70-
under **Domain Security**.
79+
under **Domain security**.
80+
{{% /notice %}}
81+
82+
#### WebLogic operator configuration override secrets
83+
84+
The WebLogic operator supports embedding macros within configuration override templates
85+
that reference Kubernetes secrets. These Kubernetes secrets can be created with any name in the
86+
namespace where the `Domain` will be running. The Kubernetes secret names are
87+
specified using `configOverrideSecrets` in the WebLogic `Domain` resource.
88+
89+
{{% notice info %}}
90+
For more information, see
91+
[Configuration overrides]({{<relref "/userguide/managing-domains/configoverrides/_index.md#how-do-you-specify-overrides">}})
92+
under **User Guide**.
7193
{{% /notice %}}
7294

7395
#### WebLogic operator external REST interface secret
@@ -84,7 +106,7 @@ under **Securty**.
84106
#### WebLogic operator internal REST interface secret
85107

86108
The operator exposes an internal REST HTTPS interface with a self-signed certificate.
87-
The certificate is kept in a Kubernetes `ConfigMap` with the name `weblogic-operator-cm ` using the key `internalOperatorCert`.
109+
The certificate is kept in a Kubernetes `ConfigMap` with the name `weblogic-operator-cm` using the key `internalOperatorCert`.
88110
The private key is kept in a Kubernetes `Secret` with the name `weblogic-operator-secrets` using the key `internalOperatorKey`.
89111
These Kubernetes objects are managed by the operator's Helm chart and are part of the
90112
namespace where the WebLogic operator is installed.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Introduction"
33
date: 2019-02-23T16:43:10-05:00
44
weight: 2
5-
description: "Learn about the operator's design, architecture, terms, and prerequisites."
5+
description: "Learn about the operator's design, architecture, important terms, and prerequisites."
66
---
77
{{% children style="h4" description="true" %}}
88

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Demo"
33
date: 2019-02-23T20:51:59-05:00
44
draft: false
55
weight: 2
6-
description: "This video provides a demonstration of the WebLogic Server Kubernetes Operator."
6+
description: "Watch a video demonstration of the WebLogic Server Kubernetes Operator."
77
---
88

99
This video provides a demonstration of the WebLogic Server Kubernetes Operator.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 4
66
description: "The Oracle WebLogic Server Kubernetes Operator (the “operator”) is designed to fulfill a similar role to that which a human operator would fill in a traditional data center deployment. It contains a set of useful built-in knowledge about how to perform various life cycle operations on a domain correctly."
77
---
88

9-
The Oracle WebLogic Server Kubernetes Operator (the “operator”) is designed to fulfill a similar role to that which a human operator would fill in a traditional data center deployment. It contains a set of useful built-in knowledge about how to perform various life cycle operations on a domain correctly.a traditional data center deployment. It contains a set of useful built-in knowledge about how to perform various life cycle operations on a domain correctly.
9+
The Oracle WebLogic Server Kubernetes Operator (the “operator”) is designed to fulfill a similar role to that which a human operator would fill in a traditional data center deployment. It contains a set of useful built-in knowledge about how to perform various life cycle operations on a domain correctly.
1010

1111
Human operators are normally responsible for starting and stopping environments, initiating backups, performing scaling operations, performing manual tasks associated with disaster recovery and high availability needs and coordinating actions with other operators in other data centers. It is envisaged that the operator will have similar responsibilities in a Kubernetes environment.
1212

0 commit comments

Comments
 (0)