Skip to content

Commit 3281191

Browse files
committed
Update staging
1 parent 9bb4f0b commit 3281191

File tree

58 files changed

+783
-237
lines changed

Some content is hidden

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

58 files changed

+783
-237
lines changed

documentation/staging/content/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Oracle is finding ways for organizations using WebLogic Server to run important
1616

1717
The fastest way to experience the operator is to follow the [Quick Start guide]({{< relref "/quickstart/_index.md" >}}), or you can peruse our [documentation]({{< relref "/userguide/_index.md" >}}), read our [blogs](https://blogs.oracle.com/weblogicserver/how-to-weblogic-server-on-kubernetes), or try out the [samples]({{< relref "/samples/_index.md" >}}).
1818

19-
{{% notice tip %}} Step through the [Tutorial](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/hands-on-lab/README.md)
19+
{{% notice tip %}} Step through the [Tutorial](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/hands-on-lab/README.md)
2020
using the operator to deploy and run a WebLogic domain container-packaged web application on an Oracle Cloud Infrastructure Container Engine for Kubernetes (OKE) cluster.
2121
{{% /notice %}}
2222

documentation/staging/content/developerguide/branching.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,12 @@ draft: false
55
weight: 4
66
---
77

8-
The `master` branch is protected and contains source for the most recently published release, including release candidates.
8+
The `main` branch is protected and contains source for the latest completed features and bug fixes. While this branch contains active work, we expect to keep it always "ready to release." Therefore, longer running feature work will be performed on specific branches, such as `feature/dynamic-clusters`.
99

10-
The `develop` branch is protected and contains source for the latest completed features and bug fixes. While this branch contains active work, we expect to keep it always "ready to release." Therefore, longer running feature work will be performed on specific branches, such as `feature/dynamic-clusters`.
10+
Because we want to balance separating destabilizing work into feature branches against the possibility of later difficult merges, we encourage developers working on features to pull out any necessary refactoring or improvements that are general purpose into their own shorter-lived branches and create pull requests to `main` when these smaller work items are completed.
1111

12-
Because we want to balance separating destabilizing work into feature branches against the possibility of later difficult merges, we encourage developers working on features to pull out any necessary refactoring or improvements that are general purpose into their own shorter-lived branches and create pull requests to `develop` when these smaller work items are completed.
12+
All commits to `main` must pass the [integration test suite]({{< relref "/developerguide/integration-tests.md" >}}). Please run these tests locally before submitting a pull request. Additionally, each push to a branch in our GitHub repository triggers a run of a subset of the integration tests with the results visible [here](http://build.weblogick8s.org:8080/job/weblogic-kubernetes-operator-quicktest/).
1313

14-
All commits to `develop` must pass the [integration test suite]({{< relref "/developerguide/integration-tests.md" >}}). Please run these tests locally before submitting a pull request. Additionally, each push to a branch in our GitHub repository triggers a run of a subset of the integration tests with the results visible [here](http://build.weblogick8s.org:8080/job/weblogic-kubernetes-operator-quicktest/).
15-
16-
Please submit pull requests to the `develop` branch unless you are collaborating on a feature and have another target branch. Please see details on the Oracle Contributor Agreement (OCA) and guidelines for pull requests on the [README]({{< relref "/_index.md#contributing-to-the-oracle-weblogic-server-kubernetes-operator-repository" >}}).
14+
Please submit pull requests to the `main` branch unless you are collaborating on a feature and have another target branch. Please see details on the Oracle Contributor Agreement (OCA) and guidelines for pull requests on the [README]({{< relref "/_index.md#contributing-to-the-oracle-weblogic-server-kubernetes-operator-repository" >}}).
1715

1816
We will create git tags for each release candidate and generally available (GA) release of the operator.

documentation/staging/content/developerguide/building.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,16 @@ You may need to create a directory called `/operator` on your machine. Please b
4242

4343
If you're not running Kubernetes on your development machine, you'll need to make the container image available to a registry visible to your Kubernetes cluster. Either `docker push` the image to a private registry or upload your image to a machine running Docker and Kubernetes as follows:
4444

45+
On your build machine:
4546
```shell
46-
# on your build machine
4747
$ docker save weblogic-kubernetes-operator:some-tag > operator.tar
48+
```
49+
```shell
4850
$ scp operator.tar YOUR_USER@YOUR_SERVER:/some/path/operator.tar
49-
# on the Kubernetes server
51+
```
52+
53+
On the Kubernetes server:
54+
```shell
5055
$ docker load < /some/path/operator.tar
5156
```
5257

documentation/staging/content/developerguide/documentation.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,30 +14,28 @@ update to the documentation, follow this process:
1414
$ git clone https://github.com/oracle/weblogic-kubernetes-operator
1515
```
1616

17-
2. Create a new branch from master.
17+
2. Create a new branch.
1818

1919
```shell
20-
$ git checkout master
21-
$ git pull origin master
2220
$ git checkout -b your-branch
2321
```
2422

2523
3. Make your documentation updates by editing the source files in
26-
`docs-source/content`.
24+
`documentation/staging/content`.
2725
{{% notice note %}}
28-
Make sure you check in the changes from the `docs-source/content` area _only_;
26+
Make sure you check in the changes from the `documentation/staging/content` area _only_;
2927
do not build the site and check in the static files.
3028
{{% /notice %}}
3129

3230
4. If you wish to view your changes, you can run the site locally using
3331
these commands. The site will be available on the URL shown here:
3432

3533
```shell
36-
$ cd docs-source
34+
$ cd documentation/staging
3735
$ hugo server -b http://localhost:1313/weblogic-kubernetes-operator
3836
```
3937

4038
5. When you are ready to submit your changes, push your branch to `origin`
4139
and submit a pull request. Remember to follow the guidelines in the
42-
[CONTRIBUTING](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/CONTRIBUTING.md)
40+
[CONTRIBUTING](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/CONTRIBUTING.md)
4341
document.

documentation/staging/content/developerguide/integration-tests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You will need to obtain the `kube.config` file for an administrative user and ma
1515
$ mvn clean verify -P java-integration-tests
1616
```
1717

18-
For more detailed information, see [How to run the Java integration tests ](https://github.com/oracle/weblogic-kubernetes-operator/tree/master/integration-tests#how-to-run-the-java-integration-tests).
18+
For more detailed information, see [How to run the Java integration tests ](https://github.com/oracle/weblogic-kubernetes-operator/tree/main/integration-tests#how-to-run-the-java-integration-tests).
1919

2020
{{% notice note %}}
2121
When you run the integrations tests, they do a cleanup of any operator or domains on that cluster.

documentation/staging/content/faq/coherence-requirements.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ If you have issues with clusters not forming, then you should check that
5353

5454
```shell
5555
$ rpm -qa | grep conntrack
56+
```
57+
```
5658
libnetfilter_conntrack-1.0.6-1.el7_3.x86_64
5759
conntrack-tools-1.4.4-4.el7.x86_64
5860
```
@@ -69,6 +71,8 @@ following command:
6971

7072
```shell
7173
$ iptables -t nat -v -L POST_public_allow -n
74+
```
75+
```
7276
Chain POST_public_allow (1 references)
7377
pkts bytes target prot opt in out source destination
7478
164K 11M MASQUERADE all -- * !lo 0.0.0.0/0 0.0.0.0/0
@@ -105,7 +109,11 @@ environment:
105109

106110
```shell
107111
$ echo 'Set up systemd service to fix iptables nat chain at each reboot (so Coherence will work)...'
112+
```
113+
```shell
108114
$ mkdir -p /etc/systemd/system/
115+
```
116+
```shell
109117
$ cat > /etc/systemd/system/fix-iptables.service << EOF
110118
[Unit]
111119
Description=Fix iptables
@@ -139,5 +147,7 @@ EOF
139147

140148
```shell
141149
$ echo 'Start the systemd service to fix iptables nat chain...'
150+
```
151+
```shell
142152
$ systemctl enable --now fix-iptables
143153
```

documentation/staging/content/faq/namespace-management.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ For example, the following command shows all the values of the operator release
3434

3535
```shell
3636
$ helm get values weblogic-operator
37+
```
38+
```
3739
domainNamespaces:
3840
- default
3941
- ns1
@@ -71,6 +73,8 @@ If you don't know the release name of the operator, you can use `helm list` to l
7173

7274
```shell
7375
$ helm list --namespace <namespace>
76+
```
77+
```shell
7478
$ helm list --all-namespaces
7579
```
7680

@@ -102,8 +106,9 @@ $ kubetctl get cm -n <namespace>
102106
For example, the following example shows that the domain `configmap` resource exists in the namespace `ns1`.
103107

104108
```shell
105-
bash-4.2$ kubectl get cm -n ns1
106-
109+
$ kubectl get cm -n ns1
110+
```
111+
```
107112
NAME DATA AGE
108113
109114
weblogic-scripts-cm 14 12m
@@ -118,9 +123,9 @@ Helm release:
118123

119124
```shell
120125
$ helm upgrade \
121-
weblogic-operator \
122-
kubernetes/charts/weblogic-operator \
123-
--reuse-values
126+
weblogic-operator \
127+
kubernetes/charts/weblogic-operator \
128+
--reuse-values
124129
```
125130

126131
#### Delete a Kubernetes namespace from the operator
@@ -134,12 +139,12 @@ name of the operator, and `kubernetes/charts/weblogic-operator` is the location
134139

135140
```shell
136141
$ helm upgrade \
137-
--reuse-values \
138-
--set "domainNamespaces={default}" \
139-
--wait \
140-
--force \
141-
weblogic-operator \
142-
kubernetes/charts/weblogic-operator
142+
--reuse-values \
143+
--set "domainNamespaces={default}" \
144+
--wait \
145+
--force \
146+
weblogic-operator \
147+
kubernetes/charts/weblogic-operator
143148
```
144149

145150
For operators configured to select managed namespaces through the use of a label selector or regular expression,

documentation/staging/content/faq/oci-fss-pv.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ see [Persistent storage]({{< relref "/userguide/managing-domains/persistent-stor
3131

3232
#### Failure during domain creation with persistent volume sample
3333

34-
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)
34+
The existing sample for [creation of a domain home on persistent volume](https://github.com/oracle/weblogic-kubernetes-operator/tree/main/kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv)
3535
uses a Kubernetes Job to create the domain. The sample uses an
3636
`initContainers` section to change the file ownership which will
3737
fail for OCI FSS created volumes used with an OKE cluster.
@@ -41,7 +41,8 @@ causing the Kubernetes Job to fail. The failure is seen in the
4141
description of the Kubernetes Job pod:
4242
```shell
4343
$ kubectl describe -n domain1-ns pod domain1-create-weblogic-sample-domain-job-wdkvs
44-
...
44+
```
45+
```
4546
Init Containers:
4647
fix-pvc-owner:
4748
Container ID: docker://7051b6abdc296c76e937246df03d157926f2f7477e63b6af3bf65f6ae1ceddee
@@ -61,11 +62,10 @@ Init Containers:
6162
Ready: False
6263
Restart Count: 0
6364
Environment: <none>
64-
...
6565
```
6666

6767
#### Updating the domain on persistent volume sample
68-
In the following snippet of the [create-domain-job-template.yaml](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv/create-domain-job-template.yaml),
68+
In the following snippet of the [create-domain-job-template.yaml](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv/create-domain-job-template.yaml),
6969
you can see the updated `command` for the init container:
7070
```yaml
7171
apiVersion: batch/v1

documentation/staging/content/faq/oci-lb.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ but initially the external IP is shown as `<pending>`.
7777

7878
```shell
7979
$ kubectl -n bob get svc
80+
```
81+
```
8082
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
8183
bobs-bookstore-admin-server ClusterIP None <none> 8888/TCP,7001/TCP,30101/TCP 9d
8284
bobs-bookstore-admin-server-ext NodePort 10.96.224.13 <none> 7001:32401/TCP 9d
@@ -91,6 +93,8 @@ external IP address will be displayed:
9193
9294
```shell
9395
$ kubectl -n bob get svc
96+
```
97+
```
9498
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
9599
bobs-bookstore-admin-server ClusterIP None <none> 8888/TCP,7001/TCP,30101/TCP 9d
96100
bobs-bookstore-admin-server-ext NodePort 10.96.224.13 <none> 7001:32401/TCP 9d

documentation/staging/content/faq/resource-settings.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,10 +133,15 @@ It's also important to keep in mind that if you set a value of CPU core count th
133133

134134
```shell
135135
$ kubectl get pod sample-domain1-managed-server1 -n sample-domain1-ns
136+
```
137+
```
136138
NAME READY STATUS RESTARTS AGE
137139
sample-domain1-managed-server1 0/1 Pending 0 65s
138-
140+
```
141+
```shell
139142
$ kubectl describe pod sample-domain1-managed-server1 -n sample-domain1-ns
143+
```
144+
```
140145
Events:
141146
Type Reason Age From Message
142147
---- ------ ---- ---- -------

0 commit comments

Comments
 (0)