Bug 1383029 - [ocp-on-osp]Need a friendly and detailed openshift_parameters.yaml for all configurable parameters
Summary: [ocp-on-osp]Need a friendly and detailed openshift_parameters.yaml for all co...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Installer
Version: 3.3.0
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
: ---
Assignee: Jan Provaznik
QA Contact: Gan Huang
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-10-09 08:39 UTC by Gan Huang
Modified: 2017-03-20 08:39 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-03-20 08:39:54 UTC
Target Upstream Version:


Attachments (Terms of Use)

Description Gan Huang 2016-10-09 08:39:03 UTC
Description of problem:
Currently there is no very detailed example openshift_parameters.yaml so that some parameters might be confused to users.

1. "deploy_registry=true" must be set together with "os_auth_url", "os_username", "os_password", "os_tenant_name", "os_region_name".

If "deploy_registry=true" is passed when creating heat stack, the stack would create a volume by following commands:
nova --os-auth-url {{ openshift_cloudprovider_openstack_auth_url }} --os-username {{ openshift_cloudprovider_openstack_username }} --os-password {{ openshift_    cloudprovider_openstack_password }} --os-tenant-name {{ openshift_cloudprovider_openstack_tenant_name }} volume-attach {{ bastion_instance_id }} {{ openshift_hosted_regi    stry_storage_openstack_volumeID }}

So "deploy_registry=true" must be set together with "os_auth_url", "os_username", "os_password", "os_tenant_name", "os_region_name"

2. It's a little hard to know that the value of loadbalancer_type should be matched with the value "OOShift::LoadBalancer", "OOShift::IPFailover". Although Loadbalancer Type seclection has been mentioned https://github.com/redhat-openstack/openshift-on-openstack#select-loadbalancer-type, but we havn't documented the usage of "loadbalancer_type" in https://github.com/redhat-openstack/openshift-on-openstack#deployment. This is quite confused and hard to understand if we want to set all variables into a env file.


Version-Release number of selected component (if applicable):
openshift-on-openstack v0.9.1

How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:


Expected results:
Need a detailed env file including the usage of all configurable parameters.

Additional info:

Comment 1 Gan Huang 2016-10-09 09:19:01 UTC
Also need to document how to set openstack cloudprovider in example env file.

Comment 2 Gan Huang 2016-10-10 02:56:24 UTC
For External loadbalancer selection, looks like we also need to set "lb_hostname" in env file, or something else need to do? At least I think we should pass the external loadbalancer hostname/ip to env file when creating the stack.

Comment 3 Gan Huang 2016-10-10 05:08:08 UTC
For Dedicated loadbalancer node, from my unstanding so far, HAProxy loadbalancer for Masters is created by openshift-ansible (that is set in lb group in inventory), HAProxy loadbalancer for router will be created in infra host (that is infra group in inventory)? Could we also document the creation for router lb?

Btw, I realized that the way of creating master lb and router lb is completely different, is it possible to separate the creation of master lb and router lb? I think that will be easier to understand.

Thanks!

Comment 4 Gan Huang 2016-10-10 10:39:41 UTC
Please consider to remove loadbalancer_image and loadbalancer_flavor in env_loadbalancer_dedicated.yaml. It's hard for customers to realized that they need to modify env_loadbalancer_dedicated.yaml in the same time.

Ideally we should put all the possible settings into one env file, then customers are able and easy to config all parameters as they want.

Comment 5 Jan Provaznik 2016-10-17 10:24:26 UTC
(In reply to Gan Huang from comment #4)
> Please consider to remove loadbalancer_image and loadbalancer_flavor in
> env_loadbalancer_dedicated.yaml. It's hard for customers to realized that
> they need to modify env_loadbalancer_dedicated.yaml in the same time.
> 
> Ideally we should put all the possible settings into one env file, then
> customers are able and easy to config all parameters as they want.

loadabalancer_* params were moved into the defaul params file in #271.

Comment 6 Jan Provaznik 2016-10-17 10:30:29 UTC
(In reply to Gan Huang from comment #3)
> For Dedicated loadbalancer node, from my unstanding so far, HAProxy
> loadbalancer for Masters is created by openshift-ansible (that is set in lb
> group in inventory), HAProxy loadbalancer for router will be created in
> infra host (that is infra group in inventory)? Could we also document the
> creation for router lb?
> 
> Btw, I realized that the way of creating master lb and router lb is
> completely different, is it possible to separate the creation of master lb
> and router lb? I think that will be easier to understand.
> 
> Thanks!


If dedicated LB is used it loadbalances requests both for console/API and for OpenShift router.

PR https://github.com/redhat-openstack/openshift-on-openstack/pull/284 adds various documentation improvements.

I was thinking about the "friendly and detailed openshift_parameters.yaml for all configurable parameters" and I think that the most reasonable way is to refer to the "parameters" section of the main template, which does exactly this. It contains all possible parameters and also description of each of them. Duplicating this list would cause only pain when trying to keep the copy of the list up-to-date.

PR https://github.com/redhat-openstack/openshift-on-openstack/pull/284 improves description of parameters and adds reference to them from the README file.

Comment 7 Jan Provaznik 2016-10-19 14:49:45 UTC
Fixed in 0.9.4

Comment 8 Gan Huang 2016-10-20 02:44:03 UTC
Verified with 0.9.4

Looks good now, thanks, Jan!


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