Skip to content

Commit

Permalink
ninja: more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
1azyman committed Feb 29, 2024
1 parent d97250f commit 0b4f0c3
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/deployment/ninja/command/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Ninja commands
:page-nav-title: Commands

Ninja currently supports these operations:

Expand Down
25 changes: 24 additions & 1 deletion docs/deployment/ninja/command/info.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,26 @@
= Info

#TODO#
`info` command prints the information about the current midPoint repository implementation and connection details.

.Sample output of info command
[source,sh]
----
$ ./bin/ninja.sh info
MidPoint home: /opt/midpoint-home/
Java home: /Library/Java/JavaVirtualMachines/temurin-17.jdk/Contents/Home
Repository test: SUCCESS
Repository diag:
Type: Native
Description: Implementation that stores data in PostgreSQL database using JDBC with Querydsl.
JDBC URL: jdbc:postgresql://localhost:5432/midpoint
Driver type: org.postgresql.Driver
Driver version: 42.5
Additional details:
- clientInfo.ApplicationName: mp-repo
- dataSource: null
- schemaAuditChangeNumber: 7
- schemaChangeNumber: 26
- select-1-round-trip-ms: 1
- transactionIsolation: TRANSACTION_READ_COMMITTED (read from connection)
----
12 changes: 11 additions & 1 deletion docs/deployment/ninja/command/trace.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
= Trace

#TODO#
`trace` command can print details about trace `zip` file defined by `--input` options and using `--print-stat` option or more detailed information using `--print-stat-extra` option.

This command can also modify trace file and filter out (remove) operation results.
`--keep` options will keep specified operation results.
Asterisk is allowed.
All above them will be removed.
`--kill` to remove operation results (with their children).
Asterisk is allowed.

Use `--output` option to specify the output file name.
Default value is `output.zip`.
10 changes: 10 additions & 0 deletions docs/deployment/ninja/command/upgrade-objects.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
= Upgrade objects

Command `upgrade-objects` can be used to _upgrade_ objects to get rid deprecated or obsolete items and configuration.
This operation can use CSV output file of `verify` command.

.Example of command that upgrades objects, also with
[source,bash]
----
./bin/ninja.sh upgrade-objects \
--verification-file verify-output.csv
----

#TODO#
2 changes: 1 addition & 1 deletion docs/deployment/ninja/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ However, this is not recommended and not supported.

Raw option will tell ninja to export objects together with their definitions if needed.
These definitions are used to import objects back to midPoint.
For more information see <<Export>>.
For more information see xref:./command/export.adoc[].

== Full help

Expand Down

0 comments on commit 0b4f0c3

Please sign in to comment.