Bug 1379977 - Lack of appliance_console_cli documentation
Summary: Lack of appliance_console_cli documentation
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat CloudForms Management Engine
Classification: Red Hat
Component: Documentation
Version: 5.6.0
Hardware: x86_64
OS: Linux
high
high
Target Milestone: GA
: 5.7.0
Assignee: Suyog Sainkar
QA Contact: Chris Budzilowicz
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-09-28 10:00 UTC by Victor Estival
Modified: 2020-03-11 15:16 UTC (History)
15 users (show)

Fixed In Version:
Doc Type: Release Note
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-02-23 05:55:43 UTC
Category: ---
Cloudforms Team: Unknown
Target Upstream Version:


Attachments (Terms of Use)

Description Victor Estival 2016-09-28 10:00:46 UTC
Document URL: https://access.redhat.com/documentation/en/red-hat-cloudforms/4.1/single/general-configuration/#configuration

Section Number and Name: Section 4 (4.1.4.2.8. External Authentication (httpd))

Describe the issue: There is no specific documentation for appliance_console_cli

When executed from the appliance it gives:

[root@cloudforms log]# appliance_console_cli --help
Usage: appliance_console_cli [options]
  -H, --host=<s>                /etc/hosts name
  -r, --region=<i>              Region Number
  -i, --internal                Internal Database
  -h, --hostname=<s>            Database Hostname
  -U, --username=<s>            Database Username (default: root)
  -p, --password=<s>            Database Password
  -d, --dbname=<s>              Database Name (default: vmdb_production)
  -k, --key                     Create encryption key
  -K, --fetch-key=<s>           SSH host with encryption key
  -f, --force-key               Forcefully create encryption key
  -s, --sshlogin=<s>            SSH login (default: root)
  -a, --sshpassword=<s>         SSH password
  -v, --verbose                 Verbose
  -b, --dbdisk=<s>              Database Disk Path
  -t, --tmpdisk=<s>             Temp storage Disk Path
  -u, --uninstall-ipa           Uninstall IPA Client
  -e, --ipaserver=<s>           IPA Server FQDN
  -n, --ipaprincipal=<s>        IPA Server principal (default: admin)
  -w, --ipapassword=<s>         IPA Server password
  -o, --ipadomain=<s>           IPA Server domain (optional)
  -l, --iparealm=<s>            IPA Server realm (optional)
  -c, --ca=<s>                  CA name used for certmonger (default: ipa)
  -g, --postgres-client-cert    install certs for postgres client
  --postgres-server-cert        install certs for postgres server
  --http-cert                   install certs for http server
  -x, --extauth-opts=<s>        External Authentication Options
  --help                        Show this message

Suggestions for improvement: Document appliance_console_cli deeper

Additional information: 


Document URL: 

Section Number and Name: 

Describe the issue: 

Suggestions for improvement: 

Additional information:

Comment 2 Tsai Li Ming 2016-09-28 14:09:42 UTC
I find no documentation on "7) Restore Database From Backup". With a new appliance setup, it failed on me because postgres wasn't running.

Comment 3 Edu Alcaniz 2016-11-17 11:53:40 UTC
Could you update the status on the documentation?

Comment 5 Andrew Dahms 2016-11-29 11:13:58 UTC
Hi Edu,

Thank you for the needinfo request, and my apologies for the delay in getting back to you.

Unfortunately, we have not been able to make progress on this request yet due to the need to focus on content for the upcoming 4.2 release, but we understand that this is an important topic, and are currently discussing when we will be able to provide some updates.

I will keep in touch with you as we proceed.

Kind regards,

Andrew

Comment 7 Andrew Dahms 2017-01-12 22:58:57 UTC
Assigning to Suyog for review.

Suyog - this might be best positioned as an appendix to the installation documentation, and I imagine we need a general introduction with a number of examples of usage.

Reach out to Edu for clarification and review as needed.

Comment 8 Edu Alcaniz 2017-01-23 11:20:53 UTC
Hi, it seems that the documentation of appliance_console_cli  is very poor. Customer request a deep explanation of options, how works, .. configurations. ..

Comment 11 Marianne Feifer 2017-01-24 15:34:20 UTC
Suyog, I agreed with Andrew regarding an appendix or KB on this.

I "thought" that most of the items in the appliance_console_cli are also available in the black appliance on the console.

I'm sending a NeedInfo to Nick as I think he is probably the best one to answer your question.

Comment 12 Nick Carboni 2017-01-24 16:08:55 UTC
Right now the appliance_console_cli is a subset of the full functionality of the appliance_console itself.

It mostly covers the functions most likely to be scripted. There is an RFE to gain parity https://bugzilla.redhat.com/show_bug.cgi?id=1385697

Database configuration options
--region (-r) create a new region in the database (requires database credentials passed)
--internal (-i) create a database on the current appliance
--dbdisk database disk device path (for configuring an internal database)
--hostname (-h) database hostname
--port database port (defaults to 5432)
--username (-U) database username (defaults to root)
--password (-p) database password
--dbname (-d) database name (defaults to vmdb_production)

v2_key options
--key (-k) create a new v2_key
--fetch_key (-K) fetch the v2_key from the given host
--force_key (-f) create or fetch the key even if one exists
--sshlogin ssh username for fetching the v2_key (defaults to root)
--sshpassword ssh password for fetching the v2_key

Other options 
--tmpdisk Initialize the given device for temp storage (volume mounted at /var/www/miq_tmp)
--host (-H) set the appliance hostname to the given name
--verbose (-v) print more debugging info

A typical usage for some of these cases could be:

`appliance_console_cli --internal --dbdisk /dev/sdb --region 0 --password smartvm` to create a new database locally on the server using /dev/sdb

`appliance_console_cli --fetch_key some.example.com --sshlogin root --sshpassword smartvm` to copy the v2_key from some.host.com to this machine.

You could even combine the two to join a region where db.example.com is the appliance hosting the database:
`appliance_console_cli --fetch_key db.example.com --sshlogin root --sshpassword smartvm --hostname db.example.com --password mydatabasepassword`

I'm not as familiar with the other options, you may need to talk to Alberto or JoeV about the ipa/external auth bits and maybe Keenan about the certs.


Note You need to log in before you can comment on or make changes to this bug.