Skip to content

Commit

Permalink
Release 23.1.1 - Oracle Identity Management documentation updates (#153)
Browse files Browse the repository at this point in the history
  • Loading branch information
ashageetha authored Jan 27, 2023
1 parent 58fd91a commit 00fe2b1
Show file tree
Hide file tree
Showing 605 changed files with 422,751 additions and 381 deletions.
13 changes: 13 additions & 0 deletions docs-source/content/idm-products/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
+++
title = "Oracle Identity Management on Kubernetes"
date = 2019-04-18T06:46:23-05:00
description= "This document lists all the Oracle Identity Management products deployment supported on Kubernetes."
+++

### Oracle Fusion Middleware on Kubernetes

Oracle supports the deployment of the following Oracle Identity Management products on Kubernetes. Click on the appropriate document link below to get started on setting up the product.


{{% children style="h3" description="true" %}}

10 changes: 10 additions & 0 deletions docs-source/content/idm-products/enterprise-deployments/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Enterprise Deployments"
description: "The complete Oracle Identity Management suite can be deployed in a production environment"
---

### Enterprise Deployments of Oracle Identity Management

The entire Oracle Identity and Access Management Suite can be deployed in a production environment. See the following sections:

{{% children style="h4" descriptions="true" %}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: "b. Enterprise Deployment Guide Automation Scripts"
description: "The Enterprise Deployment Automation scripts deploy the entire Oracle Identity and Access Management suite in a production environment automatically"
---

### Enterprise Deployment Automation


The [Enterprise Deployment Automation scripts](https://github.com/oracle/fmw-kubernetes/tree/master/FMWKubernetesMAA/OracleEnterpriseDeploymentAutomation/OracleIdentityManagement), allow you to automatically deploy the entire Oracle Identity and Access Management suite in a production environment.

For more information about the use of these scripts, see [Automating the Identity and Access Management Enterprise Deployment](https://docs.oracle.com/en/middleware/fusion-middleware/12.2.1.4/ikedg/automating-identity-management-deployment.html).


Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "a. Enterprise Deployment Guide"
description: "The Enterprise Deployment Guide shows how to deploy the entire Oracle Identity Management suite in a production environment"
---

### Enterprise Deployment Guide


The [Enterprise Deployment Guide for Oracle Identity and Access Management in a Kubernetes Cluster](https://docs.oracle.com/en/middleware/fusion-middleware/12.2.1.4/ikedg/index.html) is a step by step guide that describes how to deploy the entire Oracle Identity and Access Management Suite in a production environment. It incorporates best practices learned over many years to ensure that your Identity and Access Management deployment maintains the highest levels of Availability and Security.

It includes:

* Preparing your On-premises Kubernetes, or Oracle Cloud Infrastructure Container Engine for Kubernetes (OCI OKE), for an Identity Management (IDM) Deployment.
* Deploying and configuring Oracle Unified Directory (OUD) seeding data needed by other IDM products.
* Deploying and Configuring an Ingress Controller.
* Deploying and Configuring the WebLogic Kubernetes Operator
* Deploying and Configuring Oracle Access Management (OAM) and integrating with OUD.
* Deploying and Configuring Oracle Identity Governance (OIG) and integrating with OUD and OAM.
* Deploying and Configuring Oracle Identity Role Intelligence (OIRI) and integrating with OIG.
* Deploying and configuring Oracle Advanced Authentication (OAA) and Oracle Adaptive Risk Management (OARM) and integrating with OAM.
* Deploying and Configuring Monitoring and Centralised logging and configuring IDM to send monitoring and logging information to it.

Additionally, as per [Enterprise Deployment Automation](../enterprise-deployment-automation), all of the above can be automated using open source scripts.
10 changes: 10 additions & 0 deletions docs-source/content/idm-products/oam/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Oracle Access Management"
description: "The WebLogic Kubernetes Operator supports deployment of Oracle Access Management (OAM)."
---

### Oracle Access Management on Kubernetes

Oracle supports the deployment of Oracle Access Management on Kubernetes. See the following sections:

{{% children style="h4" descriptions="true" %}}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
+++
title = "Configure an Ingress for an OAM domain"
weight = 5
pre = "<b>5. </b>"
weight = 6
pre = "<b>6. </b>"
description= "This document provides steps to configure an Ingress to direct traffic to the OAM domain."
+++

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
+++
title = "Create OAM domains"
weight = 4
pre = "<b>4. </b>"
weight = 5
pre = "<b>5. </b>"
description = "Sample for creating an OAM domain home on an existing PV or PVC, and the domain resource YAML file for deploying the generated OAM domain."
+++

Expand Down Expand Up @@ -29,7 +29,7 @@ The OAM deployment scripts demonstrate the creation of an OAM domain home on an
Before you begin, perform the following steps:

1. Review the [Domain resource](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-resource) documentation.
1. Ensure that you have executed all the preliminary steps documented in [Prepare your environment]({{< relref "/oam/prepare-your-environment" >}}).
1. Ensure that you have executed all the preliminary steps documented in [Prepare your environment](../prepare-your-environment).
1. Ensure that the database is up and running.


Expand Down Expand Up @@ -66,7 +66,7 @@ The sample scripts for Oracle Access Management domain deployment are available
```bash
domainUID: accessdomain
domainHome: /u01/oracle/user_projects/domains/accessdomain
image: container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol7-<October`22>
image: container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol7-<January`23>
imagePullSecretName: orclcred
weblogicCredentialsSecretName: accessdomain-credentials
logHome: /u01/oracle/user_projects/domains/logs/accessdomain
Expand Down Expand Up @@ -96,7 +96,7 @@ A full list of parameters in the `create-domain-inputs.yaml` file are shown belo
| `domainType` | Type of the domain. Mandatory input for OAM domains. You must provide one of the supported domain type value: `oam` (deploys an OAM domain)| `oam`
| `exposeAdminNodePort` | Boolean indicating if the Administration Server is exposed outside of the Kubernetes cluster. | `false` |
| `exposeAdminT3Channel` | Boolean indicating if the T3 administrative channel is exposed outside the Kubernetes cluster. | `true` |
| `image` | OAM container image. The operator requires OAM 12.2.1.4. Refer to [Obtain the OAM container image]({{< relref "/oam/prepare-your-environment#obtain-the-oam-container-image" >}}) for details on how to obtain or create the image. | `oracle/oam:12.2.1.4.0` |
| `image` | OAM container image. The operator requires OAM 12.2.1.4. Refer to [Obtain the OAM container image](../prepare-your-environment#obtain-the-oam-container-image) for details on how to obtain or create the image. | `oracle/oam:12.2.1.4.0` |
| `imagePullPolicy` | WebLogic container image pull policy. Legal values are `IfNotPresent`, `Always`, or `Never` | `IfNotPresent` |
| `imagePullSecretName` | Name of the Kubernetes secret to access the container registry to pull the OAM container image. The presence of the secret will be validated when this parameter is specified. | |
| `includeServerOutInPodLog` | Boolean indicating whether to include the server .out to the pod's stdout. | `true` |
Expand Down Expand Up @@ -162,7 +162,7 @@ generated artifacts:
export initialManagedServerReplicas="2"
export managedServerNameBase="oam_server"
export managedServerPort="14100"
export image="container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol7-<October`22>"
export image="container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol7-<January`23>"
export imagePullPolicy="IfNotPresent"
export imagePullSecretName="orclcred"
export productionModeEnabled="true"
Expand Down Expand Up @@ -530,7 +530,7 @@ By default, the java memory parameters assigned to the oam_server cluster are ve
Domain Home: /u01/oracle/user_projects/domains/accessdomain
Domain Home Source Type: PersistentVolume
Http Access Log In Log Home: true
Image: container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol7-<October`22>
Image: container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol7-<January`23>
Image Pull Policy: IfNotPresent
Image Pull Secrets:
Name: orclcred
Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
+++
title = "Create or update an image"
weight = 10
pre = "<b>10. </b>"
weight = 11
pre = "<b>11. </b>"
description= "Create or update an Oracle Access Management (OAM) container image used for deploying OAM domains."
+++

As described in [Prepare Your Environment]({{< relref "/oam/prepare-your-environment" >}}) you can create your own OAM container image. If you have access to the My Oracle Support (MOS), and there is a need to build a new image with an interim or one off patch, it is recommended to use the WebLogic Image Tool to build an Oracle Access Management image for production deployments.
As described in [Prepare Your Environment](../prepare-your-environment) you can create your own OAM container image. If you have access to the My Oracle Support (MOS), and there is a need to build a new image with an interim or one off patch, it is recommended to use the WebLogic Image Tool to build an Oracle Access Management image for production deployments.


### Create or update an Oracle Access Management image using the WebLogic Image Tool

Using the WebLogic Image Tool, you can [create]({{< relref "/oam/create-or-update-image/#create-an-image" >}}) a new Oracle Access Management image with PSU's and interim patches or [update]({{< relref "/oam/create-or-update-image/#update-an-image" >}}) an existing image with one or more interim patches.
Using the WebLogic Image Tool, you can [create](../create-or-update-image/#create-an-image) a new Oracle Access Management image with PSU's and interim patches or [update](../create-or-update-image/#update-an-image) an existing image with one or more interim patches.

> **Recommendations:**
> * Use [create]({{< relref "/oam/create-or-update-image/#create-an-image" >}}) for creating a new Oracle Access Management image containing the Oracle Access Management binaries, bundle patch and interim patches. This is the recommended approach if you have access to the OAM patches because it optimizes the size of the image.
> * Use [update]({{< relref "/oam/create-or-update-image/#update-an-image" >}}) for patching an existing Oracle Access Management image with a single interim patch. Note that the patched image size may increase considerably due to additional image layers introduced by the patch application tool.
> * Use [create](../create-or-update-image/#create-an-image) for creating a new Oracle Access Management image containing the Oracle Access Management binaries, bundle patch and interim patches. This is the recommended approach if you have access to the OAM patches because it optimizes the size of the image.
> * Use [update](../create-or-update-image/#update-an-image) for patching an existing Oracle Access Management image with a single interim patch. Note that the patched image size may increase considerably due to additional image layers introduced by the patch application tool.
#### Create an image

Expand Down Expand Up @@ -134,7 +134,7 @@ Creating an Oracle Access Management container image using the WebLogic Image To

#### Create an image

After [setting up the WebLogic Image Tool]({{< relref "/oam/create-or-update-image/#set-up-the-weblogic-image-tool" >}}), follow these steps to use the WebLogic Image Tool to `create` a new Oracle Access Management image.
After [setting up the WebLogic Image Tool](../create-or-update-image/#set-up-the-weblogic-image-tool), follow these steps to use the WebLogic Image Tool to `create` a new Oracle Access Management image.

##### Download the Oracle Access Management installation binaries and patches

Expand Down Expand Up @@ -320,7 +320,7 @@ oracle/oam 12.2.1.4.0 b051804ba15f 3 months ago 3.34GB
```


1. [Set up the WebLogic Image Tool]({{< relref "/oam/create-or-update-image/#set-up-the-weblogic-image-tool" >}}).
1. [Set up the WebLogic Image Tool](../create-or-update-image/#set-up-the-weblogic-image-tool).

1. Download the required interim patch and latest Opatch (28186730) from [My Oracle Support](https://support.oracle.com). and save them in a <download location> directory of your choice.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: "Oracle Access Management"
title: "Introduction"
weight: 1
pre : "<b>1. </b>"
description: "The WebLogic Kubernetes Operator supports deployment of Oracle Access Management (OAM). Follow the instructions in this guide to set up these Oracle Access Management domains on Kubernetes."
weight: 2
---

The WebLogic Kubernetes Operator supports deployment of Oracle Access Management (OAM).
Expand All @@ -22,21 +23,21 @@ environment. You can:

### Current production release

The current production release for the Oracle Access Management domain deployment on Kubernetes is [22.4.1](https://github.com/oracle/fmw-kubernetes/releases). This release uses the WebLogic Kubernetes Operator version 3.4.2.
The current production release for the Oracle Access Management domain deployment on Kubernetes is [23.1.1](https://github.com/oracle/fmw-kubernetes/releases). This release uses the WebLogic Kubernetes Operator version 3.4.2.

For 3.3.X WebLogic Kubernetes Operator refer to [Version 22.3.1](https://oracle.github.io/fmw-kubernetes/22.3.1/oam/)

### Recent changes and known issues

See the [Release Notes]({{< relref "/oam/release-notes.md" >}}) for recent changes and known issues for Oracle Access Management domain deployment on Kubernetes.
See the [Release Notes](../release-notes/) for recent changes and known issues for Oracle Access Management domain deployment on Kubernetes.

### Limitations

See [here]({{< relref "/oam/prerequisites#limitations">}}) for limitations in this release.
See [here](../prerequisites/#limitations) for limitations in this release.

### Getting started

This documentation explains how to configure OAM on a Kubernetes cluster where no other Oracle Identity Management products will be deployed. For detailed information about this type of deployment , start at [Prerequisites]({{< relref "/oam/prerequisites" >}}) and follow this documentation sequentially.
This documentation explains how to configure OAM on a Kubernetes cluster where no other Oracle Identity Management products will be deployed. For detailed information about this type of deployment , start at [Prerequisites](../prerequisites) and follow this documentation sequentially.

If performing an Enterprise Deployment where multiple Oracle Identity Management products are deployed, refer to the [Enterprise Deployment Guide for Oracle Identity and Access Management in a Kubernetes Cluster](https://docs.oracle.com/en/middleware/fusion-middleware/12.2.1.4/ikedg/index.html) instead.

Expand All @@ -45,6 +46,7 @@ If performing an Enterprise Deployment where multiple Oracle Identity Management

To view documentation for an earlier release, see:

* [Version 22.4.1](https://oracle.github.io/fmw-kubernetes/22.4.1/oam/)
* [Version 22.3.1](https://oracle.github.io/fmw-kubernetes/22.3.1/oam/)
* [Version 22.2.1](https://oracle.github.io/fmw-kubernetes/22.2.1/oam/)
* [Version 21.4.2](https://oracle.github.io/fmw-kubernetes/21.4.2/oam/)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
+++
title = "Manage OAM Domains"
weight = 9
pre = "<b>9. </b>"
weight = 10
pre = "<b>10. </b>"
description= "This document provides steps to manage the OAM domain."
+++

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ description: "Learn about the domain life cycle of an OAM domain."
1. [Starting/Scaling up OAM Managed servers](#startingscaling-up-oam-managed-servers)
1. [Stopping/Scaling down OAM Managed servers](#stoppingscaling-down-oam-managed-servers)
1. [Stopping and starting the Administration Server and Managed Servers](#stopping-and-starting-the-administration-server-and-managed-servers)
1. [Domain lifecycle sample scripts](domain-lifecycle-sample-scripts)
1. [Domain lifecycle sample scripts](#domain-lifecycle-sample-scripts)


As OAM domains use the WebLogic Kubernetes Operator, domain lifecyle operations are managed using the WebLogic Kubernetes Operator itself.

This document shows the basic operations for starting, stopping and scaling servers in the OAM domain.

For more detailed information refer to [Domain Life Cycle](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/) in the [WebLogic Kubernetes Operator](https://oracle.github.io/weblogic-kubernetes-operator/) documentation.
For more detailed information refer to [Domain Life Cycle](https://oracle.github.io/weblogic-kubernetes-operator/managing-domains/domain-lifecycle/) in the [WebLogic Kubernetes Operator](https://oracle.github.io/weblogic-kubernetes-operator/) documentation.

{{% notice note %}}
Do not use the WebLogic Server Administration Console or Oracle Enterprise Manager Console to start or stop servers.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
+++
title = "Patch and Upgrade"
weight = 11
pre = "<b>11. </b>"
weight = 12
pre = "<b>12. </b>"
description= "This document provides steps to patch or upgrade an OAM image, WebLogic Kubernetes Operator, ELK, and Ingress."
+++

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
+++
title = "Post Install Configuration"
weight = 7
pre = "<b>7. </b>"
weight = 8
pre = "<b>8. </b>"
description = "Post install configuration."
+++

Expand Down
Loading

0 comments on commit 00fe2b1

Please sign in to comment.