# Configuration Manager: fr-config-promote

This tool is used to promote configuration from the one ForgeRock Identity Cloud tenant to the other ForgeRock Identity Cloud tenant.

## Installation

The tool is installed from the package directory as follows

```
npm install
npm link
```

## Configuration

The tool is configured via environment variables. Copy the sample `.env` file and configure as per the instructions in the [configuration README](../docs/environment.md).

## Usage

Run the `fr-config-promote` tool as follows to promote configuration from the one ForgeRock Identity Cloud tenant to the other ForgeRock Identity Cloud tenant.

```
Usage: fr-config-promote [arguments]

Commands:
  fr-config-promote check-locked-status      Checks tenants to see if it is locked
  fr-config-promote check-promotion-reports  Check promotion reports
  fr-config-promote check-promotion-status   Check Promotion Status
  fr-config-promote lock-tenants             Lock tenants
  fr-config-promote rollback                 Rollback promotion
  fr-config-promote run-dryrun-promotion     Run DryRun Promotion
  fr-config-promote run-promotion            Run Promotion
  fr-config-promote unlock-tenants           Unlock tenants

Options:
  -h, --help                       Show help                                      [boolean]
  -l, --list                       list                                            [string]
  -i, --id                         id                                              [string]
  -r, --reportID                   Report id                                       [string]
  -v, --version                    Show version number                            [boolean]
  -e, --ignore-encrypted-secrets   Ignore encrypted secrets for promotion         [boolean]
  -p, --promoter                   Name of promotion initiator                     [string]
  -c, --description                Description                                     [string]
  -t, --ticket-reference           Ticket reference                                [string]
  -u, --unlock-after               Unlock after successful promotion              [boolean]
  -D, --debug                      Run with debug output                          [boolean]
  -R, --retries                    Retry HTTP connections <n> times on failure     [number]
  -I, --retry-interval             Seconds to wait between retries                 [number]
  -H, --configuration-header-overrides  Configuration management header
                                        overrides                                  [string]
```

Notes on specific options:

`fr-config-promote check-promotion-reports`

The `--list` option can be used with the `check-promotion-reports` command to list all the promotion reports.

```
fr-config-promote check-promotion-reports --list
```

The `--reportID` option can be used with the `check-promotion-reports` command to view a specific report.

```
fr-config-promote check-promotion-reports --id "bb96cada-aeca-4c75-bede-5e1e3258b5bb"
```

## Quickstart

To perform a promotion, perform the following steps

- Make sure there isn't an existing promotion running

```
$ fr-config-promote check-promotion-status
{
  blockingError: false,
  globalLock: 'UNLOCKED',
  message: 'Environment unlocked',
  status: 'UNLOCKED',
  timeStamp: '2024-07-14T17:40:48Z',
  type: 'promotion'
}
```

- Lock tenants

```
$ fr-config-promote lock-tenants
Waiting for tenants to lock
{
  status: 'locked',
  Promotionid: '60712afb-af2c-4ca9-9e1e-fdae60b777eb'
}
```

- Kick off the promotion

```
$ fr-config-promote run-promotion
{ result: 'Promotion process initiated successfully' }
```

- Check the promotion status

```
fr-config-promote check-promotion-status
{
  blockingError: false,
  globalLock: 'LOCKED',
  message: 'Update configuration',
  promotionId: '60712afb-af2c-4ca9-9e1e-fdae60b777eb',
  status: 'RUNNING',
  timeStamp: '2024-07-14T18:07:47Z',
  type: 'promotion'
}
```

Keep checking until complete

```
$ fr-config-promote check-promotion-status
{
  blockingError: false,
  globalLock: 'LOCKED',
  message: 'Promotion completed',
  promotionId: '60712afb-af2c-4ca9-9e1e-fdae60b777eb',
  status: 'READY',
  timeStamp: '2024-07-14T18:18:12Z',
  type: 'promotion'
}
```

- Don't forget to unlock (if not using the `--unlock-after` option)

```
$ fr-config-promote  unlock-tenants -i 60712afb-af2c-4ca9-9e1e-fdae60b777eb
Waiting for tenants to unlock
{ status: 'unlocked' }
```