Skip to content

Commit d10266b

Browse files
authored
Doc updates for wcsites and oam (#42)
Doc updates for wcsites and oam
1 parent 310eeb2 commit d10266b

File tree

145 files changed

+3010
-2970
lines changed

Some content is hidden

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

145 files changed

+3010
-2970
lines changed

docs-source/content/oam/configure-ingress/ingress-nginx-setup-for-oam-domain-setup-on-K8S.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -101,13 +101,13 @@ Use helm to install NGINX.
101101
1. Install NGINX using the following helm command:
102102
103103
```bash
104-
$ helm install nginx-ingress --set controller.extraArgs.default-ssl-certificate=<domain_namespace>/<ssl_secret> --set controller.service.type=NodePort --set controller.admissionWebhooks.enabled=false stable/ingress-nginx
104+
$ helm install nginx-ingress -n <domain_namespace> --set controller.extraArgs.default-ssl-certificate=<domain_namespace>/<ssl_secret> --set controller.service.type=NodePort --set controller.admissionWebhooks.enabled=false stable/ingress-nginx
105105
```
106106
107107
For example:
108108
109109
```bash
110-
$ helm install nginx-ingress --set controller.extraArgs.default-ssl-certificate=accessns/accessinfra-tls-cert --set controller.service.type=NodePort --set controller.admissionWebhooks.enabled=false stable/ingress-nginx
110+
$ helm install nginx-ingress -n accessns --set controller.extraArgs.default-ssl-certificate=accessns/accessinfra-tls-cert --set controller.service.type=NodePort --set controller.admissionWebhooks.enabled=false stable/ingress-nginx
111111
```
112112
113113
The output will look similar to the following:
@@ -116,16 +116,16 @@ Use helm to install NGINX.
116116
NAME: nginx-ingress
117117
LAST DEPLOYED: Thu Sep 24 07:31:51 2020
118118

119-
NAMESPACE: default
119+
NAMESPACE: accessns
120120
STATUS: deployed
121121
REVISION: 1
122122
TEST SUITE: None
123123
NOTES:
124124
The nginx-ingress controller has been installed.
125125
Get the application URL by running these commands:
126-
export HTTP_NODE_PORT=$(kubectl --namespace default get services -o jsonpath="{.spec.ports[0].nodePort}" nginx-ingress-controller)
127-
export HTTPS_NODE_PORT=$(kubectl --namespace default get services -o jsonpath="{.spec.ports[1].nodePort}" nginx-ingress-controller)
128-
export NODE_IP=$(kubectl --namespace default get nodes -o jsonpath="{.items[0].status.addresses[1].address}")
126+
export HTTP_NODE_PORT=$(kubectl --namespace accessns get services -o jsonpath="{.spec.ports[0].nodePort}" nginx-ingress-controller)
127+
export HTTPS_NODE_PORT=$(kubectl --namespace accessns get services -o jsonpath="{.spec.ports[1].nodePort}" nginx-ingress-controller)
128+
export NODE_IP=$(kubectl --namespace accessns get nodes -o jsonpath="{.items[0].status.addresses[1].address}")
129129

130130
echo "Visit http://$NODE_IP:$HTTP_NODE_PORT to access your application via HTTP."
131131
echo "Visit https://$NODE_IP:$HTTPS_NODE_PORT to access your application via HTTPS."
@@ -216,7 +216,7 @@ Use helm to install NGINX.
216216
1. Find the node port of NGINX using the following command:
217217
218218
```bash
219-
$ kubectl --namespace default get services -o jsonpath="{.spec.ports[1].nodePort}" nginx-ingress-ingress-nginx-controller
219+
$ kubectl --namespace accessns get services -o jsonpath="{.spec.ports[1].nodePort}" nginx-ingress-ingress-nginx-controller
220220
```
221221
222222
The output will look similar to the following:

docs-source/content/oam/patch-and-upgrade/upgrade_an_operator_release.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ The new Oracle WebLogic Server Kubernetes Operator Docker image must be installe
1212
1. Pull the Oracle WebLogic Server Kubernetes Operator 3.X.X image by running the following command on the master node:
1313

1414
```bash
15-
$ docker pull oracle/weblogic-kubernetes-operator:3.X.X
15+
$ docker pull ghcr.io/oracle/weblogic-kubernetes-operator:3.X.X
1616
```
1717

1818
where `3.X.X` is the version of the operator you require.
1919

2020
1. Run the docker tag command as follows:
2121

2222
```bash
23-
$ docker tag oracle/weblogic-kubernetes-operator:3.X.X weblogic-kubernetes-operator:3.X.X
23+
$ docker tag ghcr.io/oracle/weblogic-kubernetes-operator:3.X.X weblogic-kubernetes-operator:3.X.X
2424
```
2525

2626
where `3.X.X` is the version of the operator downloaded.
@@ -49,14 +49,14 @@ The new Oracle WebLogic Server Kubernetes Operator Docker image must be installe
4949

5050
```bash
5151
$ cd <work directory>/weblogic-kubernetes-operator-3.X.X/weblogic-kubernetes-operator
52-
$ helm upgrade --reuse-values --set image=oracle/weblogic-kubernetes-operator:3.X.X --namespace <sample-kubernetes-operator-ns> --wait weblogic-kubernetes-operator kubernetes/charts/weblogic-operator
52+
$ helm upgrade --reuse-values --set image=weblogic-kubernetes-operator:3.X.X --namespace <sample-kubernetes-operator-ns> --wait weblogic-kubernetes-operator kubernetes/charts/weblogic-operator
5353
```
5454

5555
For example:
5656

5757
```bash
5858
$ cd /scratch/OAMDockerK8S/weblogic-kubernetes-operator-3.X.X/weblogic-kubernetes-operator
59-
$ helm upgrade --reuse-values --set image=oracle/weblogic-kubernetes-operator:3.X.X --namespace opns --wait weblogic-kubernetes-operator kubernetes/charts/weblogic-operator
59+
$ helm upgrade --reuse-values --set image=weblogic-kubernetes-operator:3.X.X --namespace opns --wait weblogic-kubernetes-operator kubernetes/charts/weblogic-operator
6060
```
6161

6262

docs-source/content/oam/post-install-config/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ For production environments, the following WebLogic Server tuning parameters mus
152152

153153
154154
```bash
155-
$ kubectl gets pods -n accessns
155+
$ kubectl get pods -n accessns
156156
```
157157

158158
The output will look similar to the following:

docs-source/content/oam/prepare-your-environment/_index.md

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -116,31 +116,31 @@ The Oracle WebLogic Server Kubernetes Operator Docker image must be installed on
116116

117117
1. Pull the Oracle WebLogic Server Kubernetes Operator 3.0.1 image by running the following command on the master node:
118118
```bash
119-
$ docker pull oracle/weblogic-kubernetes-operator:3.0.1
119+
$ docker pull ghcr.io/oracle/weblogic-kubernetes-operator:3.0.1
120120
```
121121

122122

123123
The output will look similar to the following:
124124

125125

126126
```bash
127-
Trying to pull repository docker.io/oracle/weblogic-kubernetes-operator ...
128-
3.0.1: Pulling from docker.io/oracle/weblogic-kubernetes-operator
127+
Trying to pull repository ghcr.io/oracle/weblogic-kubernetes-operator ...
128+
3.0.1: Pulling from ghcr.io/oracle/weblogic-kubernetes-operator
129129
bce8f778fef0: Already exists
130130
de14ddc50a70: Pull complete
131131
77401a861078: Pull complete
132132
9c5ac1423af4: Pull complete
133133
2b6f244f998f: Pull complete
134134
625e05083092: Pull complete
135135
Digest: sha256:27047d032ac5a9077b39bec512b99d8ca54bf9bf71227f5fd1b7b26ac80c20d3
136-
Status: Downloaded newer image for oracle/weblogic-kubernetes-operator:3.0.1
137-
oracle/weblogic-kubernetes-operator:3.0.1
136+
Status: Downloaded newer image for ghcr.io/oracle/weblogic-kubernetes-operator
137+
ghcr.io/oracle/weblogic-kubernetes-operator:3.0.1
138138
```
139139

140140
1. Run the docker tag command as follows:
141141

142142
```bash
143-
$ docker tag oracle/weblogic-kubernetes-operator:3.0.1 weblogic-kubernetes-operator:3.0.1
143+
$ docker tag ghcr.io/oracle/weblogic-kubernetes-operator:3.0.1 weblogic-kubernetes-operator:3.0.1
144144
```
145145

146146
After installing the Oracle WebLogic Server Kubernetes Operator 3.0.1 Docker image, repeat the above on the worker nodes.
@@ -823,6 +823,33 @@ In this section you prepare the environment for the OAM domain creation. This in
823823
824824
**Note**: The persistent volume directory needs to be accessible to both the master and worker node(s) via NFS. Make sure this path has full access permissions, and that the folder is empty. In this example `/scratch/OAMDockerK8S/accessdomainpv` is accessible from all nodes via NFS.
825825
826+
1. On the master node run the following command to ensure it is possible to read and write to the persistent volume:
827+
828+
```bash
829+
cd <work directory>/accessdomainpv
830+
touch filemaster.txt
831+
ls filemaster.txt
832+
```
833+
834+
For example:
835+
836+
```bash
837+
cd /scratch/OAMDockerK8S/accessdomainpv
838+
touch filemaster.txt
839+
ls filemaster.txt
840+
```
841+
842+
On the first worker node run the following to ensure it is possible to read and write to the persistent volume:
843+
844+
```bash
845+
cd /scratch/OAMDockerK8S/accessdomainpv
846+
ls filemaster.txt
847+
touch fileworker1.txt
848+
ls fileworker1.txt
849+
```
850+
851+
Repeat the above for any other worker nodes e.g fileworker2.txt etc. Once proven that it's possible to read and write from each node to the persistent volume, delete the files created.
852+
826853
1. Edit the `create-pv-pvc-inputs.yaml` file and update the following parameters to reflect your settings. Save the file when complete:
827854
828855
```bash

docs-source/content/oam/prerequisites/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ In this release, OAM domains are supported using the “domain on a persistent v
2121
* Helm 3.1.3+ (check with `helm version`).
2222
* You must have the `cluster-admin` role to install the operator.
2323
* We do not currently support running OAM in non-Linux containers.
24-
* A running Oracle Database 12.2.0.1 or later. The database must be a supported version for OAM as outlined in [Oracle Fusion Middleware 12c certifications](https://www.oracle.com/technetwork/middleware/fmw-122140-certmatrix-5763476.xlsx).
24+
* A running Oracle Database 12.2.0.1 or later. The database must be a supported version for OAM as outlined in [Oracle Fusion Middleware 12c certifications](https://www.oracle.com/technetwork/middleware/fmw-122140-certmatrix-5763476.xlsx). It must meet the requirements as outlined in [About Database Requirements for an Oracle Fusion Middleware Installation](http://www.oracle.com/pls/topic/lookup?ctx=fmw122140&id=GUID-4D3068C8-6686-490A-9C3C-E6D2A435F20A) and in [RCU Requirements for Oracle Databases](http://www.oracle.com/pls/topic/lookup?ctx=fmw122140&id=GUID-35B584F3-6F42-4CA5-9BBB-116E447DAB83).
2525

2626
### Limitations
2727

docs-source/content/oam/troubleshooting/_index.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ If the OAM domain creation fails when running `create-domain.sh`, run the follow
3636
Using the output you should be able to diagnose the problem and resolve the issue.
3737

3838
Clean down the failed domain creation by following steps 1-4 in [Delete the OAM domain home]({{< relref "/oam/manage-oam-domains/delete-domain-home" >}}). Then
39-
[recreate the PC and PVC]({{< relref "/oam/prepare-your-environment/#create-a-kubernetes-persistent-volume-and-persistent-volume-claim" >}}) then execute the [OAM domain creation]({{< relref "/oam/create-oam-domains" >}}) steps again.
39+
[recreate the PV and PVC]({{< relref "/oam/prepare-your-environment/#create-a-kubernetes-persistent-volume-and-persistent-volume-claim" >}}) then execute the [OAM domain creation]({{< relref "/oam/create-oam-domains" >}}) steps again.
4040

4141
2. If any of the above commands return the following error:
4242

@@ -49,11 +49,7 @@ If the OAM domain creation fails when running `create-domain.sh`, run the follow
4949
5050
a) The directory has 777 permissions: `chmod -R 777 <work directory>/accessdomainpv`.
5151
52-
b) If it does have the permissions, check if an `oracle` user exists and the `uid` and `gid` equal `1000`, for example:
53-
54-
```bash
55-
$ uid=1000(oracle) gid=1000(spg) groups=1000(spg),59968(oinstall),8500(dba),100(users),1007(cgbudba)
56-
```
52+
b) If it does have the permissions, check if an `oracle` user exists and the `uid` and `gid` equal `1000`.
5753
5854
Create the `oracle` user if it doesn't exist and set the `uid` and `gid` to `1000`.
5955
@@ -64,4 +60,4 @@ If the OAM domain creation fails when running `create-domain.sh`, run the follow
6460
```
6561
6662
Clean down the failed domain creation by following steps 1-4 in [Delete the OAM domain home]({{< relref "/oam/manage-oam-domains/delete-domain-home" >}}). Then
67-
[recreate the PC and PVC]({{< relref "/oam/prepare-your-environment/#create-a-kubernetes-persistent-volume-and-persistent-volume-claim" >}}) and then execute the [OAM domain creation]({{< relref "/oam/create-oam-domains" >}}) steps again.
63+
[recreate the PV and PVC]({{< relref "/oam/prepare-your-environment/#create-a-kubernetes-persistent-volume-and-persistent-volume-claim" >}}) and then execute the [OAM domain creation]({{< relref "/oam/create-oam-domains" >}}) steps again.

docs-source/content/soa-domains/appendix/quickstart-deployment-on-prem.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -447,7 +447,8 @@ Follow [these steps]({{< relref "/soa-domains/installguide/prepare-your-environm
447447
1. Pull the operator image:
448448
449449
```
450-
$ docker pull oracle/weblogic-kubernetes-operator:3.0.1
450+
$ docker pull ghcr.io/oracle/weblogic-kubernetes-operator:3.0.1
451+
$ docker tag ghcr.io/oracle/weblogic-kubernetes-operator:3.0.1 oracle/weblogic-kubernetes-operator:3.0.1
451452
```
452453
453454
1. Obtain the Oracle Database image and Oracle SOA Suite Docker image from the [Oracle Container Registry](https://container-registry.oracle.com):

docs-source/content/soa-domains/installguide/prepare-your-environment/_index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,8 @@ and accept the license agreement for the [WebLogic Server image](https://hub.doc
5555
1. Pull the operator image:
5656

5757
```bash
58-
$ docker pull oracle/weblogic-kubernetes-operator:3.0.1
58+
$ docker pull ghcr.io/oracle/weblogic-kubernetes-operator:3.0.1
59+
$ docker tag ghcr.io/oracle/weblogic-kubernetes-operator:3.0.1 oracle/weblogic-kubernetes-operator:3.0.1
5960
```
6061

6162
### Set up the code repository to deploy Oracle SOA Suite domains
@@ -400,7 +401,7 @@ $
400401
$ ./drop-rcu-schema.sh \
401402
-s SOA1 \
402403
-t soaessosb \
403-
-d soasuite:12.2.1.4 \
404+
-d oracle-db.default.svc.cluster.local:1521/devpdb.k8s \
404405
-n default \
405406
-q Oradoc_db1 \
406407
-r Oradoc_db1

0 commit comments

Comments
 (0)