ForgeOps 7.3 release notes
Get an email when there’s an update to ForgeOps 7.3. Go to the Notifications page in your Backstage profile and select ForgeOps 7.3 Changes in the Documentation Digests section.
Or subscribe to the ForgeOps 7.3 RSS feed.
Important information for this ForgeOps release:
Validated Kubernetes versions for deploying ForgeRock Identity Platform 7.3 |
|
Validated NGINX ingress versions for deploying ForgeRock Identity Platform 7.3 |
|
Limitations when deploying ForgeRock Identity Platform 7.3 on Kubernetes |
|
More information about the rapidly evolving nature of the |
|
Archive of release notes prior to April 4, 2023 |
2024
April 30, 2024
Documentation update
- AM, IDM, and audit logging links in the Troubleshooting section
-
Added links to AM, IDM, and audit logging community articles in the Troubleshooting section.
February 2, 2024
Changes
- New evaluation-only Docker images are now available from ForgeRock
-
New evaluation-only Docker images are now available for the following versions of ForgeRock Identity Platform components:
-
ForgeRock Directory Services: 7.3.4
-
ForgeRock Identity Gateway: 2023.11.0
This documentation has been updated to refer to these new versions of Docker images.
For more information about changes to the ForgeRock Identity Platform, refer to the Release Notes for platform components at https://backstage.forgerock.com/docs.
To upgrade to the new versions, you’ll need to rebuild your custom Docker images. Refer to Base Docker Images for instructions.
-
2023
November 15, 2023
Documentation updates
- New task to initialize deployments
-
A new task to initialize deployment environments has been added to the instructions for developing custom Docker images using the CDK.
Before you can use a new deployment environment, you must initialize a directory that supports the environment.
- Clarification about support for environments that deviate from the published CDK and CDM architecture
-
The Support from ForgeRock page has been updated to state that environments that deviate from the published CDK and CDM architecture are not supported. For details, refer to Support limitations.
August 10, 2023
Documentation updates
- New how-to: Upgrade the platform to a newer patch release
-
A new how-to provides steps for upgrading to newer patch releases of version 7.3.
August 3, 2023
Changes
- Running the CDK on Minikube on macOS systems with ARM-based chipsets is now available on an experimental basis
-
Running the CDK on Minikube on macOS systems with ARM-based chipsets, such as the Apple M1 or M2, is now available on an experimental basis.
Refer to this ForgeRock Community article for details.
July 11, 2023
Highlights
- Updates to the
forgeops
repository for ForgeRock Identity Platform version 7.3 -
Updates for ForgeRock Identity Platform version 7.3 are available in the
release/7.3-20240131
branch of theforgeops
repository.The
release/7.3-20240131
branch replaces therelease/7.3-20230609
branch. Upgrade to the new branch as soon as possible. - New evaluation-only Docker images are now available from ForgeRock
-
New evaluation-only Docker image versions are now available for the following ForgeRock Identity Platform components:
-
ForgeRock Directory Services: 7.3.4
-
ForgeRock Identity Gateway: 2023.11.0
This documentation has been updated to refer to these new versions of Docker images.
For more information about changes to the ForgeRock Identity Platform, refer to the Release Notes for platform components at https://backstage.forgerock.com/docs.
To upgrade to the new versions, you’ll need to rebuild your custom Docker images. Refer to Base Docker Images for instructions.
-
June 23, 2023
Documentation updates
- Updates to the Base Docker images page
-
New steps describe how to build Docker images for Java, and how to base your own base Docker images on those Java images.
June 16, 2023
Highlights
- Updates to the
forgeops
repository for ForgeRock Identity Platform version 7.3 -
Updates for ForgeRock Identity Platform version 7.3 are available in the
release/7.3-20240131
branch of theforgeops
repository.The
release/7.3-20240131
branch replaces therelease/7.3-20230404
branch. Upgrade to the new branch as soon as possible. - New evaluation-only Docker images are now available from ForgeRock
-
New evaluation-only Docker image versions are now available for the following ForgeRock Identity Platform components:
-
ForgeRock Directory Services: 7.3.4
-
ForgeRock Identity Gateway: 2023.11.0
This documentation has been updated to refer to these new versions of Docker images.
For more information about changes to the ForgeRock Identity Platform, refer to the Release Notes for platform components at https://backstage.forgerock.com/docs.
To upgrade to the new versions, you’ll need to rebuild your custom Docker images. Refer to Base Docker Images for instructions.
-
June 5, 2023
Documentation updates
- New how-to: Upgrade the platform from version 7.2 to 7.3
-
A new how-to provides steps for upgrading a version 7.2 CDM to version 7.3.
April 4, 2023
Highlights
- Terraform for CDM cluster creation and deletion
-
Use Terraform to create clusters in which you can install the CDM. Terraform artifacts are now available in the top-level terraform directory of the new
forgeops-extras
repository. Install Terraform software before you install the CDM to take advantage of this new capability.The cluster-up.sh and cluster-down.sh scripts are no longer available. Use Terraform for cluster creation and deletion instead.
You’ll find changes on the following pages in the documentation:
- Deployment environments
-
Deployment environments let you manage deployment manifests and image defaulters for multiple environments in a single
forgeops
repository clone.Specify a deployment environment by using the forgeops command’s new
--deploy-env
option.By default, the image defaulter and generated Kustomize manifests reside in the kustomize/deploy directory.
Each deployment environment has its own image defaulter, located in the kustomize/deploy-environment/image-defaulter directory.
When you specify a deployment environment, Kustomize manifests are generated in the kustomize/deploy-environment directory. For example, if you ran forgeops generate --deploy-env production, Kustomize manifests would be placed in the kustomize/deploy-production directory.
- HAProxy Ingress as the CDM ingress controller
-
You can now install HAProxy Ingress as the ingress controller for CDM deployments.
NGINX Ingress Controller remains the default ingress for controller for CDK and CDM deployments.
- New forgeops command reference
-
A reference for the forgeops command is now available here.
Changes
- CDM deployments now use Kubernetes version 1.25
-
When you create a cluster for deploying version 7.3 of the platform, use Kubernetes version 1.25.
- CDK deployments on Minikube now use the stable Kubernetes version
-
The cdk-minikube script has been modified to use the stable Kubernetes version instead of version 1.23.3. Refer to the Minikube start command reference for details about which Kubernetes version is currently considered to be the stable version.
- CDM deployments should now use NGINX Ingress Controller version 1.4.0 or higher
-
When you deploy the NGINX Ingress Controller in your CDM cluster, use version 1.4.0[1] or higher.
- Additional documented DS limitations in CDK and CDM deployments
-
Three additional limitations on DS in CDK and CDM deployments are now documented here:
-
Database encryption is not supported
-
DS starts successfully even when it cannot decrypt a backend
-
Root file system write access is required to run the DS Docker image
Please note that these are not new limitations. They had inadvertently been omitted from the DS limitations section in the documentation.
-
- Large CDM deployments now run in a single node pool
-
Large CDM deployments are now configured to run in a single node pool.
The CDM architecture previously used two node pools: one for the DS pods, and another for all the other pods in the CDM deployment.
- Automatic configuration profile creation
-
The config export am and config export idm commands now have added functionality to create new configuration profiles.
You are no longer required to create and populate subdirectories under the /path/to/forgeops/docker/am/config-profiles and /path/to/forgeops/docker/idm/config-profiles directories the first time you export configuration from the CDK to a new configuration profile in your
forgeops
repository clone. - Availability and usage of
KUBECONFIG
environment variables -
The tf-apply script creates a kubeconfig file when it creates a cluster. The documentation has been modified to support changing the Kubernetes context using
KUBECONFIG
environment variables instead of assuming you use the default kubeconfig file, $HOME/.kube/config. - CDM deployment no longer defaults to the
prod
namespace -
You can now use any namespace you want for CDM deployment.
Previously, cluster creation scripts created the
prod
namespace, and some scripts defaulted to using this namespace for CDM deployment. - Skaffold is no longer used to build Docker images
-
The forgeops build command now uses Docker rather than Skaffold to build and push Docker images.
Because of this, you no longer need to install Skaffold software when deploying the CDM or the CDK.
- New --push-to option replaces the forgeops build command’s --default-repo option
-
The forgeops build command’s --push-to option replaces the --default-repo option.
When running the forgeops build command on Minikube, you must now specify --push-to none with the forgeops build command to push a Docker image to the Docker registry embedded in the Minikube cluster. Previously, it was not necessary to specify the --default-repo option when running the forgeops build command on Minikube.
- The forgeops delete command issues new confirmation prompts and has a new option
-
The forgeops delete command now issues multiple confirmation prompts, letting you choose to delete all PVCs, volume snapshots, and/or secrets from a CDK or CDM deployment.
Previously, you could only choose to delete all three deployment artifacts, or none of them.
The forgeops delete command’s new --force --yes option lets you suppress all confirmation prompts.
- eksctl is no longer used to create EKS clusters
-
The tf-apply command uses Terraform rather than eksctl to create EKS clusters.
Because of this, you no longer need to install eksctl software when deploying the CDM.
- AM evaluation-only Docker image repository name change
-
The name of the AM evaluation-only Docker image repository has been changed to
gcr.io/forgerock-io/am-cdk
. This image repository was formerly namedgcr.io/forgerock-io/am-base
. - The AM canonical configuration is now built into the
am-cdk
Docker image -
The AM canonical configuration for the CDK has been incorporated into the
am-cdk
Docker image.Because of this, you no longer need to copy files from the docker/am/config-profiles/cdk directory when you initialize a new configuration profile. Simply create a new subdirectory under the docker/am/config-profiles directory.
Deprecated
- ForgeOps artifacts for deploying ForgeRock Identity Platform 7.2
-
The ForgeOps artifacts for deploying ForgeRock Identity Platform 7.2 are deprecated. You should migrate to version 7.3 as soon as you’re able to.
Removed
- The cluster-up and cluster-down scripts
-
The cluster-up and cluster-down scripts are no longer available. Use Terraform for cluster creation and deletion instead.
- The forgeops build command’s --default-repo option
-
The forgeops build command’s --default-repo option is no longer available. It’s been replaced by the new --push-to option.
- The cicd directory
-
The cicd directory has been removed from the
forgeops
repository.
Documentation updates
- New deployment step: back up the secrets that contain the DS master and TLS keys
-
A new step to back up the Kubernetes secrets that contain the DS master and TLS keys has been added to the instructions for deploying the CDM.
It is extremely important to back up these secrets and retain them in a secure location. Loss of these secrets could result in the inability to restore data from backups.
- Secret generation documentation corrected
-
The Secret Agent operator page previously stated that the Secret Agent operator generates all secrets required for a ForgeRock Identity Platform deployment.
This page has been corrected to state that the Secret Agent operator generates all secrets required for a ForgeRock Identity Platform deployment except for the DS master and TLS keys. In version 7.3, the DS operator calls the certificate manager to generate these two keys.
- Secret management recommendations changed
-
The recommendation that you always configure cloud secret management has been relaxed. ForgeRock now recommends that you configure cloud secret management only when you have multiple deployments that need to use the same secrets.
- Base Docker images page updated
-
The Base Docker images page has been significantly updated. A new section, Create Docker images for use in production, explains how to build customized Docker images for the ForgeRock Identity Platform that:
-
Contain customized configuration profiles for AM, IDM, and, optionally, IG.
-
Must be based on your own base Docker images.
-
Must not be based on ForgeRock’s evaluation-only Docker images.
-