Created
July 16, 2014 20:22
-
-
Save markllama/5b2bb1a2dd31315f9794 to your computer and use it in GitHub Desktop.
Katello Installer Help and Options
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Usage: | |
| katello-installer [OPTIONS] | |
| Options: | |
| = Generic: | |
| --reset This option will drop the Katello database and clear all subsequent backend data stores.You will lose all data! Unfortunately we | |
| can't detect a failure at the moment so you should verify the success | |
| manually. e.g. dropping can fail when DB is currently in use. (default: false) | |
| --[no-]colors Use color output on STDOUT (default: true) | |
| --color-of-background COLOR Your terminal background is :bright or :dark (default: :dark) | |
| -d, --dont-save-answers Skip saving answers to '/etc/katello-installer/answers.katello-installer.yaml'? (default: false) | |
| --ignore-undocumented Ignore inconsistent parameter documentation (default: false) | |
| -i, --interactive Run in interactive mode | |
| --log-level LEVEL Log level for log file output (default: :debug) | |
| -n, --noop Run puppet in noop mode? (default: false) | |
| -v, --verbose Display log on STDOUT instead of progressbar | |
| -l, --verbose-log-level LEVEL Log level for verbose mode output (default: "info") | |
| -h, --help print help | |
| --full-help print complete help | |
| --[no-]enable-capsule Enable 'capsule' puppet module (default: true) | |
| --[no-]enable-certs Enable 'certs' puppet module (default: true) | |
| --[no-]enable-foreman Enable 'foreman' puppet module (default: true) | |
| --[no-]enable-foreman-plugin-bootdisk Enable 'foreman_plugin_bootdisk' puppet module (default: true) | |
| --[no-]enable-foreman-plugin-chef Enable 'foreman_plugin_chef' puppet module (default: false) | |
| --[no-]enable-foreman-plugin-default-hostgroup Enable 'foreman_plugin_default_hostgroup' puppet module (default: false) | |
| --[no-]enable-foreman-plugin-discovery Enable 'foreman_plugin_discovery' puppet module (default: true) | |
| --[no-]enable-foreman-plugin-hooks Enable 'foreman_plugin_hooks' puppet module (default: true) | |
| --[no-]enable-foreman-plugin-puppetdb Enable 'foreman_plugin_puppetdb' puppet module (default: false) | |
| --[no-]enable-foreman-plugin-setup Enable 'foreman_plugin_setup' puppet module (default: false) | |
| --[no-]enable-foreman-plugin-templates Enable 'foreman_plugin_templates' puppet module (default: false) | |
| --[no-]enable-katello Enable 'katello' puppet module (default: true) | |
| = Module capsule: | |
| --capsule-certs-tar path to a tar with certs for the node (default: nil) | |
| --capsule-dhcp Use DHCP (default: false) | |
| --capsule-dhcp-gateway DHCP pool gateway (default: "192.168.100.1") | |
| --capsule-dhcp-interface DHCP listen interface (default: "eth0") | |
| --capsule-dhcp-nameservers DHCP nameservers (default: "default") | |
| --capsule-dhcp-range Space-separated DHCP pool range (default: false) | |
| --capsule-dns Use DNS (default: false) | |
| --capsule-dns-forwarders DNS forwarders (default: ["capsule::params::dns_forwarders"]) | |
| --capsule-dns-interface DNS interface (default: "eth0") | |
| --capsule-dns-reverse DNS reverse zone name (default: "100.168.192.in-addr.arpa") | |
| --capsule-dns-zone DNS zone name (default: "cloud.lab.eng.bos.redhat.com") | |
| --capsule-foreman-oauth-effective-user User to be used for Foreman REST interaction (default: "admin") | |
| --capsule-foreman-oauth-key OAuth key to be used for Foreman REST interaction (default: "WTKxerYQaVbKsprzgSPVRAj8EPCStgx8") | |
| --capsule-foreman-oauth-secret OAuth secret to be used for Foreman REST interaction (default: "KEoUXiFnYQ6BnP4y86B9W5YFTGXkN5db") | |
| --capsule-foreman-proxy-port Port on which will foreman proxy listen (default: 9090) | |
| --capsule-freeipa-remove-dns Remove DNS entries from FreeIPA when deleting hosts from realm (default: true) | |
| --capsule-parent-fqdn fqdn of the parent node. REQUIRED (default: "blade13.cloud.lab.eng.bos.redhat.com") | |
| --capsule-pulp should Pulp be configured on the node (default: false) | |
| --capsule-pulp-admin-password passowrd for the Pulp admin user.It should be left blank so that random password is generated (default: "BCneQN3yBDFLn6A3o6oX8LXucXuAfhj5") | |
| --capsule-pulp-oauth-effective-user User to be used for Pulp REST interaction (default: "admin") | |
| --capsule-pulp-oauth-key OAuth key to be used for Pulp REST interaction (default: "katello") | |
| --capsule-pulp-oauth-secret OAuth secret to be used for Pulp REST interaction (default: nil) | |
| --capsule-puppet Use puppet (default: true) | |
| --capsule-puppetca Use puppet ca (default: true) | |
| --capsule-realm Use realm management (default: false) | |
| --capsule-realm-keytab Kerberos keytab path to authenticate realm updates (default: "/etc/foreman-proxy/freeipa.keytab") | |
| --capsule-realm-principal Kerberos principal for realm updates (default: "realm-proxy@EXAMPLE.COM") | |
| --capsule-realm-provider Realm management provider (default: "freeipa") | |
| --capsule-register-in-foreman Register proxy back in Foreman (default: true) | |
| --capsule-tftp Use TFTP (default: false) | |
| --capsule-tftp-servername Defines the TFTP server name to use, overrides the name in the subnet declaration (default: "10.19.137.243") | |
| = Module certs: | |
| --certs-ca-common-name Common name for the generated CA certificate (default: "blade13.cloud.lab.eng.bos.redhat.com") | |
| --certs-ca-expiration Ca expiration attribute for managed certificates (default: "36500") | |
| --certs-city City attribute for managed certificates (default: "Raleigh") | |
| --certs-country Country attribute for managed certificates (default: "US") | |
| --certs-default-ca-name The name of the default CA; | |
| default 'katello' (default: "katello-ca") | |
| --certs-deploy Deploy the certs on the configured system. False means | |
| we want apply it on a different system (default: true) | |
| --certs-expiration Expiration attribute for managed certificates (default: "365") | |
| --certs-generate Should the generation of the certs be part of the | |
| configuration (default: true) | |
| --certs-group The group who should own the certs; | |
| default 'foreman' (default: "foreman") | |
| --certs-log-dir When the log files should go (default: "/var/log/certs") | |
| --certs-node-fqdn The fqdn of the host the generated certificates | |
| should be for (default: "blade13.cloud.lab.eng.bos.redhat.com") | |
| --certs-org Org attribute for managed certificates (default: "SomeOrg") | |
| --certs-org-unit Org unit attribute for managed certificates (default: "SomeOrgUnit") | |
| --certs-password-file-dir The location to store password files (default: "certs::params::password_file_dir") | |
| --certs-pki-dir The PKI directory under which to place certs (default: "/etc/pki/katello") | |
| --certs-regenerate Force regeneration of the certificates (excluding | |
| ca certificates) (default: false) | |
| --certs-regenerate-ca Force regeneration of the ca certificate (default: false) | |
| --certs-ssl-build-dir The directory where SSL keys, certs and RPMs will be generated (default: "/root/ssl-build") | |
| --certs-state State attribute for managed certificates (default: "North Carolina") | |
| --certs-user The system user name who should own the certs; | |
| default 'foreman' (default: "root") | |
| = Module foreman: | |
| --foreman-app-root Name of foreman root directory (default: "/usr/share/foreman") | |
| --foreman-authentication Enable users authentication (default user:admin pw:changeme) (default: true) | |
| --foreman-configure-epel-repo If disabled the EPEL repo will not be configured on RedHat family systems. (default: false) | |
| --foreman-configure-scl-repo If disabled the the SCL repo will not be configured on Red Hat clone systems. | |
| (Currently only installs repos for CentOS and Scientific) (default: false) | |
| --foreman-custom-repo No need to change anything here by default | |
| if set to true, no repo will be added by this module, letting you to | |
| set it to some custom location. (default: true) | |
| --foreman-db-adapter Database 'production' adapter (default: nil) | |
| --foreman-db-database Database 'production' database (e.g. foreman) (default: nil) | |
| --foreman-db-host Database 'production' host (default: nil) | |
| --foreman-db-manage if enabled, will install and configure the database server on this host (default: true) | |
| --foreman-db-password Database 'production' password (default is random) (default: "aEDZxW8M5khErZSj2xuMt3xZxnmAVCGR") | |
| --foreman-db-port Database 'production' port (default: nil) | |
| --foreman-db-sslmode Database 'production' ssl mode (default: nil) | |
| --foreman-db-type Database 'production' type (valid types: mysql/postgresql/sqlite) (default: "postgresql") | |
| --foreman-db-username Database 'production' user (e.g. foreman) (default: "foreman") | |
| --foreman-environment Rails environment of foreman (default: "production") | |
| --foreman-foreman-url URL on which foreman is going to run (default: "https://blade13.cloud.lab.eng.bos.redhat.com") | |
| --foreman-gpgcheck turn on/off gpg check in repo files (effective only on RedHat family systems) (default: true) | |
| --foreman-group Primary group for the Foreman user (default: "foreman") | |
| --foreman-locations-enabled Enable locations? (default: true) | |
| --foreman-oauth-active Enable OAuth authentication for REST API (default: true) | |
| --foreman-oauth-consumer-key OAuth consumer key (default: "WTKxerYQaVbKsprzgSPVRAj8EPCStgx8") | |
| --foreman-oauth-consumer-secret OAuth consumer secret (default: "KEoUXiFnYQ6BnP4y86B9W5YFTGXkN5db") | |
| --foreman-oauth-map-users Should foreman use the foreman_user header to identify API user? (default: true) | |
| --foreman-organizations-enabled Enable organizations? (default: true) | |
| --foreman-passenger Configure foreman via apache and passenger (default: true) | |
| --foreman-passenger-interface Defines which network interface passenger should listen on, undef means all interfaces (default: "") | |
| --foreman-passenger-min-instances Minimum passenger worker instances to keep when application is idle. (default: "1") | |
| --foreman-passenger-prestart Pre-start the first passenger worker instance process during httpd start. (default: true) | |
| --foreman-passenger-scl Software collection name (on RHEL currently 'ruby193', undef on others) (default: "ruby193") | |
| --foreman-passenger-start-timeout Amount of seconds to wait for Ruby application boot. (default: "600") | |
| --foreman-puppet-home Puppet home directory (default: "/var/lib/puppet") | |
| --foreman-repo This can be stable, rc, or nightly (default: "stable") | |
| --foreman-selinux when undef, foreman-selinux will be installed if SELinux is enabled | |
| setting to false/true will override this check (e.g. set to false on 1.1) (default: nil) | |
| --foreman-server-ssl-ca Defines Apache mod_ssl SSLCACertificateFile setting in Foreman vhost conf file. (default: "/etc/pki/katello/certs/katello-ca.crt") | |
| --foreman-server-ssl-cert Defines Apache mod_ssl SSLCertificateFile setting in Foreman vhost conf file. (default: "/etc/pki/katello/certs/katello-apache.crt") | |
| --foreman-server-ssl-chain Defines Apache mod_ssl SSLCertificateChainFile setting in Foreman vhost conf file. (default: "/etc/pki/katello/certs/katello-ca.crt") | |
| --foreman-server-ssl-key Defines Apache mod_ssl SSLCertificateKeyFile setting in Foreman vhost conf file. (default: "/etc/pki/katello/private/katello-apache.key") | |
| --foreman-ssl Enable and set require_ssl in Foreman settings (note: requires passenger, SSL does not apply to kickstarts) (default: true) | |
| --foreman-unattended Should foreman manage host provisioning as well (default: true) | |
| --foreman-use-vhost Enclose apache configuration in <VirtualHost>...</VirtualHost> (default: true) | |
| --foreman-user User under which foreman will run (default: "foreman") | |
| --foreman-user-groups Additional groups for the Foreman user (default: ["puppet"]) | |
| --foreman-version foreman package version, it's passed to ensure parameter of package resource | |
| can be set to specific version number, 'latest', 'present' etc. (default: "present") | |
| = Module foreman_plugin_discovery: | |
| --foreman-plugin-discovery-initrd name of initrd image file (default: "foreman-discovery-image-latest.el6.iso-img") | |
| --foreman-plugin-discovery-install-images should the installer download and setup discovery images | |
| for you? the average size is few hundreds of MB (default: false) | |
| --foreman-plugin-discovery-kernel name of kernel file (default: "foreman-discovery-image-latest.el6.iso-vmlinuz") | |
| --foreman-plugin-discovery-source mirror url from which the image files should be obtained, you | |
| can use http(s):// or file:// (default: "http://yum.theforeman.org/discovery/releases/latest/") | |
| --foreman-plugin-discovery-version version string of discovery image, in form of x.y.z-r (default: "latest") | |
| = Module katello: | |
| --katello-config-dir Location for Katello config files (default: "/etc/foreman/plugins") | |
| --katello-group The Katello system user group; | |
| default 'foreman' (default: "foreman") | |
| --katello-log-dir Location for Katello log files to be placed (default: "/var/log/foreman/plugins") | |
| --katello-oauth-key The oauth key for talking to the candlepin API; | |
| default 'katello' (default: "katello") | |
| --katello-oauth-secret The oauth secret for talking to the candlepin API; (default: "WxTksTavAMbYadhgw6AcLCLtJCkKTmXr") | |
| --katello-post-sync-token The shared secret for pulp notifying katello about | |
| completed syncs (default: "YfHByY5zYabtEUiFV5qGXGQcJNpiai4c") | |
| --katello-proxy-password Proxy password for authentication (default: nil) | |
| --katello-proxy-port Port the proxy is running on (default: nil) | |
| --katello-proxy-url URL of the proxy server (default: nil) | |
| --katello-proxy-username Proxy username for authentication (default: nil) | |
| --katello-use-passenger Whether Katello is being deployed with Passenger; | |
| default true (default: true) | |
| --katello-user The Katello system user name; | |
| default 'foreman' (default: "foreman") | |
| --katello-user-groups Extra user groups the Katello user is a part of; | |
| default 'foreman (default: "foreman") |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment