Bug 1131666 - No reference to the the --make-ha REST API call
Summary: No reference to the the --make-ha REST API call
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 2.1.0
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ---
: ---
Assignee: brice
QA Contact: Bilhar
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2014-08-19 19:15 UTC by Eric Rich
Modified: 2018-12-06 17:48 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Build Name: 22862, Deployment Guide-2-1.0 Build Date: 07-08-2014 10:26:45 Topic IDs: 22561-638352 [Specified]
Last Closed: 2014-09-04 05:06:49 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Eric Rich 2014-08-19 19:15:55 UTC
Title: Using an External Load Balancer for High-Availability Applications

Describe the issue:

Need a reference in this section of the docs to the following call. 

https://access.redhat.com/documentation/en-US/OpenShift_Enterprise/2/html-single/REST_API_Guide/index.html#Make_an_Application_Highly_Available_HA

Suggestions for improvement:

Reference / show an example of this curl command. 

Additional information:

See https://bugzilla.redhat.com/show_bug.cgi?id=1128856#c3 as an example.

Comment 6 brice 2014-08-29 05:06:21 UTC
Eric, thanks for so much info on this. 

However, because there's so much, I feel the need to clarify...

1. So, this command makes an application HA:

# curl -k -X POST https://$(hostname)/broker/rest/domains/{DOMAIN}/applications/{APPLICATION}/events --user {USER}:{PASSWORD} --data-urlencode event=make-ha

My confusion leads from there being so much in the BZ you linked above [1] that I feel like this command doesn't cover it.

2. Is this command just for application developers? 

From taking a look at the admin guide, it seems the admin enables an application to support high-availability, then the developer can then make their app HA. There's also the implementation of the routing layer somewhere in the middle. 


All of this HA stuff ties into the bigger picture that we're trying to document, so, understandably, I want to get it right in my head before I make any radical changes.

Thanks!

[1] https://bugzilla.redhat.com/show_bug.cgi?id=1128856#c3

Comment 7 Luke Meyer 2014-08-29 14:42:11 UTC
This REST API call is just for application developers.

The OSE admin has to set the broker to allow the developer to use the make-ha event. Then the developer can do this.

If the developer doesn't have the capability, they'll get an error message to that effect in the response to this call.

Comment 8 Eric Rich 2014-08-29 17:29:52 UTC
(In reply to brice from comment #6)
> Eric, thanks for so much info on this. 
> 
> However, because there's so much, I feel the need to clarify...
> 
> 1. So, this command makes an application HA:
> 
> # curl -k -X POST
> https://$(hostname)/broker/rest/domains/{DOMAIN}/applications/{APPLICATION}/
> events --user {USER}:{PASSWORD} --data-urlencode event=make-ha
> 
> My confusion leads from there being so much in the BZ you linked above [1]
> that I feel like this command doesn't cover it.
> 
> 2. Is this command just for application developers? 
> 
(In reply to Luke Meyer from comment #7) << Ill echo this. 

However the backstory that I think is missing is that this feature of OSE was designed to be fronted by another application (that makes this call for the developer / user). With out such a tool the user must make this call in this way them self. https://bugzilla.redhat.com/show_bug.cgi?id=1131518 was filed to address this with an RHC command but its unclear when or if that will be completed.

Comment 10 brice 2014-09-02 06:44:54 UTC
Hey, Eric.

This ties directly into another BZ from Luke [1], but I think these two BZs are different enough to talk about each in their own BZ.

So this ties into the larger HA stuff that we've been trying to write up for the docs, but this info specifically I've put into the User Guide. You'll see that it links out to other points in the Admin Guide, as I'm hoping that all of the HA stuff will be able to be read together.

Please, let me know if I've misread anything or have any errors. This subject is so big that I want to get it all right.

Thanks!

[1] https://bugzilla.redhat.com/show_bug.cgi?id=1118766

Comment 13 brice 2014-09-03 01:00:48 UTC
Eric,

Yes, I'm making an effort to try join all the information together so that it makes a running story (load balancer > enabling high-availability > making the app highly-available). I noted in the other BZ [1] that because each part of the process involves a different audience that it would not be best to put it all into one section/chapter/book, but instead insert links, or put something like "contact your system administrator". 

I realize that this may not have been too clear before, so I've now put that into a note box and neatened the topic a little. I think this section fulfills the request for this BZ alone. Of course there's still plenty to do to make the process one full story, but I can track that in the other BZ. 

Please let me know if you think any differently.

[1] https://bugzilla.redhat.com/show_bug.cgi?id=1118766

Comment 14 Eric Rich 2014-09-03 11:09:24 UTC
(In reply to brice from comment #13)

Sounds good to me.

Comment 15 brice 2014-09-03 23:46:47 UTC
Neat, thanks, Eric! Putting this onto QA.

QA:

For this BZ, like I said above, just the section on making your app HA is probably relevant here. The other HA stuff will be addressed in the other BZ.


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