Merge pull request #3799 from rhcarvalho/docs

Documentation updates
openshift · Apr 12, 2017 · ff88247 · ff88247
2 parents 8d34cd3 + 69fb4f0
commit ff88247
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 61 deletions.
diff --git a/BUILD.md b/BUILD.md
@@ -1,10 +1,12 @@
 # openshift-ansible RPM Build instructions
+
 We use tito to make building and tracking revisions easy.
 
 For more information on tito, please see the [Tito home page](https://github.com/dgoodwin/tito "Tito home page").
 
 
-## Build openshift-ansible-bin
+## Build openshift-ansible
+
 - Change into openshift-ansible
 ```
 cd openshift-ansible
@@ -22,23 +24,3 @@ tito tag
 ```
 tito build --rpm
 ```
-
-
-## Build openshift-ansible-inventory
-- Change into openshift-ansible/inventory
-```
-cd openshift-ansible/inventory
-```
-- Build a test package (no tagging needed)
-```
-tito build --test --rpm
-```
-- Tag a new build (bumps version number and adds log entries)
-```
-tito tag
-```
-- Follow the on screen tito instructions to push the tags
-- Build a new package based on the latest tag information
-```
-tito build --rpm
-```
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -200,6 +200,9 @@ test results are posted to S3 buckets when complete.
 
 The test output of each job is also posted to the Pull Request as comments.
 
+A trend of the time taken by merge jobs is available at
+https://ci.openshift.redhat.com/jenkins/job/merge_pull_request_openshift_ansible/buildTimeTrend.
+
 ---
 
 ## Appendix

diff --git a/DEPLOYMENT_TYPES.md b/DEPLOYMENT_TYPES.md
@@ -1,22 +1,17 @@
-#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`.
-
-| 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                             |
-
-
-**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.
+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).
 
+The table below outlines the defaults per `openshift_deployment_type`:
 
+| openshift_deployment_type                                       | origin                                   | openshift-enterprise                   |
+|-----------------------------------------------------------------|------------------------------------------|----------------------------------------|
+| **openshift.common.service_type** (also used for package names) | origin                                   | atomic-openshift                       |
+| **openshift.common.config_base**                                | /etc/origin                              | /etc/origin                            |
+| **openshift.common.data_dir**                                   | /var/lib/origin                          | /var/lib/origin                        |
+| **openshift.master.registry_url openshift.node.registry_url**   | openshift/origin-${component}:${version} | openshift3/ose-${component}:${version} |
+| **Image Streams**                                               | centos                                   | rhel                                   |
diff --git a/README_ANSIBLE_CONTAINER.md b/README_ANSIBLE_CONTAINER.md
diff --git 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
@@ -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
@@ -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
@@ -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
 ------------