Skip to content

Commit

Permalink
Merge branch 'update-aks-doc-20241106' into 'main'
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
rjeberhard committed Dec 2, 2024
1 parent 66b4359 commit 100fa1b
Show file tree
Hide file tree
Showing 12 changed files with 90 additions and 123 deletions.
18 changes: 16 additions & 2 deletions documentation/site/content/managing-domains/aks/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,10 @@ In this section, you can configure some options about the AKS which will run Web
| Field | Description |
|-------|-------------|
|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. |
| 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).|
| 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). |
| 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). |
| 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).|
| 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. |

#### Image selection

Expand All @@ -86,12 +87,13 @@ In this section, you can configure the image that is deployed using the model-in
| Field | Description |
|-------|-------------|
|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). |
| 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. |
| 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. |
| 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. |
| Password for Oracle Single Sign-On authentication | The password for that account. |
| 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. |
| 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. |
| Select desired combination of WebLogic Server, JDK and Operating System or fully qualified Docker tag | Select one of the supported images. |
| 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/) |

#### Application

Expand Down Expand Up @@ -333,6 +335,18 @@ After the provisioning is complete, you can create KEDA scaling rules. A sample
* The **shellCmdtoOutputKedaScalerSample** value is the base64 string of a scaler sample. Copy the value and run it in your terminal.
* 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).

When you are satisfied with your selections, select **Next** and open the **Tags** blade.

### Tags

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

Enter the desired name/value pairs for resources in the table, filling out each of the following fields.

| Name | Value | Resource |
|------|-------|----------|
| Tag name. | Tag value. | Resources available for tagging in this offer. |

When you are satisfied with your selections, select **Review + create**.

### Review + create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,13 @@ description: "Sample for creating a WebLogic domain home on an existing PV or PV

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.

#### Contents

- [Prerequisites](#prerequisites)
- [Create Resource Group](#create-resource-group)
- [Create an AKS cluster](#create-the-aks-cluster)
- [Create and configure storage](#create-storage)
- [Create an Azure Storage account and NFS share](#create-an-azure-storage-account-and-nfs-share)
- [Create SC and PVC](#create-sc-and-pvc)
- [Create a domain creation image](#create-a-domain-creation-image)
- [Install WebLogic Kubernetes Operator](#install-weblogic-kubernetes-operator-into-the-aks-cluster)
- [Create WebLogic domain](#create-weblogic-domain)
- [Create secrets](#create-secrets)
- [Create WebLogic Domain](#create-weblogic-domain-1)
- [Create LoadBalancer](#create-loadbalancer)
- [Automation](#automation)
- [Access sample application](#access-sample-application)
- [Validate NFS volume](#validate-nfs-volume)
- [Clean up resources](#clean-up-resources)
- [Troubleshooting](#troubleshooting)
- [Useful links](#useful-links)
{{< table_of_contents >}}

### Prerequisites

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

##### Prepare parameters
#### Prepare parameters

Set required parameters by running the following commands.

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

```

#### Oracle Container Registry

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

#### Sign in with Azure CLI

{{< readfile file="/samples/azure-kubernetes-service/includes/sign-in-azure.txt" >}}

#### Download the WebLogic Kubernetes Operator sample

{{< readfile file="/samples/azure-kubernetes-service/includes/download-samples-zip.txt" >}}

{{% 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.
{{% /notice %}}

### Create Resource Group

{{< readfile file="/samples/azure-kubernetes-service/includes/create-resource-group.txt" >}}

### Create the AKS cluster

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

**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" >}}).

### Create storage

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

#### Create a domain creation image
### Create a domain creation image

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" >}}).

- [Image creation prerequisites](#image-creation-prerequisites)
- [Image creation - Introduction](#image-creation---introduction)
- [Understanding your first archive](#understanding-your-first-archive)
- [Staging a ZIP file of the archive](#staging-a-zip-file-of-the-archive)
- [Staging model files](#staging-model-files)
- [Creating the image with WIT](#creating-the-image-with-wit)
- [Pushing the image to Azure Container Registry](#pushing-the-image-to-azure-container-registry)

##### Image creation prerequisites
#### Image creation prerequisites

- The `JAVA_HOME` environment variable must be set and must reference a valid JDK 8 or 11 installation.
- 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" >}}).
Expand All @@ -113,15 +100,15 @@ This sample requires [Domain creation images]({{< relref "/managing-domains/doma

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

##### Image creation - Introduction
#### Image creation - Introduction

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

##### Understanding your first archive
#### Understanding your first archive

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

##### Staging a ZIP file of the archive
#### Staging a ZIP file of the archive

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

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

##### Staging model files
#### Staging model files

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

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.

##### Creating the image with WIT
#### Creating the image with WIT

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

Expand All @@ -154,7 +141,7 @@ The `imagetool.sh` is not supported on macOS with Apple Silicon. See [Troublesho
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" >}}).
{{% /notice %}}

##### Pushing the image to Azure Container Registry
#### Pushing the image to Azure Container Registry

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

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

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" >}}).

#### Install WebLogic Kubernetes Operator into the AKS cluster
### Install WebLogic Kubernetes Operator into the AKS cluster

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.

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

#### Create WebLogic domain

- [Create secrets](#create-secrets)
- [Create WebLogic Domain](#create-weblogic-domain-1)
- [Create LoadBalancer](#create-loadbalancer)
### Create WebLogic domain

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.

##### Create secrets
#### Create secrets

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:

Expand Down Expand Up @@ -267,15 +250,15 @@ wlsregcred kubernetes.io/dockerconfigjson 1

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

##### Enable Weblogic Operator
#### Enable Weblogic Operator

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

```shell
kubectl label namespace default weblogic-operator=enabled
```

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

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

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.

#### Automation
### Automation

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

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

#### Access sample application
### Access sample application

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

Expand Down Expand Up @@ -463,7 +446,7 @@ Found 0 local data sources:
</pre></body></html>
```

#### Validate NFS volume
### Validate NFS volume

There are several approaches to validate the NFS volume:

Expand All @@ -485,18 +468,18 @@ wlsstorage1612795811.file.core.windows.net:/wlsstorage1612795811/wls-weblogic-16
...
```

#### Clean up resources
### Clean up resources

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

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

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

#### Troubleshooting
### Troubleshooting

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

#### Useful links
### Useful links

- [Domain on a PV]({{< relref "/samples/domains/domain-home-on-pv/_index.md" >}}) sample
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
##### Oracle Container Registry

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.

- 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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

#### Create the AKS cluster

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

Run the following command to create the AKS cluster.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
#### Create storage

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.

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

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

##### Create an Azure Storage account and NFS share
#### Create an Azure Storage account and NFS share

1. Create an Azure Storage Account.

Expand Down Expand Up @@ -185,9 +183,9 @@ You will dynamically create and use a persistent volume with Azure Files NFS sha
]
```

##### Create SC and PVC
#### Create SC and PVC

##### Generated configuration files
#### Generated configuration files
Use the following command to generate configuration files.

```shell
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

#### Create Resource Group

Create the resource group by issuing the following commands.

```shell
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
##### Download the WebLogic Kubernetes Operator sample.

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.

```shell
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
#### Prerequisites

This sample assumes the following prerequisite environment.

* 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.
Expand Down
Loading

0 comments on commit 100fa1b

Please sign in to comment.