Skip to content

Commit 063fd38

Browse files
committed
Sync documentation
1 parent 4586bc1 commit 063fd38

File tree

25 files changed

+260
-280
lines changed

25 files changed

+260
-280
lines changed

documentation/staging/content/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,5 +62,5 @@ See [Get help]({{< relref "userguide/introduction/get-help.md" >}}).
6262
* [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/)
6363
* [WebLogic Monitoring Exporter](https://github.com/oracle/weblogic-monitoring-exporter)
6464
* [WebLogic Logging Exporter](https://github.com/oracle/weblogic-logging-exporter)
65-
* [WebLogic Remote Console](https://github.com/oracle/weblogic-remote-console)
65+
* [WebLogic Remote Console](https://oracle.github.io/weblogic-remote-console/)
6666
* [WebLogic Kubernetes Toolkit UI](https://oracle.github.io/weblogic-toolkit-ui/)

documentation/staging/content/release-notes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,9 +146,9 @@ Updated several dependencies, including the Oracle Linux base for the container
146146
##### Features
147147

148148
* The operator's container image is based on Oracle Linux 8.
149-
* WebLogic Server container images based on Oracle Linux 8 are supported.
149+
* WebLogic Server container images based on Oracle Linux 8 are supported.
150150
* [Online updates]({{<relref "/userguide/managing-domains/model-in-image/runtime-updates/_index.md#online-updates">}}) of dynamic configuration changes for Model in Image.
151-
* Automatic injection of the [WebLogic Monitoring Exporter](https://github.com/oracle/weblogic-monitoring-exporter) as a sidecar container.
151+
* Automatic injection of the [WebLogic Monitoring Exporter](https://github.com/oracle/weblogic-monitoring-exporter) as a sidecar container.
152152
* [Events]({{< relref "/userguide/managing-domains/domain-events.md" >}}) are generated at important moments in the life cycle of the operator or a domain.
153153
* [PodDisruptionBudgets]({{<relref "/userguide/managing-domains/domain-lifecycle/startup.md#draining-a-node-and-poddisruptionbudget">}}) are generated for clusters improving the ability to maintain cluster availability during planned node shutdowns and Kubernetes upgrade.
154154
* Additional scripts to assist with common tasks, such as the `scaleCluster.sh` script.

documentation/staging/content/samples/azure-kubernetes-service/domain-on-pv.md

Lines changed: 34 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This sample demonstrates how to use the [WebLogic Kubernetes Operator](/weblogic
1515
- [Create WebLogic domain](#create-weblogic-domain)
1616
- [Automation](#automation)
1717
- [Deploy sample application](#deploy-sample-application)
18-
- [Access WebLogic Server logs](#access-weblogic-server-logs)
18+
- [Validate NFS volume](#validate-nfs-volume)
1919
- [Clean up resources](#clean-up-resources)
2020
- [Troubleshooting](#troubleshooting)
2121
- [Useful links](#useful-links)
@@ -26,7 +26,7 @@ This sample demonstrates how to use the [WebLogic Kubernetes Operator](/weblogic
2626

2727
##### Clone WebLogic Kubernetes Operator repository
2828

29-
Clone the [WebLogic Kubernetes Operator repository](https://github.com/oracle/weblogic-kubernetes-operator) to your machine. We will use several scripts in this repository to create a WebLogic domain. This sample was tested with v3.1.1, but should work with the latest release.
29+
Clone the [WebLogic Kubernetes Operator repository](https://github.com/oracle/weblogic-kubernetes-operator) to your machine. You will use several scripts in this repository to create a WebLogic domain. This sample was tested with v3.3.7, but should work with the latest release.
3030

3131
```shell
3232
$ git clone --branch v{{< latestVersion >}} https://github.com/oracle/weblogic-kubernetes-operator.git
@@ -52,17 +52,15 @@ Kubernetes Operators use [Helm](https://helm.sh/) to manage Kubernetes applicati
5252
$ helm repo add weblogic-operator https://oracle.github.io/weblogic-kubernetes-operator/charts --force-update
5353
```
5454
```shell
55-
$ helm install weblogic-operator weblogic-operator/weblogic-operator --version "3.1.1"
55+
$ helm install weblogic-operator weblogic-operator/weblogic-operator --version "3.3.7"
5656
```
5757

5858
The output will show something similar to the following:
5959

6060
```shell
61-
$ helm install weblogic-operator weblogic-operator/weblogic-operator --version "3.1.1"
62-
```
63-
```
61+
$ helm install weblogic-operator weblogic-operator/weblogic-operator --version "3.3.7"
6462
NAME: weblogic-operator
65-
LAST DEPLOYED: Wed Jul 1 23:47:44 2020
63+
LAST DEPLOYED: Tue Jan 18 17:07:56 2022
6664
NAMESPACE: default
6765
STATUS: deployed
6866
REVISION: 1
@@ -87,11 +85,11 @@ weblogic-operator-56654bcdb7-qww7f 1/1 Running 0
8785
- [Create secrets](#create-secrets)
8886
- [Create WebLogic Domain](#create-weblogic-domain-1)
8987

90-
Now that we have created the AKS cluster, installed the operator, and verified that the operator is ready to go, we can have the operator create a WLS domain.
88+
Now that You have created the AKS cluster, installed the operator, and verified that the operator is ready to go, you can have the operator create a WLS domain.
9189

9290
##### Create secrets
9391

94-
We will use the `kubernetes/samples/scripts/create-weblogic-domain-credentials/create-weblogic-credentials.sh` script to create the domain credentials as a Kubernetes secret. Please run:
92+
You will use the `kubernetes/samples/scripts/create-weblogic-domain-credentials/create-weblogic-credentials.sh` script to create the domain credentials as a Kubernetes secret. Please run:
9593

9694
```
9795
# cd kubernetes/samples/scripts/create-weblogic-domain-credentials
@@ -104,8 +102,7 @@ secret/domain1-weblogic-credentials created
104102
secret/domain1-weblogic-credentials labeled
105103
The secret domain1-weblogic-credentials has been successfully created in the default namespace.
106104
```
107-
108-
We will use the `kubernetes/samples/scripts/create-kubernetes-secrets/create-docker-credentials-secret.sh` script to create the Docker credentials as a Kubernetes secret. Please run:
105+
You will use the `kubernetes/samples/scripts/create-kubernetes-secrets/create-docker-credentials-secret.sh` script to create the Docker credentials as a Kubernetes secret. Please run:
109106

110107
```shell
111108
# Please change imagePullSecretNameSuffix if you change pre-defined value "regcred" before generating the configuration files.
@@ -116,7 +113,7 @@ $ export SECRET_NAME_DOCKER="${NAME_PREFIX}regcred"
116113
```
117114
# cd kubernetes/samples/scripts/create-kubernetes-secrets
118115
```
119-
```sehll
116+
```shell
120117
$ ./create-docker-credentials-secret.sh -s ${SECRET_NAME_DOCKER} -e [email protected] -p oracleSsoPassword -u [email protected]
121118
```
122119
```
@@ -131,7 +128,6 @@ $ kubectl get secret
131128
```
132129
```
133130
NAME TYPE DATA AGE
134-
wlsazure-secret Opaque 2 17m
135131
regcred kubernetes.io/dockerconfigjson 1 2m25s
136132
default-token-csdvd kubernetes.io/service-account-token 3 25m
137133
domain1-weblogic-credentials Opaque 2 3m42s
@@ -142,12 +138,12 @@ weblogic-operator-secrets Opaque
142138
**Note**: If the `NAME` column in your output is missing any of the values shown above, please reexamine your execution of the preceding steps in this sample to ensure that you correctly followed all of them. The `default-token-mwdj8` shown above will have a different ending in your output.
143139

144140
##### Create WebLogic Domain
145-
We will use the `kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv/create-domain.sh` script to create the WLS domain in the persistent volume we created previously.
141+
You will use the `kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv/create-domain.sh` script to create the WLS domain in the persistent volume you created previously.
146142

147143
{{% notice note %}} The `create-domain.sh` script and its inputs file are for demonstration purposes _only_; its contents and the domain resource file that it generates for you might change without notice. In production, we strongly recommend that you use the WebLogic Image Tool and WebLogic Deploy Tooling (when applicable), and directly work with domain resource files instead.
148144
{{% /notice%}}
149145

150-
We need to set up the domain configuration for the WebLogic domain.
146+
You need to set up the domain configuration for the WebLogic domain.
151147

152148
1. Check if resources are ready.
153149

@@ -166,10 +162,8 @@ We need to set up the domain configuration for the WebLogic domain.
166162
--file-share ${AKS_PERS_SHARE_NAME} \
167163
--storage-account ${AKS_PERS_STORAGE_ACCOUNT_NAME} \
168164
--domain-uid domain1 \
169-
--pv-name ${NAME_PREFIX}-azurefile-${TIMESTAMP} \
170165
--pvc-name ${NAME_PREFIX}-azurefile-${TIMESTAMP} \
171-
--secret-docker ${SECRET_NAME_DOCKER} \
172-
--secret-storage ${SECRET_NAME_AZURE_FILE}
166+
--secret-docker ${SECRET_NAME_DOCKER}
173167
```
174168

175169
You will see output with `PASS` if all the resources are ready. The following is an example of output:
@@ -181,10 +175,8 @@ We need to set up the domain configuration for the WebLogic domain.
181175
Azure Kubenetes Service instacne: wlsaks1612795811
182176
Azure storage account: wlsstorage1612795811
183177
Azure file share: wls-weblogic-1612795811
184-
Kubenetes secret for Azure storage: wlsazure-secret
185178
Kubenetes secret for Docker Account: regcred
186179
Kubenetes secret for Weblogic domain: domain1-weblogic-credentials
187-
Persistent Volume: wls-azurefile-1612795811
188180
Persistent Volume Claim: wls-azurefile-1612795811
189181
```
190182

@@ -301,7 +293,7 @@ We need to set up the domain configuration for the WebLogic domain.
301293
troubleshoot the reason and resolve it before proceeding to the next
302294
step.
303295

304-
{{% notice note %}} This sample creates WebLogic Server pods with reasonable values for memory, CPU, and JVM heap size (as a percentage of memory). You can supply different values. Edit `~/azure/weblogic-on-aks/domain1.yaml` and set the desired values for `serverPodMemoryRequest`, `serverPodMemoryLimit`, `serverPodCpuRequest`, `serverPodCpuLimit` and `javaOptions` before running `./create-domain.sh -i ~/azure/weblogic-on-aks/domain1.yaml -o ~/azure -e -v`.
296+
{{% notice note %}} This sample creates WebLogic Server pods with reasonable values for memory, CPU, and JVM heap size (as a percentage of memory). These settings were determined by running a skeleton WebLogic domain with minimal or no deployed services and applications on potentially limited or heavily shared container environments. For advice about tuning CPU and memory requests and limits for broader use cases or in a production environment, see the [Pod memory and CPU resources](https://oracle.github.io/weblogic-kubernetes-operator/faq/resource-settings/) FAQ. You can supply different values. Edit `~/azure/weblogic-on-aks/domain1.yaml` and set the desired values for `serverPodMemoryRequest`, `serverPodMemoryLimit`, `serverPodCpuRequest`, `serverPodCpuLimit` and `javaOptions` before running `./create-domain.sh -i ~/azure/weblogic-on-aks/domain1.yaml -o ~/azure -e -v`.
305297
{{% /notice%}}
306298

307299
Here is an excerpt showing reasonable values:
@@ -344,7 +336,7 @@ We need to set up the domain configuration for the WebLogic domain.
344336
type: LoadBalancer
345337
```
346338

347-
Use the sample configuration file `kubernetes/samples/scripts/create-weblogic-domain-on-azure-kubernetes-service/domain-on-pv/cluster-lb.yaml` to create a load balancer service for the Managed Servers. If you are choosing not to use the predefined YAML file and instead created new one with customized values, then substitute the following content with you domain values.
339+
Use the sample configuration file `kubernetes/samples/scripts/create-weblogic-domain-on-azure-kubernetes-service/domain-on-pv/cluster-lb.yaml` to create a load balancer service for the Managed Servers. If you are choosing not to use the predefined YAML file and instead created new one with customized values, then substitute the following content with your domain values.
348340

349341
```yaml
350342
apiVersion: v1
@@ -510,7 +502,7 @@ For input values, you can edit `kubernetes/samples/scripts/create-weblogic-domai
510502
| `dockerEmail` | `yourDockerEmail` | Oracle Single Sign-On (SSO) account email, used to pull the WebLogic Server Docker image. |
511503
| `dockerPassword` | `yourDockerPassword`| Password for Oracle SSO account, used to pull the WebLogic Server Docker image, in clear text. |
512504
| `dockerUserName` | `yourDockerId` | The same value as `dockerEmail`. |
513-
| `namePrefix` | `0730` | Alphanumeric value used as a disambiguation prefix for several Kubernetes resources. |
505+
| `namePrefix` | `wls` | Alphanumeric value used as a disambiguation prefix for several Kubernetes resources. |
514506

515507
If you don't want to change the other parameters, you can use the default values. Please make sure no extra whitespaces are added!
516508

@@ -528,7 +520,7 @@ $ ./create-domain-on-aks.sh -i my-create-domain-on-aks-inputs.yaml -o ~/azure -e
528520

529521
The script will print the Administration Server address after a successful deployment. The default user name for the Administration Console is `weblogic` and the default password is `welcome1`. Please change this for production deployments. To interact with the cluster using `kubectl`, use `az aks get-credentials` as shown in the script output.
530522

531-
{{% notice info %}} You now have created an AKS cluster with `PersistentVolumeClaim` and `PersistentVolume` to contain the WLS domain configuration files. Using those artifacts, you have used the operator to create a WLS domain.
523+
{{% notice info %}} You now have created an AKS cluster with Azure Files NFS share to contain the WLS domain configuration files. Using those artifacts, you have used the operator to create a WLS domain.
532524
{{% /notice %}}
533525

534526
#### Deploy sample application
@@ -574,22 +566,27 @@ In the example, the application address is: `http://52.224.248.40:8001/testwebap
574566

575567
The test application will list the server host and server IP on the page.
576568

577-
#### Access WebLogic Server logs
569+
#### Validate NFS volume
578570

579-
The logs are stored in the Azure file share. Follow these steps to access the log:
571+
There are several approaches to validate the NFS volume:
580572

581-
1. Go to the [Azure Portal](https://ms.portal.azure.com).
582-
2. Go to your resource group.
583-
3. Open the storage account.
584-
4. In the "File service" section of the left panel, select File shares.
585-
5. Select the file share name (e.g. weblogic in this example).
586-
6. Select logs.
587-
7. Select domain1.
588-
8. WebLogic Server logs are listed in the folder.
573+
- Use Azure Storage browser. Make sure you have permission to access the NFS server, see [Azure Storage firewalls and virtual networks document](https://docs.microsoft.com/en-us/azure/storage/common/storage-network-security?tabs=azure-portal)
574+
- Mount the same NFS share in an existing virtual machine from Azure. Access files from the mounted path, see [Mount Azure NFS file share to Linux](https://docs.microsoft.com/en-us/azure/storage/files/storage-files-how-to-mount-nfs-shares).
589575

590-
{{%expand "Click here to view the WebLogic Server logs screenshot." %}}
591-
![WebLogic Server Logs](../screenshot-logs.png)
592-
{{% /expand %}}
576+
Use `kubectl exec` to enter the admin server pod to check file system status:
577+
578+
```shell
579+
kubectl exec -it domain1-admin-server -- df -h
580+
```
581+
582+
You will find output like the following, with filesystem `${AKS_PERS_STORAGE_ACCOUNT_NAME}.file.core.windows.net:/${AKS_PERS_STORAGE_ACCOUNT_NAME}/${AKS_PERS_SHARE_NAME}`, size `100G`, and mounted on `/shared`:
583+
584+
```text
585+
Filesystem Size Used Avail Use% Mounted on
586+
...
587+
wlsstorage1612795811.file.core.windows.net:/wlsstorage1612795811/wls-weblogic-1612795811 100G 76M 100G 1% /shared
588+
...
589+
```
593590

594591
#### Clean up resources
595592

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
Azure Kubernetes Service makes it simple to deploy a managed Kubernetes cluster in Azure. AKS reduces the complexity and operational overhead of managing Kubernetes by offloading much of that responsibility to Azure. As a hosted Kubernetes service, Azure handles critical tasks like health monitoring and maintenance for you. The Kubernetes masters are managed by Azure. You manage and maintain only the agent nodes. As a managed Kubernetes service, AKS is free - you pay for only the agent nodes within your clusters, not for the masters.
1+
Azure Kubernetes Service (AKS) makes it simple to deploy a managed Kubernetes cluster in Azure. AKS reduces the complexity and operational overhead of managing Kubernetes by offloading much of that responsibility to Azure. As a hosted Kubernetes service, Azure handles critical tasks like health monitoring and maintenance for you. The Kubernetes masters are managed by Azure. You manage and maintain only the agent nodes. As a managed Kubernetes service, AKS is free - you pay for only the agent nodes within your clusters, not for the masters.
22

3-
To learn more, see [What is Azure Kubernetes Service?](https://docs.microsoft.com/en-us/azure/aks/intro-kubernetes)
3+
To learn more, see [What is Azure Kubernetes Service?](https://docs.microsoft.com/azure/aks/intro-kubernetes)

0 commit comments

Comments
 (0)