Skip to content

Commit 100fa1b

Browse files
committed
Merge branch 'update-aks-doc-20241106' into 'main'
On branch update-aks-doc-20241106 Copyediting. See merge request weblogic-cloud/weblogic-kubernetes-operator!4885 (cherry picked from commit 3353c53) ec0462b update aks userguide for Tags 7c1b110 use built-in content table in AKS samples. 96e5ca6 On branch update-aks-doc-20241106 Copyediting.
1 parent 66b4359 commit 100fa1b

File tree

12 files changed

+90
-123
lines changed

12 files changed

+90
-123
lines changed

documentation/site/content/managing-domains/aks/_index.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,10 @@ In this section, you can configure some options about the AKS which will run Web
7575
| Field | Description |
7676
|-------|-------------|
7777
|Create a new AKS cluster| If set to **Yes**, the deployment will create a new AKS cluster resource in the specified resource group. If set to **No**, you have the opportunity to select an existing AKS cluster, into which the deployment is configured. Note: the offer assumes the existing AKS cluster has no WebLogic related deployments. |
78+
| Node size | The default VM size is 2x Standard DSv2, 2 vcpus, 7 GB memory. If you want to select a different VM size, select **Change Size**, select the size from the list (for example, A3) on the Select a VM size page, and select **Select**. For more information about sizing the virtual machine, see the [Azure documentation on Sizes](https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/overview).|
7879
| Minimum node count | The minimum node count in the AKS cluster. This value can be changed after deployment. For information, see [AKS autoscaler](https://learn.microsoft.com/azure/aks/cluster-autoscaler). |
7980
| Maximum node count | The maximum node count in the AKS cluster. This value can be changed after deployment. For information, see [AKS autoscaler](https://learn.microsoft.com/azure/aks/cluster-autoscaler). |
80-
| Node size | The default VM size is 2x Standard DSv2, 2 vcpus, 7 GB memory. If you want to select a different VM size, select **Change Size**, select the size from the list (for example, A3) on the Select a VM size page, and select **Select**. For more information about sizing the virtual machine, see the [Azure documentation on Sizes](https://docs.microsoft.com/azure/cloud-services/cloud-services-sizes-specs).|
81+
| Select AKS cluster | This option is shown if **Create a new AKS cluster?** is set to **No**. If visible, select an existing Azure Kubernetes Service instance. |
8182

8283
#### Image selection
8384

@@ -86,12 +87,13 @@ In this section, you can configure the image that is deployed using the model-in
8687
| Field | Description |
8788
|-------|-------------|
8889
|Create a new Azure Container Registry to store application images?|If set to **Yes**, the offer will create a new Azure Container Registry (ACR) to hold the images for use in the deployment. If set to **No**, you must specify an existing ACR. In this case, you must be sure the selected ACR has the admin account enabled. For details, please see [Admin account](https://docs.microsoft.com/azure/container-registry/container-registry-authentication?tabs=azure-cli#admin-account). |
89-
| Select ACR instance | This option is shown if **Create a new Azure Container Registry to store application images?** is set to **No**. If visible, select an existing Acure Container Registry instance. |
90+
| Select ACR instance | This option is shown if **Create a new Azure Container Registry to store application images?** is set to **No**. If visible, select an existing Azure Container Registry instance. |
9091
| Username for Oracle Single Sign-On authentication | The Oracle Single Sign-on account user name for which the Terms and Restrictions for the selected WebLogic Server image have been accepted. |
9192
| Password for Oracle Single Sign-On authentication | The password for that account. |
9293
| Confirm password | Re-enter the value of the preceding field. | If 'Yes' is selected; the deployment process will pull from the CPU WebLogic Server image repository in the OCR. If 'No' is selected the deployment process will pull from the WebLogic Server image repository in OCR. |
9394
| Select the type of WebLogic Server Images. | If set to **Patched WebLogic Server Images**, you must accept the license agreement in the `middleware/weblogic_cpu` repository. If set to **General WebLogic Server Images**, you must accept the license agreement in the `middleware/weblogic`. Steps to accept the license agreement: log in to the [Oracle Container Registry](https://container-registry.oracle.com/); navigate to the `middleware/weblogic_cpu` and `middleware/weblogic` repository; accept license agreement. See this [document](https://aka.ms/wls-aks-ocr-doc) for more information. |
9495
| Select desired combination of WebLogic Server, JDK and Operating System or fully qualified Docker tag | Select one of the supported images. |
96+
| WebLogic Docker tag | This option is shown if **Select desired combination of WebLogic Server, JDK and Operating System or fully qualified Docker tag** is set to **Others**. If visible, input a fully qualified Docker tag. You can find the available tags from WebLogic Server Images page of [Oracle Container Registry](https://container-registry.oracle.com/) |
9597

9698
#### Application
9799

@@ -333,6 +335,18 @@ After the provisioning is complete, you can create KEDA scaling rules. A sample
333335
* The **shellCmdtoOutputKedaScalerSample** value is the base64 string of a scaler sample. Copy the value and run it in your terminal.
334336
* For guidance on how to complete the configuration, see [Tutorial: Migrate Oracle WebLogic Server to AKS with KEDA scaler based on Prometheus Metrics](https://aka.ms/wls-aks-keda-scaler).
335337

338+
When you are satisfied with your selections, select **Next** and open the **Tags** blade.
339+
340+
### Tags
341+
342+
Use the Tags blade to provide tags for resources and resource groups. Tags are name/value pairs that allow you to categorize resources and consolidate billing by applying the same tag to multiple resources and resource groups. [Learn more about tags](https://go.microsoft.com/fwlink/?linkid=873112).
343+
344+
Enter the desired name/value pairs for resources in the table, filling out each of the following fields.
345+
346+
| Name | Value | Resource |
347+
|------|-------|----------|
348+
| Tag name. | Tag value. | Resources available for tagging in this offer. |
349+
336350
When you are satisfied with your selections, select **Review + create**.
337351

338352
### Review + create

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

Lines changed: 35 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,13 @@ description: "Sample for creating a WebLogic domain home on an existing PV or PV
77

88
This sample demonstrates how to use the [WebLogic Kubernetes Operator](https://oracle.github.io/weblogic-kubernetes-operator) (hereafter "the operator") to set up a WebLogic Server (WLS) cluster on the Azure Kubernetes Service (AKS) using the domain on PV approach. After going through the steps, your WLS domain runs on an AKS cluster and you can manage your WLS domain by accessing the WebLogic Server Administration Console.
99

10-
#### Contents
11-
12-
- [Prerequisites](#prerequisites)
13-
- [Create Resource Group](#create-resource-group)
14-
- [Create an AKS cluster](#create-the-aks-cluster)
15-
- [Create and configure storage](#create-storage)
16-
- [Create an Azure Storage account and NFS share](#create-an-azure-storage-account-and-nfs-share)
17-
- [Create SC and PVC](#create-sc-and-pvc)
18-
- [Create a domain creation image](#create-a-domain-creation-image)
19-
- [Install WebLogic Kubernetes Operator](#install-weblogic-kubernetes-operator-into-the-aks-cluster)
20-
- [Create WebLogic domain](#create-weblogic-domain)
21-
- [Create secrets](#create-secrets)
22-
- [Create WebLogic Domain](#create-weblogic-domain-1)
23-
- [Create LoadBalancer](#create-loadbalancer)
24-
- [Automation](#automation)
25-
- [Access sample application](#access-sample-application)
26-
- [Validate NFS volume](#validate-nfs-volume)
27-
- [Clean up resources](#clean-up-resources)
28-
- [Troubleshooting](#troubleshooting)
29-
- [Useful links](#useful-links)
10+
{{< table_of_contents >}}
11+
12+
### Prerequisites
3013

3114
{{< readfile file="/samples/azure-kubernetes-service/includes/prerequisites-01.txt" >}}
3215

33-
##### Prepare parameters
16+
#### Prepare parameters
3417

3518
Set required parameters by running the following commands.
3619

@@ -57,36 +40,40 @@ export ACR_NAME="${NAME_PREFIX}acr${TIMESTAMP}"
5740

5841
```
5942

43+
#### Oracle Container Registry
44+
6045
{{< readfile file="/samples/azure-kubernetes-service/includes/create-aks-cluster-body-01.txt" >}}
6146

47+
#### Sign in with Azure CLI
48+
6249
{{< readfile file="/samples/azure-kubernetes-service/includes/sign-in-azure.txt" >}}
6350

51+
#### Download the WebLogic Kubernetes Operator sample
52+
6453
{{< readfile file="/samples/azure-kubernetes-service/includes/download-samples-zip.txt" >}}
6554

6655
{{% notice info %}} The following sections of the sample instructions will guide you, step-by-step, through the process of setting up a WebLogic cluster on AKS - remaining as close as possible to a native Kubernetes experience. This lets you understand and customize each step. If you wish to have a more automated experience that abstracts some lower level details, you can skip to the [Automation](#automation) section.
6756
{{% /notice %}}
6857

58+
### Create Resource Group
59+
6960
{{< readfile file="/samples/azure-kubernetes-service/includes/create-resource-group.txt" >}}
7061

62+
### Create the AKS cluster
63+
7164
{{< readfile file="/samples/azure-kubernetes-service/includes/create-aks-cluster-body-02.txt" >}}
7265

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

68+
### Create storage
69+
7570
{{< readfile file="/samples/azure-kubernetes-service/includes/create-aks-cluster-storage.txt" >}}
7671

77-
#### Create a domain creation image
72+
### Create a domain creation image
7873

7974
This sample requires [Domain creation images]({{< relref "/managing-domains/domain-on-pv/domain-creation-images" >}}). For more information, see [Domain on Persistent Volume]({{< relref "/managing-domains/domain-on-pv/overview" >}}).
8075

81-
- [Image creation prerequisites](#image-creation-prerequisites)
82-
- [Image creation - Introduction](#image-creation---introduction)
83-
- [Understanding your first archive](#understanding-your-first-archive)
84-
- [Staging a ZIP file of the archive](#staging-a-zip-file-of-the-archive)
85-
- [Staging model files](#staging-model-files)
86-
- [Creating the image with WIT](#creating-the-image-with-wit)
87-
- [Pushing the image to Azure Container Registry](#pushing-the-image-to-azure-container-registry)
88-
89-
##### Image creation prerequisites
76+
#### Image creation prerequisites
9077

9178
- The `JAVA_HOME` environment variable must be set and must reference a valid JDK 8 or 11 installation.
9279
- Copy the sample to a new directory; for example, use the directory `/tmp/dpv-sample`. In the directory name, `dpv` is short for "domain on pv". Domain on PV is one of three domain home source types supported by the operator. To learn more, see [Choose a domain home source type]({{< relref "/managing-domains/choosing-a-model/_index.md" >}}).
@@ -113,15 +100,15 @@ This sample requires [Domain creation images]({{< relref "/managing-domains/doma
113100

114101
{{< readfile file="/samples/azure-kubernetes-service/includes/download-wls-tools.txt" >}}
115102

116-
##### Image creation - Introduction
103+
#### Image creation - Introduction
117104

118105
{{< readfile file="/samples/azure-kubernetes-service/includes/auxiliary-image-directory.txt" >}}
119106

120-
##### Understanding your first archive
107+
#### Understanding your first archive
121108

122109
See [Understanding your first archive]({{< relref "/samples/domains/domain-home-on-pv/build-domain-creation-image#understand-your-first-archive" >}}).
123110

124-
##### Staging a ZIP file of the archive
111+
#### Staging a ZIP file of the archive
125112

126113
Delete any possible existing archive.zip in case we have an old leftover version.
127114

@@ -136,13 +123,13 @@ $ cd /tmp/dpv-sample/archives/archive-v1
136123
$ zip -r ${WDT_MODEL_FILES_PATH}/WLS-v1/archive.zip wlsdeploy
137124
```
138125

139-
##### Staging model files
126+
#### Staging model files
140127

141128
{{< readfile file="/samples/azure-kubernetes-service/includes/staging-model-files.txt" >}}
142129

143130
An image can contain multiple properties files, archive ZIP files, and model YAML files but in this sample you use just one of each. For a complete description of WDT model file naming conventions, file loading order, and macro syntax, see [Model files]({{< relref "/managing-domains/domain-on-pv/model-files" >}}) in the user documentation.
144131

145-
##### Creating the image with WIT
132+
#### Creating the image with WIT
146133

147134
{{< readfile file="/samples/azure-kubernetes-service/includes/run-mii-to-create-auxiliary-image.txt" >}}
148135

@@ -154,7 +141,7 @@ The `imagetool.sh` is not supported on macOS with Apple Silicon. See [Troublesho
154141
You may run into a `Dockerfile` parsing error if your Docker buildkit is enabled, see [Troubleshooting - WebLogic Image Tool failure]({{< relref "/samples/azure-kubernetes-service/troubleshooting#weblogic-image-tool-failure" >}}).
155142
{{% /notice %}}
156143

157-
##### Pushing the image to Azure Container Registry
144+
#### Pushing the image to Azure Container Registry
158145

159146
{{< readfile file="/samples/azure-kubernetes-service/includes/create-acr.txt" >}}
160147

@@ -169,7 +156,7 @@ $ docker push ${LOGIN_SERVER}/wdt-domain-image:WLS-v1
169156

170157
If you see an error that seems related to you not being an **Owner on this subscription**, please refer to the troubleshooting section [Cannot attach ACR due to not being Owner of subscription]({{< relref "/samples/azure-kubernetes-service/troubleshooting#cannot-attach-acr-due-to-not-being-owner-of-subscription" >}}).
171158

172-
#### Install WebLogic Kubernetes Operator into the AKS cluster
159+
### Install WebLogic Kubernetes Operator into the AKS cluster
173160

174161
The WebLogic Kubernetes Operator is an adapter to integrate WebLogic Server and Kubernetes, allowing Kubernetes to serve as a container infrastructure hosting WLS instances. The operator runs as a Kubernetes Pod and stands ready to perform actions related to running WLS on Kubernetes.
175162

@@ -207,15 +194,11 @@ weblogic-operator-webhook-868db5875b-55v7r 1/1 Running 0 86s
207194
{{% notice tip %}} You will have to press Ctrl-C to exit this command due to the `-w` flag.
208195
{{% /notice %}}
209196

210-
#### Create WebLogic domain
211-
212-
- [Create secrets](#create-secrets)
213-
- [Create WebLogic Domain](#create-weblogic-domain-1)
214-
- [Create LoadBalancer](#create-loadbalancer)
197+
### Create WebLogic domain
215198

216199
Now that you have created the AKS cluster, installed the operator, and verified that the operator is ready to go, you can ask the operator to create a WLS domain.
217200

218-
##### Create secrets
201+
#### Create secrets
219202

220203
You will use the `$BASE_DIR/sample-scripts/create-weblogic-domain-credentials/create-weblogic-credentials.sh` script to create the domain WebLogic administrator credentials as a Kubernetes secret. Please run the following commands:
221204

@@ -267,15 +250,15 @@ wlsregcred kubernetes.io/dockerconfigjson 1
267250

268251
**NOTE**: If the `NAME` column in your output is missing any of the values shown above, please review your execution of the preceding steps in this sample to ensure that you correctly followed all of them.
269252

270-
##### Enable Weblogic Operator
253+
#### Enable Weblogic Operator
271254

272255
Run the following command to enable the operator to monitor the namespace.
273256

274257
```shell
275258
kubectl label namespace default weblogic-operator=enabled
276259
```
277260

278-
##### Create WebLogic Domain
261+
#### Create WebLogic Domain
279262
Now, you deploy a `sample-domain1` domain resource and an associated `sample-domain1-cluster-1` cluster resource using a single YAML resource file which defines both resources. The domain resource and cluster resource tells the operator how to deploy a WebLogic domain. They do not replace the traditional WebLogic configuration files, but instead cooperate with those files to describe the Kubernetes artifacts of the corresponding domain.
280263

281264
- Run the following commands to generate resource files.
@@ -391,7 +374,7 @@ The domain resource references the cluster resource, a WebLogic Server installat
391374

392375
To access the sample application on WLS, skip to the section [Access sample application](#access-sample-application). The next section includes a script that automates all of the preceding steps.
393376

394-
#### Automation
377+
### Automation
395378

396379
If you want to automate the above steps of creating the AKS cluster and WLS domain, you can use the script `${BASE_DIR}/sample-scripts/create-weblogic-domain-on-azure-kubernetes-service/create-domain-on-aks.sh`.
397380

@@ -418,7 +401,7 @@ To interact with the cluster using `kubectl`, use `az aks get-credentials` as sh
418401
{{% 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.
419402
{{% /notice %}}
420403

421-
#### Access sample application
404+
### Access sample application
422405

423406
Access the Administration Console using the admin load balancer IP address.
424407

@@ -463,7 +446,7 @@ Found 0 local data sources:
463446
</pre></body></html>
464447
```
465448

466-
#### Validate NFS volume
449+
### Validate NFS volume
467450

468451
There are several approaches to validate the NFS volume:
469452

@@ -485,18 +468,18 @@ wlsstorage1612795811.file.core.windows.net:/wlsstorage1612795811/wls-weblogic-16
485468
...
486469
```
487470

488-
#### Clean up resources
471+
### Clean up resources
489472

490473
{{< readfile file="/samples/azure-kubernetes-service/includes/clean-up-resources-body-01.txt" >}}
491474

492475
If you created the AKS cluster step by step, run the following command to clean up resources.
493476

494477
{{< readfile file="/samples/azure-kubernetes-service/includes/clean-up-resources-body-02.txt" >}}
495478

496-
#### Troubleshooting
479+
### Troubleshooting
497480

498481
For troubleshooting advice, see [Troubleshooting]({{< relref "/samples/azure-kubernetes-service/troubleshooting.md" >}}).
499482

500-
#### Useful links
483+
### Useful links
501484

502485
- [Domain on a PV]({{< relref "/samples/domains/domain-home-on-pv/_index.md" >}}) sample

documentation/site/content/samples/azure-kubernetes-service/includes/create-aks-cluster-body-01.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
##### Oracle Container Registry
2-
31
The following steps will direct you to accept the license agreement for WebLogic Server. Make note of your Oracle Account password and email. This sample pertains to 12.2.1.4, but other versions may work as well.
42

53
- 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.

documentation/site/content/samples/azure-kubernetes-service/includes/create-aks-cluster-body-02.txt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
#### Create the AKS cluster
3-
41
This sample doesn't enable application routing. If you want to enable application routing, follow [Managed nginx Ingress with the application routing add-on in AKS](https://learn.microsoft.com/azure/aks/app-routing?tabs=default%2Cdeploy-app-default).
52

63
Run the following command to create the AKS cluster.

documentation/site/content/samples/azure-kubernetes-service/includes/create-aks-cluster-storage.txt

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
#### Create storage
2-
31
Our usage pattern for the operator involves creating Kubernetes "persistent volumes" to allow the WebLogic Server to persist its configuration and data separately from the Kubernetes Pods that run WebLogic Server workloads.
42

53
You will create an external data volume to access and persist data. There are several options for data sharing as described in [Storage options for applications in Azure Kubernetes Service (AKS)](https://docs.microsoft.com/azure/aks/concepts-storage).
64

75
You will dynamically create and use a persistent volume with Azure Files NFS share. For details about this full featured cloud storage solution, see the [Azure Files Documentation](https://docs.microsoft.com/azure/aks/azure-files-dynamic-pv).
86

9-
##### Create an Azure Storage account and NFS share
7+
#### Create an Azure Storage account and NFS share
108

119
1. Create an Azure Storage Account.
1210

@@ -185,9 +183,9 @@ You will dynamically create and use a persistent volume with Azure Files NFS sha
185183
]
186184
```
187185

188-
##### Create SC and PVC
186+
#### Create SC and PVC
189187

190-
##### Generated configuration files
188+
#### Generated configuration files
191189
Use the following command to generate configuration files.
192190

193191
```shell

documentation/site/content/samples/azure-kubernetes-service/includes/create-resource-group.txt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
#### Create Resource Group
3-
41
Create the resource group by issuing the following commands.
52

63
```shell

documentation/site/content/samples/azure-kubernetes-service/includes/download-samples-zip.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
##### Download the WebLogic Kubernetes Operator sample.
2-
31
Download the WebLogic Kubernetes Operator sample ZIP file. We will use several scripts in this zip file to create a WebLogic domain. This sample was tested with v4.2.8, but should work with the latest release.
42

53
```shell

documentation/site/content/samples/azure-kubernetes-service/includes/prerequisites-01.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
#### Prerequisites
2-
31
This sample assumes the following prerequisite environment.
42

53
* If you don't have an [Azure subscription](https://learn.microsoft.com/en-us/azure/guides/developer/azure-developer-guide#understanding-accounts-subscriptions-and-billing), create a [free account](https://azure.microsoft.com/free/?ref=microsoft.com&utm_source=microsoft.com&utm_medium=docs&utm_campaign=visualstudio) before you begin.

0 commit comments

Comments
 (0)