BZ1292961 Documenting Ansible options in Install Guide #2350

tpoitras · 2016-06-24T03:51:00Z

BZ: https://bugzilla.redhat.com/show_bug.cgi?id=1292961

This bug became something different from its original intent. It ended up covering a number of topics in the install guide, and detailed how certain things can be done with ansible, and providing example config.

tpoitras · 2016-07-27T08:46:26Z

Have put @sferich888 on NeedInfo in the BZ for assistance with technical review, since he had the most input on the BZ.

Here are the topics I've touched/added sections to:

Custom Certificates:
http://file.bne.redhat.com/tpoitras/2016/ansiblehosts/openshift-enterprise/ansibleflaginhosts-BZ1292961/install_config/certificate_customization.html

Configure Authentication:
http://file.bne.redhat.com/tpoitras/2016/ansiblehosts/openshift-enterprise/ansibleflaginhosts-BZ1292961/install_config/configuring_authentication.html#identity-providers-ansible

Configure Networking (SDN):
http://file.bne.redhat.com/tpoitras/2016/ansiblehosts/openshift-enterprise/ansibleflaginhosts-BZ1292961/install_config/configuring_sdn.html#configuring-the-pod-network-with-ansible

Proxy Configurations:
http://file.bne.redhat.com/tpoitras/2016/ansiblehosts/openshift-enterprise/ansibleflaginhosts-BZ1292961/install_config/http_proxies.html#configuring-hosts-for-proxies

Defaults and Overrides:
http://file.bne.redhat.com/tpoitras/2016/ansiblehosts/openshift-enterprise/ansibleflaginhosts-BZ1292961/install_config/build_defaults_overrides.html#setting-global-build-defaults

Web Console Modifications:
http://file.bne.redhat.com/tpoitras/2016/ansiblehosts/openshift-enterprise/ansibleflaginhosts-BZ1292961/install_config/web_console_customization.html

AWS:
http://file.bne.redhat.com/tpoitras/2016/ansiblehosts/openshift-enterprise/ansibleflaginhosts-BZ1292961/install_config/configuring_aws.html#aws-configuring-masters

OpenStack:
http://file.bne.redhat.com/tpoitras/2016/ansiblehosts/openshift-enterprise/ansibleflaginhosts-BZ1292961/install_config/configuring_openstack.html#openstack-configuring-masters

sferich888 · 2016-07-27T13:50:16Z

install_config/certificate_customization.adoc

@@ -16,8 +16,7 @@ Administrators can configure custom serving certificates for the public host
 names of the {product-title} API and
 xref:../architecture/infrastructure_components/web_console.adoc#architecture-infrastructure-components-web-console[web console].
 This can be done during an
-xref:../install_config/install/advanced_install.adoc#advanced-install-custom-certificates[advanced
-installation] or configured after installation.
+xref:../install_config/install/advanced_install.adoc#advanced-install-custom-certificates[advanced installation] or configured after installation.


I like this, however don't feel it call's out "loudly" enough that we should be using Ansible to configure these directives, when possible. I wonder if duplicating content (as a new section) on this document, from the link provided helps to make this point?

Note: I am not a fan of duplicating content.

I like what was done in https://github.com/openshift/openshift-docs/pull/2350/files#diff-2286e6c0ed74dfb182205830dcec2932R29 as it summarizes an example using the links.

I don't like duplicating content either unless absolutely necessary (and if I did, I'd use "include" statements so the text wouldn't be in there redundantly). I've made this a new section which is closer to what I did for other topics, let me know if you feel this satisfies what you were looking for.

This new section does exactly what I was hoping we could do. Looks good.

tpoitras · 2016-08-11T06:39:06Z

Updates made, PR updated, nice rendered docs here if you like: http://file.bne.redhat.com/tpoitras/2016/ansiblehosts/openshift-enterprise/ansibleflaginhosts-BZ1292961/install_config/index.html

What do you reckon, @sferich888 ? Ack?

sferich888 · 2016-08-11T13:46:48Z

install_config/configuring_openstack.adoc

@@ -13,8 +13,7 @@ toc::[]
 == Overview


In talking this over with @TheDiemer he pointed out that the titles / section headers should read:

Configuring OpenShift Enterprise [COMPONENT] for PROVIDER/PLATFORM

As its more accurate to what we are trying to configure.

adellape · 2016-08-12T15:19:06Z

install_config/configuring_sdn.adoc

-though it can be
-xref:../install_config/install/advanced_install.adoc#configuring-ansible[overridden
-during installation] using the `*os_sdn_network_plugin_name*` parameter.
+== Configuring the Pod Network with Ansible


tpoitras · 2016-08-18T12:40:18Z

Thank you @sferich888 and @adellape
I believe I've adressed everything, but as @sferich888 pointed out above, GCE is pending. I think that'll have to be addressed in a different BZ and PR though. This one needs to be put to bed. Moving this to peer review. I know @adellape has reviewed already but I wanted to leave this on peer review for today in case @sferich888 has anything else or maybe @bfallonf or @ahardin-rh want to have a look.

sferich888 · 2016-08-18T12:50:24Z

LGTM

bfallonf · 2016-08-19T03:31:08Z

install_config/configuring_aws.adoc

-== Configuring Masters
+== Configuring {product-title} Masters for AWS
+
+You can set AWS configuration on your {product-title} masters two ways:


"You can set the AWS configuration on your {product-title} master hosts in two ways:"

bfallonf · 2016-08-19T03:37:46Z

@tpoitras Some comments from me above. Overall, looks good.

tpoitras · 2016-08-19T03:40:24Z

@bfallonf Thanks so much! 🎉 ☀️ 🔧

tpoitras · 2016-08-19T03:53:50Z

[rev_history]
|xref:../install_config/build_defaults_overrides.adoc#setting-global-build-defaults[Installation and Configuration -> Configuring Global Build Defaults and Overrides]
|Added details about configuring global build defaults and overrides with Ansible.
%
|xref:../install_config/certificate_customization.adoc#ansible-configuring-custom-certificates[Installation and Configuration -> Configuring Custom Certificates]
|Added details about configuring custom certificates with Ansible.
%
|xref:../install_config/configuring_authentication.adoc#identity-providers-ansible[Installation and Configuration -> Configuring Authentication and User Agent]
|Added details about configuring authentication with Ansible.
%
|xref:../install_config/configuring_aws.adoc#aws-configuring-masters[Installation and Configuration -> Configuring for AWS]
|Added details about configuring for AWS with Ansible.
%
|xref:../install_config/configuring_openstack.adoc#openstack-configuring-masters-ansible[Installation and Configuration -> Configuring for OpenStack]
|Added details about configuring for OpenStack with Ansible.
%
|xref:../install_config/configuring_sdn.adoc#configuring-sdn-config-pod-network-ansible[Installation and Configuration -> Configuring the SDN]
|Added details about configuring the SDN with Ansible.
%
|xref:../install_config/http_proxies.adoc#configuring-hosts-for-proxies[Installation and Configuration -> Working with HTTP Proxies]
|Added details about configuring HTTP proxies with Ansible.
%
|xref:../install_config/web_console_customization.adoc#ansible-config-web-console-customizations[Installation and Configuration -> Customizing the Web Console]
|Added details about configuring the web console with Ansible.
%

vikram-redhat · 2016-08-22T10:32:47Z

@tpoitras - this shouldn't still be on peer review.

tpoitras · 2016-08-23T01:09:10Z

Thanks @vikram-redhat

adellape · 2016-08-23T15:49:01Z

@tpoitras This PR makes changes to dev_guide/builds.adoc, so I'd think we'd want to label it for dedicated-3.2 and online branches as well. But that gets into your recent question about including directories into branches that don't need them (like the install_config directory into dedicated-3.2, causing a bunch of conflicts).

We might be able to use something like this to avoid these sorts of issues:

https://git-scm.com/book/en/v2/Customizing-Git-Git-Attributes#Merge-Strategies

But in the meantime, should this get re-labeled? I.e., drop enterprise-3.2 since it already got picked there, add dedicated-3.2 and online, and re-queue into Next Release with an adjusted revhistory comment? Just in the interest of keeping dev_guide/builds.adoc in sync.

If we do do that, we should similarly re-queue this one as well, which fixed a few minor things in follow-up:

#2712

tpoitras force-pushed the ansibleflaginhosts-BZ1292961 branch from aacb6fa to 4b05f70 Compare June 24, 2016 03:51

tpoitras force-pushed the ansibleflaginhosts-BZ1292961 branch from 4b05f70 to 76648fe Compare July 15, 2016 03:06

tpoitras force-pushed the ansibleflaginhosts-BZ1292961 branch 4 times, most recently from 6685862 to 08c2ea2 Compare July 27, 2016 08:31

tpoitras changed the title ~~[WIP] BZ1292961 Ansible flag in hosts~~ BZ1292961 Ansible flag in hosts Jul 27, 2016

tpoitras changed the title ~~BZ1292961 Ansible flag in hosts~~ BZ1292961 Documenting Ansible options in Install Guide Jul 27, 2016

tpoitras added branch/enterprise-3.2 tech_review labels Jul 27, 2016

tpoitras added this to the Next Release milestone Jul 27, 2016

tpoitras self-assigned this Jul 27, 2016

tpoitras force-pushed the ansibleflaginhosts-BZ1292961 branch from 08c2ea2 to c0cb9fc Compare July 27, 2016 08:45

sferich888 reviewed Jul 27, 2016
View reviewed changes

tpoitras force-pushed the ansibleflaginhosts-BZ1292961 branch from c0cb9fc to 85f856b Compare August 11, 2016 06:32

sferich888 reviewed Aug 11, 2016
View reviewed changes

adellape reviewed Aug 12, 2016
View reviewed changes

tpoitras force-pushed the ansibleflaginhosts-BZ1292961 branch from 85f856b to d1cc3c1 Compare August 18, 2016 12:39

tpoitras added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed tech_review labels Aug 18, 2016

bfallonf reviewed Aug 19, 2016
View reviewed changes

Updates regarding options that are Ansible-configurable.

ca4fd6d

tpoitras force-pushed the ansibleflaginhosts-BZ1292961 branch from d1cc3c1 to ca4fd6d Compare August 19, 2016 03:41

tpoitras merged commit c2aa6e0 into openshift:master Aug 19, 2016

tpoitras deleted the ansibleflaginhosts-BZ1292961 branch August 21, 2016 23:57

bfallonf removed the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Aug 23, 2016

bfallonf modified the milestones: Next Release, Staging Aug 23, 2016

bfallonf modified the milestones: Staging, Published - 23/08/2016 Aug 23, 2016

adellape mentioned this pull request Aug 23, 2016

Fix proxies-using-ansible dupe IDs #2712

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BZ1292961 Documenting Ansible options in Install Guide #2350

BZ1292961 Documenting Ansible options in Install Guide #2350

tpoitras commented Jun 24, 2016 •

edited

tpoitras commented Jul 27, 2016 •

edited

sferich888 Jul 27, 2016 •

edited

tpoitras Aug 11, 2016

sferich888 Aug 11, 2016

tpoitras commented Aug 11, 2016

sferich888 Aug 11, 2016 •

edited

adellape Aug 12, 2016

tpoitras commented Aug 18, 2016 •

edited

sferich888 commented Aug 18, 2016

bfallonf Aug 19, 2016

bfallonf commented Aug 19, 2016

tpoitras commented Aug 19, 2016

tpoitras commented Aug 19, 2016

vikram-redhat commented Aug 22, 2016

tpoitras commented Aug 23, 2016

adellape commented Aug 23, 2016 •

edited

BZ1292961 Documenting Ansible options in Install Guide #2350

BZ1292961 Documenting Ansible options in Install Guide #2350

Conversation

tpoitras commented Jun 24, 2016 • edited

tpoitras commented Jul 27, 2016 • edited

sferich888 Jul 27, 2016 • edited

Choose a reason for hiding this comment

tpoitras Aug 11, 2016

Choose a reason for hiding this comment

sferich888 Aug 11, 2016

Choose a reason for hiding this comment

tpoitras commented Aug 11, 2016

sferich888 Aug 11, 2016 • edited

Choose a reason for hiding this comment

adellape Aug 12, 2016

Choose a reason for hiding this comment

tpoitras commented Aug 18, 2016 • edited

sferich888 commented Aug 18, 2016

bfallonf Aug 19, 2016

Choose a reason for hiding this comment

bfallonf commented Aug 19, 2016

tpoitras commented Aug 19, 2016

tpoitras commented Aug 19, 2016

vikram-redhat commented Aug 22, 2016

tpoitras commented Aug 23, 2016

adellape commented Aug 23, 2016 • edited

tpoitras commented Jun 24, 2016 •

edited

tpoitras commented Jul 27, 2016 •

edited

sferich888 Jul 27, 2016 •

edited

sferich888 Aug 11, 2016 •

edited

tpoitras commented Aug 18, 2016 •

edited

adellape commented Aug 23, 2016 •

edited