Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1351677

Summary: [Doc][REST-API] - Addition of new hosted-engine host via REST-API documentation is missing.
Product: Red Hat Enterprise Virtualization Manager Reporter: Nikolai Sednev <nsednev>
Component: DocumentationAssignee: rhev-docs <rhev-docs>
Status: CLOSED CURRENTRELEASE QA Contact: rhev-docs <rhev-docs>
Severity: high Docs Contact:
Priority: unspecified    
Version: 4.0.0CC: adahms, bugs, lbopf, lsurette, mavital, oourfali, rbalakri, srevivo, ykaul, ylavi
Target Milestone: ovirt-4.0.7   
Target Release: ---   
Hardware: x86_64   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-05-23 07:57:37 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: Docs RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 1148393, 1255230    

Description Nikolai Sednev 2016-06-30 14:38:16 UTC
Description of problem:
Please add documentation for how to deploy, undeploy the hosted engine host using REST-API.
I did not found it in here https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.0/html-single/REST_API_Guide/#sect-REST_API_Guide-Hosts-Memory_Management

Version-Release number of selected component (if applicable):
Currently in order to deploy hosted-engine-host using REST-API, customer will need:

POST https://FQDN_of_the_engine_here/ovirt-engine/api/hosts/;deploy_hosted_engine=true

Headers:

Header name:     Header value:
Accept	         application/xml
Content-type	 application/xml
 
Body:
<host>
  <name>FQDN_of_the_added_host_here</name>
  <address>FQDN_of_the_added_host_here</address>
  <comment>FQDN_of_the_added_host_here</comment>
  <root_password>somepasswordhere</root_password>
</host>

To change hosted-engine-host back in to regular host user will have to:
POST https://FQDN_of_the_engine_here/ovirt-engine/api/hosts/;undeploy_hosted_engine=true

Headers:

Header name:     Header value:
Accept	         application/xml
Content-type	 application/xml
 
Body:
<host>
  <name>FQDN_of_the_added_host_here</name>
  <address>FQDN_of_the_added_host_here</address>
  <comment>FQDN_of_the_added_host_here</comment>
  <root_password>somepasswordhere</root_password>
</host>

Version-Release number of selected component (if applicable):
Engine:
rhevm-doc-4.0.0-2.el7ev.noarch
rhevm-setup-plugins-4.0.0.1-1.el7ev.noarch
rhevm-spice-client-x64-msi-4.0-2.el7ev.noarch
rhevm-4.0.0.6-0.1.el7ev.noarch
rhev-release-4.0.0-19-001.noarch
rhevm-guest-agent-common-1.0.12-2.el7ev.noarch
rhevm-dependencies-4.0.0-1.el7ev.noarch
rhevm-branding-rhev-4.0.0-2.el7ev.noarch
rhevm-spice-client-x86-msi-4.0-2.el7ev.noarch
rhev-guest-tools-iso-4.0-2.el7ev.noarch
Linux version 3.10.0-327.22.2.el7.x86_64 (mockbuild.eng.bos.redhat.com) (gcc version 4.8.5 20150623 (Red Hat 4.8.5-4) (GCC) ) #1 SMP Thu Jun 9 10:09:10 EDT 2016
Linux 3.10.0-327.22.2.el7.x86_64 #1 SMP Thu Jun 9 10:09:10 EDT 2016 x86_64 x86_64 x86_64 GNU/Linux
Red Hat Enterprise Linux Server release 7.2 (Maipo)


Host:
mom-0.5.4-1.el7ev.noarch
ovirt-hosted-engine-ha-2.0.0-1.el7ev.noarch
ovirt-vmconsole-host-1.0.3-1.el7ev.noarch
ovirt-setup-lib-1.0.2-1.el7ev.noarch
qemu-kvm-rhev-2.3.0-31.el7_2.16.x86_64
libvirt-client-1.2.17-13.el7_2.5.x86_64
ovirt-engine-sdk-python-3.6.7.0-1.el7ev.noarch
rhev-release-4.0.0-19-001.noarch
ovirt-hosted-engine-setup-2.0.0.2-1.el7ev.noarch
ovirt-vmconsole-1.0.3-1.el7ev.noarch
vdsm-4.18.4-2.el7ev.x86_64
ovirt-host-deploy-1.5.0-1.el7ev.noarch
sanlock-3.2.4-2.el7_2.x86_64
Linux version 3.10.0-327.22.2.el7.x86_64 (mockbuild.eng.bos.redhat.com) (gcc version 4.8.5 20150623 (Red Hat 4.8.5-4) (GCC) ) #1 SMP Thu Jun 9 10:09:10 EDT 2016
Linux 3.10.0-327.22.2.el7.x86_64 #1 SMP Thu Jun 9 10:09:10 EDT 2016 x86_64 x86_64 x86_64 GNU/Linux
Red Hat Enterprise Linux Server release 7.2 (Maipo)


How reproducible:
100%

Steps to Reproduce:
1.Deploy hosted-engine over NFS or iSCSI or any other supported storage solutions on one host.
2.Add additional hosted-engine-host using REST-API.
3.

Actual results:
The documentation is missing.

Expected results:
Documentation should be provided.

Additional info:
Official documentation is missing this new functionality: https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.0/html-single/REST_API_Guide/#sect-REST_API_Guide-Hosts-Memory_Management , please consider on modifying our documentation accordingly.

Comment 1 Lucy Bopf 2016-08-10 22:23:50 UTC
Updating Product, Assignee, and QE Contact to downstream documentation defaults.