Skip to content

Commit 3d144c4

Browse files
update doc for K8s resource names (#1641)
* update doc for K8s resource names * fix typo
1 parent be16a25 commit 3d144c4

File tree

54 files changed

+284
-287
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+284
-287
lines changed

docs-source/content/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Oracle is finding ways for organizations using WebLogic Server to run important workloads, to move those workloads into the cloud. By certifying on industry standards, such as Docker and Kubernetes, WebLogic now runs in a cloud neutral infrastructure. In addition, we've provided an open source Oracle WebLogic Server Kubernetes Operator (the “operator”) which has several key features to assist you with deploying and managing WebLogic domains in a Kubernetes environment. You can:
44

5-
* Create WebLogic domains in a Kubernetes persistent volume. This persistent volume can reside in an NFS file system or other Kubernetes volume types.
5+
* Create WebLogic domains in a Kubernetes PersistentVolume. This PersistentVolume can reside in an NFS file system or other Kubernetes volume types.
66
* Create a WebLogic domain in a Docker image.
77
* Override certain aspects of the WebLogic domain configuration.
88
* Define WebLogic domains as a Kubernetes resource (using a Kubernetes custom resource definition).
@@ -34,7 +34,7 @@ This release candidate was published on May 8, 2020. There may be additional re
3434

3535
This release candidate introduces _non-backward compatible_ changes. This release candidate cannot be run in the same
3636
cluster as another release of the operator. You can upgrade from 2.5.0 to 3.0.0-rc1 without needing to restart or recreate
37-
any existing domains. However, please note that we do plan to support running the final 3.0.0
37+
any existing domains. However, please note that we _do_ plan to support running the final 3.0.0
3838
release in the same cluster with at least one 2.x release of the operator to allow for staged migration.
3939

4040
The feature changes in 3.0.0-rc1 are:
@@ -45,15 +45,15 @@ The feature changes in 3.0.0-rc1 are:
4545
the same model and automated updating of the domain based on model changes.
4646
The operator automates management of the domain encryption keys to ensure
4747
that they are not changed during domain updates.
48-
A [sample]({{% relref "/samples/simple/domains/model-in-image" %}}) is also provided that
48+
We provide a [sample]({{% relref "/samples/simple/domains/model-in-image" %}}) that
4949
demonstrates the key use cases for this feature.
5050
* Support for running the operator on Kubernetes 1.16.
5151
* Deprecation and removal of support for running the operator on Kubernetes 1.13
5252
and earlier versions.
5353
* Deprecation and removal of support for Helm 2.x. Helm 2.x uses the "tiller" pod
5454
which needs to run with elevated privileges (`cluster-admin` or very close to that)
5555
and which could be a vector for a privilege escalation attack. Helm 3.x removes
56-
tiller and does not create the same exposure.
56+
Tiller and does not create the same exposure.
5757

5858
***
5959

docs-source/content/developerguide/asynchronous-call-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 7
66
---
77

88

9-
Our expectation is that customers will task the operator with managing hundreds of WebLogic domains across dozens of Kubernetes namespaces. Therefore, we have designed the operator with an efficient user-level threads pattern. We've used that pattern to implement an asynchronous call model for Kubernetes API requests. This call model has built-in support for timeouts, retries with exponential back-off, and lists that exceed the requested maximum size using the continuance functionality.
9+
Our expectation is that customers will task the operator with managing hundreds of WebLogic domains across dozens of Kubernetes Namespaces. Therefore, we have designed the operator with an efficient user-level threads pattern. We've used that pattern to implement an asynchronous call model for Kubernetes API requests. This call model has built-in support for timeouts, retries with exponential back-off, and lists that exceed the requested maximum size using the continuance functionality.
1010

1111
#### User-level thread pattern
1212

docs-source/content/faq/boot-identity-not-valid.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ When you see these kinds of errors, it means that the user name and password pro
1313
have also indicated that the WebLogic domain directory's security configuration files have changed in an incompatible way between when the operator scanned
1414
the domain directory, which occurs during the "introspection" phase, and when the server instance attempted to start. There is now a separate validation for that condition described in the [Domain secret mismatch](../domain-secret-mismatch/) FAQ entry.
1515

16-
Check that the user name and password credentials stored in the Kubernetes secret referenced by `weblogicCredentialsSecret` contain the expected values for an account with administrative privilege for the WebLogic domain.
16+
Check that the user name and password credentials stored in the Kubernetes Secret referenced by `weblogicCredentialsSecret` contain the expected values for an account with administrative privilege for the WebLogic domain.
1717
Then [stop all WebLogic Server instances](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#starting-and-stopping-servers)
1818
in the domain before restarting so that the operator will repeat its introspection and generate the corrected `boot.properties` files.

docs-source/content/faq/configmaps.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
2-
title: "Providing access to a Config Map"
2+
title: "Providing access to a ConfigMap"
33
date: 2020-01-07T15:02:28-05:00
44
draft: false
55
weight: 70
66
---
7-
> I need to provide an instance with access to a Config Map.
7+
> I need to provide an instance with access to a ConfigMap.
88
9-
Configuration files can be supplied to Kubernetes pods and jobs by a
10-
[ConfigMap](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#create-a-configmap),
9+
Configuration files can be supplied to Kubernetes Pods and Jobs by a
10+
[ConfigMap](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#create-a-configmap),
1111
which consists of a set of key-value pairs. Each entry may be accessed by one or more operator-managed nodes
1212
as a read-only text file. Access can be provided across the domain, within a single cluster, or for a single server.
13-
In each case, the access is configured within the `serverPod` element of the desired scope.
13+
In each case, the access is configured within the `serverPod` element of the desired scope.
1414

1515
For example, given
1616
a ConfigMap named `my-map` with entries `key-1` and `key-2`, you can provide access to both values as separate files
1717
in the same directory within the `cluster-1` cluster with the following
1818
in your [domain resource](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/docs/domains/Domain.md):
19-
19+
2020

2121
```
2222
clusters:
@@ -26,7 +26,7 @@ in your [domain resource](https://github.com/oracle/weblogic-kubernetes-operator
2626
- name: my-volume-1
2727
configMap:
2828
name: my-map
29-
items:
29+
items:
3030
- key: key-1
3131
path: first
3232
- key: key-2
@@ -36,8 +36,7 @@ in your [domain resource](https://github.com/oracle/weblogic-kubernetes-operator
3636
mountPath: /weblogic-operator/my
3737
3838
```
39-
This provides access to two files, found at paths `/weblogic-operator/my/first` and `/weblogic-operator/my/second`.
40-
Both a `volume` and a `volumeMount` entry are required, and must have the same name. The name of the `ConfigMap` is
39+
This provides access to two files, found at paths `/weblogic-operator/my/first` and `/weblogic-operator/my/second`.
40+
Both a `volume` and a `volumeMount` entry are required, and must have the same name. The name of the `ConfigMap` is
4141
specified in the `name` field under the `configMap` entry. The `items` entry is an array,
4242
in which each entry maps a `ConfigMap` key to a file name under the directory specified as `mountPath` under a `volumeMount`.
43-

docs-source/content/faq/domain-secret-mismatch.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ To understand the "incompatible domain security configuration" type of failure,
1717
domain directory contains a `security` subdirectory that contains a file called `SerializedSystemIni.dat`. This file contains
1818
security data to bootstrap the WebLogic domain, including a domain-specific encryption key.
1919

20-
During introspection, the operator generates a Kubernetes job that runs a pod in the domain's Kubernetes namespace and with the
21-
same Kubernetes service account that will be used later to run the Administration Server. This pod has access to the Kubernetes
20+
During introspection, the operator generates a Kubernetes Job that runs a pod in the domain's Kubernetes Namespace and with the
21+
same Kubernetes ServiceAccount that will be used later to run the Administration Server. This pod has access to the Kubernetes
2222
secret referenced by `weblogicCredentialsSecret` and encrypts these values with the domain-specific encryption key so that the
2323
secured value can be injected in to the `boot.properties` files when starting server instances.
2424

docs-source/content/faq/external-clients.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Here are the steps:
3131

3232
##### Kubernetes `NodePorts`
3333

34-
The Kubernetes `NodePorts` approach for giving external WebLogic EJB or JMS clients access to a Kubernetes hosted WebLogic cluster involves configuring a network channel on the desired WebLogic cluster that accepts T3 protocol traffic, and exposing a Kubernetes `NodePort` that redirects external network traffic on the Kubernetes nodes to the network channel.
34+
The Kubernetes `NodePorts` approach for giving external WebLogic EJB or JMS clients access to a Kubernetes hosted WebLogic cluster involves configuring a network channel on the desired WebLogic cluster that accepts T3 protocol traffic, and exposing a Kubernetes `NodePort` that redirects external network traffic on the Kubernetes Nodes to the network channel.
3535

3636

3737
{{% notice note %}} The `NodePort` approach is available only when worker nodes are accessible by the clients, for example, when they have public IP addresses. If private worker nodes are used and access to them is possible only through a load balancer or bastion, then the `NodePort` approach is not a valid option to provide access to external clients.
@@ -128,7 +128,7 @@ In this example:
128128

129129
- WebLogic binds the custom network channel to port `7999` and the default network channel to `8001`.
130130

131-
- The operator will automatically create a Kubernetes service named `DOMAIN_UID-cluster-cluster-1` for both the custom and default channel.
131+
- The operator will automatically create a Kubernetes Service named `DOMAIN_UID-cluster-cluster-1` for both the custom and default channel.
132132

133133
- Internal clients running in the same Kubernetes cluster as the channel can access the cluster using `t3://DOMAIN_UID-cluster-cluster-1:8001`.
134134

docs-source/content/faq/namespace-management.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ draft: false
55
weight: 1
66
---
77

8-
Each operator deployment manages a number of Kubernetes namespaces. For more information, see [Operator Helm configuration values]({{< relref "/userguide/managing-operators/using-the-operator/using-helm#operator-helm-configuration-values" >}}). A number of Kubernetes resources
8+
Each operator deployment manages a number of Kubernetes Namespaces. For more information, see [Operator Helm configuration values]({{< relref "/userguide/managing-operators/using-the-operator/using-helm#operator-helm-configuration-values" >}}). A number of Kubernetes resources
99
must be present in a namespace before any WebLogic domain custom resources can be successfully
1010
deployed into it.
1111
Those Kubernetes resources are created either as part of the installation
@@ -16,7 +16,7 @@ This FAQ describes some considerations to be aware of when you manage the namesp
1616
* [Check the namespaces that the operator manages](#check-the-namespaces-that-the-operator-manages)
1717
* [Add a namespace for the operator to manage](#add-a-kubernetes-namespace-to-the-operator)
1818
* [Delete a namespace from the operator's domain namespace list](#delete-a-kubernetes-namespace-from-the-operator)
19-
* [Delete and recreate a Kubernetes namespace that the operator manages](#recreate-a-previously-deleted-kubernetes-namespace)
19+
* [Delete and recreate a Kubernetes Namespace that the operator manages](#recreate-a-previously-deleted-kubernetes-namespace)
2020

2121
For others, see [Common Mistakes and Solutions]({{< relref "/userguide/managing-operators/using-the-operator/using-helm#common-mistakes-and-solutions" >}}).
2222

@@ -58,7 +58,7 @@ $ helm list --namespace <namespace>
5858
$ helm list --all-namespaces
5959
```
6060

61-
#### Add a Kubernetes namespace to the operator
61+
#### Add a Kubernetes Namespace to the operator
6262
If you want an operator deployment to manage a namespace, you need to add the namespace to the operator's `domainNamespaces` list. Note that the namespace has to already exist, for example, using the `kubectl create` command.
6363

6464
Adding a namespace to the `domainNamespaces` list tells the operator deployment or runtime
@@ -98,7 +98,7 @@ NAME DATA AGE
9898
weblogic-domain-cm 14 12m
9999
```
100100

101-
#### Delete a Kubernetes namespace from the operator
101+
#### Delete a Kubernetes Namespace from the operator
102102
When you no longer want a namespace to be managed by the operator, you need to remove it from
103103
the operator's `domainNamespaces` list, so that the corresponding Kubernetes resources that are
104104
associated with the namespace can be cleaned up.
@@ -118,7 +118,7 @@ $ helm upgrade \
118118
119119
```
120120

121-
#### Recreate a previously deleted Kubernetes namespace
121+
#### Recreate a previously deleted Kubernetes Namespace
122122

123123
If you need to delete a namespace (and the resources in it) and then recreate it,
124124
remember to remove the namespace from the operator's `domainNamespaces` list

docs-source/content/faq/oci-fss-pv.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ see [Persistent storage]({{< relref "/userguide/managing-domains/persistent-stor
2626
#### Failure during domain creation with persistent volume sample
2727

2828
The existing sample for [creation of a domain home on persistent volume](https://github.com/oracle/weblogic-kubernetes-operator/tree/master/kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv)
29-
uses a Kubernetes job to create the domain. The sample uses an
29+
uses a Kubernetes Job to create the domain. The sample uses an
3030
`initContainers` section to change the file ownership which will
3131
fail for OCI FSS created volumes used with an OKE cluster.
3232

3333
The OCI FSS volume contains some files that are not modifiable thus
34-
causing the Kubernetes job to fail. The failure is seen in the
35-
description of the Kubernetes job pod:
34+
causing the Kubernetes Job to fail. The failure is seen in the
35+
description of the Kubernetes Job pod:
3636
```bash
3737
$ kubectl describe -n domain1-ns pod domain1-create-weblogic-sample-domain-job-wdkvs
3838
:

docs-source/content/faq/oci-lb.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ If you are running your Kubernetes cluster on Oracle Container Engine
99
for Kubernetes (commonly known as OKE), you can have OCI automatically
1010
provision load balancers for you by creating a `Service` of type
1111
`LoadBalancer` instead of (or in addition to) installing an
12-
Ingress controller like Traefik or Voyager.
12+
ingress controller like Traefik or Voyager.
1313

1414
OKE Kubernetes worker nodes typically do not have public IP addresses.
1515
This means that the `NodePort` services created by the operator are
@@ -20,8 +20,8 @@ to services running in OKE.
2020

2121
{{% notice note %}}
2222
It is also possible, if desirable, to have an OCI load balancer route
23-
traffic to an Ingress controller running inside the Kubernetes cluster
24-
and have that Ingress controller in turn route traffic to services in the
23+
traffic to an ingress controller running inside the Kubernetes cluster
24+
and have that ingress controller in turn route traffic to services in the
2525
cluster.
2626
{{% /notice %}}
2727

docs-source/content/faq/volumes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: "Providing access to a Persistent Volume Claim"
2+
title: "Providing access to a PersistentVolumeClaim"
33
date: 2020-01-07T15:02:28-05:00
44
draft: false
55
weight: 60
66
---
7-
> I need to provide an instance with access to a Persistent Volume Claim.
7+
> I need to provide an instance with access to a PersistentVolumeClaim.
88
99
Some applications need access to a file, either to read data or to provide additional logging beyond what is
1010
built into the operator. One common way of doing that within Kubernetes is to create a

0 commit comments

Comments
 (0)