summaryrefslogtreecommitdiffstats
path: root/ipatests/man
diff options
context:
space:
mode:
authorPetr Viktorin <pviktori@redhat.com>2013-12-12 10:19:56 +0100
committerPetr Viktorin <pviktori@redhat.com>2014-03-05 10:00:58 +0100
commit87a36db6bcb701048228402887ed0c97c6fee70e (patch)
tree58b0b86e83b2af35fb91fb9e1a5417d3a063d4a5 /ipatests/man
parent2150481f2aa9615c7ae89af8501831a37be9d660 (diff)
downloadfreeipa-87a36db6bcb701048228402887ed0c97c6fee70e.tar.gz
freeipa-87a36db6bcb701048228402887ed0c97c6fee70e.tar.xz
freeipa-87a36db6bcb701048228402887ed0c97c6fee70e.zip
ipa-test-config: Add --json and --yaml output options
Also update the man page. Part of the work for: https://fedorahosted.org/freeipa/ticket/3938 Reviewed-By: Tomas Babej <tbabej@redhat.com>
Diffstat (limited to 'ipatests/man')
-rw-r--r--ipatests/man/ipa-test-config.125
1 files changed, 24 insertions, 1 deletions
diff --git a/ipatests/man/ipa-test-config.1 b/ipatests/man/ipa-test-config.1
index 317bd40d8..320d1fe1f 100644
--- a/ipatests/man/ipa-test-config.1
+++ b/ipatests/man/ipa-test-config.1
@@ -30,7 +30,7 @@ The FreeIPA integration test suite is configured by setting environment
variables.
The ipa\-run\-tests command reads these variables and prints detailed
configuration for shell-based scripts to standard output.
-The output of ipa\-run\-tests consists of export statements that can be
+The default output of ipa\-run\-tests consists of export statements that can be
sourced by Bash.
If run without arguments, it prints out configuration specific to the local
@@ -68,10 +68,33 @@ Output configuration for the host with the given role.
\fB\-\-no\-simple\fR
Do not output Simple Vars.
These are normally included for backwards compatibility.
+.TP
+\fB\-\-yaml\fR
+Output configuration in YAML format instead of Bash script.
+This requires the PyYAML library to be installed.
+.TP
+\fB\-\-json\fR
+Output configuration in JSON format instead of Bash script.
.SH "ENVIRONMENT VARIABLES"
.TP
+File\-based configuration:
+
+.TP
+\fB$IPATEST_YAML_CONFIG\fR
+ Specifies a file that contains configuration in YAML format,
+ as given by \fBipa\-test\-config \-\-global \-\-yaml\fR.
+ If given, the other environment variables are ignored.
+ This requires the PyYAML library to be installed.
+
+.TP
+\fB$IPATEST_JSON_CONFIG\fR
+ Specifies a file that contains configuration in JSON format,
+ as given by \fBipa\-test\-config \-\-global \-\-json\fR.
+ If given, the other environment variables are ignored.
+
+.TP
Domain configuration:
Domain is implicitly defined by _envX suffix of the environment variables,
if either AD_envX or MASTER_envX is defined.