Skip to content

Commit 7ca9213

Browse files
authored
Oracle IDM Suite and OHS 12.2.1.4.0 documentation for release 24.4.1 (#228)
1 parent fd8b9fd commit 7ca9213

File tree

622 files changed

+606194
-260
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

622 files changed

+606194
-260
lines changed

docs-source/content/idm-products/oam/configure-ingress/_index.md

Lines changed: 360 additions & 145 deletions
Large diffs are not rendered by default.

docs-source/content/idm-products/oam/create-oam-domains/create-oam-domains-using-wdt-models.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ In this section you generate the required WDT models for the OAM domain, along w
313313
```
314314
domainUID: accessdomain
315315
domainHome: /u01/oracle/user_projects/domains/accessdomain
316-
image: container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<July'24>
316+
image: container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<October'24>
317317
imagePullSecretName: orclcred
318318
logHome: /u01/oracle/user_projects/domains/logs/accessdomain
319319
namespace: oamns
@@ -389,7 +389,7 @@ In this section you generate the required WDT models for the OAM domain, along w
389389
export datasourceType="generic"
390390
export edgInstall="false"
391391
export domainHome="/u01/oracle/user_projects/domains/accessdomain"
392-
export image="container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<July'24>"
392+
export image="container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<October'24>"
393393
export imagePullSecretName="orclcred"
394394
export logHome="/u01/oracle/user_projects/domains/logs/accessdomain"
395395
export exposeAdminT3Channel="false"
@@ -753,7 +753,7 @@ In this section you modify the `domain.yaml` file in preparation for creating th
753753
domainHomeSourceType: PersistentVolume
754754
755755
# The WebLogic Server image that the Operator uses to start the domain
756-
image: "container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<July'24>"
756+
image: "container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<October'24>"
757757
758758
# imagePullPolicy defaults to "Always" if image version is :latest
759759
imagePullPolicy: IfNotPresent
@@ -791,7 +791,7 @@ In this section you modify the `domain.yaml` file in preparation for creating th
791791
domainHomeSourceType: PersistentVolume
792792
793793
# The WebLogic Server image that the Operator uses to start the domain
794-
image: "container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<July'24>"
794+
image: "container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<October'24>"
795795
796796
# imagePullPolicy defaults to "Always" if image version is :latest
797797
imagePullPolicy: IfNotPresent
@@ -833,7 +833,7 @@ In this section you modify the `domain.yaml` file in preparation for creating th
833833
#DO NOT CHANGE THE NAME OF THIS INIT CONTAINER
834834
- name: compat-connector-init
835835
# OAM Product image, same as spec.image mentioned above
836-
image: "container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<July'24>"
836+
image: "container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<October'24>"
837837
imagePullPolicy: IfNotPresent
838838
command: [ "/bin/bash", "-c", "mkdir -p /u01/oracle/user_projects/domains/wdt-logs"]
839839
volumeMounts:
@@ -1283,7 +1283,7 @@ In this section you deploy the OAM domain using the `domain.yaml`.
12831283
Failure Retry Interval Seconds: 120
12841284
Failure Retry Limit Minutes: 1440
12851285
Http Access Log In Log Home: true
1286-
Image: container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<July'24>
1286+
Image: container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<October'24>
12871287
Image Pull Policy: IfNotPresent
12881288
Image Pull Secrets:
12891289
Name: orclcred
@@ -1308,7 +1308,7 @@ In this section you deploy the OAM domain using the `domain.yaml`.
13081308
/bin/bash
13091309
-c
13101310
mkdir -p /u01/oracle/user_projects/domains/wdt-logs
1311-
Image: container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<July'24>
1311+
Image: container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<October'24>
13121312
Image Pull Policy: IfNotPresent
13131313
Name: compat-connector-init
13141314
Volume Mounts:

docs-source/content/idm-products/oam/create-oam-domains/create-oam-domains-using-wlst.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ The sample scripts for Oracle Access Management domain deployment are available
6565
```bash
6666
domainUID: accessdomain
6767
domainHome: /u01/oracle/user_projects/domains/accessdomain
68-
image: container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<July'24>
68+
image: container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<October'24>
6969
imagePullSecretName: orclcred
7070
weblogicCredentialsSecretName: accessdomain-credentials
7171
logHome: /u01/oracle/user_projects/domains/logs/accessdomain
@@ -164,7 +164,7 @@ generated artifacts:
164164
export initialManagedServerReplicas="2"
165165
export managedServerNameBase="oam_server"
166166
export managedServerPort="14100"
167-
export image="container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<July'24>"
167+
export image="container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<October'24>"
168168
export imagePullPolicy="IfNotPresent"
169169
export imagePullSecretName="orclcred"
170170
export productionModeEnabled="true"
@@ -552,7 +552,7 @@ By default, the java memory parameters assigned to the oam_server cluster are ve
552552
Failure Retry Interval Seconds: 120
553553
Failure Retry Limit Minutes: 1440
554554
Http Access Log In Log Home: true
555-
Image: container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<July'24>
555+
Image: container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<October'24>
556556
Image Pull Policy: IfNotPresent
557557
Image Pull Secrets:
558558
Name: orclcred

docs-source/content/idm-products/oam/introduction/_index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The main benefits of WDT are:
3737

3838
### Current production release
3939

40-
The current production release for the Oracle Access Management domain deployment on Kubernetes is [24.3.1](https://github.com/oracle/fmw-kubernetes/releases). This release uses the WebLogic Kubernetes Operator version 4.1.8.
40+
The current production release for the Oracle Access Management domain deployment on Kubernetes is [24.4.1](https://github.com/oracle/fmw-kubernetes/releases). This release uses the WebLogic Kubernetes Operator version 4.1.8.
4141

4242
For 4.0.X WebLogic Kubernetes Operator refer to [Version 23.3.1](https://oracle.github.io/fmw-kubernetes/23.3.1/idm-products/oam/)
4343

@@ -64,11 +64,15 @@ Please note, you also have the option to follow the Enterprise Deployment Guide
6464
+ Automate the deployment of Oracle Identity Management products on any compliant Kubernetes cluster.
6565

6666

67+
### Considerations for deploying OAM and OHS on Kubernetes
68+
69+
If you intend to use Oracle HTTP Server (OHS) and Oracle WebGate, and want to deploy OHS on Kubernetes, you must read and understand the [Supported Architectures](../../../ohs/introduction/#supported-architectures) in the [Oracle HTTP Server on Kubernetes](../../../ohs) documentation before continuing.
6770

6871
### Documentation for earlier releases
6972

7073
To view documentation for an earlier release, see:
7174

75+
* [Version 24.3.1](https://oracle.github.io/fmw-kubernetes/24.3.1/idm-products/oam/)
7276
* [Version 24.2.1](https://oracle.github.io/fmw-kubernetes/24.2.1/idm-products/oam/)
7377
* [Version 24.1.1](https://oracle.github.io/fmw-kubernetes/24.1.1/idm-products/oam/)
7478
* [Version 23.4.2](https://oracle.github.io/fmw-kubernetes/23.4.2/idm-products/oam/)

docs-source/content/idm-products/oam/patch-and-upgrade/upgrade-an-ingress.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,14 +65,14 @@ To upgrade the existing ingress rules, follow the steps below:
6565
oam-nginx oamns 1 <DATE> deployed ingress-per-domain-0.1.0 1.0
6666
```
6767

68-
1. Edit the `$WORKDIR/kubernetes/charts/ingress-per-domain/values.yaml` and change the `domainUID` parameter to match your domainUID, for example `domainUID: accessdomain`. For example:
68+
1. Edit the `$WORKDIR/kubernetes/charts/ingress-per-domain/values.yaml` and change the parameters to the same as you had when you initially configured the ingress. See [Prepare the values.yaml for the ingress](../../configure-ingress/#prepare-the-values.yaml-for-the-ingress). For example:
6969

7070
```
7171
# Load balancer type. Supported values are: NGINX
7272
type: NGINX
7373
7474
# SSL configuration Type. Supported Values are : NONSSL,SSL
75-
sslType: SSL
75+
sslType: NONSSL
7676
7777
# domainType. Supported values are: oam
7878
domainType: oam
@@ -162,8 +162,7 @@ To upgrade the existing ingress rules, follow the steps below:
162162
/oam/services/rest/access/api accessdomain-cluster-oam-cluster:14100 (10.244.1.225:14100)
163163
/access accessdomain-cluster-policy-cluster:15100 (10.244.1.226:15100)
164164
/ accessdomain-cluster-oam-cluster:14100 (10.244.1.225:14100)
165-
Annotations: kubernetes.io/ingress.class: nginx
166-
meta.helm.sh/release-name: oam-nginx
165+
Annotations: meta.helm.sh/release-name: oam-nginx
167166
meta.helm.sh/release-namespace: oamns
168167
nginx.ingress.kubernetes.io/configuration-snippet:
169168
more_clear_input_headers "WL-Proxy-Client-IP" "WL-Proxy-SSL";

docs-source/content/idm-products/oam/prepare-your-environment/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ The OAM Kubernetes deployment requires access to an OAM container image. The ima
6969
#### Prebuilt OAM container image
7070

7171

72-
The prebuilt OAM July 2024 container image can be downloaded from [Oracle Container Registry](https://container-registry.oracle.com). This image is prebuilt by Oracle and includes Oracle Access Management 12.2.1.4.0, the July Patch Set Update (PSU) and other fixes released with the Critical Patch Update (CPU) program.
72+
The prebuilt OAM October 2024 container image can be downloaded from [Oracle Container Registry](https://container-registry.oracle.com). This image is prebuilt by Oracle and includes Oracle Access Management 12.2.1.4.0, the October Patch Set Update (PSU) and other fixes released with the Critical Patch Update (CPU) program.
7373

7474
**Note**: Before using this image you must login to [Oracle Container Registry](https://container-registry.oracle.com), navigate to `Middleware` > `oam_cpu` and accept the license agreement.
7575

@@ -426,7 +426,7 @@ Before following the steps in this section, make sure that the database and list
426426
For example:
427427

428428
```bash
429-
$ kubectl run --image=container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<July'24> --image-pull-policy="IfNotPresent" --overrides='{"apiVersion": "v1","spec":{"imagePullSecrets": [{"name": "orclcred"}]}}' helper -n oamns -- sleep infinity
429+
$ kubectl run --image=container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<October'24> --image-pull-policy="IfNotPresent" --overrides='{"apiVersion": "v1","spec":{"imagePullSecrets": [{"name": "orclcred"}]}}' helper -n oamns -- sleep infinity
430430
```
431431
432432
If you are not using a container registry and have loaded the image on each of the master and worker nodes, run the following command:
@@ -438,7 +438,7 @@ Before following the steps in this section, make sure that the database and list
438438
For example:
439439
440440
```bash
441-
$ kubectl run helper --image oracle/oam:12.2.1.4-jdk8-ol8-<July'24> -n oamns -- sleep infinity
441+
$ kubectl run helper --image oracle/oam:12.2.1.4-jdk8-ol8-<October'24> -n oamns -- sleep infinity
442442
```
443443

444444
The output will look similar to the following:

docs-source/content/idm-products/oam/release-notes/_index.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,26 @@ Review the latest changes and known issues for Oracle Access Management on Kuber
1010

1111
| Date | Version | Change |
1212
| --- | --- | --- |
13+
| October, 2024 | 24.4.1 | Supports Oracle Access Management 12.2.1.4 domain deployment using the October 2024 container image which contains the October Patch Set Update (PSU) and other fixes released with the Critical Patch Update (CPU) program.|
14+
| | | This release contains the following changes:
15+
| | | + Ingress now uses ingressClassName instead of the deprecated kubernetes.io/ingress.class. See, [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/#deprecated-annotation).|
16+
| | | If upgrading to October 24 (24.4.1) from April 24 (24.2.1) or later, you must upgrade the following in order:
17+
| | | 1. Patch the OAM container image to October 24|
18+
| | | 2. If you are upgrading to Kubernetes 1.29 or later, you must upgrade the ingress. See [Upgrading the ingress](../patch-and-upgrade/upgrade-an-ingress).
19+
| | | If upgrading to October 24 (24.4.1) from October 22 (22.4.1) or later, you must upgrade the following in order:
20+
| | | 1. WebLogic Kubernetes Operator to 4.1.8|
21+
| | | 2. Patch the OAM container image to October 24|
22+
| | | 3. If you are upgrading to Kubernetes 1.29 or later, you must upgrade the ingress. See [Upgrading the ingress](../patch-and-upgrade/upgrade-an-ingress).
23+
| | | If upgrading to October 24 (24.4.1) from a release prior to October 22 (22.4.1), you must upgrade the following in order:
24+
| | | 1. WebLogic Kubernetes Operator to 4.1.8|
25+
| | | 2. Patch the OAM container image to October 24|
26+
| | | 3. Upgrade the Ingress|
27+
| | | 4. Upgrade Elasticsearch and Kibana|
28+
| | | See [Patch and Upgrade](../patch-and-upgrade) for these instructions.
1329
| July, 2024 | 24.3.1 | Supports Oracle Access Management 12.2.1.4 domain deployment using the July 2024 container image which contains the July Patch Set Update (PSU) and other fixes released with the Critical Patch Update (CPU) program.|
1430
| | | This release contains no changes other than support for the July Patch Set Update.
1531
| | | If upgrading to July 24 (24.3.1) from April 24 (24.2.1), you must upgrade the following in order:
16-
| | | 1. Patch the OAM container image to July 24|
32+
| | | 1. Patch the OAM container image to January 24|
1733
| | | If upgrading to July 24 (24.3.1) from October 22 (22.4.1) or later, you must upgrade the following in order:
1834
| | | 1. WebLogic Kubernetes Operator to 4.1.8|
1935
| | | 2. Patch the OAM container image to July 24|

docs-source/content/idm-products/oam/troubleshooting/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ If the domain creation fails while creating domain resources using the `domain.y
9494
a. Create a helper pod:
9595

9696
```
97-
kubectl run --image=container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<July`24> --image-pull-policy="IfNotPresent" --overrides='{"apiVersion": "v1","spec":{"imagePullSecrets": [{"name": "orclcred"}]}}' helper -n oamns -- sleep infinity
97+
kubectl run --image=container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol8-<October`24> --image-pull-policy="IfNotPresent" --overrides='{"apiVersion": "v1","spec":{"imagePullSecrets": [{"name": "orclcred"}]}}' helper -n oamns -- sleep infinity
9898
```
9999
100100
b. Clean down the failed domain creation by following steps 1-3 in [Delete the OAM domain home](manage-oam-domains/delete-domain-home).

docs-source/content/idm-products/oam/validate-domain-urls/_index.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,20 @@ description = "Sample for validating domain urls."
77

88
In this section you validate the OAM domain URLs are accessible via the NGINX ingress.
99

10-
Make sure you know the master hostname and ingress port for NGINX before proceeding.
11-
1210

1311
#### Validate the OAM domain urls via the Ingress
1412

1513
Launch a browser and access the following URL's. Login with the weblogic username and password (`weblogic/<password>`).
1614

17-
**Note**: If using a load balancer for your ingress replace `${MASTERNODE-HOSTNAME}:${MASTERNODE-PORT}` with `${LOADBALANCER-HOSTNAME}:${LOADBALANCER-PORT}`.
15+
**Note**: The `${HOSTNAME}:${PORT}` depends on the architecture configured, and your ingress setup as per [Configuring an ingress for NGINX for the OAM Domain](../configure-ingress).
1816

1917
| Console or Page | URL |
2018
| --- | --- |
21-
| WebLogic Administration Console | `https://${MASTERNODE-HOSTNAME}:${MASTERNODE-PORT}/console` |
22-
| Oracle Enterprise Manager Console | `https://${MASTERNODE-HOSTNAME}:${MASTERNODE-PORT}/em`
23-
| Oracle Access Management Console | `https://${MASTERNODE-HOSTNAME}:${MASTERNODE-PORT}/oamconsole` |
24-
| Oracle Access Management Console | `https://${MASTERNODE-HOSTNAME}:${MASTERNODE-PORT}/access` |
25-
| Logout URL | `https://${MASTERNODE-HOSTNAME}:${MASTERNODE-PORT}/oam/server/logout` |
19+
| WebLogic Administration Console | `http(s)://${HOSTNAME}:${PORT}/console` |
20+
| Oracle Enterprise Manager Console | `http(s)://${HOSTNAME}:${PORT}/em`
21+
| Oracle Access Management Console | `http(s)://${HOSTNAME}:${PORT}/oamconsole` |
22+
| Oracle Access Management Console | `http(s)://${HOSTNAME}:${PORT}/access` |
23+
| Logout URL | `http(s)://${HOSTNAME}:${PORT}/oam/server/logout` |
2624

2725

2826
**Note**: WebLogic Administration Console and Oracle Enterprise Manager Console should only be used to monitor the servers in the OAM domain. To control the Administration Server and OAM Managed Servers (start/stop) you must use Kubernetes. See [Domain Life Cycle ](../manage-oam-domains/domain-lifecycle) for more information.

0 commit comments

Comments
 (0)