Skip to content

Commit 7f06e2f

Browse files
authored
Merge pull request #3908 from ahardin-rh/3353-followup
Follow-up edits to PR#3353
2 parents 724dab2 + a792a6d commit 7f06e2f

File tree

2 files changed

+27
-30
lines changed

2 files changed

+27
-30
lines changed

Diff for: dev_guide/create_from_url.adoc

+22-21
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,16 @@
1111

1212
toc::[]
1313

14-
[[overview]]
1514
== Overview
1615

1716
Create From URL is a function that allows you to construct a URL from an image
1817
stream, image tag, or template.
1918

20-
Create from URL only works with image streams or templates from
21-
namespaces that have been explicitly whitelisted. The whitelist contains
22-
the 'openshift' namespace by default. To add namespaces to the whitelist, see
23-
xref:../install_config/web_console_customization.adoc#configuring-the-create-
24-
from-url-namespace-whitelist[Configuring the Create From URL Namespace Whitelist].
19+
Create from URL only works with image streams or templates from namespaces that
20+
have been explicitly whitelisted. The whitelist contains the `openshift`
21+
namespace by default. To add namespaces to the whitelist, see
22+
xref:../install_config/web_console_customization.adoc#configuring-the-create-from-url-namespace-whitelist[Configuring
23+
the Create From URL Namespace Whitelist].
2524

2625
[[create-for-url-using-an-image-stream-and-image-tag]]
2726
== Using an Image Stream and Image Tag
@@ -32,24 +31,25 @@ from-url-namespace-whitelist[Configuring the Create From URL Namespace Whitelist
3231
[options="header"]
3332
|===
3433
|Name|Description|Required|Schema|Default
35-
|imageStream|The value metadata.name as defined in the image stream to be used.|
34+
|`imageStream`|The value `metadata.name` as defined in the image stream to be used.|
3635
true|string|
37-
|imageTag|The value spec.tags.name as defined in the image stream to be used.|
36+
|`imageTag`|The value `spec.tags.name` as defined in the image stream to be used.|
3837
true|string|
39-
|namespace|The name of the namespace containing the image stream and image tag
40-
to use.|false|string|openshift
41-
|name|Identifies the resources created for this application.|false|string|
42-
|sourceURI|The git repository URL containing the application source code.|false|
38+
|`namespace`|The name of the namespace containing the image stream and image tag
39+
to use.|false|string|`openshift`
40+
|`name`|Identifies the resources created for this application.|false|string|
41+
|`sourceURI`|The Git repository URL containing the application source code.|false|
4342
string|
44-
|sourceRef|The branch, tag, or commit for the application source code specified
45-
in sourceURI.|false|string|
46-
|contextDir|The subdirectory for the application source code specified in
47-
sourceURI, used as the context directory for the build.|false|string|
43+
|`sourceRef`|The branch, tag, or commit for the application source code specified
44+
in `sourceURI`.|false|string|
45+
|`contextDir`|The subdirectory for the application source code specified in
46+
`sourceURI`, used as the context directory for the build.|false|string|
4847
|===
4948

5049
[NOTE]
5150
====
52-
link:https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_reserved_characters[Reserved characters] in parameter values should be URL encoded.
51+
link:https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_reserved_characters[Reserved
52+
characters] in parameter values should be URL encoded.
5353
====
5454

5555
[[example-usage-of-an-image-stream-and-image-tag]]
@@ -67,16 +67,17 @@ link:https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_reserved_ch
6767
[options="header"]
6868
|===
6969
|Name|Description|Required|Schema|Default
70-
|template|The value of metadata.name as defined in the template to be used.|
70+
|`template`|The value of `metadata.name` as defined in the template to be used.|
7171
true|string|
72-
|templateParamsMap|A JSON parameters map containing the template parameter name
72+
|`templateParamsMap`|A JSON parameters map containing the template parameter name
7373
and corresponding value you wish to override.|false|JSON|
74-
|namespace|The name of the namespace containing the template to use.|false|string|openshift
74+
|`namespace`|The name of the namespace containing the template to use.|false|string|`openshift`
7575
|===
7676

7777
[NOTE]
7878
====
79-
link:https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_reserved_characters[Reserved characters] in parameter values should be URL encoded.
79+
link:https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_reserved_characters[Reserved
80+
characters] in parameter values should be URL encoded.
8081
====
8182

8283
[[example-usage-of-a-template]]

Diff for: install_config/web_console_customization.adoc

+5-9
Original file line numberDiff line numberDiff line change
@@ -520,48 +520,44 @@ endif::[]
520520

521521
xref:../dev_guide/create_from_url.adoc#dev-guide-create-from-url[Create from URL]
522522
only works with image streams or templates from namespaces that have been
523-
explicitly specified in OPENSHIFT_CONSTANTS.CREATE_FROM_URL_WHITELIST. To add
523+
explicitly specified in `OPENSHIFT_CONSTANTS.CREATE_FROM_URL_WHITELIST`. To add
524524
namespaces to the whitelist, follow these steps:
525525

526526
[NOTE]
527527
====
528-
'openshift' is included in the whitelist by default. It should not be removed.
528+
`openshift` is included in the whitelist by default. Do not remove it.
529529
====
530530

531531
. Create the following configuration scripts within a file (for example,
532532
*_create-from-url-whitelist.js_*):
533533
+
534-
====
535534
----
536535
// Add a namespace containing the image streams and/or templates
537536
window.OPENSHIFT_CONSTANTS.CREATE_FROM_URL_WHITELIST.push(
538537
'shared-stuff'
539538
);
540539
----
541-
====
542540

543-
. Save the file and add it to the master configuration at
541+
. Save the file and add it to the master configuration file at
544542
*_/etc/origin/master/master-config.yml_*:
545543
+
546-
====
547544
----
548545
assetConfig:
549546
...
550547
extensionScripts:
551548
- /path/to/create-from-url-whitelist.js
552549
----
553-
====
554550

555551
. Restart the master host:
556552
+
557-
====
553+
----
558554
ifdef::openshift-origin[]
559555
# systemctl restart origin-master
560556
endif::[]
561557
ifdef::openshift-enterprise[]
562558
# systemctl restart atomic-openshift-master
563559
endif::[]
564-
====
560+
----
565561

566562
endif::[]
567563

0 commit comments

Comments
 (0)