Additional setup
This page covers setup tasks that you’ll need to perform before you can develop custom Docker images for the ForgeRock Identity Platform. Complete all of the tasks on this page before proceeding.
Install additional third-party software
You should have already installed third-party software when you set up your local environment before installing the CDK. Depending on how you have installed the CDK, you might need to install additional software before you can build custom Docker images for the platform:
macOS systems with the CDK running on a Minikube cluster
| Software | Version | Homebrew package |
|---|---|---|
Docker Desktop |
4.26.1 |
|
macOS systems with the CDK running on a shared GKE, EKS, or AKS cluster
| Software | Version | Homebrew package |
|---|---|---|
Docker Desktop |
4.26.1 |
|
Linux systems with the CDK running on a shared GKE, EKS, or AKS cluster
| Software | Version | Homebrew package |
|---|---|---|
Docker Engine |
24.0.7 |
n/a |
Set up your environment to push to your Docker registry
Minikube
Set up your local environment to execute docker commands on Minikube’s Docker engine.
ForgeRock recommends using the built-in Docker engine when developing custom Docker images using Minikube. When you use Minikube’s Docker engine, you don’t have to build Docker images on a local engine and then push the images to a local or cloud-based Docker registry. Instead, you build images using the same Docker engine that Minikube uses. This streamlines development.
To set up your local computer to use Minikube’s Docker engine, run the docker-env command in your shell:
$ eval $(minikube docker-env)
For more information about using Minikube’s built-in Docker engine, see Use local images by re-using the Docker daemon in the Minikube documentation.
GKE shared cluster
To set up your local computer to build and push Docker images:
-
If it’s not already running, start Docker on your local computer. For more information, see the Docker documentation.
-
Set up a Docker credential helper:
$ gcloud auth configure-docker
EKS shared cluster
To set up your local computer to push Docker images:
-
If it’s not already running, start Docker on your local computer. For more information, see the Docker documentation.
-
Log in to Amazon ECR. Use the Docker registry location you obtained from your cluster administrator:
$ aws ecr get-login-password | \ docker login --username AWS --password-stdin my-docker-registry Login SucceededECR login sessions expire after 12 hours. Because of this, you’ll need to perform these steps again whenever your login session expires.[1]
AKS shared cluster
To set up your local computer to push Docker images:
-
If it’s not already running, start Docker on your local computer. For more information, see the Docker documentation.
-
Install the ACR Docker Credential Helper.
Identify the Docker repository to push to
When you execute the forgeops build command, specify the repository to push your Docker image to with the --push-to argument.
Note that the forgeops build command appends a component name to
the destination repository. For example, the command
forgeops build am --push-to us-docker.pkg.dev/my-project
pushes a Docker image to the us-docker.pkg.dev/my-project/am
repository.
To determine how to specify the --push-to argument:
Minikube
Specify --push-to none with the forgeops build command to push the Docker image to the Docker registry embedded in the Minikube cluster.
GKE shared cluster
Set the --push-to argument to the GCR repository that you obtained from your cluster administrator.
After it builds the Docker image, the forgeops build command pushes the Docker image to this repository.
EKS shared cluster
Set the --push-to argument to the Amazon ECR repository that you obtained from your cluster administrator.
After it builds the Docker image, the forgeops build command pushes the Docker image to this repository.
AKS shared cluster
Set the --push-to argument to the ACR repository that you obtained from your cluster administrator.
After it builds the Docker image, the forgeops build command pushes the Docker image to this repository.
Initialize deployment environments
Deployment environments let you manage deployment manifests and image defaulters
for multiple environments in a single forgeops repository clone.
By default, the forgeops build command updates the image defaulter in the kustomize/deploy directory.
When you specify a deployment environment, the forgeops build command updates the image defaulter in the kustomize/deploy-environment directory. For example, if you ran forgeops build --deploy-env production, the image defaulter in the kustomize/deploy-production/image-defaulter directory would be updated.
Before you can use a new deployment environment, you must initialize a directory based on the /path/to/forgeops/kustomize/deploy directory to support the deployment environment. Perform these steps to initialize a new deployment environment:
$ cd /path/to/forgeops/bin
$ ./forgeops clean
$ cd ../kustomize
$ cp -rp deploy deploy-my-environment
| If you need multiple deployment environments, you’ll need to initialize each environment before you can start using it. |
Next step
cron utility.