@@ -16,64 +16,126 @@ toc::[]
1616
1717ifdef::openshift-enterprise[]
1818Your OpenShift installation includes a useful set of Red Hat-provided
19- link:../architecture/core_concepts/builds_and_image_streams.html#image-streams[image streams] and
20- link:../architecture/core_concepts/templates.html[templates] to
19+ link:../architecture/core_concepts/builds_and_image_streams.html#image-streams[image
20+ streams] and link:../architecture/core_concepts/templates.html[templates] to
2121make it easy for developers to create new applications. By default, the
2222link:../install_config/install/quick_install.html[quick installation] and
23- link:../install_config/install/advanced_install.html[advanced installation] methods automatically create
24- these sets in the *openshift* project, which is a default project to which all
25- users have view access.
23+ link:../install_config/install/advanced_install.html[advanced installation]
24+ methods automatically create these sets in the *openshift* project, which is a
25+ default global project to which all users have view access.
2626endif::[]
27+
2728ifdef::openshift-origin[]
2829You can populate your OpenShift installation with a useful set of Red
2930Hat-provided
3031link:../../architecture/core_concepts/builds_and_image_streams.html#image-streams[image
31- streams]
32- and link:../../architecture/core_concepts/templates.html[templates] to
32+ streams] and link:../../architecture/core_concepts/templates.html[templates] to
3333make it easy for developers to create new applications. By default, the
3434link:advanced_install.html[advanced installation] method automatically creates
3535these sets in the *openshift* project, which is a default project to which all
3636users have view access.
3737endif::[]
3838
39- Use the following instructions to create the objects
40- yourself. The files are installed on the file system of your master.
41-
42- [NOTE]
43- ====
44- This topic is only necessary if you installed OpenShift using a method other
45- than the
4639ifdef::openshift-enterprise[]
47- link:../install_config/install/quick_install.html[quick installation] or the
48- link:../install_config/install/advanced_install.html[advanced installation].
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:
42+
43+ [horizontal]
44+ Languages::
45+ - link:../using_images/s2i_images/nodejs.html[Node.js]
46+ - link:../using_images/s2i_images/perl.html[Perl]
47+ - link:../using_images/s2i_images/php.html[PHP]
48+ - link:../using_images/s2i_images/python.html[Python]
49+ - link:../using_images/s2i_images/ruby.html[Ruby]
50+ Database::
51+ - link:../using_images/db_images/mongodb.html[MongoDB]
52+ - link:../using_images/db_images/mysql.html[MySQL]
53+ - link:../using_images/db_images/postgresql.html[PostgreSQL]
54+ Other Services::
55+ - link:../using_images/other_images/jenkins.html[Jenkins]
4956endif::[]
57+
5058ifdef::openshift-origin[]
51- link:../../install_config/install/quick_install.html[quick installation] or the
52- link:../../install_config/install/advanced_install.html[advanced installation].
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]
5374endif::[]
54- Image
55- streams and templates will be automatically populated in the `openshift` project
56- when using these methods.
57- ====
5875
59- [[prerequisites]]
76+ ifdef::openshift-enterprise[]
77+ If you also have the relevant xPaaS Middleware subscription active on your
78+ account, image streams and templates are also provided and supported by Red Hat
79+ for each of following middleware services:
80+
81+ [horizontal]
82+ Middleware Services::
83+ - link:../using_images/xpaas_images/eap.html[JBoss EAP]
84+ - link:../using_images/xpaas_images/a_mq.html[JBoss A-MQ]
85+ - link:../using_images/xpaas_images/jws.html[JBoss Web Server]
86+ - link:../using_images/xpaas_images/fuse.html[JBoss Fuse Integration Services]
87+ - link:../using_images/xpaas_images/decision_server.html[Decision Server]
88+ - link:../using_images/xpaas_images/data_grid.html[JBoss Data Grid]
89+ endif::[]
90+
91+ You can check which default image streams and templates are currently available
92+ in your OpenShift environment by logging into the web console and clicking *Add
93+ to Project*, or getting the lists for the *openshift* project using the CLI:
94+
95+ ----
96+ $ oc get is -n openshift
97+ $ oc get templates -n openshift
98+ ----
6099
100+ The JSON object definitions used to create these sets are installed on the file
101+ system of your master during
102+ ifdef::openshift-enterprise[]
103+ 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].
109+ endif::[]
110+ If you used another method to install, or if the default image streams and
111+ templates are ever removed or changed, you can use the following instructions to
112+ create the default objects yourself. Otherwise, the following instructions are
113+ not necessary.
114+
115+ [[is-templates-prereqs]]
61116== Prerequisites
62- - The
117+
118+ Before you can create the default image streams and templates (if they do not
119+ already exist):
120+
121+ - The
63122ifdef::openshift-enterprise[]
64- link:../install_config/install/docker_registry.html[integrated Docker registry]
123+ link:../install_config/install/docker_registry.html[integrated Docker registry]
65124endif::[]
66125ifdef::openshift-origin[]
67- link:../../install_config/install/docker_registry.html[integrated Docker registry]
126+ link:../../install_config/install/docker_registry.html[integrated Docker
127+ registry]
68128endif::[]
69129service must be
70130deployed in your OpenShift installation.
71131- You must be able to run the following CLI commands with
72132ifdef::openshift-enterprise[]
73- link:../architecture/additional_concepts/authorization.html#roles[*cluster-admin* privileges],
133+ link:../architecture/additional_concepts/authorization.html#roles[*cluster-admin*
134+ privileges],
74135endif::[]
75136ifdef::openshift-origin[]
76- link:../../architecture/additional_concepts/authorization.html#roles[*cluster-admin* privileges],
137+ link:../../architecture/additional_concepts/authorization.html#roles[*cluster-admin*
138+ privileges],
77139endif::[]
78140because they operate on the default *openshift*
79141ifdef::openshift-enterprise[]
@@ -82,21 +144,37 @@ endif::[]
82144ifdef::openshift-origin[]
83145link:../../architecture/core_concepts/projects_and_users.html#projects[project].
84146endif::[]
85- - You must have cloned the https://github.com/openshift/openshift-ansible/tree/master/roles/openshift_examples/files[repository] that contains the supported imagestreams:
147+ ifdef::openshift-origin[]
148+ - You must have cloned the
149+ https://github.com/openshift/openshift-ansible/tree/master/roles/openshift_examples/files[repository]
150+ that contains the default image streams and templates:
86151+
87152----
153+ $ cd ~
88154$ git clone https://github.com/openshift/openshift-ansible
89155----
156+ endif::[]
157+ ifdef::openshift-enterprise[]
158+ - 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.
161+ endif::[]
90162- Define shell variables for the directories containing image streams and templates. This significantly shortens the commands in the following sections. To do this:
91163+
92164ifdef::openshift-origin[]
93165----
94- $ IMAGESTREAMDIR="/usr/share/ansible/openshift-ansible/roles/openshift_examples/files/examples/v1.1/image-streams"; DBTEMPLATES="/usr/share/ansible/openshift-ansible/roles/openshift_examples/files/examples/v1.1/db-templates"; QSTEMPLATES="/usr/share/ansible/openshift-ansible/roles/openshift_examples/files/examples/v1.1/quickstart-templates"
166+ $ IMAGESTREAMDIR="~/openshift-ansible/roles/openshift_examples/files/examples/v1.1/image-streams"; \
167+ DBTEMPLATES="~/openshift-ansible/roles/openshift_examples/files/examples/v1.1/db-templates"; \
168+ QSTEMPLATES="~/openshift-ansible/roles/openshift_examples/files/examples/v1.1/quickstart-templates"
95169----
96170endif::[]
97171ifdef::openshift-enterprise[]
98172----
99- $ IMAGESTREAMDIR="/usr/share/ansible/openshift-ansible/roles/openshift_examples/files/examples/v1.1/image-streams"; XPAASSTREAMDIR="/usr/share/ansible/openshift-ansible/roles/openshift_examples/files/examples/v1.1/xpaas-streams"; XPAASTEMPLATES="/usr/share/ansible/openshift-ansible/roles/openshift_examples/files/examples/v1.1/xpaas-templates"; DBTEMPLATES="/usr/share/ansible/openshift-ansible/roles/openshift_examples/files/examples/v1.1/db-templates"; QSTEMPLATES="/usr/share/ansible/openshift-ansible/roles/openshift_examples/files/examples/v1.1/quickstart-templates"
173+ $ IMAGESTREAMDIR="/usr/share/ansible/openshift-ansible/roles/openshift_examples/files/examples/v1.1/image-streams"; \
174+ XPAASSTREAMDIR="/usr/share/ansible/openshift-ansible/roles/openshift_examples/files/examples/v1.1/xpaas-streams"; \
175+ XPAASTEMPLATES="/usr/share/ansible/openshift-ansible/roles/openshift_examples/files/examples/v1.1/xpaas-templates"; \
176+ DBTEMPLATES="/usr/share/ansible/openshift-ansible/roles/openshift_examples/files/examples/v1.1/db-templates"; \
177+ QSTEMPLATES="/usr/share/ansible/openshift-ansible/roles/openshift_examples/files/examples/v1.1/quickstart-templates"
100178----
101179endif::[]
102180
@@ -112,7 +190,7 @@ link:../using_images/s2i_images/python.html[*Python*], and
112190link:../using_images/s2i_images/ruby.html[*Ruby*] applications. It also
113191defines images for link:../using_images/db_images/mongodb.html[*MongoDB*],
114192link:../using_images/db_images/mysql.html[*MySQL*], and
115- link:../using_images/db_images/postgresql.html[*PostgreSQL*]
193+ link:../using_images/db_images/postgresql.html[*PostgreSQL*]
116194endif::[]
117195ifdef::openshift-origin[]
118196link:../../using_images/s2i_images/nodejs.html[*Node.js*],
@@ -122,7 +200,7 @@ link:../../using_images/s2i_images/python.html[*Python*], and
122200link:../../using_images/s2i_images/ruby.html[*Ruby*] applications. It also
123201defines images for link:../../using_images/db_images/mongodb.html[*MongoDB*],
124202link:../../using_images/db_images/mysql.html[*MySQL*], and
125- link:../../using_images/db_images/postgresql.html[*PostgreSQL*]
203+ link:../../using_images/db_images/postgresql.html[*PostgreSQL*]
126204endif::[]
127205to support data storage.
128206
@@ -149,9 +227,12 @@ ifdef::openshift-enterprise[]
149227== Creating Image Streams for xPaaS Middleware Images
150228The xPaaS Middleware image streams provide images for
151229link:../using_images/xpaas_images/eap.html[*JBoss EAP*],
152- link:../using_images/xpaas_images/jws.html[*JBoss JWS*], and
153- link:../using_images/xpaas_images/a_mq.html[*JBoss A-MQ*]. They can be used
154- to build applications for those platforms using the provided templates.
230+ link:../using_images/xpaas_images/jws.html[*JBoss JWS*],
231+ link:../using_images/xpaas_images/a_mq.html[*JBoss A-MQ*],
232+ link:../using_images/xpaas_images/fuse.html[*JBoss Fuse Integration Services*],
233+ link:../using_images/xpaas_images/decision_server.html[*Decision Server*], and
234+ link:../using_images/xpaas_images/data_grid.html[*JBoss Data Grid*]. They can be
235+ used to build applications for those platforms using the provided templates.
155236
156237To create the xPaaS Middleware set of image streams:
157238
@@ -174,12 +255,12 @@ utilized by other components. For each database
174255ifdef::openshift-enterprise[]
175256(link:../using_images/db_images/mongodb.html[*MongoDB*],
176257link:../using_images/db_images/mysql.html[*MySQL*], and
177- link:../using_images/db_images/postgresql.html[*PostgreSQL*]),
258+ link:../using_images/db_images/postgresql.html[*PostgreSQL*]),
178259endif::[]
179260ifdef::openshift-origin[]
180261(link:../../using_images/db_images/mongodb.html[*MongoDB*],
181262link:../../using_images/db_images/mysql.html[*MySQL*], and
182- link:../../using_images/db_images/postgresql.html[*PostgreSQL*]),
263+ link:../../using_images/db_images/postgresql.html[*PostgreSQL*]),
183264endif::[]
184265two templates are defined.
185266
@@ -213,17 +294,17 @@ The InstantApp templates define a full set of objects for a running application.
213294These include:
214295
215296ifdef::openshift-enterprise[]
216- - link:../architecture/core_concepts/builds_and_image_streams.html#builds[Build configurations]
297+ - link:../architecture/core_concepts/builds_and_image_streams.html#builds[Build configurations]
217298endif::[]
218299ifdef::openshift-origin[]
219- - link:../../architecture/core_concepts/builds_and_image_streams.html#builds[Build configurations]
300+ - link:../../architecture/core_concepts/builds_and_image_streams.html#builds[Build configurations]
220301endif::[]
221302to build the application from source located in a GitHub public repository
222303ifdef::openshift-enterprise[]
223- - link:../architecture/core_concepts/deployments.html#deployments-and-deployment-configurations[Deployment configurations]
304+ - link:../architecture/core_concepts/deployments.html#deployments-and-deployment-configurations[Deployment configurations]
224305endif::[]
225306ifdef::openshift-origin[]
226- - link:../../architecture/core_concepts/deployments.html#deployments-and-deployment-configurations[Deployment configurations]
307+ - link:../../architecture/core_concepts/deployments.html#deployments-and-deployment-configurations[Deployment configurations]
227308endif::[]
228309to deploy the application image after it is built.
229310ifdef::openshift-enterprise[]
@@ -240,10 +321,10 @@ ifdef::openshift-origin[]
240321link:../../architecture/core_concepts/pods_and_services.html#pods[pods].
241322endif::[]
242323ifdef::openshift-enterprise[]
243- - link:../architecture/core_concepts/routes.html[Routes]
324+ - link:../architecture/core_concepts/routes.html[Routes]
244325endif::[]
245326ifdef::openshift-origin[]
246- - link:../../architecture/core_concepts/routes.html[Routes]
327+ - link:../../architecture/core_concepts/routes.html[Routes]
247328endif::[]
248329to provide external access to the application.
249330
@@ -252,8 +333,9 @@ application can perform database operations.
252333
253334[NOTE]
254335====
255- The templates which define a database use ephemeral storage for the database content. These templates should be used
256- for demonstration purposes only as all database data will be lost if the database pod restarts for any reason.
336+ The templates which define a database use ephemeral storage for the database
337+ content. These templates should be used for demonstration purposes only as all
338+ database data will be lost if the database pod restarts for any reason.
257339====
258340
259341After creating the templates, users are able to easily instantiate full
@@ -271,9 +353,12 @@ $ oc create -f $QSTEMPLATES -n openshift
271353ifdef::openshift-enterprise[]
272354There is also a set of templates for creating applications using various xPaaS
273355Middleware products (link:../using_images/xpaas_images/eap.html[*JBoss EAP*],
274- link:../using_images/xpaas_images/jws.html[*JBoss JWS*], and
275- link:../using_images/xpaas_images/a_mq.html[*JBoss A-MQ*]), which can be
276- registered by running:
356+ link:../using_images/xpaas_images/jws.html[*JBoss JWS*],
357+ link:../using_images/xpaas_images/a_mq.html[*JBoss A-MQ*],
358+ link:../using_images/xpaas_images/fuse.html[*JBoss Fuse Integration Services*],
359+ link:../using_images/xpaas_images/decision_server.html[*Decision Server*], and
360+ link:../using_images/xpaas_images/data_grid.html[*JBoss Data Grid*]), which can
361+ be registered by running:
277362
278363----
279364$ oc create -f $XPAASTEMPLATES -n openshift
@@ -282,8 +367,9 @@ $ oc create -f $XPAASTEMPLATES -n openshift
282367[NOTE]
283368====
284369The xPaaS Middleware templates require the
285- link:../install_config/default_imagestreams_templates.html#creating-image-streams-for-xpaas-middleware-images[xPaaS Middleware image
286- streams], which in turn require the relevant xPaaS Middleware subscriptions.
370+ link:../install_config/default_imagestreams_templates.html#creating-image-streams-for-xpaas-middleware-images[xPaaS
371+ Middleware image streams], which in turn require the relevant xPaaS Middleware
372+ subscriptions.
287373====
288374
289375[NOTE]
@@ -300,17 +386,17 @@ endif::[]
300386
301387With these artifacts created, developers can now
302388ifdef::openshift-enterprise[]
303- link:../dev_guide/authentication.html[log into the web console]
389+ link:../dev_guide/authentication.html[log into the web console]
304390endif::[]
305391ifdef::openshift-origin[]
306- link:../../dev_guide/authentication.html[log into the web console]
392+ link:../../dev_guide/authentication.html[log into the web console]
307393endif::[]
308394and follow the flow for
309395ifdef::openshift-enterprise[]
310- link:../dev_guide/templates.html#creating-from-templates-using-the-web-console[creating from a template].
396+ link:../dev_guide/templates.html#creating-from-templates-using-the-web-console[creating from a template].
311397endif::[]
312398ifdef::openshift-origin[]
313- link:../../dev_guide/templates.html#creating-from-templates-using-the-web-console[creating from a template].
399+ link:../../dev_guide/templates.html#creating-from-templates-using-the-web-console[creating from a template].
314400endif::[]
315401Any of the database or application templates can be selected
316402to create a running database service or application in the current project. Note
@@ -326,10 +412,10 @@ their own applications.
326412
327413You can direct your developers to the
328414ifdef::openshift-enterprise[]
329- link:../dev_guide/templates.html#using-the-instantapp-templates[Using the InstantApp Templates]
415+ link:../dev_guide/templates.html#using-the-instantapp-templates[Using the InstantApp Templates]
330416endif::[]
331417ifdef::openshift-origin[]
332- link:../../dev_guide/templates.html#using-the-instantapp-templates[Using the InstantApp Templates]
418+ link:../../dev_guide/templates.html#using-the-instantapp-templates[Using the InstantApp Templates]
333419endif::[]
334420section in the Developer Guide for these instructions.
335421// end::firststeps[]
0 commit comments