diff --git a/documentation/3.2/content/_index.md b/documentation/3.2/content/_index.md index 807d9e8dd6d..b1738c069c7 100644 --- a/documentation/3.2/content/_index.md +++ b/documentation/3.2/content/_index.md @@ -11,7 +11,7 @@ You can: * Supply WebLogic domain configuration using: * _Domain in PV_: Locates WebLogic domain homes in a Kubernetes PersistentVolume (PV). This PV can reside in an NFS file system or other Kubernetes volume types. * _Domain in Image_: Includes a WebLogic domain home in a container image. - * _Model in Image_: Includes [WebLogic Server Deploy Tooling](https://github.com/oracle/weblogic-deploy-tooling) models and archives in a container image. + * _Model in Image_: Includes [WebLogic Server Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) models and archives in a container image. * Configure deployment of WebLogic domains as a Kubernetes resource (using a Kubernetes custom resource definition). * Override certain aspects of the WebLogic domain configuration; for example, use a different database password for different deployments. * Start and stop servers and clusters in the domain based on declarative startup parameters and desired states. diff --git a/documentation/3.2/content/faq/newbie.md b/documentation/3.2/content/faq/newbie.md index cc3688db0a5..fbd3e2ac8c5 100644 --- a/documentation/3.2/content/faq/newbie.md +++ b/documentation/3.2/content/faq/newbie.md @@ -36,7 +36,7 @@ When using the operator, each deployed domain is specified by a domain resource 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 Server Deploy Tooling](https://github.com/oracle/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 Server 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. **Q:** Is the Administration Server required? Node Manager? diff --git a/documentation/3.2/content/samples/simple/azure-kubernetes-service/model-in-image.md b/documentation/3.2/content/samples/simple/azure-kubernetes-service/model-in-image.md index e3dd5ab9b30..9ac8a49f235 100644 --- a/documentation/3.2/content/samples/simple/azure-kubernetes-service/model-in-image.md +++ b/documentation/3.2/content/samples/simple/azure-kubernetes-service/model-in-image.md @@ -202,7 +202,7 @@ The sample includes a predefined archive directory in `/tmp/mii-sample/archives/ The archive top directory, named `wlsdeploy`, contains a directory named `applications`, which includes an ‘exploded’ sample JSP web application in the directory, `myapp-v1`. Three useful aspects to remember about WDT archives are: - A model image can contain multiple WDT archives. - WDT archives can contain multiple applications, libraries, and other components. - - WDT archives have a [well defined directory structure](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/archive.md), which always has `wlsdeploy` as the top directory. + - WDT archives have a [well defined directory structure](https://oracle.github.io/weblogic-deploy-tooling/concepts/archive/), which always has `wlsdeploy` as the top directory. The application displays important details about the WebLogic Server instance that it’s running on: namely its domain name, cluster name, and server name, as well as the names of any data sources that are targeted to the server. diff --git a/documentation/3.2/content/samples/simple/domains/model-in-image/_index.md b/documentation/3.2/content/samples/simple/domains/model-in-image/_index.md index 43f803cca79..d048e172da6 100644 --- a/documentation/3.2/content/samples/simple/domains/model-in-image/_index.md +++ b/documentation/3.2/content/samples/simple/domains/model-in-image/_index.md @@ -30,7 +30,7 @@ description: "Sample for supplying a WebLogic Deploy Tooling (WDT) model that th This sample demonstrates deploying a Model in Image [domain home source type]({{< relref "/userguide/managing-domains/choosing-a-model/_index.md" >}}). Unlike Domain in PV and Domain in Image, Model in Image eliminates the need to pre-create your WebLogic domain home prior to deploying your Domain YAML file. Instead, Model in Image uses a WebLogic Deploy Tooling (WDT) model to specify your WebLogic configuration. -WDT models are a convenient and simple alternative to WebLogic Scripting Tool (WLST) configuration scripts and templates. They compactly define a WebLogic domain using YAML files and support including application archives in a ZIP file. The WDT model format is described in the open source, [WebLogic Deploy Tooling](https://github.com/oracle/weblogic-deploy-tooling) GitHub project, and the required directory structure for a WDT archive is specifically discussed [here](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/archive.md). +WDT models are a convenient and simple alternative to WebLogic Scripting Tool (WLST) configuration scripts and templates. They compactly define a WebLogic domain using YAML files and support including application archives in a ZIP file. The WDT model format is described in the open source, [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) GitHub project, and the required directory structure for a WDT archive is specifically discussed [here](https://oracle.github.io/weblogic-deploy-tooling/concepts/archive/). For more information on Model in Image, see the [Model in Image user guide]({{< relref "/userguide/managing-domains/model-in-image/_index.md" >}}). For a comparison of Model in Image to other domain home source types, see [Choose a domain home source type]({{< relref "/userguide/managing-domains/choosing-a-model/_index.md" >}}). @@ -146,5 +146,5 @@ For more information, see the [Cannot pull image FAQ]({{}}) user documentation - - [Oracle WebLogic Server Deploy Tooling](https://github.com/oracle/weblogic-deploy-tooling) - - [Oracle WebLogic Image Tool](https://github.com/oracle/weblogic-image-tool) + - [Oracle WebLogic Server Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) + - [Oracle WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) diff --git a/documentation/3.2/content/samples/simple/domains/model-in-image/initial.md b/documentation/3.2/content/samples/simple/domains/model-in-image/initial.md index 13552741a9d..9d6eb3f70a0 100644 --- a/documentation/3.2/content/samples/simple/domains/model-in-image/initial.md +++ b/documentation/3.2/content/samples/simple/domains/model-in-image/initial.md @@ -55,7 +55,7 @@ The sample includes a predefined archive directory in `/tmp/mii-sample/archives/ The archive top directory, named `wlsdeploy`, contains a directory named `applications`, which includes an 'exploded' sample JSP web application in the directory, `myapp-v1`. Three useful aspects to remember about WDT archives are: - A model image can contain multiple WDT archives. - WDT archives can contain multiple applications, libraries, and other components. - - WDT archives have a [well defined directory structure](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/archive.md), which always has `wlsdeploy` as the top directory. + - WDT archives have a [well defined directory structure](https://oracle.github.io/weblogic-deploy-tooling/concepts/archive/), which always has `wlsdeploy` as the top directory. {{%expand "If you are interested in the web application source, click here to see the JSP code." %}} diff --git a/documentation/3.2/content/samples/simple/domains/model-in-image/prerequisites.md b/documentation/3.2/content/samples/simple/domains/model-in-image/prerequisites.md index f07bb5aab8a..5e8baea0be9 100644 --- a/documentation/3.2/content/samples/simple/domains/model-in-image/prerequisites.md +++ b/documentation/3.2/content/samples/simple/domains/model-in-image/prerequisites.md @@ -44,6 +44,7 @@ weight: 1 {{< rawhtml >}} {{< /rawhtml >}} + 1. Make sure an operator is set up to manage namespace `sample-domain1-ns`. Also, make sure a Traefik ingress controller is managing the same namespace and listening on port 30305. For example, follow the same steps as the [Quick Start](https://oracle.github.io/weblogic-kubernetes-operator/quickstart/) guide up through the [Prepare for a domain]({{< relref "/quickstart/prepare.md" >}}) step. @@ -141,7 +142,7 @@ weight: 1 If you prefer, you can create your own base image and then substitute this image name in the WebLogic Image Tool `--fromImage` parameter throughout this sample. For example, you may wish to start with a base image that has patches applied. See [Preparing a Base Image]({{< relref "/userguide/base-images/_index.md" >}}). {{% /notice %}} -1. Download the latest [WebLogic Deploy Tooling](https://github.com/oracle/weblogic-deploy-tooling) (WDT) and [WebLogic Image Tool](https://github.com/oracle/weblogic-image-tool) (WIT) installer ZIP files to your `/tmp/mii-sample/model-images` directory. Both WDT and WIT are required to create your Model in Image container images. +1. Download the latest [WebLogic Deploy Tooling](https://github.com/oracle/weblogic-deploy-tooling/releases) (WDT) and [WebLogic Image Tool](https://github.com/oracle/weblogic-image-tool/releases) (WIT) installer ZIP files to your `/tmp/mii-sample/model-images` directory. Both WDT and WIT are required to create your Model in Image container images. ```shell $ cd /tmp/mii-sample/model-images @@ -180,7 +181,7 @@ weight: 1 has a version of WDT in its `--type wdt --version latest` location, then the `cache addInstaller` command would fail. For more information about the WIT cache, see the - [WIT Cache documentation](https://github.com/oracle/weblogic-image-tool/blob/master/site/cache.md). + [WIT Cache documentation](https://oracle.github.io/weblogic-image-tool/userguide/tools/cache/). These steps will install WIT to the `/tmp/mii-sample/model-images/imagetool` directory, plus put a `wdt_latest` entry in the tool's cache which points to the WDT ZIP file installer. diff --git a/documentation/3.2/content/samples/simple/tanzu-kubernetes-service/_index.md b/documentation/3.2/content/samples/simple/tanzu-kubernetes-service/_index.md index 776845dab0a..850808526f2 100644 --- a/documentation/3.2/content/samples/simple/tanzu-kubernetes-service/_index.md +++ b/documentation/3.2/content/samples/simple/tanzu-kubernetes-service/_index.md @@ -215,7 +215,7 @@ The sample includes a predefined archive directory in `/tmp/mii-sample/archives/ The archive top directory, named `wlsdeploy`, contains a directory named `applications`, which includes an ‘exploded’ sample JSP web application in the directory, `myapp-v1`. Three useful aspects to remember about WDT archives are: - A model image can contain multiple WDT archives. - WDT archives can contain multiple applications, libraries, and other components. - - WDT archives have a [well defined directory structure](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/archive.md), which always has `wlsdeploy` as the top directory. + - WDT archives have a [well defined directory structure](https://oracle.github.io/weblogic-deploy-tooling/concepts/archive/), which always has `wlsdeploy` as the top directory. The application displays important details about the WebLogic Server instance that it’s running on: namely its domain name, cluster name, and server name, as well as the names of any data sources that are targeted to the server. diff --git a/documentation/3.2/content/userguide/base-images/_index.md b/documentation/3.2/content/userguide/base-images/_index.md index d6f11782cee..9cfa5ad744c 100644 --- a/documentation/3.2/content/userguide/base-images/_index.md +++ b/documentation/3.2/content/userguide/base-images/_index.md @@ -92,14 +92,14 @@ Additional information about using this image is available in the Oracle Contain The Oracle WebLogic Server Kubernetes Operator and WebLogic Server 12.2.1.3.0 image requires patch 29135930. This patch has some prerequisite patches that will also need to be applied. The WebLogic Server 12.2.1.4.0 image does not require any patches. To create and customize the WebLogic Server image, -and apply the required patches, use the [WebLogic Image Tool](https://github.com/oracle/weblogic-image-tool). +and apply the required patches, use the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/). -To use the Image Tool, follow the [Setup](https://github.com/oracle/weblogic-image-tool/blob/master/README.md#setup) instructions -and [Quick Start](https://github.com/oracle/weblogic-image-tool/blob/master/site/quickstart.md) Guide. +To use the Image Tool, follow the [Setup](https://oracle.github.io/weblogic-image-tool/quickstart/setup/) instructions +and [Quick Start](https://oracle.github.io/weblogic-image-tool/quickstart/quickstart/) Guide. To build the WebLogic Server image and apply the patches: -1. Add the Server JRE and the WebLogic Server installer to the [`cache` command](https://github.com/oracle/weblogic-image-tool/blob/master/site/cache.md). +1. Add the Server JRE and the WebLogic Server installer to the [`cache` command](https://oracle.github.io/weblogic-image-tool/userguide/tools/cache/). ```shell $ imagetool cache addInstaller \ @@ -113,7 +113,7 @@ To build the WebLogic Server image and apply the patches: --version=12.2.1.4.0 \ --path=/home/acmeuser/wls-installers/fmw_12.2.1.4.0_wls_Disk1_1of1.zip ``` -2. Use the [Create Tool](https://github.com/oracle/weblogic-image-tool/blob/master/site/create-image.md) +2. Use the [Create Tool](https://oracle.github.io/weblogic-image-tool/userguide/tools/create-image/) to build the image and apply the patches. For the Create Tool to download the patches, you must supply your My Oracle Support credentials. @@ -140,7 +140,7 @@ You can also create an image with the WebLogic domain inside the image. are provided that demonstrate how to create the image using either: * WLST to define the domain, or -* [WebLogic Deploy Tooling](https://github.com/oracle/weblogic-deploy-tooling) to define the domain. +* [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) to define the domain. In these samples, you will see a reference to a "base" or `FROM` image. You should use an image with the mandatory patches installed as this base image. This image could be either @@ -157,14 +157,14 @@ including keys and credentials that are used to access external resources #### Patch WebLogic Server images -Use the [WebLogic Image Tool](https://github.com/oracle/weblogic-image-tool) (WIT) to patch +Use the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) (WIT) to patch WebLogic Server images with quarterly Patch Set Updates (PSUs), which include security fixes, or with one-off patches. -Use either the WIT [`create`](https://github.com/oracle/weblogic-image-tool/blob/master/site/create-image.md) or -[`update`](https://github.com/oracle/weblogic-image-tool/blob/master/site/update-image.md) command, however, +Use either the WIT [`create`](https://oracle.github.io/weblogic-image-tool/userguide/tools/create-image/) or +[`update`](https://oracle.github.io/weblogic-image-tool/userguide/tools/update-image/) command, however, patching using the `create` command results in a smaller WebLogic Server image size. Note that you will need to download the WebLogic Server 12.2.1.4.0 installer and JDK installer prior to running the `create` command. For details, see -the WIT [Quick Start](https://github.com/oracle/weblogic-image-tool/blob/master/site/quickstart.md) guide. +the WIT [Quick Start](https://oracle.github.io/weblogic-image-tool/quickstart/quickstart/) guide. Example: Create an image named `sample:wls` with the WebLogic Server 12.2.1.4.0 slim installer, JDK 8u291, a slim version of the Oracle Linux 7 container image, and latest PSU and recommended CPU and SPU patches applied. @@ -181,12 +181,12 @@ to update the running domain differs depending on the [domain home source type]( difference between the domain home source types is the location of the domain home: * Domain in PV: The container image contains the JDK and WebLogic Server binaries. The domain home is located in a Persistent Volume (PV). -* Model in Image: The container image contains the JDK, WebLogic Server binaries, and a [WebLogic Deployment Tooling](https://github.com/oracle/weblogic-deploy-tooling) (WDT) installation, WDT model file, and application archive file. +* Model in Image: The container image contains the JDK, WebLogic Server binaries, and a [WebLogic Deployment Tooling](https://oracle.github.io/weblogic-deploy-tooling/) (WDT) installation, WDT model file, and application archive file. * Domain in Image: The container image contains the JDK, WebLogic Server binaries, and domain home. For Domain in PV, the operator can apply the update to the running domain without modifying the patched container image. For Model in Image (MII) and Domain in Image, before the operator can apply the update, the patched container images must be modified to add the domain home or a -WDT model and archive. You use WebLogic Image Tool (WIT) [Rebase Image](https://github.com/oracle/weblogic-image-tool/blob/master/site/rebase-image.md) +WDT model and archive. You use WebLogic Image Tool (WIT) [Rebase Image](https://oracle.github.io/weblogic-image-tool/userguide/tools/rebase-image/) to update the Oracle Home of the original image using the patched Oracle Home from a patched container image. In all three domain home source types, you edit the [Domain Resource]({{< relref "/userguide/managing-domains/domain-resource#domain-resource-attribute-references" >}}) @@ -202,7 +202,7 @@ of the WebLogic domain to update the Oracle Home of the servers. For information on server restarts, see [Restarting]({{< relref "/userguide/managing-domains/domain-lifecycle/restarting.md" >}}). ##### Model in Image -Use the WIT [`rebase`](https://github.com/oracle/weblogic-image-tool/blob/master/site/rebase-image.md) command +Use the WIT [`rebase`](https://oracle.github.io/weblogic-image-tool/userguide/tools/rebase-image/) command to update the Oracle Home for an existing image with the model and archive files in the image using the patched Oracle Home from a patched container image. Then, the operator performs a [rolling update]({{< relref "/userguide/managing-domains/domain-lifecycle/restarting#overview" >}}) of the domain, updating the Oracle Home of each server pod. @@ -221,7 +221,7 @@ $ imagetool rebase --tag mydomain:v2 --sourceImage mydomain:v1 --targetImage ora Then, edit the Domain Resource image reference with the new image name/tag (`mydomain:2`). ##### Domain in Image -Use the WIT [`rebase`](https://github.com/oracle/weblogic-image-tool/blob/master/site/rebase-image.md) command to update the Oracle Home +Use the WIT [`rebase`](https://oracle.github.io/weblogic-image-tool/userguide/tools/rebase-image/) command to update the Oracle Home for an existing domain image using the patched Oracle Home from a patched container image. Then, the operator performs a [rolling update]({{< relref "/userguide/managing-domains/domain-lifecycle/restarting#overview" >}}) of the domain, updating the Oracle Home of each server pod. diff --git a/documentation/3.2/content/userguide/cicd/tools.md b/documentation/3.2/content/userguide/cicd/tools.md index d7c357039b2..df8d6187f47 100644 --- a/documentation/3.2/content/userguide/cicd/tools.md +++ b/documentation/3.2/content/userguide/cicd/tools.md @@ -8,7 +8,7 @@ description: "Tools that are available to build CI/CD pipelines." #### WebLogic Deploy Tooling (WDT) -You can use several of the [WDT tools](https://github.com/oracle/weblogic-deploy-tooling) +You can use several of the [WDT tools](https://oracle.github.io/weblogic-deploy-tooling/) in a CI/CD pipeline. For example, the `createDomain` tool creates a new domain based on a simple model, and `updateDomain` (and `deployApps`) uses the same model concept to update @@ -30,7 +30,7 @@ that you supply a domain home. Other than the tools themselves, there are three components to the WDT tools: - *The Domain Model* - Metadata model describing the desired domain. - The metadata domain model can be written in YAML or JSON and is documented [here](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/model.md). + The metadata domain model can be written in YAML or JSON and is documented [here](https://oracle.github.io/weblogic-deploy-tooling/concepts/model/). - *The Archive ZIP* - Binaries to supplement the model. All binaries needed to supplement the model must be specified in an archive file, which is just a ZIP file with a specific directory structure. Optionally, diff --git a/documentation/3.2/content/userguide/managing-domains/model-in-image/model-files.md b/documentation/3.2/content/userguide/managing-domains/model-in-image/model-files.md index 7061cda455a..43ab8820536 100644 --- a/documentation/3.2/content/userguide/managing-domains/model-in-image/model-files.md +++ b/documentation/3.2/content/userguide/managing-domains/model-in-image/model-files.md @@ -19,9 +19,9 @@ description = "Model file requirements, macros, and loading order." #### Introduction -This document describes basic Model in Image model file syntax, naming, and macros. For additional information, see the [WebLogic Deploy Tool](https://github.com/oracle/weblogic-deploy-tooling) documentation. +This document describes basic Model in Image model file syntax, naming, and macros. For additional information, see the [WebLogic Deploy Tool](https://oracle.github.io/weblogic-deploy-tooling/) documentation. -{{% notice tip %}} The WDT [Discover Domain Tool](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/discover.md) is particularly useful for generating model files from an existing domain home. +{{% notice tip %}} The WDT [Discover Domain Tool](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/discover/) is particularly useful for generating model files from an existing domain home. {{% /notice %}} #### Sample model file @@ -68,7 +68,7 @@ For a description of model file macro references to secrets and environment vari - All password fields in a model should use a secret macro. Passwords should not be directly included in property or model files because the files may appear in logs or debugging. - - Model files encrypted with the WDT [Encrypt Model Tool](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/encrypt.md) are not supported. Use secrets instead. + - Model files encrypted with the WDT [Encrypt Model Tool](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/encrypt/)) are not supported. Use secrets instead. - You can use model macros to reference arbitrary environment variables from model files. This is useful for handling plain text mutable values that you can define using an `env` stanza in your Domain YAML file, and is also useful for accessing the built in `DOMAIN_UID` environment variable. See [Using environment variables in model files](#using-environment-variables-in-model-files). diff --git a/documentation/3.2/content/userguide/managing-domains/model-in-image/overview.md b/documentation/3.2/content/userguide/managing-domains/model-in-image/overview.md index a14ad643c64..7347531e6ff 100644 --- a/documentation/3.2/content/userguide/managing-domains/model-in-image/overview.md +++ b/documentation/3.2/content/userguide/managing-domains/model-in-image/overview.md @@ -35,7 +35,7 @@ For JRF domains, Model in Image provides additional support for initializing the #### WebLogic Deploy Tool models -WDT models are a convenient and simple alternative to WebLogic Scripting Tool (WLST) configuration scripts and templates. They compactly define a WebLogic domain using YAML files and support including application archives in a ZIP file. For a discussion of the model format and its integration with Model in Image, see [WebLogic Server image]({{< relref "/userguide/managing-domains/model-in-image/usage/_index.md#weblogic-server-image" >}}) and [Model files]({{< relref "/userguide/managing-domains/model-in-image/model-files.md" >}}). The WDT model format is fully described in the open source, [WebLogic Deploy Tool](https://github.com/oracle/weblogic-deploy-tooling) GitHub project. +WDT models are a convenient and simple alternative to WebLogic Scripting Tool (WLST) configuration scripts and templates. They compactly define a WebLogic domain using YAML files and support including application archives in a ZIP file. For a discussion of the model format and its integration with Model in Image, see [WebLogic Server image]({{< relref "/userguide/managing-domains/model-in-image/usage/_index.md#weblogic-server-image" >}}) and [Model files]({{< relref "/userguide/managing-domains/model-in-image/model-files.md" >}}). The WDT model format is fully described in the open source, [WebLogic Deploy Tool](https://oracle.github.io/weblogic-deploy-tooling/) GitHub project. #### Runtime behavior @@ -69,8 +69,8 @@ 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" >}}) - - [WebLogic Deploy Tool (WDT)](https://github.com/oracle/weblogic-deploy-tooling) - - [WebLogic Image Tool (WIT)](https://github.com/oracle/weblogic-image-tool) + - [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" >}}) - [CI/CD considerations]({{< relref "/userguide/cicd/_index.md" >}}) diff --git a/documentation/3.2/content/userguide/managing-domains/model-in-image/runtime-updates.md b/documentation/3.2/content/userguide/managing-domains/model-in-image/runtime-updates.md index d0c86295bcc..d34db20f79d 100644 --- a/documentation/3.2/content/userguide/managing-domains/model-in-image/runtime-updates.md +++ b/documentation/3.2/content/userguide/managing-domains/model-in-image/runtime-updates.md @@ -101,7 +101,7 @@ documented as [unsupported](#unsupported-updates) below: MaxCapacity: 5 ``` - For more information, see [Using Multiple Models](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/model.md#using-multiple-models) in the WebLogic Deploy Tooling documentation. + For more information, see [Using Multiple Models](https://oracle.github.io/weblogic-deploy-tooling/concepts/model/#using-multiple-models) in the WebLogic Deploy Tooling documentation. - You can change or add secrets that your model macros reference (macros that use the `@@SECRET:secretname:secretkey@@` syntax). @@ -130,7 +130,7 @@ documented as [unsupported](#unsupported-updates) below: There are [some exceptions for online updates](#online-update-handling-of-deletes). For more information, see - [Declaring Named MBeans to Delete](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/model.md#declaring-named-mbeans-to-delete) + [Declaring Named MBeans to Delete](https://oracle.github.io/weblogic-deploy-tooling/concepts/model/#declaring-named-mbeans-to-delete) in the WebLogic Deploying Tooling documentation. #### Unsupported updates @@ -201,13 +201,13 @@ and a description of workarounds and alternatives when applicable: `spec.logHomeEnabled`, or `spec.httpAccessLogInLogHome` attributes. - Embedded LDAP security entries for - [users, groups, roles](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/use_cases.md#modeling-weblogic-users-groups-and-roles), - and [credential mappings](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/use_cases.md#modeling-weblogic-user-password-credential-mapping). + [users, groups, roles](https://oracle.github.io/weblogic-deploy-tooling/samples/usersgroups-model/), + and [credential mappings](https://oracle.github.io/weblogic-deploy-tooling/samples/pwcredentialmap-model/). For example, you cannot add a user to the default security realm. Online update attempts in this area will fail during the introspector job, and offline update attempts may result in inconsistent security checks during the offline update's rolling cycle. If you need to make these kinds of updates, then shut down your domain entirely before making the change, - or switch to an [external security provider](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/use_cases.md#modeling-security-providers). + or switch to an [external security provider](https://oracle.github.io/weblogic-deploy-tooling/samples/securityproviders-model/). - Any Model YAML `topology:` stanza changes, for example, `ConsoleEnabled`, `RootDirectory`, `AdminServerName`, and such. @@ -272,7 +272,7 @@ plus an offline update if there are any accompanying model changes. Model updates can include additions, changes, and deletions. For help generating model changes: - For a discussion of model file syntax, see the - [WebLogic Deploy Tool](https://github.com/oracle/weblogic-deploy-tooling) documentation + [WebLogic Deploy Tool](https://oracle.github.io/weblogic-deploy-tooling/) documentation and Model in Image [Model files]({{< relref "/userguide/managing-domains/model-in-image/model-files.md" >}}) documentation. - For a discussion about helper tooling that you can use to generate model change YAML, @@ -804,9 +804,9 @@ in the Model in Image sample. Optionally, you can use the WDT Discover Domain and Compare Domain Tools to help generate your model file updates. The WebLogic Deploy Tooling -[Discover Domain Tool](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/discover.md) +[Discover Domain Tool](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/discover/) generates model files from an existing domain home, -and its [Compare Model Tool](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/compare.md) +and its [Compare Model Tool](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/compare/) compares two domain models and generates the YAML file for updating the first domain to the second domain. For example, assuming you've installed WDT in `/u01/wdt/weblogic-deploy` and assuming your domain type is `WLS`: diff --git a/documentation/3.2/content/userguide/managing-domains/model-in-image/usage.md b/documentation/3.2/content/userguide/managing-domains/model-in-image/usage.md index 00043d9328a..96cbf837b3e 100644 --- a/documentation/3.2/content/userguide/managing-domains/model-in-image/usage.md +++ b/documentation/3.2/content/userguide/managing-domains/model-in-image/usage.md @@ -53,7 +53,7 @@ There are three methods for layering Model in Image artifacts on top of a base i - Manual Image Creation: Use Docker commands to layer the WDT artifacts from the above table on top of your base image into a new image. - - WebLogic Image Tool: Use the [WebLogic Image Tool](https://github.com/oracle/weblogic-image-tool). 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. + - WebLogic Image Tool: Use the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/). 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. - Persistent Volume Claim: This method is for advanced use cases only. Supply WDT model YAML, variable, or archive files in a [Persistent Volume Claim]({{< relref "/faq/volumes.md" >}}) and modify `configuration.model.modelHome` to the corresponding directory within the PVC's mount location. This method does not address the requirement to include unzipped WDT install binaries in the `/u01/wdt/weblogic-deploy` directory (use either of the previous two methods). @@ -123,7 +123,7 @@ The following Domain fields are specific to Model in Image domains. | `configuration.model.configMap` | Optional. Set if you have stored additional models in a ConfigMap as per [Optional WDT model ConfigMap](#optional-wdt-model-configmap). | | `configuration.secrets` | Optional. Set this array if your image or ConfigMap models contain macros that reference custom Kubernetes Secrets. For example, if your macros depend on secrets `my-secret` and `my-other-secret`, then set to `[my-secret, my-other-secret]`.| | `configuration.model.runtimeEncryptionSecret`| Required. All Model in Image domains must specify a runtime encryption secret. See [Required runtime encryption secret](#required-runtime-encryption-secret). | -| `configuration.model.domainType` | Set the type of domain. Valid values are `WLS`, `JRF`, and `RestrictedJRF`, where `WLS` is the default. See [WDT Domain Types](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/tool_configuration.md#domain-type-definitions).| +| `configuration.model.domainType` | Set the type of domain. Valid values are `WLS`, `JRF`, and `RestrictedJRF`, where `WLS` is the default. See [WDT Domain Types](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools-config/domain_def/).| | `configuration.model.runtimeEncryptionSecret`| Required. All Model in Image domains must specify a runtime encryption secret. See [Required runtime encryption secret](#required-runtime-encryption-secret). | | `configuration.model.modelHome` | Optional. Location of the WDT model home, which can include model YAML files, `.properties` files, and application `.zip` archives. Defaults to `/u01/wdt/models`.| @@ -251,4 +251,4 @@ Follow these steps to ensure that a JRF domain can continue to access its RCU da 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. -See also, [Specifying RCU connection information in the model](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/rcuinfo.md) in the WDT documentation. +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/_index.md b/documentation/staging/content/_index.md index 3f29301590b..d9ca26a7229 100644 --- a/documentation/staging/content/_index.md +++ b/documentation/staging/content/_index.md @@ -11,7 +11,7 @@ You can: * Supply WebLogic domain configuration using: * _Domain in PV_: Locates WebLogic domain homes in a Kubernetes PersistentVolume (PV). This PV can reside in an NFS file system or other Kubernetes volume types. * _Domain in Image_: Includes a WebLogic domain home in a container image. - * _Model in Image_: Includes [WebLogic Deploy Tooling](https://github.com/oracle/weblogic-deploy-tooling) models and archives in a container image. + * _Model in Image_: Includes [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) models and archives in a container image. * Configure deployment of WebLogic domains as a Kubernetes resource (using a Kubernetes custom resource definition). * Override certain aspects of the WebLogic domain configuration; for example, use a different database password for different deployments. * Start and stop servers and clusters in the domain based on declarative startup parameters and desired states. diff --git a/documentation/staging/content/faq/newbie.md b/documentation/staging/content/faq/newbie.md index a49db27ad21..c27daf543ca 100644 --- a/documentation/staging/content/faq/newbie.md +++ b/documentation/staging/content/faq/newbie.md @@ -36,7 +36,7 @@ When using the operator, each deployed domain is specified by a domain resource 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://github.com/oracle/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/simple/_index.md" >}}) show how to create domains using WLST and using WDT. **Q:** Is the Administration Server required? Node Manager? diff --git a/documentation/staging/content/samples/simple/azure-kubernetes-service/model-in-image.md b/documentation/staging/content/samples/simple/azure-kubernetes-service/model-in-image.md index 4b5e5b366b2..758d9bdb064 100644 --- a/documentation/staging/content/samples/simple/azure-kubernetes-service/model-in-image.md +++ b/documentation/staging/content/samples/simple/azure-kubernetes-service/model-in-image.md @@ -202,7 +202,7 @@ The sample includes a predefined archive directory in `/tmp/mii-sample/archives/ The archive top directory, named `wlsdeploy`, contains a directory named `applications`, which includes an ‘exploded’ sample JSP web application in the directory, `myapp-v1`. Three useful aspects to remember about WDT archives are: - A model image can contain multiple WDT archives. - WDT archives can contain multiple applications, libraries, and other components. - - WDT archives have a [well defined directory structure](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/archive.md), which always has `wlsdeploy` as the top directory. + - WDT archives have a [well defined directory structure](https://oracle.github.io/weblogic-deploy-tooling/concepts/archive/), which always has `wlsdeploy` as the top directory. The application displays important details about the WebLogic Server instance that it’s running on: namely its domain name, cluster name, and server name, as well as the names of any data sources that are targeted to the server. diff --git a/documentation/staging/content/samples/simple/domains/model-in-image/_index.md b/documentation/staging/content/samples/simple/domains/model-in-image/_index.md index 80d87195f9a..d4afccb4d19 100644 --- a/documentation/staging/content/samples/simple/domains/model-in-image/_index.md +++ b/documentation/staging/content/samples/simple/domains/model-in-image/_index.md @@ -30,7 +30,7 @@ description: "Sample for supplying a WebLogic Deploy Tooling (WDT) model that th This sample demonstrates deploying a Model in Image [domain home source type]({{< relref "/userguide/managing-domains/choosing-a-model/_index.md" >}}). Unlike Domain in PV and Domain in Image, Model in Image eliminates the need to pre-create your WebLogic domain home prior to deploying your Domain YAML file. Instead, Model in Image uses a WebLogic Deploy Tooling (WDT) model to specify your WebLogic configuration. -WDT models are a convenient and simple alternative to WebLogic Scripting Tool (WLST) configuration scripts and templates. They compactly define a WebLogic domain using YAML files and support including application archives in a ZIP file. The WDT model format is described in the open source, [WebLogic Deploy Tooling](https://github.com/oracle/weblogic-deploy-tooling) GitHub project, and the required directory structure for a WDT archive is specifically discussed [here](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/archive.md). +WDT models are a convenient and simple alternative to WebLogic Scripting Tool (WLST) configuration scripts and templates. They compactly define a WebLogic domain using YAML files and support including application archives in a ZIP file. The WDT model format is described in the open source, [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) GitHub project, and the required directory structure for a WDT archive is specifically discussed [here](https://oracle.github.io/weblogic-deploy-tooling/concepts/archive/). For more information on Model in Image, see the [Model in Image user guide]({{< relref "/userguide/managing-domains/model-in-image/_index.md" >}}). For a comparison of Model in Image to other domain home source types, see [Choose a domain home source type]({{< relref "/userguide/managing-domains/choosing-a-model/_index.md" >}}). @@ -146,5 +146,5 @@ For more information, see the [Cannot pull image FAQ]({{}}) user documentation - - [WebLogic Deploy Tooling](https://github.com/oracle/weblogic-deploy-tooling) - - [WebLogic Image Tool](https://github.com/oracle/weblogic-image-tool) + - [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) + - [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) diff --git a/documentation/staging/content/samples/simple/domains/model-in-image/initial.md b/documentation/staging/content/samples/simple/domains/model-in-image/initial.md index 13552741a9d..9d6eb3f70a0 100644 --- a/documentation/staging/content/samples/simple/domains/model-in-image/initial.md +++ b/documentation/staging/content/samples/simple/domains/model-in-image/initial.md @@ -55,7 +55,7 @@ The sample includes a predefined archive directory in `/tmp/mii-sample/archives/ The archive top directory, named `wlsdeploy`, contains a directory named `applications`, which includes an 'exploded' sample JSP web application in the directory, `myapp-v1`. Three useful aspects to remember about WDT archives are: - A model image can contain multiple WDT archives. - WDT archives can contain multiple applications, libraries, and other components. - - WDT archives have a [well defined directory structure](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/archive.md), which always has `wlsdeploy` as the top directory. + - WDT archives have a [well defined directory structure](https://oracle.github.io/weblogic-deploy-tooling/concepts/archive/), which always has `wlsdeploy` as the top directory. {{%expand "If you are interested in the web application source, click here to see the JSP code." %}} diff --git a/documentation/staging/content/samples/simple/domains/model-in-image/prerequisites.md b/documentation/staging/content/samples/simple/domains/model-in-image/prerequisites.md index f07bb5aab8a..991d91d1633 100644 --- a/documentation/staging/content/samples/simple/domains/model-in-image/prerequisites.md +++ b/documentation/staging/content/samples/simple/domains/model-in-image/prerequisites.md @@ -141,7 +141,7 @@ weight: 1 If you prefer, you can create your own base image and then substitute this image name in the WebLogic Image Tool `--fromImage` parameter throughout this sample. For example, you may wish to start with a base image that has patches applied. See [Preparing a Base Image]({{< relref "/userguide/base-images/_index.md" >}}). {{% /notice %}} -1. Download the latest [WebLogic Deploy Tooling](https://github.com/oracle/weblogic-deploy-tooling) (WDT) and [WebLogic Image Tool](https://github.com/oracle/weblogic-image-tool) (WIT) installer ZIP files to your `/tmp/mii-sample/model-images` directory. Both WDT and WIT are required to create your Model in Image container images. +1. Download the latest [WebLogic Deploy Tooling](https://github.com/oracle/weblogic-deploy-tooling/releases) (WDT) and [WebLogic Image Tool](https://github.com/oracle/weblogic-image-tool/releases) (WIT) installer ZIP files to your `/tmp/mii-sample/model-images` directory. Both WDT and WIT are required to create your Model in Image container images. ```shell $ cd /tmp/mii-sample/model-images @@ -180,7 +180,7 @@ weight: 1 has a version of WDT in its `--type wdt --version latest` location, then the `cache addInstaller` command would fail. For more information about the WIT cache, see the - [WIT Cache documentation](https://github.com/oracle/weblogic-image-tool/blob/master/site/cache.md). + [WIT Cache documentation](https://oracle.github.io/weblogic-image-tool/userguide/tools/cache/). These steps will install WIT to the `/tmp/mii-sample/model-images/imagetool` directory, plus put a `wdt_latest` entry in the tool's cache which points to the WDT ZIP file installer. diff --git a/documentation/staging/content/samples/simple/tanzu-kubernetes-service/_index.md b/documentation/staging/content/samples/simple/tanzu-kubernetes-service/_index.md index e6f9187525f..cbeec61c563 100644 --- a/documentation/staging/content/samples/simple/tanzu-kubernetes-service/_index.md +++ b/documentation/staging/content/samples/simple/tanzu-kubernetes-service/_index.md @@ -215,7 +215,7 @@ The sample includes a predefined archive directory in `/tmp/mii-sample/archives/ The archive top directory, named `wlsdeploy`, contains a directory named `applications`, which includes an ‘exploded’ sample JSP web application in the directory, `myapp-v1`. Three useful aspects to remember about WDT archives are: - A model image can contain multiple WDT archives. - WDT archives can contain multiple applications, libraries, and other components. - - WDT archives have a [well defined directory structure](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/archive.md), which always has `wlsdeploy` as the top directory. + - WDT archives have a [well defined directory structure](https://oracle.github.io/weblogic-deploy-tooling/concepts/archive/), which always has `wlsdeploy` as the top directory. The application displays important details about the WebLogic Server instance that it’s running on: namely its domain name, cluster name, and server name, as well as the names of any data sources that are targeted to the server. diff --git a/documentation/staging/content/userguide/base-images/_index.md b/documentation/staging/content/userguide/base-images/_index.md index 9ffd8bedd4a..0c86cae1505 100644 --- a/documentation/staging/content/userguide/base-images/_index.md +++ b/documentation/staging/content/userguide/base-images/_index.md @@ -92,14 +92,14 @@ Additional information about using this image is available in the Oracle Contain The WebLogic Kubernetes Operator and WebLogic Server 12.2.1.3.0 image requires patch 29135930. This patch has some prerequisite patches that will also need to be applied. The WebLogic Server 12.2.1.4.0 image does not require any patches. To create and customize the WebLogic Server image, -and apply the required patches, use the [WebLogic Image Tool](https://github.com/oracle/weblogic-image-tool). +and apply the required patches, use the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/). -To use the Image Tool, follow the [Setup](https://github.com/oracle/weblogic-image-tool/blob/master/README.md#setup) instructions -and [Quick Start](https://github.com/oracle/weblogic-image-tool/blob/master/site/quickstart.md) Guide. +To use the Image Tool, follow the [Setup](https://oracle.github.io/weblogic-image-tool/quickstart/setup/) instructions +and [Quick Start](https://oracle.github.io/weblogic-image-tool/quickstart/quickstart/) Guide. To build the WebLogic Server image and apply the patches: -1. Add the Server JRE and the WebLogic Server installer to the [`cache` command](https://github.com/oracle/weblogic-image-tool/blob/master/site/cache.md). +1. Add the Server JRE and the WebLogic Server installer to the [`cache` command](https://oracle.github.io/weblogic-image-tool/userguide/tools/cache/). ```shell $ imagetool cache addInstaller \ @@ -113,7 +113,7 @@ To build the WebLogic Server image and apply the patches: --version=12.2.1.4.0 \ --path=/home/acmeuser/wls-installers/fmw_12.2.1.4.0_wls_Disk1_1of1.zip ``` -2. Use the [Create Tool](https://github.com/oracle/weblogic-image-tool/blob/master/site/create-image.md) +2. Use the [Create Tool](https://oracle.github.io/weblogic-image-tool/userguide/tools/create-image/) to build the image and apply the patches. For the Create Tool to download the patches, you must supply your My Oracle Support credentials. @@ -140,7 +140,7 @@ You can also create an image with the WebLogic domain inside the image. are provided that demonstrate how to create the image using either: * WLST to define the domain, or -* [WebLogic Deploy Tooling](https://github.com/oracle/weblogic-deploy-tooling) to define the domain. +* [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) to define the domain. In these samples, you will see a reference to a "base" or `FROM` image. You should use an image with the mandatory patches installed as this base image. This image could be either @@ -157,14 +157,14 @@ including keys and credentials that are used to access external resources #### Patch WebLogic Server images -Use the [WebLogic Image Tool](https://github.com/oracle/weblogic-image-tool) (WIT) to patch +Use the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) (WIT) to patch WebLogic Server images with quarterly Patch Set Updates (PSUs), which include security fixes, or with one-off patches. -Use either the WIT [`create`](https://github.com/oracle/weblogic-image-tool/blob/master/site/create-image.md) or -[`update`](https://github.com/oracle/weblogic-image-tool/blob/master/site/update-image.md) command, however, +Use either the WIT [`create`](https://oracle.github.io/weblogic-image-tool/userguide/tools/create-image/) or +[`update`](https://oracle.github.io/weblogic-image-tool/userguide/tools/update-image/) command, however, patching using the `create` command results in a smaller WebLogic Server image size. Note that you will need to download the WebLogic Server 12.2.1.4.0 installer and JDK installer prior to running the `create` command. For details, see -the WIT [Quick Start](https://github.com/oracle/weblogic-image-tool/blob/master/site/quickstart.md) guide. +the WIT [Quick Start](https://oracle.github.io/weblogic-image-tool/quickstart/quickstart/) guide. Example: Create an image named `sample:wls` with the WebLogic Server 12.2.1.4.0 slim installer, JDK 8u291, a slim version of the Oracle Linux 7 container image, and latest PSU and recommended CPU and SPU patches applied. @@ -181,12 +181,12 @@ to update the running domain differs depending on the [domain home source type]( difference between the domain home source types is the location of the domain home: * Domain in PV: The container image contains the JDK and WebLogic Server binaries. The domain home is located in a Persistent Volume (PV). -* Model in Image: The container image contains the JDK, WebLogic Server binaries, and a [WebLogic Deployment Tooling](https://github.com/oracle/weblogic-deploy-tooling) (WDT) installation, WDT model file, and application archive file. +* Model in Image: The container image contains the JDK, WebLogic Server binaries, and a [WebLogic Deployment Tooling](https://oracle.github.io/weblogic-deploy-tooling/) (WDT) installation, WDT model file, and application archive file. * Domain in Image: The container image contains the JDK, WebLogic Server binaries, and domain home. For Domain in PV, the operator can apply the update to the running domain without modifying the patched container image. For Model in Image (MII) and Domain in Image, before the operator can apply the update, the patched container images must be modified to add the domain home or a -WDT model and archive. You use WebLogic Image Tool (WIT) [Rebase Image](https://github.com/oracle/weblogic-image-tool/blob/master/site/rebase-image.md) +WDT model and archive. You use WebLogic Image Tool (WIT) [Rebase Image](https://oracle.github.io/weblogic-image-tool/userguide/tools/rebase-image/) to update the Oracle Home of the original image using the patched Oracle Home from a patched container image. In all three domain home source types, you edit the [Domain Resource]({{< relref "/userguide/managing-domains/domain-resource#domain-resource-attribute-references" >}}) @@ -202,7 +202,7 @@ of the WebLogic domain to update the Oracle Home of the servers. For information on server restarts, see [Restarting]({{< relref "/userguide/managing-domains/domain-lifecycle/restarting.md" >}}). ##### Model in Image -Use the WIT [`rebase`](https://github.com/oracle/weblogic-image-tool/blob/master/site/rebase-image.md) command +Use the WIT [`rebase`](https://oracle.github.io/weblogic-image-tool/userguide/tools/rebase-image/) command to update the Oracle Home for an existing image with the model and archive files in the image using the patched Oracle Home from a patched container image. Then, the operator performs a [rolling update]({{< relref "/userguide/managing-domains/domain-lifecycle/restarting#overview" >}}) of the domain, updating the Oracle Home of each server pod. @@ -221,7 +221,7 @@ $ imagetool rebase --tag mydomain:v2 --sourceImage mydomain:v1 --targetImage ora Then, edit the Domain Resource image reference with the new image name/tag (`mydomain:2`). ##### Domain in Image -Use the WIT [`rebase`](https://github.com/oracle/weblogic-image-tool/blob/master/site/rebase-image.md) command to update the Oracle Home +Use the WIT [`rebase`](https://oracle.github.io/weblogic-image-tool/userguide/tools/rebase-image/) command to update the Oracle Home for an existing domain image using the patched Oracle Home from a patched container image. Then, the operator performs a [rolling update]({{< relref "/userguide/managing-domains/domain-lifecycle/restarting#overview" >}}) of the domain, updating the Oracle Home of each server pod. diff --git a/documentation/staging/content/userguide/cicd/tools.md b/documentation/staging/content/userguide/cicd/tools.md index 67b4225d9b2..c24da983249 100644 --- a/documentation/staging/content/userguide/cicd/tools.md +++ b/documentation/staging/content/userguide/cicd/tools.md @@ -8,7 +8,7 @@ description: "Tools that are available to build CI/CD pipelines." #### WebLogic Deploy Tooling (WDT) -You can use several of the [WDT tools](https://github.com/oracle/weblogic-deploy-tooling) +You can use several of the [WDT tools](https://oracle.github.io/weblogic-deploy-tooling/) in a CI/CD pipeline. For example, the `createDomain` tool creates a new domain based on a simple model, and `updateDomain` (and `deployApps`) uses the same model concept to update @@ -30,7 +30,7 @@ that you supply a domain home. Other than the tools themselves, there are three components to the WDT tools: - *The Domain Model* - Metadata model describing the desired domain. - The metadata domain model can be written in YAML or JSON and is documented [here](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/model.md). + The metadata domain model can be written in YAML or JSON and is documented [here](https://oracle.github.io/weblogic-deploy-tooling/concepts/model/). - *The Archive ZIP* - Binaries to supplement the model. All binaries needed to supplement the model must be specified in an archive file, which is just a ZIP file with a specific directory structure. Optionally, diff --git a/documentation/staging/content/userguide/managing-domains/model-in-image/model-files.md b/documentation/staging/content/userguide/managing-domains/model-in-image/model-files.md index 7061cda455a..ce4a7e28de7 100644 --- a/documentation/staging/content/userguide/managing-domains/model-in-image/model-files.md +++ b/documentation/staging/content/userguide/managing-domains/model-in-image/model-files.md @@ -19,9 +19,9 @@ description = "Model file requirements, macros, and loading order." #### Introduction -This document describes basic Model in Image model file syntax, naming, and macros. For additional information, see the [WebLogic Deploy Tool](https://github.com/oracle/weblogic-deploy-tooling) documentation. +This document describes basic Model in Image model file syntax, naming, and macros. For additional information, see the [WebLogic Deploy Tool](https://oracle.github.io/weblogic-deploy-tooling/) documentation. -{{% notice tip %}} The WDT [Discover Domain Tool](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/discover.md) is particularly useful for generating model files from an existing domain home. +{{% notice tip %}} The WDT [Discover Domain Tool](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/discover/) is particularly useful for generating model files from an existing domain home. {{% /notice %}} #### Sample model file @@ -68,7 +68,7 @@ For a description of model file macro references to secrets and environment vari - All password fields in a model should use a secret macro. Passwords should not be directly included in property or model files because the files may appear in logs or debugging. - - Model files encrypted with the WDT [Encrypt Model Tool](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/encrypt.md) are not supported. Use secrets instead. + - Model files encrypted with the WDT [Encrypt Model Tool](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/encrypt/) are not supported. Use secrets instead. - You can use model macros to reference arbitrary environment variables from model files. This is useful for handling plain text mutable values that you can define using an `env` stanza in your Domain YAML file, and is also useful for accessing the built in `DOMAIN_UID` environment variable. See [Using environment variables in model files](#using-environment-variables-in-model-files). 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 a14ad643c64..7347531e6ff 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 @@ -35,7 +35,7 @@ For JRF domains, Model in Image provides additional support for initializing the #### WebLogic Deploy Tool models -WDT models are a convenient and simple alternative to WebLogic Scripting Tool (WLST) configuration scripts and templates. They compactly define a WebLogic domain using YAML files and support including application archives in a ZIP file. For a discussion of the model format and its integration with Model in Image, see [WebLogic Server image]({{< relref "/userguide/managing-domains/model-in-image/usage/_index.md#weblogic-server-image" >}}) and [Model files]({{< relref "/userguide/managing-domains/model-in-image/model-files.md" >}}). The WDT model format is fully described in the open source, [WebLogic Deploy Tool](https://github.com/oracle/weblogic-deploy-tooling) GitHub project. +WDT models are a convenient and simple alternative to WebLogic Scripting Tool (WLST) configuration scripts and templates. They compactly define a WebLogic domain using YAML files and support including application archives in a ZIP file. For a discussion of the model format and its integration with Model in Image, see [WebLogic Server image]({{< relref "/userguide/managing-domains/model-in-image/usage/_index.md#weblogic-server-image" >}}) and [Model files]({{< relref "/userguide/managing-domains/model-in-image/model-files.md" >}}). The WDT model format is fully described in the open source, [WebLogic Deploy Tool](https://oracle.github.io/weblogic-deploy-tooling/) GitHub project. #### Runtime behavior @@ -69,8 +69,8 @@ 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" >}}) - - [WebLogic Deploy Tool (WDT)](https://github.com/oracle/weblogic-deploy-tooling) - - [WebLogic Image Tool (WIT)](https://github.com/oracle/weblogic-image-tool) + - [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" >}}) - [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 88c70e7dc88..d2c16764be0 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 @@ -101,7 +101,7 @@ documented as [unsupported](#unsupported-updates) below: MaxCapacity: 5 ``` - For more information, see [Using Multiple Models](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/model.md#using-multiple-models) in the WebLogic Deploy Tooling documentation. + For more information, see [Using Multiple Models](https://oracle.github.io/weblogic-deploy-tooling/concepts/model/#using-multiple-models) in the WebLogic Deploy Tooling documentation. - You can change or add secrets that your model macros reference (macros that use the `@@SECRET:secretname:secretkey@@` syntax). @@ -130,7 +130,7 @@ documented as [unsupported](#unsupported-updates) below: There are [some exceptions for online updates](#online-update-handling-of-deletes). For more information, see - [Declaring Named MBeans to Delete](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/model.md#declaring-named-mbeans-to-delete) + [Declaring Named MBeans to Delete](https://oracle.github.io/weblogic-deploy-tooling/concepts/model/#declaring-named-mbeans-to-delete) in the WebLogic Deploying Tooling documentation. #### Unsupported updates @@ -201,13 +201,13 @@ and a description of workarounds and alternatives when applicable: `spec.logHomeEnabled`, or `spec.httpAccessLogInLogHome` attributes. - Embedded LDAP security entries for - [users, groups, roles](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/use_cases.md#modeling-weblogic-users-groups-and-roles), - and [credential mappings](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/use_cases.md#modeling-weblogic-user-password-credential-mapping). + [users, groups, roles](https://oracle.github.io/weblogic-deploy-tooling/samples/usersgroups-model/), + and [credential mappings](https://oracle.github.io/weblogic-deploy-tooling/samples/pwcredentialmap-model/). For example, you cannot add a user to the default security realm. Online update attempts in this area will fail during the introspector job, and offline update attempts may result in inconsistent security checks during the offline update's rolling cycle. If you need to make these kinds of updates, then shut down your domain entirely before making the change, - or switch to an [external security provider](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/use_cases.md#modeling-security-providers). + or switch to an [external security provider](https://oracle.github.io/weblogic-deploy-tooling/samples/securityproviders-model/). - Any Model YAML `topology:` stanza changes, for example, `ConsoleEnabled`, `RootDirectory`, `AdminServerName`, and such. @@ -272,7 +272,7 @@ plus an offline update if there are any accompanying model changes. Model updates can include additions, changes, and deletions. For help generating model changes: - For a discussion of model file syntax, see the - [WebLogic Deploy Tool](https://github.com/oracle/weblogic-deploy-tooling) documentation + [WebLogic Deploy Tool](https://oracle.github.io/weblogic-deploy-tooling/) documentation and Model in Image [Model files]({{< relref "/userguide/managing-domains/model-in-image/model-files.md" >}}) documentation. - For a discussion about helper tooling that you can use to generate model change YAML, @@ -804,9 +804,9 @@ in the Model in Image sample. Optionally, you can use the WDT Discover Domain and Compare Domain Tools to help generate your model file updates. The WebLogic Deploy Tooling -[Discover Domain Tool](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/discover.md) +[Discover Domain Tool](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/discover/) generates model files from an existing domain home, -and its [Compare Model Tool](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/compare.md) +and its [Compare Model Tool](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools/compare/) compares two domain models and generates the YAML file for updating the first domain to the second domain. For example, assuming you've installed WDT in `/u01/wdt/weblogic-deploy` and assuming your domain type is `WLS`: 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 1139734b033..e22abf1c5c5 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 @@ -53,7 +53,7 @@ There are three methods for layering Model in Image artifacts on top of a base i - Manual Image Creation: Use Docker commands to layer the WDT artifacts from the above table on top of your base image into a new image. - - WebLogic Image Tool: Use the [WebLogic Image Tool](https://github.com/oracle/weblogic-image-tool). 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. + - WebLogic Image Tool: Use the [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/). 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. - Persistent Volume Claim: This method is for advanced use cases only. Supply WDT model YAML, variable, or archive files in a [Persistent Volume Claim]({{< relref "/faq/volumes.md" >}}) and modify `configuration.model.modelHome` to the corresponding directory within the PVC's mount location. This method does not address the requirement to include unzipped WDT install binaries in the `/u01/wdt/weblogic-deploy` directory (use either of the previous two methods). @@ -123,7 +123,7 @@ The following Domain fields are specific to Model in Image domains. | `configuration.model.configMap` | Optional. Set if you have stored additional models in a ConfigMap as per [Optional WDT model ConfigMap](#optional-wdt-model-configmap). | | `configuration.secrets` | Optional. Set this array if your image or ConfigMap models contain macros that reference custom Kubernetes Secrets. For example, if your macros depend on secrets `my-secret` and `my-other-secret`, then set to `[my-secret, my-other-secret]`.| | `configuration.model.runtimeEncryptionSecret`| Required. All Model in Image domains must specify a runtime encryption secret. See [Required runtime encryption secret](#required-runtime-encryption-secret). | -| `configuration.model.domainType` | Set the type of domain. Valid values are `WLS`, `JRF`, and `RestrictedJRF`, where `WLS` is the default. See [WDT Domain Types](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/tool_configuration.md#domain-type-definitions).| +| `configuration.model.domainType` | Set the type of domain. Valid values are `WLS`, `JRF`, and `RestrictedJRF`, where `WLS` is the default. See [WDT Domain Types](https://oracle.github.io/weblogic-deploy-tooling/userguide/tools-config/domain_def/).| | `configuration.model.runtimeEncryptionSecret`| Required. All Model in Image domains must specify a runtime encryption secret. See [Required runtime encryption secret](#required-runtime-encryption-secret). | | `configuration.model.modelHome` | Optional. Location of the WDT model home, which can include model YAML files, `.properties` files, and application `.zip` archives. Defaults to `/u01/wdt/models`.| @@ -251,4 +251,4 @@ Follow these steps to ensure that a JRF domain can continue to access its RCU da 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. -See also, [Specifying RCU connection information in the model](https://github.com/oracle/weblogic-deploy-tooling/blob/master/site/rcuinfo.md) in the WDT documentation. +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.