Add pages for new OpenShift on OpenStack provider #6020

bogdando · 2017-10-30T16:12:34Z

The new shift-on-stack provider [0] complements and will replace some of
the existing documentation for OCP on OSP 10 reference architecture.
It is planned to be the supported solution in the OSP 13 time frame.

Note that the provider is being moved under the openshift-ansible
repo [1]. Its link must be updated after the documentation moved as
the part of that change request.
"Configuring OpenShift Origin for OpenStack with Ansible" will likely
need some updates as well.

[0] https://github.com/openshift/openshift-ansible-contrib
[1] openshift/openshift-ansible#6039

Changes:

Clarify on-premises and cloud providers cases in
the Getting Started, Planning and Advanced Installation pages for
the openshift-origin/enterprise distros.
Link documentation pages for the shift-on-stack provider, which
is currently hosted in-repo docs.
Add a link and a deprecation note for OCP 2.6 on OSP 10 reference
architecture based on Heat Templates.

Highlight other cloud offerings as well.
Describe alternative cloud solitions in the planning OpenShift
Enterprise installation pages. For some cases, OpenShift Dedicated
or Online might be a better fit. This makes things more clear for
users from the first docs pages read.

Additionally, highlight the Dedicated alternative, when describing
the cloud hosted infrustracture configuration prerequisites in the
Enterprise advanced installation guide.

Depends-on openshift/openshift-ansible#6039

Signed-off-by: Bogdan Dobrelya [email protected]

bogdando · 2017-10-30T16:13:42Z

@openshift/team-documentation @e-minguez @tomassedovic PTAL

e-minguez

I've added a few comments.

e-minguez · 2017-10-30T16:20:45Z

install_config/install/advanced_install.adoc

+
+In order to provision and install {product-title} on OpenStack, see
+link:https://access.redhat.com/documentation/en-us/reference_architectures/2017/html-single/deploying_and_managing_red_hat_openshift_container_platform_3.6_on_red_hat_openstack_platform_10[the reference architecture for Red Hat OpenStack Platform 10],
+which is based on link:https://docs.openstack.org/heat/latest[OpenStack Heat]


The current ref. arch. is not based on Heat but in a manual procedure using the openstack cli

Perhaps I have to point the https://github.com/redhat-openstack/openshift-on-openstack then? But now I'm confused as I thought that complements the OSP 10 ref arch! @tomassedovic need your inputs please.

e-minguez · 2017-10-30T16:22:53Z

install_config/install/advanced_install.adoc

+====
+[IMPORTANT]
+The reference architecture for {product-title} on Red Hat OpenStack Platform 10
+is deprecated. For OSP 13 time frame, it is being replaced with the


AFAIK OCP 3.6 on OSP 10 ref. arch. is not deprecated (we've just released a few weeks ago[1]), OCP 3.4 on OSP 10 is deprecated[2]
[1] https://access.redhat.com/documentation/en-us/reference_architectures/2017/html-single/deploying_and_managing_red_hat_openshift_container_platform_3.6_on_red_hat_openstack_platform_10/
[2] https://access.redhat.com/documentation/en-us/reference_architectures/2017/html/deploying_red_hat_openshift_container_platform_3.4_on_red_hat_openstack_platform_10/

@tomassedovic could you please comment and help to get the better wording to point OSP >10 users to the right docs?

e-minguez · 2017-10-30T16:23:57Z

install_config/install/advanced_install.adoc

+[IMPORTANT]
+The reference architecture for {product-title} on Red Hat OpenStack Platform 10
+is deprecated. For OSP 13 time frame, it is being replaced with the
+link:https://github.com/openshift/openshift-ansible-contrib/tree/master/playbooks/provisioning/openstack[Ansible driven deployment solution].


I don't know about providing links in the official documentation to the unsupported o-a-c repo

Please take a look the commit message, it states that the repo is being moved and the link will have to be adjusted. So this is only a landing page, and the dependency patch. I'll put the dependency though! thanks!

sdodson · 2017-10-30T16:33:56Z

CC: @openshift/team-documentation

The new shift-on-stack provider [0] complements and will replace some of the existing documentation and reference architectures for OCP 3.4/3.6 on OSP 10. It is planned to be the supported solution in the OSP 13 time frame. [0] https://github.com/openshift/openshift-ansible-contrib Changes: * Clarify on-premises and cloud providers cases in the Getting Started, Planning and Advanced Installation pages for the openshift-origin/enterprise distros. * Link documentation pages for the shift-on-stack provider, which is currently hosted in-repo docs. * Add links for published OCP on OSP ref. architectures * Add a deprecation note for OCP 3.4 on OSP 10 reference architecture based on Heat Templates. Note that the new provider is being moved under the openshift-ansible repo [1]. The links must be updated after the documentation moved as the part of that change request. "Configuring OpenShift Origin for OpenStack with Ansible" will likely need some updates as well. [1] openshift/openshift-ansible#5797 . Signed-off-by: Bogdan Dobrelya <[email protected]>

bogdando · 2017-10-31T13:15:55Z

Looking at https://docs.openshift.com/ I'm wondering if the descriptions given for "OpenShift Container Platform - Red Hat's private, on-premise" and "OpenShift Dedicated - Red Hat's managed public cloud" fits the proposed changes. It seems that we need to provide a comparison to over products to clarify the cloud providers case for Origin/Enterprise?.. Any help with that?

tomassedovic · 2017-10-31T13:41:07Z

install_config/install/advanced_install.adoc

+The reference architecture for automated installations based on
+link:https://docs.openstack.org/heat/latest[OpenStack Heat] templates for
+link:https://access.redhat.com/documentation/en-us/reference_architectures/2017/html/deploying_red_hat_openshift_container_platform_3.4_on_red_hat_openstack_platform_10[{product-title} (OCP 3.4) on Red Hat OpenStack Platform 10]
+is deprecated. For OSP 13 time frame, it is being replaced with the


I'm not sure it's been officially deprecated. More like it's not being actively developed anymore.

I'm not sure the docs should state something is not being actively developed anymore :) sounds a little bit too much of dramatic.

let it be 'unsupported'

tomassedovic · 2017-10-31T13:42:53Z

install_config/install/advanced_install.adoc

+Some of the basic configuration may be assisted by that reference architecture
+and the
+xref:../../install_config/install/prerequisites#prereq-cloud-provider-considerations[cloud provider considerations].
+For advanced configuration prerequisites, like DNS, load balancing and high


The reference architecture handles complex deployments including HA, DNS and LB as well I believe.

I would just say that it describes a manual way of configuring the OpenStack resources and installing OpenShift and the playbooks below automate it.

@e-minguez would you comment please?

@tomassedovic is right, the current ref. arch. includes how to deploy DNS, LB and an HA OCP environment based on manual steps for the infrastructure, then openshift-ansible for installing OCP.

done, thanks

Describe alternative cloud solitions in the planning OpenShift Enterprise installation pages. For some cases, OpenShift Dedicated or Online might be a better fit. This makes things more clear for users from the first docs pages read. Additionally, highlight the Dedicated alternative, when describing the cloud hosted infrustracture configuration prerequisites in the Enterprise advanced installation guide. Signed-off-by: Bogdan Dobrelya <[email protected]>

bogdando · 2017-10-31T14:21:17Z

Addressed the #6020 (comment) in the follow-up commit

bogdando · 2017-10-31T14:30:43Z

install_config/install/planning.adoc

+* _Will you manage your dedicated cloud hosted infrastructure or prefer
+having it managed as a service?_ See the
+link:https://www.openshift.com/dedicated/index.html[OpenShift Dedicated]
+product offering that might fit the case better.


Kudos Chris Pitman for explaining this on a mail list

Signed-off-by: Bogdan Dobrelya <[email protected]>

bogdando · 2017-11-08T09:01:56Z

^^
3.7 branch is forked hopefully we can "unfreeze" with code reviews now? :)

JAORMX

LGTM

bogdando · 2017-11-17T10:21:21Z

It's time to rebase on openshift/openshift-ansible#6039 merged

Point to the official location of the provider's new home. Signed-off-by: Bogdan Dobrelya <[email protected]>

bogdando · 2017-11-17T10:28:59Z

The dependency patch is now merged, and the external links in this patch adjusted. So this one is good to go now. PTAL folks!

bogdando · 2017-11-28T17:37:26Z

sup ^^

sdodson · 2017-11-30T16:29:08Z

/lgtm

bogdando · 2017-12-04T09:17:22Z

Folks can we have this merged please?

sdodson · 2017-12-04T13:48:56Z

Yeah, not sure why the bot didn't merge it automatically.

mburke5678 · 2017-12-04T21:58:52Z

@sdodson @bogdando
This PR was merged into the docs repo. However, it doesn't appear that anyone from the docs team had a chance to review it.
Is the material technically correct and could be reviewed by docs? If so, we can do a follow-up PR.
If the material is not 100% technical correct at this point, we probably should try to revert the changes.

cc. @adellape

sdodson · 2017-12-05T03:43:49Z

@mburke5678 Sorry, I shouldn't have merged this. I lost track of which repo I was in. I suspect the right thing to do is revert it and allow docs team to properly review the content.

As far as technical accuracy it looks accurate to me but @tomassedovic would be the SME.

bogdando · 2017-12-05T07:19:56Z

@mburke5678 @adellape that's a good point. I wish more folks from the documentation team have reviewed this patch, indeed. It's been open for a month, I've got a single peer review and hoped that it came from the docs team (I can't see the @openshift/team-documentation members). So that brought I little bit of confusion for us all. Would be nice to improve review process for future cooperation.

mburke5678 · 2017-12-05T15:54:14Z

Follow up proofread edits #6610

mburke5678 · 2017-12-05T17:44:24Z

@bogdando @sdodson Should the links at the following locations be in Origin in addition to OCP? The ifdef is for OCP only.
https://github.com/openshift/openshift-docs/pull/6020/files#diff-fe94157edddadf88425cf07b556a00a3R89
https://github.com/openshift/openshift-docs/pull/6020/files#diff-fe94157edddadf88425cf07b556a00a3R116
https://github.com/openshift/openshift-docs/pull/6020/files#diff-e084990ba21e030cb515dc99b559edbbR23

bogdando · 2017-12-06T08:38:11Z

@mburke5678 I didn't propose those commercial alternatives for non-commercial Origin (IIUC) by intention. I think those should only be visible for OCP (Enterprise) pages, otherwise it may be treated like ads IMO. Feel free to alter this as you think it should be though. Either way would work for me.

mburke5678 · 2017-12-06T19:14:25Z

@bogdando @sdodson Please see @aheslin comment in my follow-up:
#6610 (comment)
"I agree that the links to Dedicated don't need to be in the Advanced Installer topic. It veers towards marketing content."

mburke5678 · 2018-03-12T20:56:51Z

@sdodson @bogdando @tomassedovic Should these changes have been added to Enterprise?
I do not recall why this and my follow-up were merged to Origin only . I do not recall the reason. Any help would be appreciated.

adellape · 2018-04-02T17:42:20Z

@mburke5678 I finished placing the remaining ifdefs related to this PR as part of #8535 and #8537. So this content should all be appropriately ifdef'd for Origin only now on the master, enterprise-3.9, and enterprise-3.10 branches; if/when it's vetted for downstream docs, we can remove or adjust those as needed.

e-minguez reviewed Oct 30, 2017

View reviewed changes

bogdando force-pushed the shift-on-stack-landing branch from 5746f4a to 725ee74 Compare October 30, 2017 16:24

bogdando changed the title ~~Add pages for new OpenShift on OpenStack provider~~ [WIP] Add pages for new OpenShift on OpenStack provider Oct 30, 2017

bogdando force-pushed the shift-on-stack-landing branch from 725ee74 to 33e8b58 Compare October 31, 2017 11:13

tomassedovic reviewed Oct 31, 2017

View reviewed changes

bogdando commented Oct 31, 2017

View reviewed changes

Update the deprecation and ref arch wording

36b4aa9

Signed-off-by: Bogdan Dobrelya <[email protected]>

bogdando changed the title ~~[WIP] Add pages for new OpenShift on OpenStack provider~~ Add pages for new OpenShift on OpenStack provider Nov 2, 2017

JAORMX approved these changes Nov 9, 2017

View reviewed changes

ncbaratta added the peer-review-done Signifies that the peer review team has reviewed this PR label Nov 9, 2017

Adjust openstack provider links

27ea12a

Point to the official location of the provider's new home. Signed-off-by: Bogdan Dobrelya <[email protected]>

openshift-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Nov 17, 2017

tomassedovic approved these changes Nov 30, 2017

View reviewed changes

openshift-ci-robot assigned sdodson Nov 30, 2017

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Nov 30, 2017

sdodson removed their assignment Nov 30, 2017

sdodson merged commit a756c17 into openshift:master Dec 4, 2017

mburke5678 mentioned this pull request Dec 5, 2017

follow up edits #6610

Closed

mburke5678 mentioned this pull request Dec 5, 2017

added missing endif #6614

Merged

mburke5678 mentioned this pull request Dec 11, 2017

Followup edits to bogdando PR #6700

Merged

gaurav-nelson mentioned this pull request Feb 27, 2018

Recreated advanced_install.adoc from history #7953

Closed

bogdando mentioned this pull request Mar 6, 2018

Re-organized OpenStack documentation openshift/openshift-ansible#7398

Merged

Add pages for new OpenShift on OpenStack provider #6020

Add pages for new OpenShift on OpenStack provider #6020

Conversation

bogdando commented Oct 30, 2017 • edited Loading

bogdando commented Oct 30, 2017

e-minguez left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sdodson commented Oct 30, 2017

bogdando commented Oct 31, 2017

Choose a reason for hiding this comment

bogdando Oct 31, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bogdando commented Oct 31, 2017 • edited Loading

Choose a reason for hiding this comment

bogdando commented Nov 8, 2017

JAORMX left a comment

Choose a reason for hiding this comment

bogdando commented Nov 17, 2017 • edited Loading

bogdando commented Nov 17, 2017

bogdando commented Nov 28, 2017

sdodson commented Nov 30, 2017

bogdando commented Dec 4, 2017

sdodson commented Dec 4, 2017

mburke5678 commented Dec 4, 2017 • edited Loading

sdodson commented Dec 5, 2017 • edited Loading

bogdando commented Dec 5, 2017 • edited Loading

mburke5678 commented Dec 5, 2017

mburke5678 commented Dec 5, 2017

bogdando commented Dec 6, 2017 • edited Loading

mburke5678 commented Dec 6, 2017 • edited Loading

mburke5678 commented Mar 12, 2018 • edited Loading

adellape commented Apr 2, 2018

bogdando commented Oct 30, 2017 •

edited

Loading

bogdando Oct 31, 2017 •

edited

Loading

bogdando commented Oct 31, 2017 •

edited

Loading

bogdando commented Nov 17, 2017 •

edited

Loading

mburke5678 commented Dec 4, 2017 •

edited

Loading

sdodson commented Dec 5, 2017 •

edited

Loading

bogdando commented Dec 5, 2017 •

edited

Loading

bogdando commented Dec 6, 2017 •

edited

Loading

mburke5678 commented Dec 6, 2017 •

edited

Loading

mburke5678 commented Mar 12, 2018 •

edited

Loading