summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRodolfo Carvalho <rhcarvalho@gmail.com>2017-03-29 16:46:54 +0200
committerRodolfo Carvalho <rhcarvalho@gmail.com>2017-04-11 13:21:39 +0200
commit79456a702e201c32aa6709dd767c84e70945f451 (patch)
treedc93ea04b28381721029f79f82e6681cafcba80c
parent61d1a8ccbe90373a4ae7f0e3e5ba7a98d0a87132 (diff)
downloadopenshift-79456a702e201c32aa6709dd767c84e70945f451.tar.gz
openshift-79456a702e201c32aa6709dd767c84e70945f451.tar.bz2
openshift-79456a702e201c32aa6709dd767c84e70945f451.tar.xz
openshift-79456a702e201c32aa6709dd767c84e70945f451.zip
Update deployment_type documentation
-rw-r--r--DEPLOYMENT_TYPES.md32
-rw-r--r--README_CONTAINERIZED_INSTALLATION.md2
-rw-r--r--inventory/byo/hosts.origin.example2
-rw-r--r--inventory/byo/hosts.ose.example2
-rw-r--r--roles/openshift_repos/README.md8
5 files changed, 24 insertions, 22 deletions
diff --git a/DEPLOYMENT_TYPES.md b/DEPLOYMENT_TYPES.md
index 42ac5635a..3ad7f05b3 100644
--- a/DEPLOYMENT_TYPES.md
+++ b/DEPLOYMENT_TYPES.md
@@ -1,22 +1,24 @@
-#Deployment Types
+# Deployment Types
-This module supports OpenShift Origin and OpenShift Enterprise Each deployment
-type sets various defaults used throughout your environment.
+This repository supports OpenShift Origin and OpenShift Container Platform.
-The table below outlines the defaults per `deployment_type`.
+Various defaults used throughout the playbooks and roles in this repository are
+set based on the deployment type configuration (usually defined in an Ansible
+hosts file).
-| deployment_type | origin | enterprise (< 3.1) | openshift-enterprise (>= 3.1) |
-|-----------------------------------------------------------------|------------------------------------------|----------------------------------------|----------------------------------|
-| **openshift.common.service_type** (also used for package names) | origin | openshift | |
-| **openshift.common.config_base** | /etc/origin | /etc/openshift | /etc/origin |
-| **openshift.common.data_dir** | /var/lib/origin | /var/lib/openshift | /var/lib/origin |
-| **openshift.master.registry_url openshift.node.registry_url** | openshift/origin-${component}:${version} | openshift3/ose-${component}:${version} | aos3/aos-${component}:${version} |
-| **Image Streams** | centos | rhel + xpaas | rhel |
+The table below outlines the defaults per `openshift_deployment_type`:
+| openshift_deployment_type | origin | enterprise (< 3.1) | openshift-enterprise (>= 3.1) |
+|-----------------------------------------------------------------|------------------------------------------|----------------------------------------|----------------------------------------|
+| **openshift.common.service_type** (also used for package names) | origin | openshift | |
+| **openshift.common.config_base** | /etc/origin | /etc/openshift | /etc/origin |
+| **openshift.common.data_dir** | /var/lib/origin | /var/lib/openshift | /var/lib/origin |
+| **openshift.master.registry_url openshift.node.registry_url** | openshift/origin-${component}:${version} | openshift3/ose-${component}:${version} | openshift3/ose-${component}:${version} |
+| **Image Streams** | centos | rhel + xpaas | rhel |
-**NOTE** `enterprise` deployment type is used for OpenShift Enterprise version
-3.0.x OpenShift Enterprise deployments utilizing version 3.1 and later will
-make use of the new `openshift-enterprise` deployment type. Additional work to
-migrate between the two will be forthcoming.
+**NOTES**:
+- `enterprise` deployment type is used for OpenShift Enterprise version
+3.0.x.
+- `openshift-enterprise` deployment type is used for OpenShift Enterprise (and now OpenShift Container Platform) version 3.1 and later.
diff --git a/README_CONTAINERIZED_INSTALLATION.md b/README_CONTAINERIZED_INSTALLATION.md
index 5e013e809..c697783e3 100644
--- a/README_CONTAINERIZED_INSTALLATION.md
+++ b/README_CONTAINERIZED_INSTALLATION.md
@@ -38,7 +38,7 @@ and _/tmp_. Be mindful of this when passing in files to be processed by `oc` or
### Requisite Images
-Based on your deployment_type the installer will make use of the following
+Based on your `openshift_deployment_type` the installer will make use of the following
images. Because you may make use of a private repository we've moved the
configuration of docker additional, insecure, and blocked registries to the
beginning of the installation process ensuring that these settings are applied
diff --git a/inventory/byo/hosts.origin.example b/inventory/byo/hosts.origin.example
index 27914e60a..a99423411 100644
--- a/inventory/byo/hosts.origin.example
+++ b/inventory/byo/hosts.origin.example
@@ -22,7 +22,7 @@ ansible_ssh_user=root
# Debug level for all OpenShift components (Defaults to 2)
debug_level=2
-# deployment type valid values are origin, online, atomic-enterprise and openshift-enterprise
+# Specify the deployment type. Valid values are origin and openshift-enterprise.
openshift_deployment_type=origin
# Specify the generic release of OpenShift to install. This is used mainly just during installation, after which we
diff --git a/inventory/byo/hosts.ose.example b/inventory/byo/hosts.ose.example
index f0269bff8..9774aa66b 100644
--- a/inventory/byo/hosts.ose.example
+++ b/inventory/byo/hosts.ose.example
@@ -22,7 +22,7 @@ ansible_ssh_user=root
# Debug level for all OpenShift components (Defaults to 2)
debug_level=2
-# deployment type valid values are origin, online, atomic-enterprise, and openshift-enterprise
+# Specify the deployment type. Valid values are origin and openshift-enterprise.
openshift_deployment_type=openshift-enterprise
# Specify the generic release of OpenShift to install. This is used mainly just during installation, after which we
diff --git a/roles/openshift_repos/README.md b/roles/openshift_repos/README.md
index 95b155b29..abd1997dd 100644
--- a/roles/openshift_repos/README.md
+++ b/roles/openshift_repos/README.md
@@ -12,10 +12,10 @@ rhel-7-server-extra-rpms, and rhel-7-server-ose-3.0-rpms repos.
Role Variables
--------------
-| Name | Default value | |
-|-------------------------------|---------------|----------------------------------------------|
-| openshift_deployment_type | None | Possible values enterprise, origin, online |
-| openshift_additional_repos | {} | TODO |
+| Name | Default value | |
+|-------------------------------|---------------|------------------------------------|
+| openshift_deployment_type | None | Possible values enterprise, origin |
+| openshift_additional_repos | {} | TODO |
Dependencies
------------