--- title: Repositories description: The ForgeOps project provides two public GitHub repositories; the forgeops and forgeops-extras repositories. component: forgeops version: 2026.1 page_id: forgeops:start:repositories canonical_url: https://docs.pingidentity.com/forgeops/2026.1/start/repositories.html keywords: ["forgeops Repository", "forgeops-extras"] section_ids: forgeops_repository: forgeops repository forgeops-updates: forgeops repository updates forgeops-reference: forgeops repository reference directories: Directories bin: bin charts: charts cluster_removed: cluster removed docker: docker etc: etc helm: helm how_tos: how-tos intezer: intezer jenkins_scripts: jenkins-scripts kustomize: kustomize legacy_docs: legacy-docs lib: lib releases_removed: releases removed upgrade: upgrade files_in_the_top_level_directory: Files in the top-level directory gcloudignore_gitchangelog_rc_gitignore_forgeops_conf_example: .gcloudignore, .gitchangelog.rc, .gitignore, forgeops.conf.example changelog_md: CHANGELOG.md license: LICENSE makefile: Makefile notifications_json: notifications.json readme_md: README.md forgeops_extras_repository: forgeops-extras repository forgeops-extras-reference: forgeops-extras repository reference directories_2: Directories terraform: terraform forgeops-fork: Git clone or Git fork? --- # Repositories The ForgeOps project provides two public GitHub repositories; the `forgeops` and `forgeops-extras` repositories. This page provides a high-level overview of the two repositories. ## `forgeops` repository The [`forgeops` repository](https://github.com/ForgeRock/forgeops.git) contains files needed for customizing and deploying the Ping Identity Platform on a Kubernetes cluster: * Files used to build Docker images for the Ping Identity Platform: * Dockerfiles * Scripts and configuration files incorporated into ForgeOps-provided Docker images * Canonical configuration profiles for the platform * Helm charts * Kustomize bases and overlays In addition, the repository contains utility scripts and sample files. The scripts and samples are useful for: * Performing ForgeOps deployments quickly and easily * Exploring monitoring, alerts, and security customization Learn more about the files in the repository, recommendations about how to work with them, and the support status for the files in the [`forgeops` repository reference](#forgeops-reference). | | | | - | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | Learn more about configuring GitHub notifications [here](https://docs.github.com/en/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications) so you can get notified on ForgeOps releases. | ### `forgeops` repository updates New `forgeops` repository features become available in the `2026.1.0` tag of the `main` branch from time to time. When you start working with the `forgeops` repository, clone the repository. Depending on your organization's setup, you'll clone the repository either from the public repository on GitHub, or from a fork. You can find more information in [Git clone or Git fork?](#forgeops-fork). Then, check out the `2026.1.0` tag of the `main` branch and create a working branch. For example: ``` $ git checkout 2026.1.0 $ git checkout -b my-working-branch ``` The ForgeOps team recommends that you regularly incorporate updates to the `2026.1.0` tag into your working branch: 1. [Get emails or subscribe to the ForgeOps RSS feed](../rn/rn.html) to be notified when there have been updates to ForgeOps 2026.1.0. 2. Pull new commits in the `2026.1.0` tag of the `main` branch into your clone's `2026.1.0` branch. 3. Rebase the commits from the new branch into your working branch in your `forgeops` repository clone. It's important to understand the impact of rebasing changes from the `forgeops` repository into your branches. [`forgeops` repository reference](#forgeops-reference) provides advice about which files in the `forgeops` repository to change, which files not to change, and what to look out for when you rebase. Follow the advice in [`forgeops` repository reference](#forgeops-reference) to reduce merge conflicts, and to better understand how to resolve them when you rebase your working branch with updates that the ForgeOps team has made to the `2026.1.0` tag of the `main` branch. ### `forgeops` repository reference For more information about support for the `forgeops` repository, see [Support for ForgeOps](support.html). #### Directories ##### bin Example scripts you can use or model for a variety of deployment tasks. Recommendation: Don't modify the files in this directory. If you want to add your own scripts to the `forgeops` repository, create a subdirectory under bin, and store your scripts there. Support Status: Sample files. [Not supported by Ping Identity.](support.html#commercial-support) ##### charts Helm charts. Recommendation: Don't modify the files in this directory. If you want to update a values.yaml file, create your deployment environment using the forgeops env command, and edit values.yaml files in the new environment you created. Learn more in the [`forgeops env` command reference](../reference/forgeops-cmd-ref.html#forgeops-env). Support Status: [Supported is available from Ping Identity.](support.html#commercial-support) ##### cluster removed The required ForgeOps contents in this directory have been moved to other directories as relevant and this directory has been removed. ##### docker Contains three types of files needed to build Docker images for the Ping Identity Platform: Dockerfiles, support files that go into Docker images, and configuration profiles. **Dockerfile** Common deployment customizations require modifications to the Dockerfile in the docker directory. Recommendation: Expect to encounter merge conflicts when you rebase changes from ForgeOps into your branches. Be sure to track changes you've made to Dockerfiles, so that you're prepared to resolve merge conflicts after a rebase. Support Status: Dockerfiles. [Support is available from Ping Identity.](support.html#commercial-support) **Support Files Referenced by Dockerfiles** When customizing the default ForgeOps deployments, you might need to add files to the docker directory. For example, to customize the AM WAR file, you might need to add plugin JAR files, user interface customization files, or image files. Recommendation: If you only add new files to the docker directory, you should not encounter merge conflicts when you rebase changes from ForgeOps into your branches. However, if you need to modify any files from ForgeOps, you might encounter merge conflicts. Be sure to track changes you've made to any files in the docker directory, so that you're prepared to resolve merge conflicts after a rebase. Support Status: Scripts and other files from ForgeOps that are incorporated into Docker images for the Ping Identity Platform: [Support is available from Ping Identity.](support.html#commercial-support) User customizations that are incorporated into custom Docker images for the Ping Identity Platform: [Support is not available from Ping Identity.](support.html#commercial-support) **Configuration Profiles** The starter configuration profiles provided with ForgeOps. To create your own configuration profiles, use the forgeops config command in your ForgeOps deployment environment. Add your own configuration profiles to the docker directory using the export command. Don't modify the internal-use only `idm-only` and `ig-only` configuration profiles provided by ForgeOps. Recommendation: You should not encounter merge conflicts when you rebase changes from ForgeOps into your branches. Support Status: Configuration profiles. [Support is available from Ping Identity.](support.html#commercial-support) ##### etc Files used to support ForgeOps deployments. Recommendation: Don't modify the files in this directory (or its subdirectories). Support Status: Sample files. [Not supported by Ping Identity.](support.html#commercial-support) ##### helm Helm values files for each client environment (env) for use with Helm charts. The Helm values files are created and managed by the forgeops env command. **Files in each ForgeOps deployment environment** | File | Description | | ------------------- | ---------------------------------------------------------------------- | | env.log | Log of `forgeops env` runs. | | values.yaml | Configuration of components in ForgeOps deployment using Helm. | | values-images.yaml | Docker image used in ForgeOps deployment. | | values-ingress.yaml | Ingress configuration, such as FQDN. | | values-size.yaml | Component size information such as number of replicas, cpu, and memory | Support Status: Environment specific files. [Support is available from ForgeRock.](support.html#commercial-support) ##### how-tos Description and usage of various utilities provided with ForgeOps. Recommendation: Don't change these files. Support Status: Description files. [Support is available from ForgeRock.](support.html#commercial-support) ##### intezer For ForgeRock internal use only. Don't modify or use. ##### jenkins-scripts For ForgeRock internal use only. Don't modify or use. ##### kustomize Artifacts for orchestrating the Ping Identity Platform using Kustomize. Recommendation: Common deployment customizations, such as changing the deployment namespace and providing a customized FQDN, require modifications to files in the kustomize/overlay directory. Be sure to track changes you've made to the files in the kustomize directory, so that you're prepared to resolve merge conflicts after a rebase. Support Status: Kustomize bases and overlays. [Support is available from Ping Identity.](support.html#commercial-support) ##### legacy-docs Documentation for performing ForgeOps deployments using older versions. Includes documentation for supported and deprecated versions of the `forgeops` repository. Recommendation: Don't modify the files in this directory. Support Status: Documentation for supported versions of the `forgeops` repository: [Support is available from Ping Identity.](support.html#commercial-support) Documentation for deprecated versions of the `forgeops` repository: [Not supported by Ping Identity.](support.html#commercial-support) ##### lib Python and shell library files used internally. Don't modify. ##### releases removed ##### upgrade Files to enable `secret-generator` as the secret management tool in ForgeOps deployments. For ForgeOps internal use only. Don't modify. #### Files in the top-level directory ##### .gcloudignore, .gitchangelog.rc, .gitignore, forgeops.conf.example For ForgeOps internal use only. Don't modify. ##### CHANGELOG.md This file records changes in ForgeOps artifacts, processes, and procedures. Recommendation: Don't modify this file. ##### LICENSE Software license for artifacts in the `forgeops` repository. Don't modify. ##### Makefile For ForgeOps internal use only. Don't modify. ##### notifications.json For ForgeOps internal use only. Don't modify. ##### README.md The top-level `forgeops` repository README file. Don't modify. ## `forgeops-extras` repository Use the [forgeops-extras](https://github.com/ForgeRock/forgeops-extras) repository to create sample Kubernetes clusters in which you can deploy the Ping Identity Platform. ### `forgeops-extras` repository reference For more information about support for the `forgeops-extras` repository, see [Support for ForgeOps](support.html). #### Directories ##### terraform Example Terraform artifacts that automate cluster creation and deletion. Recommendation: Don't modify the files in this directory. If you want to add your own cluster creation support files to the `forgeops` repository, copy the terraform.tfvars file to a new file and make changes there. Support Status: Sample files. [Not supported by Ping Identity.](support.html#commercial-support) ## Git clone or Git fork? Cloning ForgeOps public repository from GitHub is adequate for the simple use cases, such as: * A single user in an organization performing a ForgeOps deployment for a proof of concept. * Exploring of the platform capabilities. If, however, your use case is more complex, you might want to fork the repositories, and use the forks as your common upstream repositories. For example: * Multiple users in your organization need to access a common version of the repository and share changes made by other users. * Your organization plans to incorporate `forgeops` and `forgeops-extras` repository changes from ForgeOps. * Your organization wants to use pull requests when making repository updates. If you've forked the `forgeops` and `forgeops-extras` repositories: * You'll need to synchronize your forks with ForgeOps repositories on GitHub when ForgeOps releases new branches. * Your users will need to clone your forks before they start working instead of cloning the public repositories from GitHub. Because procedures in the documentation tell users to clone the public repositories, you'll need to make sure your users follow different procedures to clone the forks instead. * The steps to initially get and update your repository clones will differ from the steps provided in the documentation. You'll need to let users know how to work with the forks as the upstream repositories instead of following the steps in the documentation.