Bug 1619539

Summary: [Docs][Octavia] Document API call to see LBs image version and release
Product: Red Hat OpenStack Reporter: Lucy Bopf <lbopf>
Component: documentationAssignee: Joanne O'Flynn <joflynn>
Status: CLOSED CURRENTRELEASE QA Contact: James Smith <jamsmith>
Severity: medium Docs Contact:
Priority: medium    
Version: 14.0 (Rocky)CC: cgoncalves, dcadzow, joflynn, sclewis, srevivo
Target Milestone: betaKeywords: Documentation, FutureFeature, Reopened, Triaged
Target Release: 14.0 (Rocky)   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Enhancement
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2019-01-11 12:00:30 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On: 1536970    
Bug Blocks:    

Description Lucy Bopf 2018-08-21 07:14:18 UTC
Name of function:
API call to see LBs image version and release

User story:
N/A

Purpose of function:
This feature will introduce LB/amphora image information output when the openstack loadbalancer list/show command is used.  Having  to login into the amphora for this is inconvenient and not a great user experience.

octavia image create should create the image with name of the used OS file name, and the filename should be detailed

Work required (from detail plan):
Procedural 
------
How to update the images for load balancer and seeking LB/amphora information with which to do that   (check if there’s existing docs and update)

This is for cloud administrators and not cloud users
------

Conceptual 
------
N/A
------

Reference
------
N/A
------

Comment 3 Lucy Bopf 2018-08-21 07:22:02 UTC
Accepting into RHOSP 14 documentation program.

Comment 4 Lucy Bopf 2018-08-28 04:18:22 UTC
Adding estimate based on the requirement for one procedure.

Comment 5 Lucy Bopf 2018-08-28 04:20:36 UTC
Assigning to Joanne for review, and targeting at 14-Beta.

Comment 12 Joanne O'Flynn 2018-10-01 15:38:35 UTC
Please find the updated documentation at the following location:

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/13/html/networking_guide/sec-octavia#verifying_the_load_balancer

Comment 13 Carlos Goncalves 2018-10-01 17:08:32 UTC
Joanne, the doc update should have been reflected for >=OSP14 only. The image field is not available in OSP13. If you want, you can leave the amphora show command to view amphora information part you added to OSP13 doc, but remove the "image_id" field from the output.

Comment 14 Joanne O'Flynn 2018-10-02 13:09:01 UTC
(In reply to Carlos Goncalves from comment #13)
> Joanne, the doc update should have been reflected for >=OSP14 only. The
> image field is not available in OSP13. If you want, you can leave the
> amphora show command to view amphora information part you added to OSP13
> doc, but remove the "image_id" field from the output.

Thank you for catching this Carlos!

The corrected documentation for OSP 13 is located here:

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/13/html/networking_guide/sec-octavia#verifying_the_load_balancer

Awaiting branch creation for 14.