Skip to content

Commit 990503f

Browse files
author
Timothy Poitras
committed
Tech Rev 2: removed many ifdefs, removed first steps, fixed broken links
1 parent da9284b commit 990503f

File tree

20 files changed

+48
-207
lines changed

20 files changed

+48
-207
lines changed

_build_cfg.yml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -170,19 +170,16 @@ Topics:
170170
File: docker_registry
171171
- Name: Deploying a Router
172172
File: deploy_router
173-
- Name: First Steps
174-
File: first_steps
175-
Distros: openshift-origin
176173
- Name: Upgrading
177174
File: upgrades
178175
- Name: Downgrading
179176
File: downgrade
180177
Distros: openshift-enterprise
181178
- Name: Master and Node Configuration
182179
File: master_node_configuration
183-
- Name: Default Image Streams and Templates
184-
File: default_imagestreams_templates
185-
Distros: openshift-enterprise
180+
- Name: Image Streams and Templates
181+
File: imagestreams_templates
182+
Distros: openshift-enterprise,openshift-origin
186183
- Name: Configuring Custom Certificates
187184
File: certificate_customization
188185
- Name: Configuring Authentication

architecture/core_concepts/templates.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ application.
8888
Templates can be processed from a definition in a file or
8989
from an existing OpenShift API object. Cluster administrators can
9090
ifdef::openshift-origin[]
91-
link:../../install_config/install/first_steps.html#creating-instantapp-templates[define standard templates in the API]
91+
link:../../install_config/imagestreams_templates.html#creating-instantapp-templates[define standard templates in the API]
9292
endif::[]
9393
ifdef::openshift-enterprise[]
9494
link:../../install_config/default_imagestreams_templates.html#creating-instantapp-templates[define standard templates in the API]

dev_guide/templates.adoc

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -249,14 +249,9 @@ You can list the available default InstantApp templates with:
249249
$ oc get templates -n openshift
250250
----
251251

252-
ifdef::openshift-origin[]
253252
If they are not available, direct your cluster administrator to the
254-
link:../install_config/install/first_steps.html[First Steps] topic.
255-
endif::[]
256-
ifdef::openshift-enterprise[]
257-
If they are not available, direct your cluster administrator to the
258-
link:../install_config/default_imagestreams_templates.html[Default Image Streams and Templates] topic.
259-
endif::[]
253+
link:../install_config/imagestreams_templates.html[Image Streams and Templates]
254+
topic.
260255

261256
By default, the templates build using a public source repository on
262257
https://github.com[GitHub] that contains the necessary application code. In

getting_started/developers/developers_cli.adoc

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,8 @@ endif::openshift-dedicated[]
5959

6060
- Your instance must be pre-configured by a cluster administrator with the InstantApp templates and builder images. If they
6161
are not available,
62-
ifdef::openshift-origin[]
6362
direct your cluster administrator to the
64-
link:../../install_config/install/first_steps.html[First Steps] topic.
65-
endif::[]
66-
ifdef::openshift-enterprise[]
67-
direct your cluster administrator to the
68-
link:../../install_config/default_imagestreams_templates.html[Default Image Streams and Templates] topic.
69-
endif::[]
63+
link:../install_config/imagestreams_templates.html[Image Streams and Templates] topic.
7064
ifdef::openshift-dedicated[]
7165
contact your cluster administrator.
7266
endif::[]

install_config/default_imagestreams_templates.adoc renamed to install_config/imagestreams_templates.adoc

Lines changed: 19 additions & 122 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Default Image Streams and Templates
1+
= Image Streams and Templates
22
{product-author}
33
{product-version}
44
:data-uri:
@@ -10,8 +10,6 @@
1010

1111
toc::[]
1212

13-
// tag::firststeps[]
14-
1513
== Overview
1614

1715
ifdef::openshift-enterprise[]
@@ -26,19 +24,24 @@ default global project to which all users have view access.
2624
endif::[]
2725

2826
ifdef::openshift-origin[]
29-
You can populate your OpenShift installation with a useful set of Red
30-
Hat-provided
31-
link:../../architecture/core_concepts/builds_and_image_streams.html#image-streams[image
32-
streams] and link:../../architecture/core_concepts/templates.html[templates] to
27+
You can populate your OpenShift installation with a useful set of
28+
Red Hat-provided
29+
link:../architecture/core_concepts/builds_and_image_streams.html#image-streams[image streams] and
30+
link:../architecture/core_concepts/templates.html[templates] to
3331
make it easy for developers to create new applications. By default, the
34-
link:advanced_install.html[advanced installation] method automatically creates
32+
link:../install_config/install/advanced_install.html[advanced installation] method automatically creates
3533
these sets in the *openshift* project, which is a default project to which all
3634
users have view access.
3735
endif::[]
3836

3937
ifdef::openshift-enterprise[]
40-
The core set of image streams and templates are provided and supported by Red Hat
41-
with an active OpenShift Enterprise subscription for the following technologies:
38+
The core set of image streams and templates are provided and supported by
39+
Red Hat with an active OpenShift Enterprise subscription for the following
40+
technologies:
41+
endif::[]
42+
ifdef::openshift-origin[]
43+
Image streams and templates are provided for the following technologies:
44+
endif::[]
4245

4346
[horizontal]
4447
Languages::
@@ -53,25 +56,6 @@ Database::
5356
- link:../using_images/db_images/postgresql.html[PostgreSQL]
5457
Other Services::
5558
- link:../using_images/other_images/jenkins.html[Jenkins]
56-
endif::[]
57-
58-
ifdef::openshift-origin[]
59-
Image streams and templates are provided for the following technologies:
60-
61-
[horizontal]
62-
Languages::
63-
- link:../../using_images/s2i_images/nodejs.html[Node.js]
64-
- link:../../using_images/s2i_images/perl.html[Perl]
65-
- link:../../using_images/s2i_images/php.html[PHP]
66-
- link:../../using_images/s2i_images/python.html[Python]
67-
- link:../../using_images/s2i_images/ruby.html[Ruby]
68-
Database::
69-
- link:../../using_images/db_images/mongodb.html[MongoDB]
70-
- link:../../using_images/db_images/mysql.html[MySQL]
71-
- link:../../using_images/db_images/postgresql.html[PostgreSQL]
72-
Other Services::
73-
- link:../../using_images/other_images/jenkins.html[Jenkins]
74-
endif::[]
7559

7660
ifdef::openshift-enterprise[]
7761
If you also have the relevant xPaaS Middleware subscription active on your
@@ -101,12 +85,9 @@ The JSON object definitions used to create these sets are installed on the file
10185
system of your master during
10286
ifdef::openshift-enterprise[]
10387
a link:../install_config/install/quick_install.html[quick] or
104-
link:../install_config/install/advanced_install.html[advanced installation].
105-
endif::[]
106-
ifdef::openshift-origin[]
107-
an link:../../install_config/install/advanced_install.html[advanced
108-
installation].
10988
endif::[]
89+
an
90+
link:../install_config/install/advanced_install.html[advanced installation].
11091
If you used another method to install, or if the default image streams and
11192
templates are ever removed or changed, you can use the following instructions to
11293
create the default objects yourself. Otherwise, the following instructions are
@@ -119,31 +100,12 @@ Before you can create the default image streams and templates (if they do not
119100
already exist):
120101

121102
- The
122-
ifdef::openshift-enterprise[]
123103
link:../install_config/install/docker_registry.html[integrated Docker registry]
124-
endif::[]
125-
ifdef::openshift-origin[]
126-
link:../../install_config/install/docker_registry.html[integrated Docker
127-
registry]
128-
endif::[]
129-
service must be
130-
deployed in your OpenShift installation.
104+
service must be deployed in your OpenShift installation.
131105
- You must be able to run the following CLI commands with
132-
ifdef::openshift-enterprise[]
133-
link:../architecture/additional_concepts/authorization.html#roles[*cluster-admin*
134-
privileges],
135-
endif::[]
136-
ifdef::openshift-origin[]
137-
link:../../architecture/additional_concepts/authorization.html#roles[*cluster-admin*
138-
privileges],
139-
endif::[]
106+
link:../architecture/additional_concepts/authorization.html#roles[*cluster-admin* privileges],
140107
because they operate on the default *openshift*
141-
ifdef::openshift-enterprise[]
142108
link:../architecture/core_concepts/projects_and_users.html#projects[project].
143-
endif::[]
144-
ifdef::openshift-origin[]
145-
link:../../architecture/core_concepts/projects_and_users.html#projects[project].
146-
endif::[]
147109
ifdef::openshift-origin[]
148110
- You must have cloned the
149111
https://github.com/openshift/openshift-ansible/tree/master/roles/openshift_examples/files[repository]
@@ -156,8 +118,8 @@ $ git clone https://github.com/openshift/openshift-ansible
156118
endif::[]
157119
ifdef::openshift-enterprise[]
158120
- You must have installed the *atomic-openshift-utils* RPM package. See
159-
link:../install_config/install/prerequisites.html#software-prerequisites[Software
160-
Prerequisites] for instructions.
121+
link:../install_config/install/prerequisites.html#software-prerequisites[Software Prerequisites]
122+
for instructions.
161123
endif::[]
162124
- Define shell variables for the directories containing image streams and templates. This significantly shortens the commands in the following sections. To do this:
163125
+
@@ -182,7 +144,6 @@ endif::[]
182144

183145
== Creating Image Streams for OpenShift Images
184146
The core set of image streams provide images that can be used to build
185-
ifdef::openshift-enterprise[]
186147
link:../using_images/s2i_images/nodejs.html[*Node.js*],
187148
link:../using_images/s2i_images/perl.html[*Perl*],
188149
link:../using_images/s2i_images/php.html[*PHP*],
@@ -191,17 +152,6 @@ link:../using_images/s2i_images/ruby.html[*Ruby*] applications. It also
191152
defines images for link:../using_images/db_images/mongodb.html[*MongoDB*],
192153
link:../using_images/db_images/mysql.html[*MySQL*], and
193154
link:../using_images/db_images/postgresql.html[*PostgreSQL*]
194-
endif::[]
195-
ifdef::openshift-origin[]
196-
link:../../using_images/s2i_images/nodejs.html[*Node.js*],
197-
link:../../using_images/s2i_images/perl.html[*Perl*],
198-
link:../../using_images/s2i_images/php.html[*PHP*],
199-
link:../../using_images/s2i_images/python.html[*Python*], and
200-
link:../../using_images/s2i_images/ruby.html[*Ruby*] applications. It also
201-
defines images for link:../../using_images/db_images/mongodb.html[*MongoDB*],
202-
link:../../using_images/db_images/mysql.html[*MySQL*], and
203-
link:../../using_images/db_images/postgresql.html[*PostgreSQL*]
204-
endif::[]
205155
to support data storage.
206156

207157
If your node hosts are subscribed using Red Hat Subscription Manager and you
@@ -252,16 +202,9 @@ endif::[]
252202
== Creating Database Service Templates
253203
The database service templates make it easy to run a database image which can be
254204
utilized by other components. For each database
255-
ifdef::openshift-enterprise[]
256205
(link:../using_images/db_images/mongodb.html[*MongoDB*],
257206
link:../using_images/db_images/mysql.html[*MySQL*], and
258207
link:../using_images/db_images/postgresql.html[*PostgreSQL*]),
259-
endif::[]
260-
ifdef::openshift-origin[]
261-
(link:../../using_images/db_images/mongodb.html[*MongoDB*],
262-
link:../../using_images/db_images/mysql.html[*MySQL*], and
263-
link:../../using_images/db_images/postgresql.html[*PostgreSQL*]),
264-
endif::[]
265208
two templates are defined.
266209

267210
One template uses ephemeral storage in the container which means data stored
@@ -270,12 +213,7 @@ template should be used for demonstration purposes only.
270213

271214
The other template defines a persistent volume for storage, however it requires
272215
your OpenShift installation to have
273-
ifdef::openshift-enterprise[]
274216
link:../install_config/persistent_storage/persistent_storage_nfs.html[persistent volumes]
275-
endif::[]
276-
ifdef::openshift-origin[]
277-
link:../../install_config/persistent_storage/persistent_storage_nfs.html[persistent volumes]
278-
endif::[]
279217
configured.
280218

281219
To create the core set of database templates:
@@ -293,39 +231,14 @@ templates, giving them quick access to a database deployment.
293231
The InstantApp templates define a full set of objects for a running application.
294232
These include:
295233

296-
ifdef::openshift-enterprise[]
297234
- link:../architecture/core_concepts/builds_and_image_streams.html#builds[Build configurations]
298-
endif::[]
299-
ifdef::openshift-origin[]
300-
- link:../../architecture/core_concepts/builds_and_image_streams.html#builds[Build configurations]
301-
endif::[]
302235
to build the application from source located in a GitHub public repository
303-
ifdef::openshift-enterprise[]
304236
- link:../architecture/core_concepts/deployments.html#deployments-and-deployment-configurations[Deployment configurations]
305-
endif::[]
306-
ifdef::openshift-origin[]
307-
- link:../../architecture/core_concepts/deployments.html#deployments-and-deployment-configurations[Deployment configurations]
308-
endif::[]
309237
to deploy the application image after it is built.
310-
ifdef::openshift-enterprise[]
311238
- link:../architecture/core_concepts/pods_and_services.html#services[Services]
312-
endif::[]
313-
ifdef::openshift-origin[]
314-
- link:../../architecture/core_concepts/pods_and_services.html#services[Services]
315-
endif::[]
316239
to provide load balancing for the application
317-
ifdef::openshift-enterprise[]
318240
link:../architecture/core_concepts/pods_and_services.html#pods[pods].
319-
endif::[]
320-
ifdef::openshift-origin[]
321-
link:../../architecture/core_concepts/pods_and_services.html#pods[pods].
322-
endif::[]
323-
ifdef::openshift-enterprise[]
324241
- link:../architecture/core_concepts/routes.html[Routes]
325-
endif::[]
326-
ifdef::openshift-origin[]
327-
- link:../../architecture/core_concepts/routes.html[Routes]
328-
endif::[]
329242
to provide external access to the application.
330243

331244
Some of the templates also define a database deployment and service so the
@@ -385,19 +298,9 @@ endif::[]
385298
== What's Next?
386299

387300
With these artifacts created, developers can now
388-
ifdef::openshift-enterprise[]
389301
link:../dev_guide/authentication.html[log into the web console]
390-
endif::[]
391-
ifdef::openshift-origin[]
392-
link:../../dev_guide/authentication.html[log into the web console]
393-
endif::[]
394302
and follow the flow for
395-
ifdef::openshift-enterprise[]
396303
link:../dev_guide/templates.html#creating-from-templates-using-the-web-console[creating from a template].
397-
endif::[]
398-
ifdef::openshift-origin[]
399-
link:../../dev_guide/templates.html#creating-from-templates-using-the-web-console[creating from a template].
400-
endif::[]
401304
Any of the database or application templates can be selected
402305
to create a running database service or application in the current project. Note
403306
that some of the application templates define their own database services as
@@ -411,11 +314,5 @@ creating from the templates. This allows developers to experiment with creating
411314
their own applications.
412315

413316
You can direct your developers to the
414-
ifdef::openshift-enterprise[]
415317
link:../dev_guide/templates.html#using-the-instantapp-templates[Using the InstantApp Templates]
416-
endif::[]
417-
ifdef::openshift-origin[]
418-
link:../../dev_guide/templates.html#using-the-instantapp-templates[Using the InstantApp Templates]
419-
endif::[]
420318
section in the Developer Guide for these instructions.
421-
// end::firststeps[]

install_config/install/advanced_install.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1092,5 +1092,6 @@ endif::[]
10921092
- Deploy an link:docker_registry.html[integrated Docker registry].
10931093
- Deploy a link:deploy_router.html[router].
10941094
ifdef::openshift-origin[]
1095-
- link:../../install_config/install/first_steps.html[Populate your OpenShift installation] with a useful set of Red Hat-provided image streams and templates.
1095+
- link:../../install_config/imagestreams_templates.html[Populate your OpenShift installation]
1096+
with a useful set of Red Hat-provided image streams and templates.
10961097
endif::[]

install_config/install/deploy_router.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -827,6 +827,6 @@ All].
827827
endif::[]
828828
- Deploy an link:docker_registry.html[integrated Docker registry].
829829
ifdef::openshift-origin[]
830-
- link:../../install_config/install/first_steps.html[Populate your OpenShift installation] with a useful set
831-
of Red Hat-provided image streams and templates.
830+
- link:../../install_config/imagestreams_templates.html[Populate your OpenShift installation]
831+
with a useful set of Red Hat-provided image streams and templates.
832832
endif::[]

install_config/install/docker_registry.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -704,6 +704,6 @@ All].
704704
endif::[]
705705
- Deploy a link:deploy_router.html[router].
706706
ifdef::openshift-origin[]
707-
- link:../../install_config/install/first_steps.html[Populate your OpenShift installation] with a useful set
708-
of Red Hat-provided image streams and templates.
707+
- link:../../install_config/imagestreams_templates.html[Populate your OpenShift installation]
708+
with a useful set of Red Hat-provided image streams and templates.
709709
endif::[]

install_config/install/first_steps.adoc

Lines changed: 0 additions & 13 deletions
This file was deleted.

install_config/install/quick_install.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,7 @@ All].
307307
- Deploy an link:docker_registry.html[integrated Docker registry].
308308
- Deploy a link:deploy_router.html[router].
309309
\\\\
310-
- link:first_steps.html[Populate your OpenShift installation] with a useful set
311-
of Red Hat-provided image streams and templates.
310+
- link:../../install_config/imagestreams_templates.html[Populate your OpenShift installation]
311+
with a useful set of Red Hat-provided image streams and templates.
312312
\\\\
313313
endif::[]

0 commit comments

Comments
 (0)