From 45e8259747813489a62714f73353a118c5918d1e Mon Sep 17 00:00:00 2001 From: Rosemary Marano Date: Tue, 20 Jul 2021 18:03:52 -0400 Subject: [PATCH 1/2] change samples directory --- documentation/staging/content/_index.md | 2 +- documentation/staging/content/faq/newbie.md | 8 +-- .../content/quickstart/create-domain.md | 4 +- .../staging/content/quickstart/prepare.md | 4 +- .../staging/content/samples/_index.md | 3 + .../azure-kubernetes-service/_index.md | 10 +-- .../azure-kubernetes-service/domain-on-pv.md | 28 ++++---- .../includes/clean-up-resources-body-01.txt | 0 .../includes/clean-up-resources-body-02.txt | 0 .../includes/create-aks-cluster-body-01.txt | 0 .../includes/create-aks-cluster-body-02.txt | 0 .../includes/create-aks-cluster-storage.txt | 0 .../includes/prerequisites-01.txt | 0 .../includes/prerequisites-02.txt | 0 .../model-in-image.md | 24 +++---- .../screenshot-deploy-test-app.png | Bin .../screenshot-logs.png | Bin .../troubleshooting.md | 0 .../{simple => }/credentials/_index.md | 0 .../samples/{simple => }/database/_index.md | 2 +- .../samples/{simple => }/domains/_index.md | 0 .../domains/delete-domain/_index.md | 0 .../domains/domain-home-in-image/_index.md | 2 +- .../domains/domain-home-on-pv/_index.md | 4 +- .../fmw-domain-home-in-image/_index.md | 2 +- .../{simple => }/domains/fmw-domain/_index.md | 2 +- .../{simple => }/domains/lifecycle/_index.md | 0 .../domains/manually-create-domain/_index.md | 0 .../domains/model-in-image/_index.md | 26 +++---- .../domains/model-in-image/cleanup.md | 0 .../domains/model-in-image/initial.md | 12 ++-- .../domains/model-in-image/prerequisites.md | 6 +- .../domains/model-in-image/update1.md | 16 ++--- .../domains/model-in-image/update2.md | 18 ++--- .../domains/model-in-image/update3.md | 34 +++++----- .../domains/model-in-image/update4.md | 12 ++-- .../{simple => }/elastic-stack/_index.md | 0 .../elastic-stack/operator/_index.md | 0 .../elastic-stack/weblogic-domain/_index.md | 0 .../samples/{simple => }/ingress/_index.md | 0 .../content/samples/production/_index.md | 11 --- .../samples/{simple => }/rest/_index.md | 0 .../staging/content/samples/simple/_index.md | 11 --- .../samples/{simple => }/storage/_index.md | 0 .../tanzu-kubernetes-service/_index.md | 2 +- .../staging/content/security/certificates.md | 2 +- .../content/userguide/base-images/_index.md | 2 +- .../staging/content/userguide/cicd/tools.md | 4 +- .../content/userguide/kubernetes/k8s-setup.md | 2 +- .../userguide/managing-domains/_index.md | 4 +- .../choosing-a-model/_index.md | 6 +- .../managing-domains/domain-resource.md | 4 +- .../model-in-image/auxiliary-images.md | 64 +++++++++--------- .../model-in-image/overview.md | 4 +- .../model-in-image/runtime-updates.md | 6 +- .../managing-domains/model-in-image/usage.md | 8 +-- .../persistent-storage/_index.md | 2 +- .../userguide/managing-domains/prepare.md | 4 +- .../userguide/managing-fmw-domains/_index.md | 4 +- .../userguide/managing-operators/_index.md | 4 +- .../content/userguide/prepare/_index.md | 6 +- 61 files changed, 175 insertions(+), 194 deletions(-) rename documentation/staging/content/samples/{simple => }/azure-kubernetes-service/_index.md (80%) rename documentation/staging/content/samples/{simple => }/azure-kubernetes-service/domain-on-pv.md (93%) rename documentation/staging/content/samples/{simple => }/azure-kubernetes-service/includes/clean-up-resources-body-01.txt (100%) rename documentation/staging/content/samples/{simple => }/azure-kubernetes-service/includes/clean-up-resources-body-02.txt (100%) rename documentation/staging/content/samples/{simple => }/azure-kubernetes-service/includes/create-aks-cluster-body-01.txt (100%) rename documentation/staging/content/samples/{simple => }/azure-kubernetes-service/includes/create-aks-cluster-body-02.txt (100%) rename documentation/staging/content/samples/{simple => }/azure-kubernetes-service/includes/create-aks-cluster-storage.txt (100%) rename documentation/staging/content/samples/{simple => }/azure-kubernetes-service/includes/prerequisites-01.txt (100%) rename documentation/staging/content/samples/{simple => }/azure-kubernetes-service/includes/prerequisites-02.txt (100%) rename documentation/staging/content/samples/{simple => }/azure-kubernetes-service/model-in-image.md (96%) rename documentation/staging/content/samples/{simple => }/azure-kubernetes-service/screenshot-deploy-test-app.png (100%) rename documentation/staging/content/samples/{simple => }/azure-kubernetes-service/screenshot-logs.png (100%) rename documentation/staging/content/samples/{simple => }/azure-kubernetes-service/troubleshooting.md (100%) rename documentation/staging/content/samples/{simple => }/credentials/_index.md (100%) rename documentation/staging/content/samples/{simple => }/database/_index.md (98%) rename documentation/staging/content/samples/{simple => }/domains/_index.md (100%) rename documentation/staging/content/samples/{simple => }/domains/delete-domain/_index.md (100%) rename documentation/staging/content/samples/{simple => }/domains/domain-home-in-image/_index.md (99%) rename documentation/staging/content/samples/{simple => }/domains/domain-home-on-pv/_index.md (97%) rename documentation/staging/content/samples/{simple => }/domains/fmw-domain-home-in-image/_index.md (99%) rename documentation/staging/content/samples/{simple => }/domains/fmw-domain/_index.md (99%) rename documentation/staging/content/samples/{simple => }/domains/lifecycle/_index.md (100%) rename documentation/staging/content/samples/{simple => }/domains/manually-create-domain/_index.md (100%) rename documentation/staging/content/samples/{simple => }/domains/model-in-image/_index.md (81%) rename documentation/staging/content/samples/{simple => }/domains/model-in-image/cleanup.md (100%) rename documentation/staging/content/samples/{simple => }/domains/model-in-image/initial.md (98%) rename documentation/staging/content/samples/{simple => }/domains/model-in-image/prerequisites.md (99%) rename documentation/staging/content/samples/{simple => }/domains/model-in-image/update1.md (96%) rename documentation/staging/content/samples/{simple => }/domains/model-in-image/update2.md (95%) rename documentation/staging/content/samples/{simple => }/domains/model-in-image/update3.md (89%) rename documentation/staging/content/samples/{simple => }/domains/model-in-image/update4.md (94%) rename documentation/staging/content/samples/{simple => }/elastic-stack/_index.md (100%) rename documentation/staging/content/samples/{simple => }/elastic-stack/operator/_index.md (100%) rename documentation/staging/content/samples/{simple => }/elastic-stack/weblogic-domain/_index.md (100%) rename documentation/staging/content/samples/{simple => }/ingress/_index.md (100%) delete mode 100644 documentation/staging/content/samples/production/_index.md rename documentation/staging/content/samples/{simple => }/rest/_index.md (100%) delete mode 100644 documentation/staging/content/samples/simple/_index.md rename documentation/staging/content/samples/{simple => }/storage/_index.md (100%) rename documentation/staging/content/samples/{simple => }/tanzu-kubernetes-service/_index.md (99%) diff --git a/documentation/staging/content/_index.md b/documentation/staging/content/_index.md index dcfc7fb20bd..a58c9f383aa 100644 --- a/documentation/staging/content/_index.md +++ b/documentation/staging/content/_index.md @@ -22,7 +22,7 @@ You can: * Publish operator and WebLogic Server logs into Elasticsearch and interact with them in Kibana. {{% notice tip %}} -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/simple/_index.md" >}}). +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" >}}). Also, you can step through the [Tutorial](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/hands-on-lab/README.md) 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. {{% /notice %}} diff --git a/documentation/staging/content/faq/newbie.md b/documentation/staging/content/faq/newbie.md index 835efe577e9..e40b0f1fed3 100644 --- a/documentation/staging/content/faq/newbie.md +++ b/documentation/staging/content/faq/newbie.md @@ -31,13 +31,13 @@ To learn how, see [Get help]({{< relref "userguide/introduction/get-help.md" >}} **Q:** How is the WebLogic Server domain configured in a container (for example, databases, JMS, and such) that is potentially shared by many domains? -**A:** In a Kubernetes and container environment, the WebLogic domain home can be externalized to a persistent volume, or supplied in an image (by using a layer on top of a WebLogic Server image). For WebLogic domains that are supplied using an image, the domain logs and store locations optionally can be located on a persistent volume. See the [samples]({{< relref "/samples/simple/_index.md" >}}) in this project. +**A:** In a Kubernetes and container environment, the WebLogic domain home can be externalized to a persistent volume, or supplied in an image (by using a layer on top of a WebLogic Server image). For WebLogic domains that are supplied using an image, the domain logs and store locations optionally can be located on a persistent volume. See the [samples]({{< relref "/samples/_index.md" >}}) in this project. When using the operator, each deployed domain is specified by a domain resource that you define which describes important aspects of the domain. These include the location of the WebLogic Server image you wish to use, a unique identifier for the domain called the `domain-uid`, any PVs or PVC the domain pods will need to mount, the WebLogic clusters and servers which you want to be running, and the location of its domain home. Multiple deployments of the same domain are supported by specifying a unique `domain-uid` string for each deployed domain and specifying a different domain resource. The `domain-uid` is in turn used by the operator as the name-prefix and/or label for the domain's Kubernetes resources that the operator deploys for you. The WebLogic configuration of a domain's deployments optionally can by customized by specifying configuration overrides in the domain resource -- which, for example, is useful for overriding the configuration of a data source URL, user name, or password. -The operator does not specify how a WebLogic domain home configuration is created. You can use WLST, REST, or a very convenient new tool called [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) (WDT). WDT allows you to compactly specify WebLogic configuration and deployments (including JMS, data sources, applications, authenticators, and such) using a YAML file and a ZIP file (which include the binaries). The operator [samples]({{< relref "/samples/simple/_index.md" >}}) show how to create domains using WLST and using WDT. +The operator does not specify how a WebLogic domain home configuration is created. You can use WLST, REST, or a very convenient new tool called [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) (WDT). WDT allows you to compactly specify WebLogic configuration and deployments (including JMS, data sources, applications, authenticators, and such) using a YAML file and a ZIP file (which include the binaries). The operator [samples]({{< relref "/samples/_index.md" >}}) show how to create domains using WLST and using WDT. **Q:** Is the Administration Server required? Node Manager? @@ -61,7 +61,7 @@ For an example, see the Quick Start, [Install the operator and ingress controlle * _JMS, EJB, and other types of RMI communication with locations outside of the Kubernetes cluster_: This is typically accomplished by tunneling the RMI traffic over HTTP through a load balancer or, less commonly accomplished by using T3 or T3S directly with Kubernetes NodePorts; see [External WebLogic clients]({{< relref "/faq/external-clients.md" >}}). -* _Access the WebLogic Server Administration Console_: This can be done through a load balancer; see the [Model in Image]({{< relref "/samples/simple/domains/model-in-image/_index.md" >}}) sample. Or, this can be done through a Kubernetes NodePort service; run `$ kubectl explain domain.spec.adminServer.adminService.channels`. +* _Access the WebLogic Server Administration Console_: This can be done through a load balancer; see the [Model in Image]({{< relref "/samples/domains/model-in-image/_index.md" >}}) sample. Or, this can be done through a Kubernetes NodePort service; run `$ kubectl explain domain.spec.adminServer.adminService.channels`. * _Access the WebLogic Remote Console_: This can be done using a load balancer or Kubernetes NodePort service; see [Use the Remote Console]({{< relref "/userguide/managing-domains/accessing-the-domain/admin-console.md" >}}). @@ -124,6 +124,6 @@ For more information, see the [Domain life cycle]({{< relref "/userguide/managin **Q:** Integration with ecosystems: logging, monitoring (OS, JVM and application level), and such. -**A:** WebLogic Server `stdout` logging is echoed to their pod logs by default, and WebLogic Server file logs are optionally persisted to an external volume. We are working on a project to integrate WebLogic Server logs with the Elastic Stack. See [Elastic Stack]({{< relref "/samples/simple/elastic-stack/_index.md" >}}). +**A:** WebLogic Server `stdout` logging is echoed to their pod logs by default, and WebLogic Server file logs are optionally persisted to an external volume. We are working on a project to integrate WebLogic Server logs with the Elastic Stack. See [Elastic Stack]({{< relref "/samples/elastic-stack/_index.md" >}}). With regards to monitoring, all the tools that are traditionally used to monitor WebLogic Server can be used running in containers and Kubernetes. In addition, as mentioned previously, we have developed the [WebLogic Monitoring Exporter](https://github.com/oracle/weblogic-monitoring-exporter), which exports WebLogic metrics in a format that can be read and displayed in dashboards like Prometheus and Grafana. diff --git a/documentation/staging/content/quickstart/create-domain.md b/documentation/staging/content/quickstart/create-domain.md index d8319076c1c..5536248c74e 100644 --- a/documentation/staging/content/quickstart/create-domain.md +++ b/documentation/staging/content/quickstart/create-domain.md @@ -24,7 +24,7 @@ weight: 6 1. Create a new image with a domain home, plus create a domain resource that the operator will use to deploy the image, by running the [create-domain](http://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/scripts/create-weblogic-domain/domain-home-in-image/create-domain.sh) script. - The script's behavior is controlled by an inputs file plus command-line options. The script downloads the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) and [WebLogic Deploy Tool](https://oracle.github.io/weblogic-deploy-tooling/) and uses these tools to create a new image with a domain home. The script also creates a domain resource YAML file that references the image, and, if the `-e` option is specified, deploys the domain resource to Kubernetes. For a detailed understanding of the steps that the `create-domain.sh` script performs for you, see the bulleted items under [Use the script to create a domain]({{< relref "/samples/simple/domains/domain-home-in-image/#use-the-script-to-create-a-domain" >}}) + The script's behavior is controlled by an inputs file plus command-line options. The script downloads the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) and [WebLogic Deploy Tool](https://oracle.github.io/weblogic-deploy-tooling/) and uses these tools to create a new image with a domain home. The script also creates a domain resource YAML file that references the image, and, if the `-e` option is specified, deploys the domain resource to Kubernetes. For a detailed understanding of the steps that the `create-domain.sh` script performs for you, see the bulleted items under [Use the script to create a domain]({{< relref "/samples/domains/domain-home-in-image/#use-the-script-to-create-a-domain" >}}) {{% 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. {{% /notice%}} @@ -51,7 +51,7 @@ weight: 6 respectively, as you provided when creating the Kubernetes Secret in Step 2. {{% /notice %}} - For the detailed steps that the `create-domain.sh` script performs, see [Domain Home In Image]({{< relref "/samples/simple/domains/domain-home-in-image/_index.md" >}}). + For the detailed steps that the `create-domain.sh` script performs, see [Domain Home In Image]({{< relref "/samples/domains/domain-home-in-image/_index.md" >}}). 1. Confirm that the operator started the servers for the domain: diff --git a/documentation/staging/content/quickstart/prepare.md b/documentation/staging/content/quickstart/prepare.md index 9701195c45a..834c41f6fd0 100644 --- a/documentation/staging/content/quickstart/prepare.md +++ b/documentation/staging/content/quickstart/prepare.md @@ -21,10 +21,10 @@ weight: 5 $ helm upgrade traefik-operator traefik/traefik \ --namespace traefik \ --reuse-values \ - --set "kubernetes.namespaces={traefik,sample-domain1-ns}" + --set "kubernetes.namespaces={traefik,sample-domain1-ns}" ``` {{% notice note %}} If you have reached this point while following the "Model in Image" sample, please -stop here and return to the [sample instructions]({{< relref "/samples/simple/domains/model-in-image/prerequisites#resume" >}}). +stop here and return to the [sample instructions]({{< relref "/samples/domains/model-in-image/prerequisites#resume" >}}). {{% /notice %}} diff --git a/documentation/staging/content/samples/_index.md b/documentation/staging/content/samples/_index.md index 7bfa29a5392..d1bce3ffe2a 100644 --- a/documentation/staging/content/samples/_index.md +++ b/documentation/staging/content/samples/_index.md @@ -6,3 +6,6 @@ pre = " " +++ The samples provide demonstrations of how to accomplish common tasks. These samples are provided for educational and demonstration purposes only; they are not intended to be used in production deployments or to be depended upon to create production environments. + + +{{% children style="h4" description="true" %}} diff --git a/documentation/staging/content/samples/simple/azure-kubernetes-service/_index.md b/documentation/staging/content/samples/azure-kubernetes-service/_index.md similarity index 80% rename from documentation/staging/content/samples/simple/azure-kubernetes-service/_index.md rename to documentation/staging/content/samples/azure-kubernetes-service/_index.md index ebb1092da88..c125392f1d4 100644 --- a/documentation/staging/content/samples/simple/azure-kubernetes-service/_index.md +++ b/documentation/staging/content/samples/azure-kubernetes-service/_index.md @@ -11,9 +11,9 @@ description: "Sample for using the operator to set up a WLS cluster on the Azure - [Introduction](#introduction) - [Azure Kubernetes Service cluster](#azure-kubernetes-service-cluster) - [Domain home source types](#domain-home-source-types) - - [Domain in PV]({{< relref "/samples/simple/azure-kubernetes-service/domain-on-pv.md" >}}): Running the WebLogic cluster on AKS with domain home on PV - - [Model in Image]({{< relref "/samples/simple/azure-kubernetes-service/model-in-image.md" >}}): Running the WebLogic cluster on AKS with domain model in image - - [Troubleshooting]({{< relref "/samples/simple/azure-kubernetes-service/troubleshooting.md" >}}) + - [Domain in PV]({{< relref "/samples/azure-kubernetes-service/domain-on-pv.md" >}}): Running the WebLogic cluster on AKS with domain home on PV + - [Model in Image]({{< relref "/samples/azure-kubernetes-service/model-in-image.md" >}}): Running the WebLogic cluster on AKS with domain model in image + - [Troubleshooting]({{< relref "/samples/azure-kubernetes-service/troubleshooting.md" >}}) ### Introduction @@ -30,13 +30,13 @@ To learn more, see the [What is Azure Kubernetes Service?](https://docs.microsof 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" >}}). -- [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: +- [Model in Image]({{< relref "/samples/azure-kubernetes-service/model-in-image.md" >}}): running the WebLogic cluster on AKS with domain home in image offers the following benefits: - Reuse image to create different domains with different `domainUID` and different configurations. - 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. - 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. -- [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: +- [Domain in PV]({{< relref "/samples/azure-kubernetes-service/domain-on-pv.md" >}}): running the WebLogic cluster on AKS with domain home in PV offers the following benefits: - Use standard Oracle-provided images with patches installed. - No Docker environment required. You are able to run your business quickly without building knowledge of Docker. diff --git a/documentation/staging/content/samples/simple/azure-kubernetes-service/domain-on-pv.md b/documentation/staging/content/samples/azure-kubernetes-service/domain-on-pv.md similarity index 93% rename from documentation/staging/content/samples/simple/azure-kubernetes-service/domain-on-pv.md rename to documentation/staging/content/samples/azure-kubernetes-service/domain-on-pv.md index 3225f2bfcdd..ed101fef6dd 100644 --- a/documentation/staging/content/samples/simple/azure-kubernetes-service/domain-on-pv.md +++ b/documentation/staging/content/samples/azure-kubernetes-service/domain-on-pv.md @@ -20,9 +20,9 @@ This sample demonstrates how to use the [WebLogic Kubernetes Operator](/weblogic - [Troubleshooting](#troubleshooting) - [Useful links](#useful-links) -{{< readfile file="/samples/simple/azure-kubernetes-service/includes/prerequisites-01.txt" >}} +{{< readfile file="/samples/azure-kubernetes-service/includes/prerequisites-01.txt" >}} -{{< readfile file="/samples/simple/azure-kubernetes-service/includes/create-aks-cluster-body-01.txt" >}} +{{< readfile file="/samples/azure-kubernetes-service/includes/create-aks-cluster-body-01.txt" >}} ##### Clone WebLogic Kubernetes Operator repository @@ -35,11 +35,11 @@ $ git clone --branch v3.3.0 https://github.com/oracle/weblogic-kubernetes-operat {{% 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 %}} -{{< readfile file="/samples/simple/azure-kubernetes-service/includes/create-aks-cluster-body-02.txt" >}} +{{< 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/simple/azure-kubernetes-service/troubleshooting#virtual-machine-size-is-not-supported" >}}). + **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" >}}). -{{< readfile file="/samples/simple/azure-kubernetes-service/includes/create-aks-cluster-storage.txt" >}} +{{< readfile file="/samples/azure-kubernetes-service/includes/create-aks-cluster-storage.txt" >}} #### Install WebLogic Kubernetes Operator into the AKS cluster @@ -190,7 +190,7 @@ We need to set up the domain configuration for the WebLogic domain. 2. Now let's ask the operator to create a WebLogic Server domain within the AKS cluster. - 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. + For complete details on domain creation, see [Domain home on a PV - Use the script to create a domain]({{< relref "/samples/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. ``` # cd kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv @@ -319,7 +319,7 @@ We need to set up the domain configuration for the WebLogic domain. Notice that the `Limit` and `Request` values are the same for each of `serverPodMemory` and `serverPodCpu`. This is intentional. To learn why, see [Create a Pod that gets assigned a QoS class of Guaranteed](https://kubernetes.io/docs/tasks/configure-pod-container/quality-service-pod/#create-a-pod-that-gets-assigned-a-qos-class-of-guaranteed). You must have allocated sufficient CPU and memory resources so that the pod can be scheduled for running by Kubernetes. This is an example of **capacity planning**, a very important Kubernetes success factor. For more details on capacity planning with AKS, see [Azure Kubernetes Service Cluster Capacity Planning ](https://techcommunity.microsoft.com/t5/core-infrastructure-and-security/azure-kubernetes-service-cluster-capacity-planning/ba-p/1474990). For more details about Java and capacity planning, see [Java heap size and memory resource considerations]({{< relref "/faq/resource-settings.md" >}}). - The complete set of values that can be configured in this way is described in [configuration parameters]({{< relref "/samples/simple/domains/domain-home-on-pv/#configuration-parameters" >}}). If you want further advanced domain configuration, then run `./create-domain.sh -i ~/azure/weblogic-on-aks/domain1.yaml -o ~/azure`, which will output a Kubernetes domain resource YAML file in `~/azure/weblogic-domains/domain.yaml`. Edit the `domain.yaml` file and use `kubectl create -f ~/azure/weblogic-domains/domain.yaml` to create domain resources. + The complete set of values that can be configured in this way is described in [configuration parameters]({{< relref "/samples/domains/domain-home-on-pv/#configuration-parameters" >}}). If you want further advanced domain configuration, then run `./create-domain.sh -i ~/azure/weblogic-on-aks/domain1.yaml -o ~/azure`, which will output a Kubernetes domain resource YAML file in `~/azure/weblogic-domains/domain.yaml`. Edit the `domain.yaml` file and use `kubectl create -f ~/azure/weblogic-domains/domain.yaml` to create domain resources. 4. You must create `LoadBalancer` services for the Administration Server and the WLS cluster. This enables WLS to service requests from outside the AKS cluster. @@ -504,9 +504,9 @@ For input values, you can edit `kubernetes/samples/scripts/create-weblogic-domai | Name in YAML file | Example value | Notes | |-------------------|---------------|-------| -| `azureServicePrincipalAppId` | `nr086o75-pn59-4782-no5n-nq2op0rsr1q6` | Application ID of your service principal; refer to the application ID in the [Create Service Principal]({{< relref "/samples/simple/azure-kubernetes-service/domain-on-pv#create-a-service-principal-for-aks" >}}) section. | -| `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. | -| `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. | +| `azureServicePrincipalAppId` | `nr086o75-pn59-4782-no5n-nq2op0rsr1q6` | Application ID of your service principal; refer to the application ID in the [Create Service Principal]({{< relref "/samples/azure-kubernetes-service/domain-on-pv#create-a-service-principal-for-aks" >}}) section. | +| `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/azure-kubernetes-service/domain-on-pv#create-a-service-principal-for-aks" >}}) section. | +| `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/azure-kubernetes-service/domain-on-pv#create-a-service-principal-for-aks" >}}) section. | | `dockerEmail` | `yourDockerEmail` | Oracle Single Sign-On (SSO) account email, used to pull the WebLogic Server Docker image. | | `dockerPassword` | `yourDockerPassword`| Password for Oracle SSO account, used to pull the WebLogic Server Docker image, in clear text. | | `dockerUserName` | `yourDockerId` | The same value as `dockerEmail`. | @@ -593,16 +593,16 @@ The logs are stored in the Azure file share. Follow these steps to access the lo #### Clean up resources -{{< readfile file="/samples/simple/azure-kubernetes-service/includes/clean-up-resources-body-01.txt" >}} +{{< 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 commands to clean up resources. -{{< readfile file="/samples/simple/azure-kubernetes-service/includes/clean-up-resources-body-02.txt" >}} +{{< readfile file="/samples/azure-kubernetes-service/includes/clean-up-resources-body-02.txt" >}} #### Troubleshooting -For troubleshooting advice, see [Troubleshooting]({{< relref "/samples/simple/azure-kubernetes-service/troubleshooting.md" >}}). +For troubleshooting advice, see [Troubleshooting]({{< relref "/samples/azure-kubernetes-service/troubleshooting.md" >}}). #### Useful links -- [Domain on a PV]({{< relref "/samples/simple/domains/domain-home-on-pv/_index.md" >}}) sample +- [Domain on a PV]({{< relref "/samples/domains/domain-home-on-pv/_index.md" >}}) sample diff --git a/documentation/staging/content/samples/simple/azure-kubernetes-service/includes/clean-up-resources-body-01.txt b/documentation/staging/content/samples/azure-kubernetes-service/includes/clean-up-resources-body-01.txt similarity index 100% rename from documentation/staging/content/samples/simple/azure-kubernetes-service/includes/clean-up-resources-body-01.txt rename to documentation/staging/content/samples/azure-kubernetes-service/includes/clean-up-resources-body-01.txt diff --git a/documentation/staging/content/samples/simple/azure-kubernetes-service/includes/clean-up-resources-body-02.txt b/documentation/staging/content/samples/azure-kubernetes-service/includes/clean-up-resources-body-02.txt similarity index 100% rename from documentation/staging/content/samples/simple/azure-kubernetes-service/includes/clean-up-resources-body-02.txt rename to documentation/staging/content/samples/azure-kubernetes-service/includes/clean-up-resources-body-02.txt diff --git a/documentation/staging/content/samples/simple/azure-kubernetes-service/includes/create-aks-cluster-body-01.txt b/documentation/staging/content/samples/azure-kubernetes-service/includes/create-aks-cluster-body-01.txt similarity index 100% rename from documentation/staging/content/samples/simple/azure-kubernetes-service/includes/create-aks-cluster-body-01.txt rename to documentation/staging/content/samples/azure-kubernetes-service/includes/create-aks-cluster-body-01.txt diff --git a/documentation/staging/content/samples/simple/azure-kubernetes-service/includes/create-aks-cluster-body-02.txt b/documentation/staging/content/samples/azure-kubernetes-service/includes/create-aks-cluster-body-02.txt similarity index 100% rename from documentation/staging/content/samples/simple/azure-kubernetes-service/includes/create-aks-cluster-body-02.txt rename to documentation/staging/content/samples/azure-kubernetes-service/includes/create-aks-cluster-body-02.txt diff --git a/documentation/staging/content/samples/simple/azure-kubernetes-service/includes/create-aks-cluster-storage.txt b/documentation/staging/content/samples/azure-kubernetes-service/includes/create-aks-cluster-storage.txt similarity index 100% rename from documentation/staging/content/samples/simple/azure-kubernetes-service/includes/create-aks-cluster-storage.txt rename to documentation/staging/content/samples/azure-kubernetes-service/includes/create-aks-cluster-storage.txt diff --git a/documentation/staging/content/samples/simple/azure-kubernetes-service/includes/prerequisites-01.txt b/documentation/staging/content/samples/azure-kubernetes-service/includes/prerequisites-01.txt similarity index 100% rename from documentation/staging/content/samples/simple/azure-kubernetes-service/includes/prerequisites-01.txt rename to documentation/staging/content/samples/azure-kubernetes-service/includes/prerequisites-01.txt diff --git a/documentation/staging/content/samples/simple/azure-kubernetes-service/includes/prerequisites-02.txt b/documentation/staging/content/samples/azure-kubernetes-service/includes/prerequisites-02.txt similarity index 100% rename from documentation/staging/content/samples/simple/azure-kubernetes-service/includes/prerequisites-02.txt rename to documentation/staging/content/samples/azure-kubernetes-service/includes/prerequisites-02.txt diff --git a/documentation/staging/content/samples/simple/azure-kubernetes-service/model-in-image.md b/documentation/staging/content/samples/azure-kubernetes-service/model-in-image.md similarity index 96% rename from documentation/staging/content/samples/simple/azure-kubernetes-service/model-in-image.md rename to documentation/staging/content/samples/azure-kubernetes-service/model-in-image.md index d93ee3aed2c..fcdf6fb5f76 100644 --- a/documentation/staging/content/samples/simple/azure-kubernetes-service/model-in-image.md +++ b/documentation/staging/content/samples/azure-kubernetes-service/model-in-image.md @@ -20,10 +20,10 @@ This sample demonstrates how to use the [WebLogic Kubernetes Operator](/weblogic - [Troubleshooting](#troubleshooting) - [Useful links](#useful-links) -{{< readfile file="/samples/simple/azure-kubernetes-service/includes/prerequisites-02.txt" >}} +{{< readfile file="/samples/azure-kubernetes-service/includes/prerequisites-02.txt" >}} -{{< readfile file="/samples/simple/azure-kubernetes-service/includes/create-aks-cluster-body-01.txt" >}} +{{< readfile file="/samples/azure-kubernetes-service/includes/create-aks-cluster-body-01.txt" >}} ##### Clone WebLogic Kubernetes Operator repository @@ -36,9 +36,9 @@ $ git clone --branch v3.3.0 https://github.com/oracle/weblogic-kubernetes-operat $ cd weblogic-kubernetes-operator ``` -{{< readfile file="/samples/simple/azure-kubernetes-service/includes/create-aks-cluster-body-02.txt" >}} +{{< 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/simple/azure-kubernetes-service/troubleshooting#virtual-machine-size-is-not-supported" >}}). +**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" >}}). #### Install WebLogic Kubernetes Operator @@ -117,11 +117,11 @@ weblogic-operator-775b668c8f-nwwnn 1/1 Running 0 32s ``` {{% notice note %}} -You can sepcify the operator image by changing value of `--set image`. If you run into failures, see [Troubleshooting - WebLogic Kubernetes Operator installation failure]({{< relref "/samples/simple/azure-kubernetes-service/troubleshooting#weblogic-kubernetes-operator-installation-failure" >}}). +You can sepcify the operator image by changing value of `--set image`. If you run into failures, see [Troubleshooting - WebLogic Kubernetes Operator installation failure]({{< relref "/samples/azure-kubernetes-service/troubleshooting#weblogic-kubernetes-operator-installation-failure" >}}). {{% /notice %}} {{% notice info %}} -If you have a Docker image built with domain models following [Model in Image]({{< relref "/samples/simple/domains/model-in-image/_index.md" >}}), you can go to [Create WebLogic domain](#create-weblogic-domain) directly. +If you have a Docker image built with domain models following [Model in Image]({{< relref "/samples/domains/model-in-image/_index.md" >}}), you can go to [Create WebLogic domain](#create-weblogic-domain) directly. {{% /notice %}} #### Create Docker image @@ -352,7 +352,7 @@ model-in-image WLS-v1 012d3bfa3536 5 days ago 1.13GB ``` {{% notice note %}} -You may run into a `Dockerfile` parsing error if your Docker buildkit is enabled, see [Troubleshooting - WebLogic Image Tool failure]({{< relref "/samples/simple/azure-kubernetes-service/troubleshooting#weblogic-image-tool-failure" >}}). +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 @@ -399,7 +399,7 @@ Finally, connect AKS to the ACR. For more details on connecting ACR to an exist $ az aks update --name $AKS_CLUSTER_NAME --resource-group $AKS_PERS_RESOURCE_GROUP --attach-acr $AKS_PERS_RESOURCE_GROUP ``` -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/simple/azure-kubernetes-service/troubleshooting#cannot-attach-acr-due-to-not-being-owner-of-subscription" >}}). +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" >}}). Successful output will be a JSON object with the entry `"type": "Microsoft.ContainerService/ManagedClusters"`. @@ -895,19 +895,19 @@ Found 0 local data sources: #### Rolling updates -Naturally, you will want to deploy newer versions of the EAR application, located in the WDT archive ZIP file at `wlsdeploy/applications/myapp-v1`. To learn how to do this, follow the steps in [Update 3]({{< relref "/samples/simple/domains/model-in-image/update3" >}}). +Naturally, you will want to deploy newer versions of the EAR application, located in the WDT archive ZIP file at `wlsdeploy/applications/myapp-v1`. To learn how to do this, follow the steps in [Update 3]({{< relref "/samples/domains/model-in-image/update3" >}}). #### Clean up resources Run the following commands to clean up resources. -{{< readfile file="/samples/simple/azure-kubernetes-service/includes/clean-up-resources-body-02.txt" >}} +{{< readfile file="/samples/azure-kubernetes-service/includes/clean-up-resources-body-02.txt" >}} #### Troubleshooting -For troubleshooting advice, see [Troubleshooting]({{< relref "/samples/simple/azure-kubernetes-service/troubleshooting.md" >}}). +For troubleshooting advice, see [Troubleshooting]({{< relref "/samples/azure-kubernetes-service/troubleshooting.md" >}}). #### Useful links - [Model in Image]({{< relref "/userguide/managing-domains/model-in-image/_index.md" >}}) user documentation -- [Model in Image]({{< relref "/samples/simple/domains/model-in-image/_index.md" >}}) sample +- [Model in Image]({{< relref "/samples/domains/model-in-image/_index.md" >}}) sample diff --git a/documentation/staging/content/samples/simple/azure-kubernetes-service/screenshot-deploy-test-app.png b/documentation/staging/content/samples/azure-kubernetes-service/screenshot-deploy-test-app.png similarity index 100% rename from documentation/staging/content/samples/simple/azure-kubernetes-service/screenshot-deploy-test-app.png rename to documentation/staging/content/samples/azure-kubernetes-service/screenshot-deploy-test-app.png diff --git a/documentation/staging/content/samples/simple/azure-kubernetes-service/screenshot-logs.png b/documentation/staging/content/samples/azure-kubernetes-service/screenshot-logs.png similarity index 100% rename from documentation/staging/content/samples/simple/azure-kubernetes-service/screenshot-logs.png rename to documentation/staging/content/samples/azure-kubernetes-service/screenshot-logs.png diff --git a/documentation/staging/content/samples/simple/azure-kubernetes-service/troubleshooting.md b/documentation/staging/content/samples/azure-kubernetes-service/troubleshooting.md similarity index 100% rename from documentation/staging/content/samples/simple/azure-kubernetes-service/troubleshooting.md rename to documentation/staging/content/samples/azure-kubernetes-service/troubleshooting.md diff --git a/documentation/staging/content/samples/simple/credentials/_index.md b/documentation/staging/content/samples/credentials/_index.md similarity index 100% rename from documentation/staging/content/samples/simple/credentials/_index.md rename to documentation/staging/content/samples/credentials/_index.md diff --git a/documentation/staging/content/samples/simple/database/_index.md b/documentation/staging/content/samples/database/_index.md similarity index 98% rename from documentation/staging/content/samples/simple/database/_index.md rename to documentation/staging/content/samples/database/_index.md index c8ab982a5e6..84b8e69400b 100644 --- a/documentation/staging/content/samples/simple/database/_index.md +++ b/documentation/staging/content/samples/database/_index.md @@ -93,7 +93,7 @@ The following example shows how to set up an ephemeral Oracle database with the $ start-db-service.sh ``` - This step is based on the steps documented in [Run a Database]({{< relref "/samples/simple/database/_index.md" >}}). + This step is based on the steps documented in [Run a Database]({{< relref "/samples/database/_index.md" >}}). ### MySQL database in Kubernetes diff --git a/documentation/staging/content/samples/simple/domains/_index.md b/documentation/staging/content/samples/domains/_index.md similarity index 100% rename from documentation/staging/content/samples/simple/domains/_index.md rename to documentation/staging/content/samples/domains/_index.md diff --git a/documentation/staging/content/samples/simple/domains/delete-domain/_index.md b/documentation/staging/content/samples/domains/delete-domain/_index.md similarity index 100% rename from documentation/staging/content/samples/simple/domains/delete-domain/_index.md rename to documentation/staging/content/samples/domains/delete-domain/_index.md diff --git a/documentation/staging/content/samples/simple/domains/domain-home-in-image/_index.md b/documentation/staging/content/samples/domains/domain-home-in-image/_index.md similarity index 99% rename from documentation/staging/content/samples/simple/domains/domain-home-in-image/_index.md rename to documentation/staging/content/samples/domains/domain-home-in-image/_index.md index 48aeb8a6b07..aa09ea7e4c8 100644 --- a/documentation/staging/content/samples/simple/domains/domain-home-in-image/_index.md +++ b/documentation/staging/content/samples/domains/domain-home-in-image/_index.md @@ -16,7 +16,7 @@ The following prerequisites must be met prior to running the create domain scrip * The WebLogic Image Tool requires that `JAVA_HOME` is set to a Java JDK version 8 or later. * The operator requires an image with either Oracle WebLogic Server 12.2.1.3.0 with patch 29135930 applied, or Oracle WebLogic Server 12.2.1.4.0, or Oracle WebLogic Server 14.1.1.0.0. The existing WebLogic Server image, `container-registry.oracle.com/middleware/weblogic:12.2.1.3`, has all the necessary patches applied. For details on how to obtain or create the image, see [WebLogic Server images]({{< relref "/userguide/base-images/_index.md#create-or-obtain-weblogic-server-images" >}}). * Create a Kubernetes Namespace for the domain unless you intend to use the default namespace. -* If `logHomeOnPV` is enabled, create the Kubernetes PersistentVolume where the log home will be hosted, and the Kubernetes PersistentVolumeClaim for the domain in the same Kubernetes Namespace. For samples to create a PV and PVC, see [Create sample PV and PVC]({{< relref "/samples/simple/storage/_index.md" >}}). +* If `logHomeOnPV` is enabled, create the Kubernetes PersistentVolume where the log home will be hosted, and the Kubernetes PersistentVolumeClaim for the domain in the same Kubernetes Namespace. For samples to create a PV and PVC, see [Create sample PV and PVC]({{< relref "/samples/storage/_index.md" >}}). * Create a Kubernetes Secret for the WebLogic administrator credentials that contains the fields `username` and `password`, and make sure that the secret name matches the value specified for `weblogicCredentialsSecretName`; see [Configuration parameters](#configuration-parameters) below. For example: ```shell diff --git a/documentation/staging/content/samples/simple/domains/domain-home-on-pv/_index.md b/documentation/staging/content/samples/domains/domain-home-on-pv/_index.md similarity index 97% rename from documentation/staging/content/samples/simple/domains/domain-home-on-pv/_index.md rename to documentation/staging/content/samples/domains/domain-home-on-pv/_index.md index 6c08a85ea0c..aab7734965d 100644 --- a/documentation/staging/content/samples/simple/domains/domain-home-on-pv/_index.md +++ b/documentation/staging/content/samples/domains/domain-home-on-pv/_index.md @@ -17,7 +17,7 @@ The following prerequisites must be met prior to running the create domain scrip * Make sure the WebLogic Kubernetes Operator is running. * The operator requires an image with Oracle WebLogic Server 12.2.1.3.0 with patch 29135930 applied, or Oracle WebLogic Server 12.2.1.4.0, or Oracle WebLogic Server 14.1.1.0.0. The existing WebLogic Server image, `container-registry.oracle.com/middleware/weblogic:12.2.1.3`, has all the necessary patches applied. For details on how to obtain or create the image, see [WebLogic Server images]({{< relref "/userguide/base-images/_index.md#create-or-obtain-weblogic-server-images" >}}). * Create a Kubernetes Namespace for the domain unless you intend to use the default namespace. -* In the same Kubernetes Namespace, create the Kubernetes PersistentVolume (PV) where the domain home will be hosted, and the Kubernetes PersistentVolumeClaim (PVC) for the domain. For samples to create a PV and PVC, see [Create sample PV and PVC]({{< relref "/samples/simple/storage/_index.md" >}}). By default, the `create-domain.sh` script creates a domain with the `domainUID` set to `domain1` and expects the PVC `domain1-weblogic-sample-pvc` to be present. You can create `domain1-weblogic-sample-pvc` using [create-pv-pvc.sh](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/scripts/create-weblogic-domain-pv-pvc/create-pv-pvc.sh) with an inputs file that has the `domainUID` set to `domain1`. +* In the same Kubernetes Namespace, create the Kubernetes PersistentVolume (PV) where the domain home will be hosted, and the Kubernetes PersistentVolumeClaim (PVC) for the domain. For samples to create a PV and PVC, see [Create sample PV and PVC]({{< relref "/samples/storage/_index.md" >}}). By default, the `create-domain.sh` script creates a domain with the `domainUID` set to `domain1` and expects the PVC `domain1-weblogic-sample-pvc` to be present. You can create `domain1-weblogic-sample-pvc` using [create-pv-pvc.sh](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/scripts/create-weblogic-domain-pv-pvc/create-pv-pvc.sh) with an inputs file that has the `domainUID` set to `domain1`. * Create the Kubernetes Secrets `username` and `password` of the administrative account in the same Kubernetes Namespace as the domain. {{% notice note %}} @@ -448,7 +448,7 @@ The most common cause is a poor choice of value for `weblogicDomainStoragePath` ```shell $ create-pv-pvc.sh ``` - You should [delete the resources for your sample domain]({{< relref "/samples/simple/domains/delete-domain/_index.md" >}}), correct the value in that file, and rerun the commands to create the PV/PVC and the credential before you attempt to rerun: + You should [delete the resources for your sample domain]({{< relref "/samples/domains/delete-domain/_index.md" >}}), correct the value in that file, and rerun the commands to create the PV/PVC and the credential before you attempt to rerun: ```shell $ create-domain.sh ``` diff --git a/documentation/staging/content/samples/simple/domains/fmw-domain-home-in-image/_index.md b/documentation/staging/content/samples/domains/fmw-domain-home-in-image/_index.md similarity index 99% rename from documentation/staging/content/samples/simple/domains/fmw-domain-home-in-image/_index.md rename to documentation/staging/content/samples/domains/fmw-domain-home-in-image/_index.md index 558187981f9..07111d43711 100644 --- a/documentation/staging/content/samples/simple/domains/fmw-domain-home-in-image/_index.md +++ b/documentation/staging/content/samples/domains/fmw-domain-home-in-image/_index.md @@ -24,7 +24,7 @@ The following prerequisites must be met prior to running the create domain scrip For details on how to obtain or create the image, refer to [FMW Infrastructure domains]({{< relref "/userguide/managing-fmw-domains/#obtaining-the-fmw-infrastructure-image" >}}). * Create a Kubernetes Namespace for the domain unless you intend to use the default namespace. -* If `logHomeOnPV` is enabled, create the Kubernetes PersistentVolume where the log home will be hosted, and the Kubernetes PersistentVolumeClaim for the domain in the same Kubernetes Namespace. For samples to create a PV and PVC, see [Create sample PV and PVC]({{< relref "/samples/simple/storage/_index.md" >}}). +* If `logHomeOnPV` is enabled, create the Kubernetes PersistentVolume where the log home will be hosted, and the Kubernetes PersistentVolumeClaim for the domain in the same Kubernetes Namespace. For samples to create a PV and PVC, see [Create sample PV and PVC]({{< relref "/samples/storage/_index.md" >}}). * Create the Kubernetes Secrets `username` and `password` of the administrative account in the same Kubernetes namespace as the domain. * Unless you are creating a Restricted-JRF domain, you also need to: diff --git a/documentation/staging/content/samples/simple/domains/fmw-domain/_index.md b/documentation/staging/content/samples/domains/fmw-domain/_index.md similarity index 99% rename from documentation/staging/content/samples/simple/domains/fmw-domain/_index.md rename to documentation/staging/content/samples/domains/fmw-domain/_index.md index 5b7e58f2d34..55865cf0686 100644 --- a/documentation/staging/content/samples/simple/domains/fmw-domain/_index.md +++ b/documentation/staging/content/samples/domains/fmw-domain/_index.md @@ -26,7 +26,7 @@ The following prerequisites must be met prior to running the create domain scrip * Create a Kubernetes Namespace for the domain unless you intend to use the default namespace. * In the same Kubernetes Namespace, create the Kubernetes PersistentVolume (PV) where the domain home will be hosted, and the Kubernetes PersistentVolumeClaim (PVC) for the domain. For samples - to create a PV and PVC, see [Create sample PV and PVC]({{< relref "/samples/simple/storage/_index.md" >}}). + to create a PV and PVC, see [Create sample PV and PVC]({{< relref "/samples/storage/_index.md" >}}). By default, the `create-domain.sh` script creates a domain with the `domainUID` set to `domain1` and expects the PVC `domain1-weblogic-sample-pvc` to be present. You can create `domain1-weblogic-sample-pvc` using diff --git a/documentation/staging/content/samples/simple/domains/lifecycle/_index.md b/documentation/staging/content/samples/domains/lifecycle/_index.md similarity index 100% rename from documentation/staging/content/samples/simple/domains/lifecycle/_index.md rename to documentation/staging/content/samples/domains/lifecycle/_index.md diff --git a/documentation/staging/content/samples/simple/domains/manually-create-domain/_index.md b/documentation/staging/content/samples/domains/manually-create-domain/_index.md similarity index 100% rename from documentation/staging/content/samples/simple/domains/manually-create-domain/_index.md rename to documentation/staging/content/samples/domains/manually-create-domain/_index.md diff --git a/documentation/staging/content/samples/simple/domains/model-in-image/_index.md b/documentation/staging/content/samples/domains/model-in-image/_index.md similarity index 81% rename from documentation/staging/content/samples/simple/domains/model-in-image/_index.md rename to documentation/staging/content/samples/domains/model-in-image/_index.md index d4afccb4d19..d097145ba45 100644 --- a/documentation/staging/content/samples/simple/domains/model-in-image/_index.md +++ b/documentation/staging/content/samples/domains/model-in-image/_index.md @@ -15,14 +15,14 @@ description: "Sample for supplying a WebLogic Deploy Tooling (WDT) model that th - [Ensuring your Kubernetes cluster can access images](#ensuring-your-kubernetes-cluster-can-access-images) - [References](#references) - Sample steps - - [Prerequisites for all domain types]({{< relref "/samples/simple/domains/model-in-image/prerequisites#prerequisites-for-all-domain-types" >}}) - - [Additional prerequisites for JRF domains]({{< relref "/samples/simple/domains/model-in-image/prerequisites#additional-prerequisites-for-jrf-domains" >}}) - - [Initial]({{< relref "/samples/simple/domains/model-in-image/initial.md" >}}): Deploying an initial WebLogic domain - - [Update 1]({{< relref "/samples/simple/domains/model-in-image/update1.md" >}}): Dynamically adding a data source using a model ConfigMap and a domain restart (roll) - - [Update 2]({{< relref "/samples/simple/domains/model-in-image/update2.md" >}}): Deploying an additional domain - - [Update 3]({{< relref "/samples/simple/domains/model-in-image/update3.md" >}}): Updating an application using an updated image and a domain restart (roll) - - [Update 4]({{< relref "/samples/simple/domains/model-in-image/update4.md" >}}): Dynamically updating the WebLogic configuration without restarting (rolling) servers - - [Cleanup]({{< relref "/samples/simple/domains/model-in-image/cleanup.md" >}}) + - [Prerequisites for all domain types]({{< relref "/samples/domains/model-in-image/prerequisites#prerequisites-for-all-domain-types" >}}) + - [Additional prerequisites for JRF domains]({{< relref "/samples/domains/model-in-image/prerequisites#additional-prerequisites-for-jrf-domains" >}}) + - [Initial]({{< relref "/samples/domains/model-in-image/initial.md" >}}): Deploying an initial WebLogic domain + - [Update 1]({{< relref "/samples/domains/model-in-image/update1.md" >}}): Dynamically adding a data source using a model ConfigMap and a domain restart (roll) + - [Update 2]({{< relref "/samples/domains/model-in-image/update2.md" >}}): Deploying an additional domain + - [Update 3]({{< relref "/samples/domains/model-in-image/update3.md" >}}): Updating an application using an updated image and a domain restart (roll) + - [Update 4]({{< relref "/samples/domains/model-in-image/update4.md" >}}): Dynamically updating the WebLogic configuration without restarting (rolling) servers + - [Cleanup]({{< relref "/samples/domains/model-in-image/cleanup.md" >}}) ### Introduction @@ -44,7 +44,7 @@ The `JRF` domain path through the sample includes additional steps required for This sample demonstrates five Model in Image use cases: -- [Initial]({{< relref "/samples/simple/domains/model-in-image/initial.md" >}}): An initial WebLogic domain with the following characteristics: +- [Initial]({{< relref "/samples/domains/model-in-image/initial.md" >}}): An initial WebLogic domain with the following characteristics: - Image `model-in-image:WLS-v1` with: - A WebLogic installation @@ -63,7 +63,7 @@ This sample demonstrates five Model in Image use cases: - `spec.image: model-in-image:WLS-v1` - References to the secrets -- [Update 1]({{< relref "/samples/simple/domains/model-in-image/update1.md" >}}): Demonstrates updating the initial domain by dynamically adding a data source using a model ConfigMap and then restarting (rolling) the domain to propagate the change. +- [Update 1]({{< relref "/samples/domains/model-in-image/update1.md" >}}): Demonstrates updating the initial domain by dynamically adding a data source using a model ConfigMap and then restarting (rolling) the domain to propagate the change. - Image `model-in-image:WLS-v1`: - Same image as Initial use case @@ -75,7 +75,7 @@ This sample demonstrates five Model in Image use cases: - `spec.model.configMap` referencing the ConfigMap - References to data source secrets -- [Update 2]({{< relref "/samples/simple/domains/model-in-image/update2.md" >}}): Demonstrates deploying a second domain (similar to the Update 1 use case domain). +- [Update 2]({{< relref "/samples/domains/model-in-image/update2.md" >}}): Demonstrates deploying a second domain (similar to the Update 1 use case domain). - Image `model-in-image:WLS-v1`: - Same image as the Initial and Update 1 use cases @@ -86,7 +86,7 @@ This sample demonstrates five Model in Image use cases: - Its secret/ConfigMap references are decorated with `sample-domain2` instead of `sample-domain1` - Has a changed `env` variable that sets a new domain name -- [Update 3]({{< relref "/samples/simple/domains/model-in-image/update3.md" >}}): Demonstrates deploying an updated image with an updated application to the Update 1 use case domain and then restarting (rolling) its domain to propagate the change. +- [Update 3]({{< relref "/samples/domains/model-in-image/update3.md" >}}): Demonstrates deploying an updated image with an updated application to the Update 1 use case domain and then restarting (rolling) its domain to propagate the change. - Image `model-in-image:WLS-v2`, similar to `model-in-image:WLS-v1` image with: - An updated web application `v2` at the `myapp-v2` directory path instead of `myapp-v1` @@ -96,7 +96,7 @@ This sample demonstrates five Model in Image use cases: - A Domain: - Same as the Update 1 use case, except `spec.image` is `model-in-image:WLS-v2` -- [Update 4]({{< relref "/samples/simple/domains/model-in-image/update4.md" >}}): Demonstrates dynamically updating the running Update 1 or Update 3 WebLogic domain configuration without requiring a domain restart (roll). +- [Update 4]({{< relref "/samples/domains/model-in-image/update4.md" >}}): Demonstrates dynamically updating the running Update 1 or Update 3 WebLogic domain configuration without requiring a domain restart (roll). - Image `model-in-image:WLS-v1` or `model-in-image:WLS-v2`: - Same image as Update 1 or Update 3 use cases diff --git a/documentation/staging/content/samples/simple/domains/model-in-image/cleanup.md b/documentation/staging/content/samples/domains/model-in-image/cleanup.md similarity index 100% rename from documentation/staging/content/samples/simple/domains/model-in-image/cleanup.md rename to documentation/staging/content/samples/domains/model-in-image/cleanup.md diff --git a/documentation/staging/content/samples/simple/domains/model-in-image/initial.md b/documentation/staging/content/samples/domains/model-in-image/initial.md similarity index 98% rename from documentation/staging/content/samples/simple/domains/model-in-image/initial.md rename to documentation/staging/content/samples/domains/model-in-image/initial.md index ddbbd5e1496..b1940f11ec8 100644 --- a/documentation/staging/content/samples/simple/domains/model-in-image/initial.md +++ b/documentation/staging/content/samples/domains/model-in-image/initial.md @@ -31,7 +31,7 @@ In this use case, you set up an initial WebLogic domain. This involves: After the Domain is deployed, the operator starts an 'introspector job' that converts your models into a WebLogic configuration, and then passes this configuration to each WebLogic Server in the domain. {{% notice note %}} -Perform the steps in [Prerequisites for all domain types]({{< relref "/samples/simple/domains/model-in-image/prerequisites.md" >}}) before performing the steps in this use case. +Perform the steps in [Prerequisites for all domain types]({{< relref "/samples/domains/model-in-image/prerequisites.md" >}}) before performing the steps in this use case. If you are taking the `JRF` path through the sample, then substitute `JRF` for `WLS` in your image names and directory paths. Also note that the JRF-v1 model YAML file differs from the WLS-v1 YAML file (it contains an additional `domainInfo -> RCUDbInfo` stanza). {{% /notice %}} @@ -330,7 +330,7 @@ At this point, you have staged all of the files needed for image `model-in-image - `/tmp/mii-sample/model-images/model-in-image__WLS-v1/model.10.properties` - `/tmp/mii-sample/model-images/model-in-image__WLS-v1/archive.zip` -If you don't see the `weblogic-deploy.zip` file, then you missed a step in the [prerequisites]({{< relref "/samples/simple/domains/model-in-image/prerequisites.md" >}}). +If you don't see the `weblogic-deploy.zip` file, then you missed a step in the [prerequisites]({{< relref "/samples/domains/model-in-image/prerequisites.md" >}}). Now, you use the Image Tool to create an image named `model-in-image:WLS-v1` that's layered on a base WebLogic image. You've already set up this tool during the prerequisite steps. @@ -352,7 +352,7 @@ Run the following commands to create the model image and verify that it worked: --chown oracle:root ``` -If you don't see the `imagetool` directory, then you missed a step in the [prerequisites]({{< relref "/samples/simple/domains/model-in-image/prerequisites.md" >}}). +If you don't see the `imagetool` directory, then you missed a step in the [prerequisites]({{< relref "/samples/domains/model-in-image/prerequisites.md" >}}). This command runs the WebLogic Image Tool in its Model in Image mode, and does the following: @@ -724,7 +724,7 @@ Copy the following to a file called `/tmp/mii-sample/mii-initial.yaml` or simila ``` {{% /expand %}} - > **Note**: Before you deploy the domain custom resource, determine if you have Kubernetes cluster worker nodes that are remote to your local machine. If so, you need to put the Domain's image in a location that these nodes can access and you may also need to modify your Domain YAML file to reference the new location. See [Ensuring your Kubernetes cluster can access images]({{< relref "/samples/simple/domains/model-in-image/_index.md#ensuring-your-kubernetes-cluster-can-access-images" >}}). + > **Note**: Before you deploy the domain custom resource, determine if you have Kubernetes cluster worker nodes that are remote to your local machine. If so, you need to put the Domain's image in a location that these nodes can access and you may also need to modify your Domain YAML file to reference the new location. See [Ensuring your Kubernetes cluster can access images]({{< relref "/samples/domains/model-in-image/_index.md#ensuring-your-kubernetes-cluster-can-access-images" >}}). Run the following command to create the domain custom resource: @@ -933,6 +933,6 @@ You will see output like the following: **Note**: If you're running your `curl` commands on a remote machine, then substitute `localhost` with an external address suitable for contacting your Kubernetes cluster. A Kubernetes cluster address that often works can be obtained by using the address just after `https://` in the KubeDNS line of the output from the `kubectl cluster-info` command. - If you want to continue to the [Update 1]({{< relref "/samples/simple/domains/model-in-image/update1.md" >}}) use case, then leave your domain running. + If you want to continue to the [Update 1]({{< relref "/samples/domains/model-in-image/update1.md" >}}) use case, then leave your domain running. - To remove the resources you have created in this sample, see [Cleanup]({{< relref "/samples/simple/domains/model-in-image/cleanup.md" >}}). + To remove the resources you have created in this sample, see [Cleanup]({{< relref "/samples/domains/model-in-image/cleanup.md" >}}). diff --git a/documentation/staging/content/samples/simple/domains/model-in-image/prerequisites.md b/documentation/staging/content/samples/domains/model-in-image/prerequisites.md similarity index 99% rename from documentation/staging/content/samples/simple/domains/model-in-image/prerequisites.md rename to documentation/staging/content/samples/domains/model-in-image/prerequisites.md index 5965351f831..243293ebd80 100644 --- a/documentation/staging/content/samples/simple/domains/model-in-image/prerequisites.md +++ b/documentation/staging/content/samples/domains/model-in-image/prerequisites.md @@ -188,7 +188,7 @@ weight: 1 ### Additional prerequisites for JRF domains -> __NOTE__: If you're using a `WLS` domain type, skip this section and continue [here]({{< relref "/samples/simple/domains/model-in-image/initial.md" >}}). +> __NOTE__: If you're using a `WLS` domain type, skip this section and continue [here]({{< relref "/samples/domains/model-in-image/initial.md" >}}). #### JRF Prerequisites Contents @@ -238,7 +238,7 @@ A JRF domain requires an infrastructure database and requires initializing this This script will deploy a database in the `default` namespace with the connect string `oracle-db.default.svc.cluster.local:1521/devpdb.k8s`, and administration password `Oradoc_db1`. - This step is based on the steps documented in [Run a Database]({{< relref "/samples/simple/database/_index.md" >}}). + This step is based on the steps documented in [Run a Database]({{< relref "/samples/database/_index.md" >}}). __NOTE__: If your Kubernetes cluster nodes do not all have access to the database image in a local cache, then deploy a Kubernetes `docker secret` to the default namespace with login credentials for `container-registry.oracle.com`, and pass the name of this secret as a parameter to `start-db-service.sh` using `-s your-image-pull-secret`. Alternatively, copy the database image to each local Docker cache in the cluster. For more information, see the [Cannot pull image FAQ]({{}}). @@ -322,7 +322,7 @@ __Important! Back up your wallet file to a safe location that can be retrieved l To reuse the wallet file in subsequent redeployments or to share the domain's OPSS tables between different domains: 1. Load the saved wallet file into a secret with a key named `walletFile` (again, assuming that your domain UID is `sample-domain1` and your namespace is `sample-domain1-ns`): - + ```shell $ kubectl -n sample-domain1-ns create secret generic sample-domain1-opss-walletfile-secret \ --from-file=walletFile=./ewallet.p12 diff --git a/documentation/staging/content/samples/simple/domains/model-in-image/update1.md b/documentation/staging/content/samples/domains/model-in-image/update1.md similarity index 96% rename from documentation/staging/content/samples/simple/domains/model-in-image/update1.md rename to documentation/staging/content/samples/domains/model-in-image/update1.md index e0651528901..a88bc214180 100644 --- a/documentation/staging/content/samples/simple/domains/model-in-image/update1.md +++ b/documentation/staging/content/samples/domains/model-in-image/update1.md @@ -20,7 +20,7 @@ Here are the steps: 1. Ensure that you have a running domain. - Make sure you have deployed the domain from the [Initial]({{< relref "/samples/simple/domains/model-in-image/initial.md" >}}) use case. + Make sure you have deployed the domain from the [Initial]({{< relref "/samples/domains/model-in-image/initial.md" >}}) use case. 1. Create a data source model YAML file. @@ -82,7 +82,7 @@ Here are the steps: weblogic.domainUID=sample-domain1 ``` - We deliberately specify an incorrect password and a low maximum pool capacity because we will demonstrate dynamically correcting the data source attributes in the [Update 4]({{< relref "/samples/simple/domains/model-in-image/update4.md" >}}) use case without requiring rolling the domain. + We deliberately specify an incorrect password and a low maximum pool capacity because we will demonstrate dynamically correcting the data source attributes in the [Update 4]({{< relref "/samples/domains/model-in-image/update4.md" >}}) use case without requiring rolling the domain. You name and label secrets using their associated domain UID for two reasons: - To make it obvious which secret belongs to which domains. @@ -114,7 +114,7 @@ Here are the steps: - Option 1: Update a copy of your Domain YAML file from the Initial use case. - - In the [Initial]({{< relref "/samples/simple/domains/model-in-image/initial.md" >}}) use case, we suggested creating a Domain YAML file named `/tmp/mii-sample/mii-initial.yaml` or using the `/tmp/mii-sample/domain-resources/WLS/mii-initial-d1-WLS-v1.yaml` file that is supplied with the sample. + - In the [Initial]({{< relref "/samples/domains/model-in-image/initial.md" >}}) use case, we suggested creating a Domain YAML file named `/tmp/mii-sample/mii-initial.yaml` or using the `/tmp/mii-sample/domain-resources/WLS/mii-initial-d1-WLS-v1.yaml` file that is supplied with the sample. - We suggest copying the original Domain YAML file and naming the copy `/tmp/mii-sample/mii-update1.yaml` before making any changes. - Working on a copy is not strictly necessary, but it helps keep track of your work for the different use cases in this sample and provides you a backup of your previous work. @@ -145,7 +145,7 @@ Here are the steps: - Apply your changed Domain YAML file: - > **Note**: Before you deploy the domain custom resource, determine if you have Kubernetes cluster worker nodes that are remote to your local machine. If so, then you need to put the Domain YAML file's image in a location that these nodes can access and you may also need to modify your Domain YAML file to reference the new location. See [Ensuring your Kubernetes cluster can access images]({{< relref "/samples/simple/domains/model-in-image/_index.md#ensuring-your-kubernetes-cluster-can-access-images" >}}). + > **Note**: Before you deploy the domain custom resource, determine if you have Kubernetes cluster worker nodes that are remote to your local machine. If so, then you need to put the Domain YAML file's image in a location that these nodes can access and you may also need to modify your Domain YAML file to reference the new location. See [Ensuring your Kubernetes cluster can access images]({{< relref "/samples/domains/model-in-image/_index.md#ensuring-your-kubernetes-cluster-can-access-images" >}}). ```shell $ kubectl apply -f /tmp/mii-sample/mii-update1.yaml @@ -153,7 +153,7 @@ Here are the steps: - Option 2: Use the updated Domain YAML file that is supplied with the sample: - > **Note**: Before you deploy the domain custom resource, determine if you have Kubernetes cluster worker nodes that are remote to your local machine. If so, then you need to put the Domain YAML file's image in a location that these nodes can access and you may also need to modify your Domain YAML file to reference the new location. See [Ensuring your Kubernetes cluster can access images]({{< relref "/samples/simple/domains/model-in-image/_index.md#ensuring-your-kubernetes-cluster-can-access-images" >}}). + > **Note**: Before you deploy the domain custom resource, determine if you have Kubernetes cluster worker nodes that are remote to your local machine. If so, then you need to put the Domain YAML file's image in a location that these nodes can access and you may also need to modify your Domain YAML file to reference the new location. See [Ensuring your Kubernetes cluster can access images]({{< relref "/samples/domains/model-in-image/_index.md#ensuring-your-kubernetes-cluster-can-access-images" >}}). ```shell $ kubectl apply -f /tmp/miisample/domain-resources/WLS/mii-update1-d1-WLS-v1-ds.yaml @@ -484,10 +484,10 @@ Here are the steps: ``` -A `TestPool Failure` is expected because we will demonstrate dynamically correcting the data source attributes in [Update 4]({{< relref "/samples/simple/domains/model-in-image/update4.md" >}}). +A `TestPool Failure` is expected because we will demonstrate dynamically correcting the data source attributes in [Update 4]({{< relref "/samples/domains/model-in-image/update4.md" >}}). If you see an error other than the expected `TestPool Failure`, then consult [Debugging]({{< relref "/userguide/managing-domains/model-in-image/debugging.md" >}}) in the Model in Image user guide. -If you plan to run the [Update 3]({{< relref "/samples/simple/domains/model-in-image/update3.md" >}}) or [Update 4]({{< relref "/samples/simple/domains/model-in-image/update4.md" >}}) use case, then leave your domain running. +If you plan to run the [Update 3]({{< relref "/samples/domains/model-in-image/update3.md" >}}) or [Update 4]({{< relref "/samples/domains/model-in-image/update4.md" >}}) use case, then leave your domain running. -To remove the resources you have created in the samples, see [Cleanup]({{< relref "/samples/simple/domains/model-in-image/cleanup.md" >}}). +To remove the resources you have created in the samples, see [Cleanup]({{< relref "/samples/domains/model-in-image/cleanup.md" >}}). diff --git a/documentation/staging/content/samples/simple/domains/model-in-image/update2.md b/documentation/staging/content/samples/domains/model-in-image/update2.md similarity index 95% rename from documentation/staging/content/samples/simple/domains/model-in-image/update2.md rename to documentation/staging/content/samples/domains/model-in-image/update2.md index 4f615491e52..f2b35cfba5f 100644 --- a/documentation/staging/content/samples/simple/domains/model-in-image/update2.md +++ b/documentation/staging/content/samples/domains/model-in-image/update2.md @@ -4,7 +4,7 @@ date: 2019-02-23T17:32:31-05:00 weight: 4 --- -This use case demonstrates concurrently deploying a domain that is similar to the [Update 1]({{< relref "/samples/simple/domains/model-in-image/update1.md" >}}) use case domain to the same `sample-domain1-ns` namespace, but with a different domain UID, a different WebLogic domain name, and a different WebLogic domain encryption key. It does this by: +This use case demonstrates concurrently deploying a domain that is similar to the [Update 1]({{< relref "/samples/domains/model-in-image/update1.md" >}}) use case domain to the same `sample-domain1-ns` namespace, but with a different domain UID, a different WebLogic domain name, and a different WebLogic domain encryption key. It does this by: - Using the same image, image model YAML file, and application archive as the Initial and Update 1 use cases. - Using the same model update ConfigMap source file as the Update 1 use case (a data source). @@ -27,7 +27,7 @@ Oracle requires interoperating WebLogic domains to have different domain names. Here are the steps for this use case: -1. Make sure you have deployed the domain from the [Update 1]({{< relref "/samples/simple/domains/model-in-image/update1.md" >}}) use case. +1. Make sure you have deployed the domain from the [Update 1]({{< relref "/samples/domains/model-in-image/update1.md" >}}) use case. 1. Create a ConfigMap with the WDT model that contains the data source definition. @@ -108,7 +108,7 @@ Here are the steps for this use case: - You use a different set of secrets for the new domain for two reasons: - To make it easier to keep the life cycle and/or CI/CD process for the two domains simple and independent. - To 'future proof' the new domain so that changes to the original domain's secrets or new domain's secrets can be independent. - - We deliberately specify an incorrect password and a low maximum pool capacity in the data source secret because we will demonstrate dynamically correcting the data source attributes for `sample-domain1` in the [Update 4]({{< relref "/samples/simple/domains/model-in-image/update4.md" >}}) use case. + - We deliberately specify an incorrect password and a low maximum pool capacity in the data source secret because we will demonstrate dynamically correcting the data source attributes for `sample-domain1` in the [Update 4]({{< relref "/samples/domains/model-in-image/update4.md" >}}) use case. If you're following the `JRF` path through the sample, then you also need to deploy the additional secret referenced by macros in the `JRF` model `RCUDbInfo` clause, plus an `OPSS` wallet password secret. For details about the uses of these secrets, see the [Model in Image]({{< relref "/userguide/managing-domains/model-in-image/_index.md" >}}) user documentation. Note that we are using the RCU prefix `FMW2` for this domain, because the first domain is already using `FMW1`. @@ -142,7 +142,7 @@ Here are the steps for this use case: - Option 1: Update a copy of your Domain YAML file from the Update 1 use case. - - In the [Update 1]({{< relref "/samples/simple/domains/model-in-image/update1.md" >}}) use case, we suggested creating a file named `/tmp/mii-sample/mii-update1.yaml` or using the `/tmp/mii-sample/domain-resources/WLS/mii-update1-d1-WLS-v1-ds.yaml` file that is supplied with the sample. + - In the [Update 1]({{< relref "/samples/domains/model-in-image/update1.md" >}}) use case, we suggested creating a file named `/tmp/mii-sample/mii-update1.yaml` or using the `/tmp/mii-sample/domain-resources/WLS/mii-update1-d1-WLS-v1-ds.yaml` file that is supplied with the sample. - We suggest copying this Domain YAML file and naming the copy `/tmp/mii-sample/mii-update2.yaml` before making any changes. - Working on a copy is not strictly necessary, but it helps keep track of your work for the different use cases in this sample and provides you a backup of your previous work. @@ -212,7 +212,7 @@ Here are the steps for this use case: ``` To this: - + ```yaml spec: ... @@ -309,7 +309,7 @@ Here are the steps for this use case: - Apply your changed Domain YAML file: - > **Note**: Before you deploy the Domain YAML file, determine if you have Kubernetes cluster worker nodes that are remote to your local machine. If so, you need to put the Domain's image in a location that these nodes can access and you may also need to modify your Domain YAML file to reference the new location. See [Ensuring your Kubernetes cluster can access images]({{< relref "/samples/simple/domains/model-in-image/_index.md#ensuring-your-kubernetes-cluster-can-access-images" >}}). + > **Note**: Before you deploy the Domain YAML file, determine if you have Kubernetes cluster worker nodes that are remote to your local machine. If so, you need to put the Domain's image in a location that these nodes can access and you may also need to modify your Domain YAML file to reference the new location. See [Ensuring your Kubernetes cluster can access images]({{< relref "/samples/domains/model-in-image/_index.md#ensuring-your-kubernetes-cluster-can-access-images" >}}). ```shell $ kubectl apply -f /tmp/mii-sample/mii-update2.yaml @@ -317,7 +317,7 @@ Here are the steps for this use case: - Option 2: Use the updated Domain YAML file that is supplied with the sample: - > **Note**: Before you deploy the Domain YAML file, determine if you have Kubernetes cluster worker nodes that are remote to your local machine. If so, you need to put the Domain's image in a location that these nodes can access and you may also need to modify your Domain YAML file to reference the new location. See [Ensuring your Kubernetes cluster can access images]({{< relref "/samples/simple/domains/model-in-image/_index.md#ensuring-your-kubernetes-cluster-can-access-images" >}}). + > **Note**: Before you deploy the Domain YAML file, determine if you have Kubernetes cluster worker nodes that are remote to your local machine. If so, you need to put the Domain's image in a location that these nodes can access and you may also need to modify your Domain YAML file to reference the new location. See [Ensuring your Kubernetes cluster can access images]({{< relref "/samples/domains/model-in-image/_index.md#ensuring-your-kubernetes-cluster-can-access-images" >}}). ```shell $ kubectl apply -f /tmp/miisample/domain-resources/WLS/mii-update2-d2-WLS-v1-ds.yaml @@ -503,10 +503,10 @@ Here are the steps for this use case: ``` -A `TestPool Failure` is expected because we will demonstrate dynamically correcting the data source attributes for `sample-domain1` in [Update 4]({{< relref "/samples/simple/domains/model-in-image/update4.md" >}}). +A `TestPool Failure` is expected because we will demonstrate dynamically correcting the data source attributes for `sample-domain1` in [Update 4]({{< relref "/samples/domains/model-in-image/update4.md" >}}). If you see an error other than the expected `TestPool Failure`, then consult [Debugging]({{< relref "/userguide/managing-domains/model-in-image/debugging.md" >}}) in the Model in Image user guide. You will not be using the `sample-domain2` domain again in this sample; if you wish, you can shut it down now by calling `kubectl -n sample-domain1-ns delete domain sample-domain2`. -To remove the resources you have created in the samples, see [Cleanup]({{< relref "/samples/simple/domains/model-in-image/cleanup.md" >}}). +To remove the resources you have created in the samples, see [Cleanup]({{< relref "/samples/domains/model-in-image/cleanup.md" >}}). diff --git a/documentation/staging/content/samples/simple/domains/model-in-image/update3.md b/documentation/staging/content/samples/domains/model-in-image/update3.md similarity index 89% rename from documentation/staging/content/samples/simple/domains/model-in-image/update3.md rename to documentation/staging/content/samples/domains/model-in-image/update3.md index 913999becac..91049c1e6e3 100644 --- a/documentation/staging/content/samples/simple/domains/model-in-image/update3.md +++ b/documentation/staging/content/samples/domains/model-in-image/update3.md @@ -4,14 +4,14 @@ date: 2019-02-23T17:32:31-05:00 weight: 5 --- -The Update 3 use case demonstrates deploying an updated WebLogic application to the running [Update 1]({{< relref "/samples/simple/domains/model-in-image/update1.md" >}}) use case domain using an updated image. +The Update 3 use case demonstrates deploying an updated WebLogic application to the running [Update 1]({{< relref "/samples/domains/model-in-image/update1.md" >}}) use case domain using an updated image. In the use case, you will: - Create an image `model-in-image:WLS-v2` that is similar to the currently active `model-in-image:WLS-v1` image, but with the following updates: - An updated web application `v2` at the `myapp-v2` directory path within the WDT application archive instead of `myapp-v1`. - An updated model YAML file within the image that points to the new web application path. - - Apply an updated Domain YAML file that references the new image while still referencing the original [Update 1]({{< relref "/samples/simple/domains/model-in-image/update1.md" >}}) use case secrets and model ConfigMap. + - Apply an updated Domain YAML file that references the new image while still referencing the original [Update 1]({{< relref "/samples/domains/model-in-image/update1.md" >}}) use case secrets and model ConfigMap. After the updated Domain YAML file is applied, the operator will: @@ -25,21 +25,21 @@ Note that the old version of the application `v1` remains in the new image's arc Here are the steps for this use case: -1. Make sure you have deployed the domain from the [Update 1]({{< relref "/samples/simple/domains/model-in-image/update1.md" >}}) use case. +1. Make sure you have deployed the domain from the [Update 1]({{< relref "/samples/domains/model-in-image/update1.md" >}}) use case. 2. Create an updated image. - Recall that a goal of the [Initial]({{< relref "/samples/simple/domains/model-in-image/initial.md" >}}) use case was to demonstrate using the WebLogic Image Tool to create an image named `model-in-image:WLS-v1` from files that were staged in `/tmp/mii-sample/model-images/model-in-image:WLS-v1/`. The staged files included a web application in a WDT ZIP archive, and WDT model configuration for a WebLogic Administration Server called `admin-server` and a WebLogic cluster called `cluster-1`. The final image was called `model-in-image:WLS-v1` and, in addition to having a copy of the staged files in its `/u01/wdt/models` directory, also contained a WebLogic installation and a WebLogic Deploy Tooling installation. + Recall that a goal of the [Initial]({{< relref "/samples/domains/model-in-image/initial.md" >}}) use case was to demonstrate using the WebLogic Image Tool to create an image named `model-in-image:WLS-v1` from files that were staged in `/tmp/mii-sample/model-images/model-in-image:WLS-v1/`. The staged files included a web application in a WDT ZIP archive, and WDT model configuration for a WebLogic Administration Server called `admin-server` and a WebLogic cluster called `cluster-1`. The final image was called `model-in-image:WLS-v1` and, in addition to having a copy of the staged files in its `/u01/wdt/models` directory, also contained a WebLogic installation and a WebLogic Deploy Tooling installation. - In this use case, you will follow similar steps to the [Initial]({{< relref "/samples/simple/domains/model-in-image/initial.md" >}}) use case in order to create a new image with an updated application and model, plus deploy the updated model and application to the running [Update 1]({{< relref "/samples/simple/domains/model-in-image/update1.md" >}}) use case domain. + In this use case, you will follow similar steps to the [Initial]({{< relref "/samples/domains/model-in-image/initial.md" >}}) use case in order to create a new image with an updated application and model, plus deploy the updated model and application to the running [Update 1]({{< relref "/samples/domains/model-in-image/update1.md" >}}) use case domain. - Understanding your updated WDT archive. - The updated archive for this use case is in directory `/tmp/mii-sample/archives/archive-v2`. You will use it to create an archive ZIP file for the image. This archive is similar to the `/tmp/mii-sample/archives/archive-v1` from the [Initial]({{< relref "/samples/simple/domains/model-in-image/initial.md" >}}) use case with the following differences: + The updated archive for this use case is in directory `/tmp/mii-sample/archives/archive-v2`. You will use it to create an archive ZIP file for the image. This archive is similar to the `/tmp/mii-sample/archives/archive-v1` from the [Initial]({{< relref "/samples/domains/model-in-image/initial.md" >}}) use case with the following differences: - It includes an updated version of the application in `./wlsdeploy/applications/myapp-v2` (while keeping the original application in directory `./wlsdeploy/applications/myapp-v1`). - The application in `./wlsdeploy/applications/myapp-v2/myapp_war/index.jsp` contains a single difference from the original application: it changes the line `out.println("Hello World! This is version 'v1' of the mii-sample JSP web-app.");` to `out.println("Hello World! This is version 'v2' of the mii-sample JSP web-app.");`. - For additional information about archives, see [Understanding your first archive]({{< relref "/samples/simple/domains/model-in-image/initial#understanding-your-first-archive" >}}) in the Initial use case. + For additional information about archives, see [Understanding your first archive]({{< relref "/samples/domains/model-in-image/initial#understanding-your-first-archive" >}}) in the Initial use case. - Stage a ZIP file of the WDT archive. @@ -83,7 +83,7 @@ Here are the steps for this use case: Target: 'cluster-1' ``` - If you would like to review the entire original model before this change, see [Staging model files]({{< relref "/samples/simple/domains/model-in-image/initial#staging-model-files" >}}) in the Initial use case. + If you would like to review the entire original model before this change, see [Staging model files]({{< relref "/samples/domains/model-in-image/initial#staging-model-files" >}}) in the Initial use case. - Create a new image from your staged model files using WIT. @@ -96,7 +96,7 @@ Here are the steps for this use case: - `/tmp/mii-sample/model-images/model-in-image__WLS-v2/model.10.properties` - `/tmp/mii-sample/model-images/model-in-image__WLS-v2/archive.zip` - If you don't see the `weblogic-deploy.zip` file, then you missed a step in the [prerequisites]({{< relref "/samples/simple/domains/model-in-image/prerequisites.md" >}}). + If you don't see the `weblogic-deploy.zip` file, then you missed a step in the [prerequisites]({{< relref "/samples/domains/model-in-image/prerequisites.md" >}}). Now, you use the Image Tool to create an image named `model-in-image:WLS-v2` that's layered on a base WebLogic image. You've already set up this tool during the prerequisite steps. @@ -117,7 +117,7 @@ Here are the steps for this use case: --chown oracle:root ``` - If you don't see the `imagetool` directory, then you missed a step in the [prerequisites]({{< relref "/samples/simple/domains/model-in-image/prerequisites.md" >}}). + If you don't see the `imagetool` directory, then you missed a step in the [prerequisites]({{< relref "/samples/domains/model-in-image/prerequisites.md" >}}). This command runs the WebLogic Image Tool in its Model in Image mode, and does the following: - Builds the final container image as a layer on the `container-registry.oracle.com/middleware/weblogic:12.2.1.4` base image. @@ -134,7 +134,7 @@ Here are the steps for this use case: Also, if you run the `docker images` command, then you will see an image named `model-in-image:WLS-v2`. - > **Note**: If you have Kubernetes cluster worker nodes that are remote to your local machine, then you need to put the image in a location that these nodes can access. See [Ensuring your Kubernetes cluster can access images]({{< relref "/samples/simple/domains/model-in-image/_index.md#ensuring-your-kubernetes-cluster-can-access-images" >}}). + > **Note**: If you have Kubernetes cluster worker nodes that are remote to your local machine, then you need to put the image in a location that these nodes can access. See [Ensuring your Kubernetes cluster can access images]({{< relref "/samples/domains/model-in-image/_index.md#ensuring-your-kubernetes-cluster-can-access-images" >}}). #### Deploy resources - Introduction @@ -144,7 +144,7 @@ Here are the steps for this use case: - Option 1: Update a copy of your Domain YAML file from the Update 1 use case. - - In the [Update 1]({{< relref "/samples/simple/domains/model-in-image/update1.md" >}}) use case, we suggested creating a file named `/tmp/mii-sample/mii-update1.yaml` or using the `/tmp/mii-sample/domain-resources/WLS/mii-update1-d1-WLS-v1-ds.yaml` file that is supplied with the sample. + - In the [Update 1]({{< relref "/samples/domains/model-in-image/update1.md" >}}) use case, we suggested creating a file named `/tmp/mii-sample/mii-update1.yaml` or using the `/tmp/mii-sample/domain-resources/WLS/mii-update1-d1-WLS-v1-ds.yaml` file that is supplied with the sample. - We suggest copying this Domain YAML file and naming the copy `/tmp/mii-sample/mii-update3.yaml` before making any changes. @@ -163,7 +163,7 @@ Here are the steps for this use case: - Apply your changed Domain YAML file: - > **Note**: Before you deploy the domain custom resource, determine if you have Kubernetes cluster worker nodes that are remote to your local machine. If so, you need to put the Domain YAML file's image in a location that these nodes can access and you may also need to modify your Domain YAML file to reference the new location. See [Ensuring your Kubernetes cluster can access images]({{< relref "/samples/simple/domains/model-in-image/_index.md#ensuring-your-kubernetes-cluster-can-access-images" >}}). + > **Note**: Before you deploy the domain custom resource, determine if you have Kubernetes cluster worker nodes that are remote to your local machine. If so, you need to put the Domain YAML file's image in a location that these nodes can access and you may also need to modify your Domain YAML file to reference the new location. See [Ensuring your Kubernetes cluster can access images]({{< relref "/samples/domains/model-in-image/_index.md#ensuring-your-kubernetes-cluster-can-access-images" >}}). ```shell $ kubectl apply -f /tmp/mii-sample/mii-update3.yaml @@ -171,7 +171,7 @@ Here are the steps for this use case: - Option 2: Use the updated Domain YAML file that is supplied with the sample: - > **Note**: Before you deploy the Domain YAML file, determine if you have Kubernetes cluster worker nodes that are remote to your local machine. If so, you need to put the Domain YAML file's image in a location that these nodes can access and you may also need to modify your Domain YAML file to reference the new location. See [Ensuring your Kubernetes cluster can access images]({{< relref "/samples/simple/domains/model-in-image/_index.md#ensuring-your-kubernetes-cluster-can-access-images" >}}). + > **Note**: Before you deploy the Domain YAML file, determine if you have Kubernetes cluster worker nodes that are remote to your local machine. If so, you need to put the Domain YAML file's image in a location that these nodes can access and you may also need to modify your Domain YAML file to reference the new location. See [Ensuring your Kubernetes cluster can access images]({{< relref "/samples/domains/model-in-image/_index.md#ensuring-your-kubernetes-cluster-can-access-images" >}}). ```shell $ kubectl apply -f /tmp/miisample/domain-resources/WLS/mii-update3-d1-WLS-v2-ds.yaml @@ -441,10 +441,10 @@ Here are the steps for this use case: ``` -A `TestPool Failure` is expected because we will demonstrate dynamically correcting the data source attributes in [Update 4]({{< relref "/samples/simple/domains/model-in-image/update4.md" >}}). +A `TestPool Failure` is expected because we will demonstrate dynamically correcting the data source attributes in [Update 4]({{< relref "/samples/domains/model-in-image/update4.md" >}}). If you see an error other than the expected `TestPool Failure`, then consult [Debugging]({{< relref "/userguide/managing-domains/model-in-image/debugging.md" >}}) in the Model in Image user guide. -If you plan to run the [Update 4]({{< relref "/samples/simple/domains/model-in-image/update4.md" >}}) use case, then leave your domain running. +If you plan to run the [Update 4]({{< relref "/samples/domains/model-in-image/update4.md" >}}) use case, then leave your domain running. -To remove the resources you have created in the samples, see [Cleanup]({{< relref "/samples/simple/domains/model-in-image/cleanup.md" >}}). +To remove the resources you have created in the samples, see [Cleanup]({{< relref "/samples/domains/model-in-image/cleanup.md" >}}). diff --git a/documentation/staging/content/samples/simple/domains/model-in-image/update4.md b/documentation/staging/content/samples/domains/model-in-image/update4.md similarity index 94% rename from documentation/staging/content/samples/simple/domains/model-in-image/update4.md rename to documentation/staging/content/samples/domains/model-in-image/update4.md index b8c3c0736e3..3f7a4ae7933 100644 --- a/documentation/staging/content/samples/simple/domains/model-in-image/update4.md +++ b/documentation/staging/content/samples/domains/model-in-image/update4.md @@ -8,21 +8,21 @@ This use case demonstrates dynamically changing the Work Manager threads constra In the use case, you will: - - Update the ConfigMap containing the WDT model created in the [Update 1]({{< relref "/samples/simple/domains/model-in-image/update1.md" >}}) use case with changes to the Work Manager threads constraint configuration. - - Update the data source secret created in the [Update 1]({{< relref "/samples/simple/domains/model-in-image/update1.md" >}}) use case to provide the correct password and an increased maximum pool capacity. + - Update the ConfigMap containing the WDT model created in the [Update 1]({{< relref "/samples/domains/model-in-image/update1.md" >}}) use case with changes to the Work Manager threads constraint configuration. + - Update the data source secret created in the [Update 1]({{< relref "/samples/domains/model-in-image/update1.md" >}}) use case to provide the correct password and an increased maximum pool capacity. - Update the Domain YAML file to enable the Model in Image online update feature. - Update the Domain YAML file to trigger a domain introspection, which applies the new configuration values without restarting servers. - Optionally, start a database (to demonstrate that the updated data source attributes have taken effect). Here are the steps: -1. Make sure that you have deployed the domain from the [Update 1]({{< relref "/samples/simple/domains/model-in-image/update1.md" >}}) use case, or have deployed an updated version of this same domain from the [Update 3]({{< relref "/samples/simple/domains/model-in-image/update3.md" >}}) use case. +1. Make sure that you have deployed the domain from the [Update 1]({{< relref "/samples/domains/model-in-image/update1.md" >}}) use case, or have deployed an updated version of this same domain from the [Update 3]({{< relref "/samples/domains/model-in-image/update3.md" >}}) use case. There should be three WebLogic Server pods with names that start with `sample-domain1` running in the `sample-domain1-ns` namespace, a domain named `sample-domain1`, a ConfigMap named `sample-domain1-wdt-config-map`, and a Secret named `sample-domain1-datasource-secret`. 1. Add the Work Manager threads constraint configuration WDT model updates to the existing data source model updates in the Model in Image model ConfigMap. - In this step, we will update the model ConfigMap from the [Update 1]({{< relref "/samples/simple/domains/model-in-image/update1.md" >}}) use case with the desired changes to the minimum and maximum threads constraints. + In this step, we will update the model ConfigMap from the [Update 1]({{< relref "/samples/domains/model-in-image/update1.md" >}}) use case with the desired changes to the minimum and maximum threads constraints. Here's an example model configuration that updates the configured count values for the `SampleMinThreads` minimum threads constraint and `SampleMaxThreads` maximum threads constraint: ```yaml @@ -85,7 +85,7 @@ Here are the steps: - If you are taking the `JRF` path through the sample, then the database will already be running. - If you are taking the `WLS` path through the sample, then you can deploy the database by: - - Following the first step in [Set up and initialize an infrastructure database]({{< relref "/samples/simple/domains/model-in-image/prerequisites#set-up-and-initialize-an-infrastructure-database" >}}). This step is titled, "Ensure that you have access to the database image, and then create a deployment using it." + - Following the first step in [Set up and initialize an infrastructure database]({{< relref "/samples/domains/model-in-image/prerequisites#set-up-and-initialize-an-infrastructure-database" >}}). This step is titled, "Ensure that you have access to the database image, and then create a deployment using it." - You can skip the remaining steps (they are only needed for `JRF`). 1. Update your Domain YAML file to enable `onlineUpdate`. @@ -318,4 +318,4 @@ If you see any other error, then consult [Debugging]({{< relref "/userguide/mana This completes the sample scenarios. -To remove the resources you have created in the samples, see [Cleanup]({{< relref "/samples/simple/domains/model-in-image/cleanup.md" >}}). +To remove the resources you have created in the samples, see [Cleanup]({{< relref "/samples/domains/model-in-image/cleanup.md" >}}). diff --git a/documentation/staging/content/samples/simple/elastic-stack/_index.md b/documentation/staging/content/samples/elastic-stack/_index.md similarity index 100% rename from documentation/staging/content/samples/simple/elastic-stack/_index.md rename to documentation/staging/content/samples/elastic-stack/_index.md diff --git a/documentation/staging/content/samples/simple/elastic-stack/operator/_index.md b/documentation/staging/content/samples/elastic-stack/operator/_index.md similarity index 100% rename from documentation/staging/content/samples/simple/elastic-stack/operator/_index.md rename to documentation/staging/content/samples/elastic-stack/operator/_index.md diff --git a/documentation/staging/content/samples/simple/elastic-stack/weblogic-domain/_index.md b/documentation/staging/content/samples/elastic-stack/weblogic-domain/_index.md similarity index 100% rename from documentation/staging/content/samples/simple/elastic-stack/weblogic-domain/_index.md rename to documentation/staging/content/samples/elastic-stack/weblogic-domain/_index.md diff --git a/documentation/staging/content/samples/simple/ingress/_index.md b/documentation/staging/content/samples/ingress/_index.md similarity index 100% rename from documentation/staging/content/samples/simple/ingress/_index.md rename to documentation/staging/content/samples/ingress/_index.md diff --git a/documentation/staging/content/samples/production/_index.md b/documentation/staging/content/samples/production/_index.md deleted file mode 100644 index 4d82e986b0c..00000000000 --- a/documentation/staging/content/samples/production/_index.md +++ /dev/null @@ -1,11 +0,0 @@ -+++ -title = "Production samples" -date = 2019-02-23T17:11:39-05:00 -weight = 2 -draft = true -pre = " " -+++ - - - -The samples in this section are intended to help you create a production deployment of WebLogic on Kubernetes. diff --git a/documentation/staging/content/samples/simple/rest/_index.md b/documentation/staging/content/samples/rest/_index.md similarity index 100% rename from documentation/staging/content/samples/simple/rest/_index.md rename to documentation/staging/content/samples/rest/_index.md diff --git a/documentation/staging/content/samples/simple/_index.md b/documentation/staging/content/samples/simple/_index.md deleted file mode 100644 index a47fe7ee348..00000000000 --- a/documentation/staging/content/samples/simple/_index.md +++ /dev/null @@ -1,11 +0,0 @@ -+++ -title = "Simple samples" -date = 2019-02-23T17:11:34-05:00 -weight = 1 -pre = " " -+++ - - -This section provides samples for individual tasks. The samples in this section are intended to be modified before production use. - -{{% children style="h4" description="true" %}} diff --git a/documentation/staging/content/samples/simple/storage/_index.md b/documentation/staging/content/samples/storage/_index.md similarity index 100% rename from documentation/staging/content/samples/simple/storage/_index.md rename to documentation/staging/content/samples/storage/_index.md diff --git a/documentation/staging/content/samples/simple/tanzu-kubernetes-service/_index.md b/documentation/staging/content/samples/tanzu-kubernetes-service/_index.md similarity index 99% rename from documentation/staging/content/samples/simple/tanzu-kubernetes-service/_index.md rename to documentation/staging/content/samples/tanzu-kubernetes-service/_index.md index 2efeea56cce..959c5af31b1 100644 --- a/documentation/staging/content/samples/simple/tanzu-kubernetes-service/_index.md +++ b/documentation/staging/content/samples/tanzu-kubernetes-service/_index.md @@ -564,7 +564,7 @@ Copy the following to a file called `/tmp/mii-sample/mii-initial.yaml` or simila {{% /expand %}} - > **Note**: Before you deploy the domain custom resource, determine if you have Kubernetes cluster worker nodes that are remote to your local machine. If so, you need to put the Domain's image in a location that these nodes can access and you may also need to modify your Domain YAML file to reference the new location. See [Ensuring your Kubernetes cluster can access images]({{< relref "/samples/simple/domains/model-in-image/_index.md#ensuring-your-kubernetes-cluster-can-access-images" >}}). + > **Note**: Before you deploy the domain custom resource, determine if you have Kubernetes cluster worker nodes that are remote to your local machine. If so, you need to put the Domain's image in a location that these nodes can access and you may also need to modify your Domain YAML file to reference the new location. See [Ensuring your Kubernetes cluster can access images]({{< relref "/samples/domains/model-in-image/_index.md#ensuring-your-kubernetes-cluster-can-access-images" >}}). Run the following command to create the domain custom resource: diff --git a/documentation/staging/content/security/certificates.md b/documentation/staging/content/security/certificates.md index d5df91cf133..ae0f5c4ae31 100644 --- a/documentation/staging/content/security/certificates.md +++ b/documentation/staging/content/security/certificates.md @@ -41,4 +41,4 @@ $ helm -n weblogic-operator-ns upgrade weblogic-operator kubernetes/charts/weblo #### Additional reading * [Configure the external REST interface SSL/TLS identity]({{}}) * [REST interface configuration settings]({{}}) -* [Sample to create external certificate and key]({{}}) +* [Sample to create external certificate and key]({{}}) diff --git a/documentation/staging/content/userguide/base-images/_index.md b/documentation/staging/content/userguide/base-images/_index.md index c43fb258cbb..f9986731db8 100644 --- a/documentation/staging/content/userguide/base-images/_index.md +++ b/documentation/staging/content/userguide/base-images/_index.md @@ -136,7 +136,7 @@ to build the image and apply the patches. #### Create a custom image with your domain inside the image You can also create an image with the WebLogic domain inside the image. -[Samples]({{< relref "/samples/simple/domains/domain-home-in-image/_index.md" >}}) +[Samples]({{< relref "/samples/domains/domain-home-in-image/_index.md" >}}) are provided that demonstrate how to create the image using either: * WLST to define the domain, or diff --git a/documentation/staging/content/userguide/cicd/tools.md b/documentation/staging/content/userguide/cicd/tools.md index c24da983249..db9215538bc 100644 --- a/documentation/staging/content/userguide/cicd/tools.md +++ b/documentation/staging/content/userguide/cicd/tools.md @@ -46,8 +46,8 @@ Other than the tools themselves, there are three components to the WDT tools: [here](https://github.com/oracle/weblogic-deploy-tooling/tree/master/samples/docker-domain). - (Kubernetes) A similar sample of creating a domain in an image with WDT can be found in the WebLogic Kubernetes Operator project for creating a - [domain-in-image with WDT](https://oracle.github.io/weblogic-kubernetes-operator/samples/simple/domains/domain-home-in-image/). -- (Kubernetes) A [Model in Image sample]({{< relref "/samples/simple/domains/model-in-image/_index.md" >}}) + [domain-in-image with WDT]({{< relref "/samples/domains/domain-home-in-image/" >}}). +- (Kubernetes) A [Model in Image sample]({{< relref "/samples/domains/model-in-image/_index.md" >}}) for supplying an image that contains a WDT model only, instead of a domain home. In this case, the operator generates the domain home for you at runtime. diff --git a/documentation/staging/content/userguide/kubernetes/k8s-setup.md b/documentation/staging/content/userguide/kubernetes/k8s-setup.md index c4d1cacf9b8..1bf936d6542 100644 --- a/documentation/staging/content/userguide/kubernetes/k8s-setup.md +++ b/documentation/staging/content/userguide/kubernetes/k8s-setup.md @@ -18,7 +18,7 @@ weight: 10 ### Cheat sheet for setting up Kubernetes -If you need some help setting up a Kubernetes environment to experiment with the operator, please read on! The supported environments are either an on-premises installation of Kubernetes, for example, on bare metal, or on a cloud provider like Oracle Cloud, [Microsoft Azure](/weblogic-kubernetes-operator/samples/simple/azure-kubernetes-service/), Google, or Amazon. Cloud providers allow you to provision a managed Kubernetes environment from their management consoles. You could also set up Kubernetes manually using compute resources on a cloud. There are also a number of ways to run a Kubernetes single-node cluster that are suitable for development or testing purposes. Your options include: +If you need some help setting up a Kubernetes environment to experiment with the operator, please read on! The supported environments are either an on-premises installation of Kubernetes, for example, on bare metal, or on a cloud provider like Oracle Cloud, [Microsoft Azure](/weblogic-kubernetes-operator/samples/azure-kubernetes-service/), Google, or Amazon. Cloud providers allow you to provision a managed Kubernetes environment from their management consoles. You could also set up Kubernetes manually using compute resources on a cloud. There are also a number of ways to run a Kubernetes single-node cluster that are suitable for development or testing purposes. Your options include: "Production" options: diff --git a/documentation/staging/content/userguide/managing-domains/_index.md b/documentation/staging/content/userguide/managing-domains/_index.md index b93a9b2095f..08046b57056 100644 --- a/documentation/staging/content/userguide/managing-domains/_index.md +++ b/documentation/staging/content/userguide/managing-domains/_index.md @@ -109,12 +109,12 @@ When a domain resource or WebLogic domain configuration violates the limits, the ### Creating and managing WebLogic domains You can locate a WebLogic domain either in a persistent volume (PV) or in an image. -For examples of each, see the [WebLogic Kubernetes Operator samples]({{< relref "/samples/simple/domains/_index.md" >}}). +For examples of each, see the [WebLogic Kubernetes Operator samples]({{< relref "/samples/domains/_index.md" >}}). If you want to create your own container images, for example, to choose a specific set of patches or to create a domain with a specific configuration or applications deployed, then you can create the domain custom resource manually to deploy your domain. This process is documented in [this -sample]({{< relref "/samples/simple/domains/manually-create-domain/_index.md" >}}). +sample]({{< relref "/samples/domains/manually-create-domain/_index.md" >}}). ### Modifying domain configurations diff --git a/documentation/staging/content/userguide/managing-domains/choosing-a-model/_index.md b/documentation/staging/content/userguide/managing-domains/choosing-a-model/_index.md index abcdba8a8e9..149472ae432 100644 --- a/documentation/staging/content/userguide/managing-domains/choosing-a-model/_index.md +++ b/documentation/staging/content/userguide/managing-domains/choosing-a-model/_index.md @@ -7,17 +7,17 @@ pre = " " When using the operator to start WebLogic Server instances from a domain, you have the choice of the following WebLogic domain home source types: - - **[Domain in PV]({{< relref "/samples/simple/domains/domain-home-on-pv/_index.md" >}})**: + - **[Domain in PV]({{< relref "/samples/domains/domain-home-on-pv/_index.md" >}})**: - Supply a WebLogic installation in an image and supply WebLogic configuration as a domain home in a persistent volume. - Supply WebLogic applications in the persistent volume. - Mutate WebLogic configuration using WLST, the WebLogic Server Administration Console, or [configuration overrides]({{< relref "/userguide/managing-domains/configoverrides/_index.md" >}}) supplied in a Kubernetes ConfigMap. - - **[Domain in Image]({{< relref "/samples/simple/domains/domain-home-in-image/_index.md" >}})**: + - **[Domain in Image]({{< relref "/samples/domains/domain-home-in-image/_index.md" >}})**: - Supply a WebLogic installation in an image and supply WebLogic configuration as a domain home layered on this image. - Supply WebLogic applications layered on the installation image. - Mutate WebLogic configuration by supplying a new image and rolling, or by configuration overrides supplied in a Kubernetes ConfigMap. - - **[Model in Image]({{< relref "/samples/simple/domains/model-in-image/_index.md" >}})**: + - **[Model in Image]({{< relref "/samples/domains/model-in-image/_index.md" >}})**: - Supply a WebLogic installation in an image and supply WebLogic configuration in one of three ways: - As WebLogic Deployment Tool (WDT) model YAML file layered on the WebLogic installation image. - As WDT model YAML file supplied in separate [auxiliary images]({{< relref "/userguide/managing-domains/model-in-image/auxiliary-images.md" >}}). diff --git a/documentation/staging/content/userguide/managing-domains/domain-resource.md b/documentation/staging/content/userguide/managing-domains/domain-resource.md index d3c6e8118dd..d3a17a4c3fd 100644 --- a/documentation/staging/content/userguide/managing-domains/domain-resource.md +++ b/documentation/staging/content/userguide/managing-domains/domain-resource.md @@ -40,8 +40,8 @@ For example, see the [Quick Start]({{< relref "/quickstart/_index.md" >}}). Domains are defined using YAML files. For each WebLogic Server domain you want to run, you should create one Domain resource YAML file and apply it. In the example referenced below, the sample scripts generate a Domain resource YAML file that you can use as a basis. Copy the file and override the default settings so that it matches all the WebLogic Server domain parameters that define your domain. -See the WebLogic Server samples, [Domain home on a PV]({{< relref "/samples/simple/domains/domain-home-on-pv/_index.md" >}}), -[Domain home in Image]({{< relref "/samples/simple/domains/domain-home-in-image/_index.md" >}}), and [Model in Image]({{< relref "/samples/simple/domains/model-in-image/_index.md" >}}). +See the WebLogic Server samples, [Domain home on a PV]({{< relref "/samples/domains/domain-home-on-pv/_index.md" >}}), +[Domain home in Image]({{< relref "/samples/domains/domain-home-in-image/_index.md" >}}), and [Model in Image]({{< relref "/samples/domains/model-in-image/_index.md" >}}). After you have written your YAML files, you use them to create your domain artifacts using the `kubectl apply -f` command. diff --git a/documentation/staging/content/userguide/managing-domains/model-in-image/auxiliary-images.md b/documentation/staging/content/userguide/managing-domains/model-in-image/auxiliary-images.md index c2e2e235c99..e0d981e2401 100644 --- a/documentation/staging/content/userguide/managing-domains/model-in-image/auxiliary-images.md +++ b/documentation/staging/content/userguide/managing-domains/model-in-image/auxiliary-images.md @@ -133,7 +133,7 @@ container image. #### Step 1: Prerequisites - First, follow all of the steps in the Model in Image - [initial use case sample](/weblogic-kubernetes-operator/samples/simple/domains/model-in-image/initial/). + [initial use case sample](/weblogic-kubernetes-operator/samples/domains/model-in-image/initial/). This will: @@ -532,23 +532,23 @@ their corresponding values in their domain resource. ```text Usage: - + wl-pod-wait.sh [-n mynamespace] [-d mydomainuid] \ [-p expected_pod_count] \ [-t timeout_secs] \ [-q] - + Exits non-zero if 'timeout_secs' is reached before 'pod_count' is reached. - + Parameters: - + -d : Defaults to 'sample-domain1'. - + -n : Defaults to 'sample-domain1-ns'. - + -p 0 : Wait until there are no running WebLogic Server pods for a domain. The default. - + -p : Wait until all of the following are true for exactly 'pod_count' WebLogic Server pods in the domain: @@ -560,12 +560,12 @@ their corresponding values in their domain resource. - same image as the domain resource's 'spec.image' - same auxiliary images as the domain resource's 'spec.serverPod.auxiliaryImages' - + -t : Timeout in seconds. Defaults to '1000'. - + -q : Quiet mode. Show only a count of wl pods that have reached the desired criteria. - + -? : This help. ``` {{% /expand %}} @@ -580,81 +580,81 @@ their corresponding values in their domain resource. @@ [2021-06-14T20:35:35][seconds=0] Info: introspectVersion='1' @@ [2021-06-14T20:35:35][seconds=0] Info: namespace='sample-domain1-ns' @@ [2021-06-14T20:35:35][seconds=0] Info: domainUID='sample-domain1' - + @@ [2021-06-14T20:35:35][seconds=0] Info: '0' WebLogic Server pods currently match all criteria, expecting '3'. @@ [2021-06-14T20:35:35][seconds=0] Info: Introspector and WebLogic Server pods with same namespace and domain-uid: - + NAME RVER IVER IMAGE CMIMAGES READY PHASE ---- ---- ---- ----- -------- ----- ----- 'sample-domain1-introspector-wz8q6' '' '' '' 'model-in-image:WLS-AI-v1' '' 'Pending' - + @@ [2021-06-14T20:35:39][seconds=4] Info: '0' WebLogic Server pods currently match all criteria, expecting '3'. @@ [2021-06-14T20:35:39][seconds=4] Info: Introspector and WebLogic Server pods with same namespace and domain-uid: - + NAME RVER IVER IMAGE CMIMAGES READY PHASE ---- ---- ---- ----- -------- ----- ----- 'sample-domain1-introspector-wz8q6' '' '' '' 'model-in-image:WLS-AI-v1' '' 'Running' - + @@ [2021-06-14T20:36:51][seconds=76] Info: '0' WebLogic Server pods currently match all criteria, expecting '3'. @@ [2021-06-14T20:36:51][seconds=76] Info: Introspector and WebLogic Server pods with same namespace and domain-uid: - + NAME RVER IVER IMAGE CMIMAGES READY PHASE ---- ---- ---- ----- -------- ----- ----- 'sample-domain1-admin-server' '1' '1' 'container-registry.oracle.com/middleware/weblogic:12.2.1.4' 'model-in-image:WLS-AI-v1' 'false' 'Pending' - + @@ [2021-06-14T20:36:55][seconds=80] Info: '0' WebLogic Server pods currently match all criteria, expecting '3'. @@ [2021-06-14T20:36:55][seconds=80] Info: Introspector and WebLogic Server pods with same namespace and domain-uid: - + NAME RVER IVER IMAGE CMIMAGES READY PHASE ---- ---- ---- ----- -------- ----- ----- 'sample-domain1-admin-server' '1' '1' 'container-registry.oracle.com/middleware/weblogic:12.2.1.4' 'model-in-image:WLS-AI-v1' 'false' 'Running' - + @@ [2021-06-14T20:37:34][seconds=119] Info: '1' WebLogic Server pods currently match all criteria, expecting '3'. @@ [2021-06-14T20:37:34][seconds=119] Info: Introspector and WebLogic Server pods with same namespace and domain-uid: - + NAME RVER IVER IMAGE CMIMAGES READY PHASE ---- ---- ---- ----- -------- ----- ----- 'sample-domain1-admin-server' '1' '1' 'container-registry.oracle.com/middleware/weblogic:12.2.1.4' 'model-in-image:WLS-AI-v1' 'true' 'Running' 'sample-domain1-managed-server1' '1' '1' 'container-registry.oracle.com/middleware/weblogic:12.2.1.4' 'model-in-image:WLS-AI-v1' 'false' 'Pending' 'sample-domain1-managed-server2' '1' '1' 'container-registry.oracle.com/middleware/weblogic:12.2.1.4' 'model-in-image:WLS-AI-v1' 'false' 'Pending' - + @@ [2021-06-14T20:37:35][seconds=120] Info: '1' WebLogic Server pods currently match all criteria, expecting '3'. @@ [2021-06-14T20:37:35][seconds=120] Info: Introspector and WebLogic Server pods with same namespace and domain-uid: - + NAME RVER IVER IMAGE CMIMAGES READY PHASE ---- ---- ---- ----- -------- ----- ----- 'sample-domain1-admin-server' '1' '1' 'container-registry.oracle.com/middleware/weblogic:12.2.1.4' 'model-in-image:WLS-AI-v1' 'true' 'Running' 'sample-domain1-managed-server1' '1' '1' 'container-registry.oracle.com/middleware/weblogic:12.2.1.4' 'model-in-image:WLS-AI-v1' 'false' 'Running' 'sample-domain1-managed-server2' '1' '1' 'container-registry.oracle.com/middleware/weblogic:12.2.1.4' 'model-in-image:WLS-AI-v1' 'false' 'Pending' - + @@ [2021-06-14T20:37:37][seconds=122] Info: '1' WebLogic Server pods currently match all criteria, expecting '3'. @@ [2021-06-14T20:37:37][seconds=122] Info: Introspector and WebLogic Server pods with same namespace and domain-uid: - + NAME RVER IVER IMAGE CMIMAGES READY PHASE ---- ---- ---- ----- -------- ----- ----- 'sample-domain1-admin-server' '1' '1' 'container-registry.oracle.com/middleware/weblogic:12.2.1.4' 'model-in-image:WLS-AI-v1' 'true' 'Running' 'sample-domain1-managed-server1' '1' '1' 'container-registry.oracle.com/middleware/weblogic:12.2.1.4' 'model-in-image:WLS-AI-v1' 'false' 'Running' 'sample-domain1-managed-server2' '1' '1' 'container-registry.oracle.com/middleware/weblogic:12.2.1.4' 'model-in-image:WLS-AI-v1' 'false' 'Running' - + @@ [2021-06-14T20:38:18][seconds=163] Info: '2' WebLogic Server pods currently match all criteria, expecting '3'. @@ [2021-06-14T20:38:18][seconds=163] Info: Introspector and WebLogic Server pods with same namespace and domain-uid: - + NAME RVER IVER IMAGE CMIMAGES READY PHASE ---- ---- ---- ----- -------- ----- ----- 'sample-domain1-admin-server' '1' '1' 'container-registry.oracle.com/middleware/weblogic:12.2.1.4' 'model-in-image:WLS-AI-v1' 'true' 'Running' 'sample-domain1-managed-server1' '1' '1' 'container-registry.oracle.com/middleware/weblogic:12.2.1.4' 'model-in-image:WLS-AI-v1' 'false' 'Running' 'sample-domain1-managed-server2' '1' '1' 'container-registry.oracle.com/middleware/weblogic:12.2.1.4' 'model-in-image:WLS-AI-v1' 'true' 'Running' - + @@ [2021-06-14T20:38:20][seconds=165] Info: '3' WebLogic Server pods currently match all criteria, expecting '3'. @@ [2021-06-14T20:38:20][seconds=165] Info: Introspector and WebLogic Server pods with same namespace and domain-uid: - + NAME RVER IVER IMAGE CMIMAGES READY PHASE ---- ---- ---- ----- -------- ----- ----- 'sample-domain1-admin-server' '1' '1' 'container-registry.oracle.com/middleware/weblogic:12.2.1.4' 'model-in-image:WLS-AI-v1' 'true' 'Running' 'sample-domain1-managed-server1' '1' '1' 'container-registry.oracle.com/middleware/weblogic:12.2.1.4' 'model-in-image:WLS-AI-v1' 'true' 'Running' 'sample-domain1-managed-server2' '1' '1' 'container-registry.oracle.com/middleware/weblogic:12.2.1.4' 'model-in-image:WLS-AI-v1' 'true' 'Running' - - + + @@ [2021-06-14T20:38:20][seconds=165] Info: Success! ``` {{% /expand %}} @@ -664,5 +664,5 @@ If you see an error, then consult [Debugging]({{< relref "/userguide/managing-do #### Step 4: Invoke the web application To invoke the web application, follow the same steps as described in the -[Invoke the web application](/weblogic-kubernetes-operator/samples/simple/domains/model-in-image/initial/#invoke-the-web-application) +[Invoke the web application](/weblogic-kubernetes-operator/samples/domains/model-in-image/initial/#invoke-the-web-application) section of the initial use case. diff --git a/documentation/staging/content/userguide/managing-domains/model-in-image/overview.md b/documentation/staging/content/userguide/managing-domains/model-in-image/overview.md index 2fbd3f7d285..cb1a7719972 100644 --- a/documentation/staging/content/userguide/managing-domains/model-in-image/overview.md +++ b/documentation/staging/content/userguide/managing-domains/model-in-image/overview.md @@ -81,9 +81,9 @@ To understand how Model in Image works with CI/CD, see [CI/CD considerations]({{ ### References - - [Model in Image sample]({{< relref "/samples/simple/domains/model-in-image/_index.md" >}}) + - [Model in Image sample]({{< relref "/samples/domains/model-in-image/_index.md" >}}) - [WebLogic Deploy Tool (WDT)](https://oracle.github.io/weblogic-deploy-tooling/) - [WebLogic Image Tool (WIT)](https://oracle.github.io/weblogic-image-tool/) - Domain [schema](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/documentation/domains/Domain.md), [documentation]({{< relref "/userguide/managing-domains/domain-resource.md" >}}) - - HTTP load balancers: Ingress [documentation]({{< relref "/userguide/managing-domains/ingress/_index.md" >}}), [sample]({{< relref "/samples/simple/ingress/_index.md" >}}) + - HTTP load balancers: Ingress [documentation]({{< relref "/userguide/managing-domains/ingress/_index.md" >}}), [sample]({{< relref "/samples/ingress/_index.md" >}}) - [CI/CD considerations]({{< relref "/userguide/cicd/_index.md" >}}) diff --git a/documentation/staging/content/userguide/managing-domains/model-in-image/runtime-updates.md b/documentation/staging/content/userguide/managing-domains/model-in-image/runtime-updates.md index 68e6b7d968f..128566e8767 100644 --- a/documentation/staging/content/userguide/managing-domains/model-in-image/runtime-updates.md +++ b/documentation/staging/content/userguide/managing-domains/model-in-image/runtime-updates.md @@ -346,7 +346,7 @@ for advice. #### Offline update sample For an offline update sample which adds a data source, see the -[Update 1 use case]({{< relref "/samples/simple/domains/model-in-image/update1.md" >}}) +[Update 1 use case]({{< relref "/samples/domains/model-in-image/update1.md" >}}) in the Model in Image sample. ### Online updates @@ -810,7 +810,7 @@ _Here are some of the expected WebLogic pod labels after an online update succes #### Online update sample For an online update sample which alters a data source and Work Manager, see the -[Update 4 use case]({{< relref "/samples/simple/domains/model-in-image/update4.md" >}}) +[Update 4 use case]({{< relref "/samples/domains/model-in-image/update4.md" >}}) in the Model in Image sample. ### Appendices @@ -939,4 +939,4 @@ the Domain `spec.introspectVersion`. Here are some common ways to alter either o the `kubernetes/samples/scripts/create-weblogic-domain/model-in-image/utils/` directory. - Or, see the more advanced `introspectDomain.sh` and `rollDomain.sh` among - the [Domain lifecycle sample scripts]({{< relref "/samples/simple/domains/lifecycle/_index.md">}}). + the [Domain lifecycle sample scripts]({{< relref "/samples/domains/lifecycle/_index.md">}}). diff --git a/documentation/staging/content/userguide/managing-domains/model-in-image/usage.md b/documentation/staging/content/userguide/managing-domains/model-in-image/usage.md index 85d7faa59cc..aa2390f77cb 100644 --- a/documentation/staging/content/userguide/managing-domains/model-in-image/usage.md +++ b/documentation/staging/content/userguide/managing-domains/model-in-image/usage.md @@ -29,7 +29,7 @@ Deploy the operator and ensure that it is monitoring the desired namespace for y Model in Image requires an image with a WebLogic Server installation. -- You can start with a WebLogic Server 12.2.1.3 or later Oracle Container Registry pre-built base image such as `container-registry.oracle.com/middleware/weblogic:12.2.1.3` for WLS domains or `container-registry.oracle.com/middleware/fmw-infrastructure:12.2.1.3` for JRF domains. For an example of this approach for both WLS and JRF domains, see the [Model in Image]({{< relref "/samples/simple/domains/model-in-image/_index.md" >}}) sample. For detailed instructions on how to log in to the Oracle Container Registry and accept the license agreement for an image (required to allow pulling an Oracle Container Registry image), see this [document]({{< relref "/userguide/base-images/_index.md#obtain-standard-images-from-the-oracle-container-registry" >}}). +- You can start with a WebLogic Server 12.2.1.3 or later Oracle Container Registry pre-built base image such as `container-registry.oracle.com/middleware/weblogic:12.2.1.3` for WLS domains or `container-registry.oracle.com/middleware/fmw-infrastructure:12.2.1.3` for JRF domains. For an example of this approach for both WLS and JRF domains, see the [Model in Image]({{< relref "/samples/domains/model-in-image/_index.md" >}}) sample. For detailed instructions on how to log in to the Oracle Container Registry and accept the license agreement for an image (required to allow pulling an Oracle Container Registry image), see this [document]({{< relref "/userguide/base-images/_index.md#obtain-standard-images-from-the-oracle-container-registry" >}}). - Or, you can manually build your own base image, as described in [Preparing a Base Image]({{< relref "/userguide/base-images/_index.md#create-a-custom-image-with-patches-applied" >}}). This is useful if you want your base images to include additional patches. Note that any 12.2.1.3 image must also include patch 29135930 (the pre-built images already contain this patch). @@ -75,7 +75,7 @@ There are multiple methods for supplying Model in Image WDT artifacts: on top of your base image into a new image. - The _WebLogic Image Tool_ (WIT) has built-in options for layering WDT model files, WDT binaries, WebLogic Server binaries, and WebLogic Server patches in an image. - The [Model in Image]({{< relref "/samples/simple/domains/model-in-image/_index.md" >}}) sample uses the WIT approach. + The [Model in Image]({{< relref "/samples/domains/model-in-image/_index.md" >}}) sample uses the WIT approach. - __Use auxiliary images__: Use [auxiliary images]({{< relref "/userguide/managing-domains/model-in-image/auxiliary-images.md" >}}) @@ -176,7 +176,7 @@ The following Domain fields are specific to Model in Image domains. - For fully specified Model in Image Domain YAML file examples, see the operator source directory `kubernetes/samples/scripts/create-weblogic-domain/model-in-image/domain-resources` - for the [Model in Image sample]({{< relref "/samples/simple/domains/model-in-image/_index.md" >}}). + for the [Model in Image sample]({{< relref "/samples/domains/model-in-image/_index.md" >}}). The `WLS` and `JRF` subdirectories in this directory correspond to the `configuration.model.domainType`. #### Always use external state @@ -289,6 +289,6 @@ Follow these steps to ensure that a JRF domain can continue to access its RCU da ##### JRF references -For an example of using JRF in combination with Model in Image, see the [Model in Image]({{< relref "/samples/simple/domains/model-in-image/_index.md" >}}) sample. +For an example of using JRF in combination with Model in Image, see the [Model in Image]({{< relref "/samples/domains/model-in-image/_index.md" >}}) sample. See also, [Specifying RCU connection information in the model](https://github.com/oracle/weblogic-deploy-tooling/blob/main/documentation/1.9/content/rcuinfo.md) in the WDT documentation. diff --git a/documentation/staging/content/userguide/managing-domains/persistent-storage/_index.md b/documentation/staging/content/userguide/managing-domains/persistent-storage/_index.md index 2b9b6da5ed1..1f2457933c2 100644 --- a/documentation/staging/content/userguide/managing-domains/persistent-storage/_index.md +++ b/documentation/staging/content/userguide/managing-domains/persistent-storage/_index.md @@ -69,7 +69,7 @@ $ sudo chgrp -R 6789 logs/ Persistent volumes and claims are described in YAML files. For each PersistentVolume, you should create one PersistentVolume YAML file and one PersistentVolumeClaim YAML file. In the example below, you will find two YAML templates, one for the volume and one for the claim. As stated above, they either can be dedicated to a specific domain, or shared across multiple domains. For the use cases where a volume will be dedicated to a particular domain, it is a best practice to label it with `weblogic.domainUID=[domain name]`. This makes it easy to search for, and clean up resources associated with that particular domain. -For sample YAML templates, refer to the [PersistentVolumes example]({{< relref "/samples/simple/storage/_index.md" >}}). +For sample YAML templates, refer to the [PersistentVolumes example]({{< relref "/samples/storage/_index.md" >}}). ### Kubernetes resources diff --git a/documentation/staging/content/userguide/managing-domains/prepare.md b/documentation/staging/content/userguide/managing-domains/prepare.md index b5823397022..1f194e5e585 100644 --- a/documentation/staging/content/userguide/managing-domains/prepare.md +++ b/documentation/staging/content/userguide/managing-domains/prepare.md @@ -18,7 +18,7 @@ Perform these steps to prepare your Kubernetes cluster to run a WebLogic domain: numbers, and hyphens. 1. Create a Kubernetes Secret containing the Administration Server boot credentials. You can do this manually or by using - [the provided sample]({{< relref "/samples/simple/credentials/_index.md" >}}). To create + [the provided sample]({{< relref "/samples/credentials/_index.md" >}}). To create the secret manually, use this command: ```shell @@ -33,7 +33,7 @@ Perform these steps to prepare your Kubernetes cluster to run a WebLogic domain: * Replace the string `username` in the third line with the user name for the administrative user. * Replace the string `password` in the fourth line with the password. -1. Optionally, [create a PV & PersistentVolumeClaim (PVC)]({{< relref "/samples/simple/storage/_index.md" >}}) which can hold the domain home, logs, and application binaries. +1. Optionally, [create a PV & PersistentVolumeClaim (PVC)]({{< relref "/samples/storage/_index.md" >}}) which can hold the domain home, logs, and application binaries. Even if you put your domain in an image, you may want to put the logs on a persistent volume so that they are available after the pods terminate. This may be instead of, or as well as, other approaches like streaming logs into Elasticsearch. 1. Optionally, [configure load balancer](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/charts/README.md) to manage access to any WebLogic clusters. diff --git a/documentation/staging/content/userguide/managing-fmw-domains/_index.md b/documentation/staging/content/userguide/managing-fmw-domains/_index.md index 829254b9f06..d1e6c7e7deb 100644 --- a/documentation/staging/content/userguide/managing-fmw-domains/_index.md +++ b/documentation/staging/content/userguide/managing-fmw-domains/_index.md @@ -412,7 +412,7 @@ password will be the password you provided for regular schema users during RCU c #### Creating an FMW Infrastructure domain Now that you have your images and you have created your RCU schemas, you are ready -to create your domain. We provide a [sample]({{< relref "/samples/simple/domains/fmw-domain/_index.md" >}}) +to create your domain. We provide a [sample]({{< relref "/samples/domains/fmw-domain/_index.md" >}}) that demonstrates how to create an FMW Infrastructure domain. #### Patching the FMW Infrastructure image @@ -449,4 +449,4 @@ for more information. #### Additional considerations for Model in Image -If you are using Model in Image, then see the [Model in Image sample]({{< relref "/samples/simple/domains/model-in-image/_index.md" >}}), which demonstrates a JRF model and its RCU schema setup, and see [Model in Image requirements for JRF domain types]({{< relref "/userguide/managing-domains/model-in-image/usage/_index.md#requirements-for-jrf-domain-types" >}}). +If you are using Model in Image, then see the [Model in Image sample]({{< relref "/samples/domains/model-in-image/_index.md" >}}), which demonstrates a JRF model and its RCU schema setup, and see [Model in Image requirements for JRF domain types]({{< relref "/userguide/managing-domains/model-in-image/usage/_index.md#requirements-for-jrf-domain-types" >}}). diff --git a/documentation/staging/content/userguide/managing-operators/_index.md b/documentation/staging/content/userguide/managing-operators/_index.md index 4e6091a731b..bf386c9b036 100644 --- a/documentation/staging/content/userguide/managing-operators/_index.md +++ b/documentation/staging/content/userguide/managing-operators/_index.md @@ -9,7 +9,7 @@ description: "Helm is used to create and deploy necessary operator resources and ### Overview Helm is a framework that helps you manage Kubernetes applications, and Helm charts help you define and install Helm applications into a Kubernetes cluster. The operator's Helm chart is located in the `kubernetes/charts/weblogic-operator` directory. - + ### Install Helm @@ -62,7 +62,7 @@ should contain valid host names, expiration dates, and key constraints. {{% /notice %}} For more detailed information about the sample script and how to run it, see -the [REST APIs]({{}}). +the [REST APIs]({{}}). #### Optional: Elastic Stack (Elasticsearch, Logstash, and Kibana) integration diff --git a/documentation/staging/content/userguide/prepare/_index.md b/documentation/staging/content/userguide/prepare/_index.md index aa36db15e46..0f770786bb3 100644 --- a/documentation/staging/content/userguide/prepare/_index.md +++ b/documentation/staging/content/userguide/prepare/_index.md @@ -20,13 +20,13 @@ description: "Follow these steps to set up your environment." 1. [Install the operator]({{< relref "/userguide/managing-operators/installation.md" >}}). -1. Optional. Run a database. For example, run an [Oracle database]({{< relref "/samples/simple/database/#run-the-oracle-database-in-kubernetes" >}}) inside Kubernetes. +1. Optional. Run a database. For example, run an [Oracle database]({{< relref "/samples/database/#run-the-oracle-database-in-kubernetes" >}}) inside Kubernetes. 1. Optional. Load balance with an ingress controller or a web server. For information about the current capabilities and setup instructions for each of the supported load balancers, see the [WebLogic Operator Load Balancer Samples](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/charts/README.md). 1. Optional. Configure Kibana and Elasticsearch. You can send the operator logs to Elasticsearch, to be displayed in Kibana. Use -this [sample script]({{< relref "/samples/simple/elastic-stack/_index.md" >}}) to configure Elasticsearch and Kibana deployments and services. +this [sample script]({{< relref "/samples/elastic-stack/_index.md" >}}) to configure Elasticsearch and Kibana deployments and services. -1. Optional. Create persistent file storage. For example, a Kubernetes [PersistentVolume (PV) and PersistentVolumeClaim (PVC)]({{< relref "/samples/simple/storage/_index.md" >}}). +1. Optional. Create persistent file storage. For example, a Kubernetes [PersistentVolume (PV) and PersistentVolumeClaim (PVC)]({{< relref "/samples/storage/_index.md" >}}). 1. Set up your domain. For information, see [Choose a domain home source type]({{< relref "/userguide/managing-domains/choosing-a-model/_index.md" >}}). From 9f902f933811fd0a46723cdaafae3ad8ac92c576 Mon Sep 17 00:00:00 2001 From: Tom Barnes Date: Wed, 21 Jul 2021 15:13:59 +0000 Subject: [PATCH 2/2] remove /simple from hugo doc refs in the sample source --- README.md | 2 +- kubernetes/samples/README.md | 6 +++--- .../README.md | 2 +- .../create-domain-on-aks.sh | 2 +- .../validate.sh | 2 +- .../scripts/create-weblogic-domain/model-in-image/README.md | 4 ++-- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4a93a132135..7bda5d85668 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ You can: * Publish operator and WebLogic Server logs into Elasticsearch and interact with them in Kibana. -The fastest way to experience the operator is to follow the [Quick Start guide](https://oracle.github.io/weblogic-kubernetes-operator/quickstart/), or you can peruse our [documentation](https://oracle.github.io/weblogic-kubernetes-operator), read our [blogs](https://blogs.oracle.com/weblogicserver/how-to-weblogic-server-on-kubernetes), or try out the [samples](https://oracle.github.io/weblogic-kubernetes-operator/samples/simple/). +The fastest way to experience the operator is to follow the [Quick Start guide](https://oracle.github.io/weblogic-kubernetes-operator/quickstart/), or you can peruse our [documentation](https://oracle.github.io/weblogic-kubernetes-operator), read our [blogs](https://blogs.oracle.com/weblogicserver/how-to-weblogic-server-on-kubernetes), or try out the [samples](https://oracle.github.io/weblogic-kubernetes-operator/samples/). *** The [current release of the operator](https://github.com/oracle/weblogic-kubernetes-operator/releases) is 3.3.0. diff --git a/kubernetes/samples/README.md b/kubernetes/samples/README.md index 7187c0e5a52..4f792e13f39 100644 --- a/kubernetes/samples/README.md +++ b/kubernetes/samples/README.md @@ -10,9 +10,9 @@ While these samples may be useful and usable as is, it is intended that you woul * [Sample for creating a Kubernetes secret](scripts/create-weblogic-domain-credentials/README.md) that contains the Administration Server credentials. This secret can be used in creating a WebLogic domain resource. * [Sample for creating a PV or PVC](scripts/create-weblogic-domain-pv-pvc/README.md) that can be used by a domain resource as the persistent storage for the WebLogic domain home or log files. -* [Sample for creating a WebLogic domain home on an existing PV or PVC (Domain in PV)](https://oracle.github.io/weblogic-kubernetes-operator/samples/simple/domains/domain-home-on-pv/), and the domain resource YAML file for deploying the generated WebLogic domain. -* [Sample for creating a WebLogic domain home inside a Docker image (Domain in Image)](https://oracle.github.io/weblogic-kubernetes-operator/samples/simple/domains/domain-home-in-image/), and the domain resource YAML file for deploying the generated WebLogic domain. -* [Sample for creating a WebLogic Deploy Tool model inside a Docker image (Model in Image)](https://oracle.github.io/weblogic-kubernetes-operator/samples/simple/domains/model-in-image/), and the domain resource YAML file for deploying the generated WebLogic domain. +* [Sample for creating a WebLogic domain home on an existing PV or PVC (Domain in PV)](https://oracle.github.io/weblogic-kubernetes-operator/samples/domains/domain-home-on-pv/), and the domain resource YAML file for deploying the generated WebLogic domain. +* [Sample for creating a WebLogic domain home inside a Docker image (Domain in Image)](https://oracle.github.io/weblogic-kubernetes-operator/samples/domains/domain-home-in-image/), and the domain resource YAML file for deploying the generated WebLogic domain. +* [Sample for creating a WebLogic Deploy Tool model inside a Docker image (Model in Image)](https://oracle.github.io/weblogic-kubernetes-operator/samples/domains/model-in-image/), and the domain resource YAML file for deploying the generated WebLogic domain. * [Sample for configuring the Elasticsearch and Kibana](scripts/elasticsearch-and-kibana/README.md) deployments and services for the operator's logs. * [Sample for generating a self-signed certificate and private key](scripts/rest/README.md) that can be used for the operator's external REST API. * [Sample for creating an OKE cluster using Terraform](scripts/terraform/README.md). diff --git a/kubernetes/samples/scripts/create-weblogic-domain-on-azure-kubernetes-service/README.md b/kubernetes/samples/scripts/create-weblogic-domain-on-azure-kubernetes-service/README.md index 6c958edafe1..2ae19c9e274 100644 --- a/kubernetes/samples/scripts/create-weblogic-domain-on-azure-kubernetes-service/README.md +++ b/kubernetes/samples/scripts/create-weblogic-domain-on-azure-kubernetes-service/README.md @@ -1 +1 @@ -Please see the documentation for this sample [in the documentation for the Operator](https://oracle.github.io/weblogic-kubernetes-operator/samples/simple/azure-kubernetes-service/). +Please see the documentation for this sample [in the documentation for the Operator](https://oracle.github.io/weblogic-kubernetes-operator/samples/azure-kubernetes-service/). diff --git a/kubernetes/samples/scripts/create-weblogic-domain-on-azure-kubernetes-service/create-domain-on-aks.sh b/kubernetes/samples/scripts/create-weblogic-domain-on-azure-kubernetes-service/create-domain-on-aks.sh index f0b6926558a..79fa7c11a0c 100755 --- a/kubernetes/samples/scripts/create-weblogic-domain-on-azure-kubernetes-service/create-domain-on-aks.sh +++ b/kubernetes/samples/scripts/create-weblogic-domain-on-azure-kubernetes-service/create-domain-on-aks.sh @@ -445,7 +445,7 @@ function waitForJobComplete { kubectl get pods kubectl get svc else - echo It takes a little long to create domain, please refer to http://oracle.github.io/weblogic-kubernetes-operator/samples/simple/azure-kubernetes-service/#troubleshooting + echo It takes a little long to create domain, please refer to http://oracle.github.io/weblogic-kubernetes-operator/samples/azure-kubernetes-service/#troubleshooting fi } diff --git a/kubernetes/samples/scripts/create-weblogic-domain-on-azure-kubernetes-service/validate.sh b/kubernetes/samples/scripts/create-weblogic-domain-on-azure-kubernetes-service/validate.sh index 669997a4aa9..6477ebacfe8 100755 --- a/kubernetes/samples/scripts/create-weblogic-domain-on-azure-kubernetes-service/validate.sh +++ b/kubernetes/samples/scripts/create-weblogic-domain-on-azure-kubernetes-service/validate.sh @@ -309,7 +309,7 @@ function validateOperator { function validateDomain { ret=$(kubectl get domain | grep "${domainUID}") if [ -n "$ret" ]; then - fail "${domainUID} is created! Please create a new domain or follow the page to delete it https://oracle.github.io/weblogic-kubernetes-operator/samples/simple/domains/domain-home-on-pv/#delete-the-generated-domain-home." + fail "${domainUID} is created! Please create a new domain or follow the page to delete it https://oracle.github.io/weblogic-kubernetes-operator/samples/domains/domain-home-on-pv/#delete-the-generated-domain-home." fi } diff --git a/kubernetes/samples/scripts/create-weblogic-domain/model-in-image/README.md b/kubernetes/samples/scripts/create-weblogic-domain/model-in-image/README.md index df3bd9290ba..7d274427591 100644 --- a/kubernetes/samples/scripts/create-weblogic-domain/model-in-image/README.md +++ b/kubernetes/samples/scripts/create-weblogic-domain/model-in-image/README.md @@ -6,8 +6,8 @@ This sample demonstrates the WebLogic Kubernetes Operator "Model in Image" featu - Sample doc: - Location in documentation menu: `Samples -> Simple Samples -> Domains -> Model in Image`. - - [source](../../../../../docs-source/content/samples/simple/domains/model-in-image/_index.md) - - [latest public](https://oracle.github.io/weblogic-kubernetes-operator/samples/simple/domains/model-in-image) + - [source](../../../../../docs-source/content/samples/domains/model-in-image/_index.md) + - [latest public](https://oracle.github.io/weblogic-kubernetes-operator/samples/domains/model-in-image) - User doc: - Location in documentation menu: `User Guide -> Manage WebLogic Domains -> Model in Image`.