Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@
{% include "../../../../../includes/deploy/ctl-tool/propagate-between-child-organizations.md" %}
{% include "../../../../../includes/deploy/ctl-tool/customization-options.md" %}
{% include "../../../../../includes/deploy/ctl-tool/logging.md" %}
{% include "../../../../../includes/deploy/ctl-tool/dryRun-mode.md" %}
{% include "../../../../../includes/deploy/ctl-tool/resource-specific-notes.md" %}
32 changes: 32 additions & 0 deletions en/identity-server/5.11.0/docs/setup/promote-configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,3 +183,35 @@ Add a `LOGS` block to your `toolConfig.json` to configure logging behavior:

!!! warning "Sensitive data in request payloads"
Request bodies may contain sensitive credentials (client secrets, passwords, access tokens). Enabling `LOG_REQUEST_PAYLOADS` will write these values to your log output. Only enable this option in secure, non-production environments, and ensure log files are adequately protected.

## Dry-run mode

Dry-run mode lets you preview what `importAll` or `exportAll` would do without modifying the server or deleting any local files.

### Usage

Pass the `--dryRun` (`-d`) flag to either command:

#### Import

```bash
iamctl importAll --config ./env --dryRun
```

#### Export

```bash
iamctl exportAll --config ./env --dryRun
```

### Behavior

In dry-run mode, all mutating operations (POST, PUT, PATCH, DELETE) are skipped and logged with a `[DRY RUN] Would <METHOD> <url>` message instead of being sent to the server:

#### Sample log output

```bash
[DRY RUN] Would POST https://localhost:9443/api/server/v1/applications
```

During import, no resources are created, updated, or deleted on the server. During export, resources are still fetched and written to disk, but stale local files and directories are left in place. The end-of-run summary reports `Would Import`, `Would Update`, and `Would Delete` counts in place of the applied counts.
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@
{% include "../../../../includes/deploy/ctl-tool/propagate-between-child-organizations.md" %}
{% include "../../../../includes/deploy/ctl-tool/customization-options.md" %}
{% include "../../../../includes/deploy/ctl-tool/logging.md" %}
{% include "../../../../includes/deploy/ctl-tool/dryRun-mode.md" %}
{% include "../../../../includes/deploy/ctl-tool/resource-specific-notes.md" %}
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@
{% include "../../../../includes/deploy/ctl-tool/propagate-between-child-organizations.md" %}
{% include "../../../../includes/deploy/ctl-tool/customization-options.md" %}
{% include "../../../../includes/deploy/ctl-tool/logging.md" %}
{% include "../../../../includes/deploy/ctl-tool/dryRun-mode.md" %}
{% include "../../../../includes/deploy/ctl-tool/resource-specific-notes.md" %}
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@
{% include "../../../../includes/deploy/ctl-tool/propagate-between-child-organizations.md" %}
{% include "../../../../includes/deploy/ctl-tool/customization-options.md" %}
{% include "../../../../includes/deploy/ctl-tool/logging.md" %}
{% include "../../../../includes/deploy/ctl-tool/dryRun-mode.md" %}
{% include "../../../../includes/deploy/ctl-tool/resource-specific-notes.md" %}
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@
{% include "../../../../includes/deploy/ctl-tool/propagate-between-child-organizations.md" %}
{% include "../../../../includes/deploy/ctl-tool/customization-options.md" %}
{% include "../../../../includes/deploy/ctl-tool/logging.md" %}
{% include "../../../../includes/deploy/ctl-tool/dryRun-mode.md" %}
{% include "../../../../includes/deploy/ctl-tool/resource-specific-notes.md" %}
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@
{% include "../../../../includes/deploy/ctl-tool/propagate-between-child-organizations.md" %}
{% include "../../../../includes/deploy/ctl-tool/customization-options.md" %}
{% include "../../../../includes/deploy/ctl-tool/logging.md" %}
{% include "../../../../includes/deploy/ctl-tool/dryRun-mode.md" %}
{% include "../../../../includes/deploy/ctl-tool/resource-specific-notes.md" %}
29 changes: 29 additions & 0 deletions en/includes/deploy/ctl-tool/dryRun-mode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## Dry-run mode

Dry-run mode lets you preview what `importAll` or `exportAll` would do without modifying the server or deleting any local files.

### Usage

Pass the `--dryRun` (`-d`) flag to either command:

=== "Import"

```bash
iamctl importAll --config ./env --dryRun
```

=== "Export"

```bash
iamctl exportAll --config ./env --dryRun
```

### Behavior

In dry-run mode, all mutating operations (POST, PUT, PATCH, DELETE) are skipped and logged with a `[DRY RUN] Would <METHOD> <url>` message instead of being sent to the server:

```bash title="Sample log output"
[DRY RUN] Would POST https://localhost:9443/api/server/v1/applications
```

During import, no resources are created, updated, or deleted on the server. During export, resources are still fetched and written to disk, but stale local files and directories are left in place. The end-of-run summary reports `Would Import`, `Would Update`, and `Would Delete` counts in place of the applied counts.
Loading