Skip to content

Commit c4c59ff

Browse files
edit sample docs (#2226)
* edit sample docs * remove x-refs
1 parent b6de65c commit c4c59ff

File tree

9 files changed

+78
-79
lines changed

9 files changed

+78
-79
lines changed

docs-source/content/samples/simple/azure-kubernetes-service/_index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,28 +18,28 @@ description: "Sample for using the operator to set up a WLS cluster on the Azure
1818

1919
### Introduction
2020

21-
This sample demonstrates how to use the [Oracle WebLogic Server Kubernetes Operator]({{< relref "/_index.md" >}}) (hereafter "the operator") to set up a WebLogic Server (WLS) cluster on the Azure Kubernetes Service (AKS). After going through the steps, your WLS domain runs on an AKS cluster. You have several options for managing the cluster, depending on which [domain home source type]({{< relref "/userguide/managing-domains/choosing-a-model/_index.md" >}}) you choose. With Domain in PV, you can manage your WLS domain by accessing the WebLogic Server Administration Console or WLST. With Model in Image you use the operator to perform WLS administrative operations.
21+
This sample demonstrates how to use the [Oracle WebLogic Server Kubernetes Operator]({{< relref "/_index.md" >}}) (hereafter "the operator") to set up a WebLogic Server (WLS) cluster on the Azure Kubernetes Service (AKS). After going through the steps, your WLS domain runs on an AKS cluster. You have several options for managing the cluster, depending on which [domain home source type]({{< relref "/userguide/managing-domains/choosing-a-model/_index.md" >}}) you choose. With Domain in PV, you can manage your WLS domain by accessing the WebLogic Server Administration Console or WLST. With Model in Image, you use the operator to perform WLS administrative operations.
2222

2323
#### Azure Kubernetes Service cluster
2424

2525
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 only manage and maintain the agent nodes. As a managed Kubernetes service, AKS is free - you only pay for the agent nodes within your clusters, not for the masters.
2626

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

2929
#### Domain home source types
3030

31-
This sample demonstrates running the WebLogic cluster on AKS using two domain home types. The instructions for each are self contained and independent. This section lists the domain home source types recommended for use with AKS, along with some benefits of each. For complete details on domain home source types, see [Choose a domain home source type]({{< relref "/userguide/managing-domains/choosing-a-model/_index.md" >}}).
31+
This sample demonstrates running the WebLogic cluster on AKS using two domain home types. The instructions for each are self-contained and independent. This section lists the domain home source types recommended for use with AKS, along with some benefits of each. For complete details on domain home source types, see [Choose a domain home source type]({{< relref "/userguide/managing-domains/choosing-a-model/_index.md" >}}).
3232

33-
- [Model in Image]({{< relref "/samples/simple/azure-kubernetes-service/model-in-image.md" >}}): running the WebLogic cluster on AKS with domain home in image offers the following benefits.
33+
- [Model in Image]({{< relref "/samples/simple/azure-kubernetes-service/model-in-image.md" >}}): running the WebLogic cluster on AKS with domain home in image offers the following benefits:
3434

3535
- Reuse image to create different domains with different `domainUID` and different configurations.
3636
- Mutate the domain home configuration with additional model files supplied in a `ConfigMap`. Many such changes do not need to restart the entire domain for the change to take effect.
3737
- The model file syntax is far simpler and less error prone than the configuration override syntax, and, unlike configuration overrides, allows you to directly add data sources and JMS modules.
3838

39-
- [Domain in PV]({{< relref "/samples/simple/azure-kubernetes-service/domain-on-pv.md" >}}): running the WebLogic cluster on AKS with domain home in PV offers the following benefits.
39+
- [Domain in PV]({{< relref "/samples/simple/azure-kubernetes-service/domain-on-pv.md" >}}): running the WebLogic cluster on AKS with domain home in PV offers the following benefits:
4040

4141
- Use standard Oracle-provided images with patches installed.
42-
- No docker environment required. You are able to run your business quickly without building knowledge of docker.
42+
- No Docker environment required. You are able to run your business quickly without building knowledge of Docker.
4343
- Mutate the live domain configuration with Administration Console from a browser or WLST.
4444

4545
### References

docs-source/content/samples/simple/azure-kubernetes-service/domain-on-pv.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This sample demonstrates how to use the [Oracle WebLogic Server Kubernetes Opera
1717
- [Deploy sample application](#deploy-sample-application)
1818
- [Access WebLogic Server logs](#access-weblogic-server-logs)
1919
- [Clean up resources](#clean-up-resources)
20-
- [Troubleshooting](#troubleshooting)
20+
- [Troubleshooting](#troubleshooting)
2121
- [Useful links](#useful-links)
2222

2323
{{< readfile file="/samples/simple/azure-kubernetes-service/includes/prerequisites-01.txt" >}}
@@ -37,7 +37,7 @@ $ git clone https://github.com/oracle/weblogic-kubernetes-operator.git
3737

3838
{{< readfile file="/samples/simple/azure-kubernetes-service/includes/create-aks-cluster-body-02.txt" >}}
3939

40-
> **Note**: If you run into VM size failure, see [Troubleshooting - Virtual Machine size is not supported]({{< relref "/samples/simple/azure-kubernetes-service/troubleshooting#virtual-machine-size-is-not-supported" >}}).
40+
**Note**: If you run into VM size failure, see [Troubleshooting - Virtual Machine size is not supported]({{< relref "/samples/simple/azure-kubernetes-service/troubleshooting#virtual-machine-size-is-not-supported" >}}).
4141

4242
{{< readfile file="/samples/simple/azure-kubernetes-service/includes/create-aks-cluster-storage.txt" >}}
4343

@@ -121,18 +121,18 @@ sh.helm.release.v1.weblogic-operator.v1 helm.sh/release.v1
121121
weblogic-operator-secrets Opaque 1 5m41s
122122
```
123123

124-
> **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.
124+
**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.
125125

126126
##### Create WebLogic Domain
127127
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.
128128

129129
We need to set up the domain configuration for the WebLogic domain.
130130

131-
1. Check if resources are ready
131+
1. Check if resources are ready.
132132

133133
If you used the automation script to create the AKS cluster, skip this step and go to step 2.
134134

135-
If you create Azure resources step by step according to the steps above, validate all the resources created above using the script `kubernetes/samples/scripts/create-weblogic-domain-on-azure-kubernetes-service/validate.sh`.
135+
If you created Azure resources, step-by-step, according to the previous steps, then validate that all the resources above were created by using the script `kubernetes/samples/scripts/create-weblogic-domain-on-azure-kubernetes-service/validate.sh`.
136136

137137
Use the following commands to check if the resources are ready:
138138

@@ -165,7 +165,7 @@ We need to set up the domain configuration for the WebLogic domain.
165165
Persistent Volume Claim: wls-azurefile-1612795811
166166
```
167167

168-
2. Now let's ask the operator to create a WebLogic Server domain within the AKS cluster.
168+
2. Now let's ask the operator to create a WebLogic Server domain within the AKS cluster.
169169

170170
For complete details on domain creation, see [Domain home on a PV - Use the script to create a domain]({{< relref "/samples/simple/domains/domain-home-on-pv#use-the-script-to-create-a-domain" >}}). If you do not want the complete details and just want to continue with the domain creation for AKS, invoke the `create-domain.sh` script as shown next.
171171

@@ -191,11 +191,11 @@ We need to set up the domain configuration for the WebLogic domain.
191191
Failed to pull image "container-registry.oracle.com/middleware/weblogic:12.2.1.4": rpc error: code = Unknown desc = Error response from daemon: Get https://container-registry-phx.oracle.com/v2/middleware/weblogic/manifests/12.2.1.4: unauthorized: authentication required
192192
```
193193

194-
Ensure the arguments you passed to the script `create-docker-credentials-secret.sh` are correct with respect to your Oracle SSO credentials.
194+
Ensure that the arguments you passed to the script `create-docker-credentials-secret.sh` are correct with respect to your Oracle SSO credentials.
195195

196196
The following example output shows the WebLogic domain was created successfully.
197197

198-
{{%expand "Click here to view the example output." %}}
198+
{{%expand "Click here to view the example output." %}}
199199
```bash
200200
$ ./create-domain.sh -i ~/azure/weblogic-on-aks/my-create-domain-inputs.yaml -o ~/azure -e -v
201201
Input parameters being used
@@ -270,7 +270,7 @@ We need to set up the domain configuration for the WebLogic domain.
270270
```
271271
{{% /expand %}}
272272
273-
> **Note**: If your output does not show a successful completion, you must
273+
**Note**: If your output does not show a successful completion, you must
274274
troubleshoot the reason and resolve it before proceeding to the next
275275
step.
276276
@@ -297,7 +297,7 @@ We need to set up the domain configuration for the WebLogic domain.
297297
type: LoadBalancer
298298
```
299299
300-
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.
300+
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.
301301
302302
```yaml
303303
apiVersion: v1
@@ -356,7 +356,7 @@ We need to set up the domain configuration for the WebLogic domain.
356356
weblogic-operator-56654bcdb7-qww7f 1/1 Running 0 25m
357357
```
358358
359-
{{% notice tip %}} If Kubernetes advertises the WebLogic pod as `Running` you can be assured the WebLogic Server actually is running because the operator ensures the Kubernetes health checks are actually polling the WebLogic health check mechanism.
359+
{{% notice tip %}} If Kubernetes advertises the WebLogic pod as `Running` you can be assured the WebLogic Server actually is running because the operator ensures that the Kubernetes health checks are actually polling the WebLogic health check mechanism.
360360
{{% /notice %}}
361361
362362
Get the addresses of the Administration Server and Managed Servers (please wait for the external IP addresses to be assigned):
@@ -439,7 +439,7 @@ To deploy a sample application on WLS, you may skip to the section [Deploy sampl
439439
440440
If you want to automate the above steps of creating AKS cluster and WLS domain, you can use the script `kubernetes/samples/scripts/create-weblogic-domain-on-azure-kubernetes-service/create-domain-on-aks.sh`.
441441
442-
The sample script will create a WLS domain home on the AKS cluster, including
442+
The sample script will create a WLS domain home on the AKS cluster, including:
443443
- Creating a new Azure resource group, with a new Azure Storage Account and Azure File Share to allow WebLogic to persist its configuration and data separately from the Kubernetes pods that run WLS workloads.
444444
- Creating WLS domain home.
445445
- Generating the domain resource YAML files, which can be used to restart the Kubernetes artifacts of the corresponding domain.
@@ -452,7 +452,7 @@ For input values, you can edit `kubernetes/samples/scripts/create-weblogic-domai
452452
| `azureServicePrincipalClientSecret` | `8693089o-q190-45ps-9319-or36252s3s90` | A client secret of your service principal; refer to the client secret in the [Create Service Principal]({{< relref "/samples/simple/azure-kubernetes-service/domain-on-pv#create-a-service-principal-for-aks" >}}) section. |
453453
| `azureServicePrincipalTenantId` | `72s988os-86s1-cafe-babe-2q7pq011qo47` | Tenant (Directory ) ID of your service principal; refer to the client secret in the [Create Service Principal]({{< relref "/samples/simple/azure-kubernetes-service/domain-on-pv#create-a-service-principal-for-aks" >}}) section. |
454454
| `dockerEmail` | `yourDockerEmail` | Oracle Single Sign-On (SSO) account email, used to pull the WebLogic Server Docker image. |
455-
| `dockerPassword` | `yourDockerPassword`| Password for Oracle SSO account, used to pull the WebLogic Server Docker image. In clear text. |
455+
| `dockerPassword` | `yourDockerPassword`| Password for Oracle SSO account, used to pull the WebLogic Server Docker image, in clear text. |
456456
| `dockerUserName` | `yourDockerId` | The same value as `dockerEmail`. |
457457
| `namePrefix` | `0730` | Alphanumeric value used as a disambiguation prefix for several Kubernetes resources. |
458458

docs-source/content/samples/simple/azure-kubernetes-service/includes/create-aks-cluster-body-01.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Found an existing application instance of "5pn2s201-nq4q-43n1-z942-p9r9571qr3rp"
3232
Insufficient privileges to complete the operation.
3333
```
3434

35-
The problem may be a pre-existing service principal with the same name. Either delete the other Service Principal or pick a different name.
35+
The problem may be a pre-existing service principal with the same name. Either delete the other service principal or pick a different name.
3636

3737
Successful output will look like the following:
3838

@@ -74,9 +74,9 @@ You will need an Oracle account. The following steps will direct you to accept t
7474

7575
- In a web browser, navigate to https://container-registry.oracle.com and log in using the Oracle Single Sign-On authentication service. If you do not already have SSO credentials, at the top of the page, click the **Sign In** link to create them.
7676
- The Oracle Container Registry provides a WebLogic Server 12.2.1.4.0 Docker image, which already has the necessary patches applied, and the Oracle WebLogic Server 12.2.1.4.0 and 14.1.1.0.0 images, which do not require any patches.
77-
- Ensure Docker desktop is running. Find and then pull the WebLogic 12.2.1.4 install image:
77+
- Ensure that Docker desktop is running. Find and then pull the WebLogic 12.2.1.4 install image:
7878
```bash
7979
$ docker pull container-registry.oracle.com/middleware/weblogic:12.2.1.4
8080
```
8181

82-
If you have problems accessing the Oracle Container Registry, you can build your own docker images from the [Oracle GitHub repository](https://github.com/oracle/docker-images/tree/main/OracleWebLogic/dockerfiles).
82+
If you have problems accessing the Oracle Container Registry, you can build your own Docker images from the [Oracle GitHub repository](https://github.com/oracle/docker-images/tree/main/OracleWebLogic/dockerfiles).

docs-source/content/samples/simple/azure-kubernetes-service/includes/create-aks-cluster-body-02.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#### Create the AKS cluster
22

3-
This sample requires that you disable the AKS addon `http_application_routing` by default. If you want to enable `http_application_routing`, please follow [HTTP application routing](https://docs.microsoft.com/azure/aks/http-application-routing).
3+
This sample requires that you disable the AKS addon `http_application_routing` by default. If you want to enable `http_application_routing`, then follow [HTTP application routing](https://docs.microsoft.com/azure/aks/http-application-routing).
44

55
Run the following commands to create the AKS cluster instance.
66

@@ -43,12 +43,11 @@ Successful output will look similar to:
4343
Merged "wlsaks1596087429" as current context in /home/username/.kube/config
4444
```
4545

46-
After your Kubernetes cluster is up and running, run the following commands to make sure kubectl can access the Kubernetes cluster:
46+
After your Kubernetes cluster is up and running, run the following commands to make sure `kubectl` can access the Kubernetes cluster:
4747

4848
```shell
4949
$ kubectl get nodes -o wide
5050
NAME STATUS ROLES AGE VERSION INTERNAL-IP EXTERNAL-IP OS-IMAGE KERNEL-VERSION CONTAINER-RUNTIME
5151
aks-pool1haiche-33688868-vmss000000 Ready agent 4m25s v1.17.13 10.240.0.4 <none> Ubuntu 16.04.7 LTS 4.15.0-1098-azure docker://19.3.12
5252
aks-pool1haiche-33688868-vmss000001 Ready agent 4m12s v1.17.13 10.240.0.5 <none> Ubuntu 16.04.7 LTS 4.15.0-1098-azure docker://19.3.12
5353
```
54-

0 commit comments

Comments
 (0)