From 33e8b58ccbb10182c376020c644915d53d73483d Mon Sep 17 00:00:00 2001 From: Bogdan Dobrelya Date: Mon, 30 Oct 2017 13:26:51 +0100 Subject: [PATCH 1/4] Add pages for new OpenShift on OpenStack provider 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] https://github.com/openshift/openshift-ansible/pull/5797 . Signed-off-by: Bogdan Dobrelya --- getting_started/administrators.adoc | 13 ++++++ install_config/install/advanced_install.adoc | 46 ++++++++++++++++++-- install_config/install/planning.adoc | 11 +++++ 3 files changed, 67 insertions(+), 3 deletions(-) diff --git a/getting_started/administrators.adoc b/getting_started/administrators.adoc index 9899a390e359..8e4889638d82 100644 --- a/getting_started/administrators.adoc +++ b/getting_started/administrators.adoc @@ -40,6 +40,19 @@ networking. Ensure that local firewall rules and other software making iptable changes do not alter the {product-title} and Docker service setup. ==== +ifdef::openshift-origin[] + +[[get-started-cloud-providers]] +=== On-premises vs Cloud Providers + +{product-title} can be installed on-premises or hosted on public or private +clouds. For more details, +xref:../install_config/install/advanced_install.adoc#advanced-cloud-providers[see the advanced installation guide]. + +Once you have your cluster nodes provisioned, choose the +installation method that fits your case the best. +endif::[] + [[installation-methods]] == Installation Methods diff --git a/install_config/install/advanced_install.adoc b/install_config/install/advanced_install.adoc index cc6289c63670..b07d5eace32c 100644 --- a/install_config/install/advanced_install.adoc +++ b/install_config/install/advanced_install.adoc @@ -71,9 +71,49 @@ see the xref:../../scaling_performance/install_practices.adoc#scaling-performance-install-best-practices[Scaling and Performance Guide]. After following the instructions in the -xref:../../install_config/install/prerequisites.adoc#install-config-install-prerequisites[Prerequisites] topic and -deciding between the RPM and containerized methods, you can continue in this -topic to xref:configuring-ansible[Configuring Ansible Inventory Files]. +xref:../../install_config/install/prerequisites.adoc#install-config-install-prerequisites[Prerequisites] +topic, deciding between the RPM and containerized methods and +xref:advanced-cloud-providers[choosing from the on-premises or cloud scenarios], +you can continue in this topic to +xref:configuring-ansible[Configuring Ansible Inventory Files]. + +[[advanced-cloud-providers]] +=== Choosing clouds over on-premises + +Provisioning of VMs in a cloud, defining your cloud infrastructure and applying +the required post-provision configuration tasks may be assisted with Ansible +automation playbooks for the supported cloud providers. This advanced installation +guide is happen to fulfill that purpose as well. + +==== OpenStack provider + +In order to install {product-title} with manual steps using OpenStack CLI, +see the +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[reference architecture], +which is actual for {product-title} 3.6 and Red Hat OpenStack Platform 10. + +As a prerequisite, you will have to provision VMs and configure the cloud +infrastructure, like network, storage, firewall and security groups. +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 +availability, you may want to use the +link:https://github.com/openshift/openshift-ansible-contrib/tree/master/playbooks/provisioning/openstack[Ansible automation playbooks] +instead. For automated installations, see also +xref:../../install_config/configuring_openstack#install-config-configuring-openstack[Configuring for OpenStack] +and +xref:configuring-ansible[Configuring Ansible Inventory Files]. + +==== +[IMPORTANT] +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 +link:https://github.com/openshift/openshift-ansible-contrib/tree/master/playbooks/provisioning/openstack[Ansible driven deployment solution]. +For automated installations, please follow that guide instead! +==== [[configuring-ansible]] == Configuring Ansible Inventory Files diff --git a/install_config/install/planning.adoc b/install_config/install/planning.adoc index 06e02f173cbb..2bda3be8a509 100644 --- a/install_config/install/planning.adoc +++ b/install_config/install/planning.adoc @@ -17,6 +17,9 @@ toc::[] For production environments, several factors influence installation. Consider the following questions as you read through the documentation: +* _Do you install on-premises or in public/private clouds?_ The xref:planning-cloud-providers[Installation Methods] +section provides more information about the cloud providers options available. + * _Which installation method do you want to use?_ The xref:installation-methods[Installation Methods] section provides some information about the quick and advanced installation methods. @@ -65,6 +68,14 @@ the same installer tool. If you wanted to later switch to using the advanced method, you can create an inventory file for your configuration and carry on that way. +[[planning-cloud-providers]] +=== On-premises vs Cloud Providers + +{product-title} can be installed on-premises or hosted on public or private +clouds. The aforementioned Ansible playbooks will help you with automation of +the provisioning and installation processes. For more details, +xref:../../install_config/install/advanced_install.adoc#advanced-cloud-providers[see the advanced installation guide]. + [[sizing]] == Sizing Considerations From 3eeb3a7917af9942b4df3764c4e890111f5d15df Mon Sep 17 00:00:00 2001 From: Bogdan Dobrelya Date: Tue, 31 Oct 2017 15:15:37 +0100 Subject: [PATCH 2/4] 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. Signed-off-by: Bogdan Dobrelya --- getting_started/administrators.adoc | 3 --- install_config/install/advanced_install.adoc | 16 +++++++++++++--- install_config/install/planning.adoc | 13 +++++++++++++ 3 files changed, 26 insertions(+), 6 deletions(-) diff --git a/getting_started/administrators.adoc b/getting_started/administrators.adoc index 8e4889638d82..ad7eee807039 100644 --- a/getting_started/administrators.adoc +++ b/getting_started/administrators.adoc @@ -40,8 +40,6 @@ networking. Ensure that local firewall rules and other software making iptable changes do not alter the {product-title} and Docker service setup. ==== -ifdef::openshift-origin[] - [[get-started-cloud-providers]] === On-premises vs Cloud Providers @@ -51,7 +49,6 @@ xref:../install_config/install/advanced_install.adoc#advanced-cloud-providers[se Once you have your cluster nodes provisioned, choose the installation method that fits your case the best. -endif::[] [[installation-methods]] == Installation Methods diff --git a/install_config/install/advanced_install.adoc b/install_config/install/advanced_install.adoc index b07d5eace32c..a61f75b0c291 100644 --- a/install_config/install/advanced_install.adoc +++ b/install_config/install/advanced_install.adoc @@ -80,11 +80,19 @@ xref:configuring-ansible[Configuring Ansible Inventory Files]. [[advanced-cloud-providers]] === Choosing clouds over on-premises -Provisioning of VMs in a cloud, defining your cloud infrastructure and applying -the required post-provision configuration tasks may be assisted with Ansible +Provisioning of VMs in a cloud, defining your cloud hosted infrastructure and +applying post-provision configuration may be assisted with Ansible automation playbooks for the supported cloud providers. This advanced installation guide is happen to fulfill that purpose as well. +ifdef::openshift-enterprise[] +==== +A managed dedicated cloud hosted infrastructure may be alternatively +operated as a service by Red Hat, see the +link:https://www.openshift.com/dedicated/index.html[OpenShift Dedicated] +product offering for more details. +==== + ==== OpenStack provider In order to install {product-title} with manual steps using OpenStack CLI, @@ -105,15 +113,17 @@ xref:../../install_config/configuring_openstack#install-config-configuring-opens and xref:configuring-ansible[Configuring Ansible Inventory Files]. +ifdef::openshift-enterprise[] ==== [IMPORTANT] 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] +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} 3.4 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]. For automated installations, please follow that guide instead! ==== +endif::[] [[configuring-ansible]] == Configuring Ansible Inventory Files diff --git a/install_config/install/planning.adoc b/install_config/install/planning.adoc index 2bda3be8a509..257669405f37 100644 --- a/install_config/install/planning.adoc +++ b/install_config/install/planning.adoc @@ -20,6 +20,19 @@ the following questions as you read through the documentation: * _Do you install on-premises or in public/private clouds?_ The xref:planning-cloud-providers[Installation Methods] section provides more information about the cloud providers options available. +ifdef::openshift-enterprise[] +* _Do you need a dedicated cloud hosted infrastructure?_ There might be +managed multi-tenant alternatives as well. For example, operated as a service +by Red Hat cloud hosted infrastructure where your workloads run +alongside other customers' containers. If that fits your case, see +link:https://www.openshift.com/[OpenShift Online] for more details. + +* _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. +endif::[] + * _Which installation method do you want to use?_ The xref:installation-methods[Installation Methods] section provides some information about the quick and advanced installation methods. From 36b4aa927277fb4488bccaf69bebe82378d77ab7 Mon Sep 17 00:00:00 2001 From: Bogdan Dobrelya Date: Tue, 31 Oct 2017 16:08:38 +0100 Subject: [PATCH 3/4] Update the deprecation and ref arch wording Signed-off-by: Bogdan Dobrelya --- install_config/install/advanced_install.adoc | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/install_config/install/advanced_install.adoc b/install_config/install/advanced_install.adoc index a61f75b0c291..5b6449fbcfba 100644 --- a/install_config/install/advanced_install.adoc +++ b/install_config/install/advanced_install.adoc @@ -102,13 +102,11 @@ which is actual for {product-title} 3.6 and Red Hat OpenStack Platform 10. As a prerequisite, you will have to provision VMs and configure the cloud infrastructure, like network, storage, firewall and security groups. -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 -availability, you may want to use the -link:https://github.com/openshift/openshift-ansible-contrib/tree/master/playbooks/provisioning/openstack[Ansible automation playbooks] -instead. For automated installations, see also +These configuration tasks may be assisted by that reference architecture, +the +xref:../../install_config/install/prerequisites#prereq-cloud-provider-considerations[cloud provider considerations] +and link:https://github.com/openshift/openshift-ansible-contrib/tree/master/playbooks/provisioning/openstack[Ansible playbooks] +to automate it. See also xref:../../install_config/configuring_openstack#install-config-configuring-openstack[Configuring for OpenStack] and xref:configuring-ansible[Configuring Ansible Inventory Files]. @@ -119,7 +117,7 @@ ifdef::openshift-enterprise[] 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} 3.4 on Red Hat OpenStack Platform 10] -is deprecated. For OSP 13 time frame, it is being replaced with the +is not supported anymore. 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]. For automated installations, please follow that guide instead! ==== From 27ea12a051de4ab152e4a3c6b9a7fefe8bbc0b98 Mon Sep 17 00:00:00 2001 From: Bogdan Dobrelya Date: Fri, 17 Nov 2017 11:26:41 +0100 Subject: [PATCH 4/4] Adjust openstack provider links Point to the official location of the provider's new home. Signed-off-by: Bogdan Dobrelya --- install_config/install/advanced_install.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/install_config/install/advanced_install.adoc b/install_config/install/advanced_install.adoc index 5b6449fbcfba..51b41e1f629f 100644 --- a/install_config/install/advanced_install.adoc +++ b/install_config/install/advanced_install.adoc @@ -105,7 +105,7 @@ infrastructure, like network, storage, firewall and security groups. These configuration tasks may be assisted by that reference architecture, the xref:../../install_config/install/prerequisites#prereq-cloud-provider-considerations[cloud provider considerations] -and link:https://github.com/openshift/openshift-ansible-contrib/tree/master/playbooks/provisioning/openstack[Ansible playbooks] +and link:https://github.com/openshift/openshift-ansible/tree/master/playbooks/openstack[Ansible playbooks] to automate it. See also xref:../../install_config/configuring_openstack#install-config-configuring-openstack[Configuring for OpenStack] and @@ -118,7 +118,7 @@ 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} 3.4 on Red Hat OpenStack Platform 10] is not supported anymore. 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]. +link:https://github.com/openshift/openshift-ansible/tree/master/playbooks/openstack[Ansible driven deployment solution]. For automated installations, please follow that guide instead! ==== endif::[]