Adding Create From URL documentation #3353
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| [[dev-guide-create-from-url]] | ||
| = Create from URL | ||
| {product-author} | ||
| {product-version} | ||
| :data-uri: | ||
| :icons: | ||
| :experimental: | ||
| :toc: macro | ||
| :toc-title: | ||
| :prewrap!: | ||
|
|
||
| toc::[] | ||
|
|
||
| [[overview]] | ||
| == Overview | ||
|
|
||
| Create From URL is a function that allows you to construct a URL from an image | ||
| stream, image tag, or template. | ||
|
|
||
| Create from URL only works with image streams or templates from | ||
| namespaces that have been explicitly whitelisted. The whitelist contains | ||
| the 'openshift' namespace by default. To add namespaces to the whitelist, see | ||
| xref:../install_config/web_console_customization.adoc#configuring-the-create- | ||
| from-url-namespace-whitelist[Configuring the Create From URL Namespace Whitelist]. | ||
|
|
||
| [[create-for-url-using-an-image-stream-and-image-tag]] | ||
| == Using an Image Stream and Image Tag | ||
|
|
||
| [[image-stream-and-image-tag-query-string-parameters]] | ||
| === Query String Parameters | ||
|
|
||
| [options="header"] | ||
| |=== | ||
| |Name|Description|Required|Schema|Default | ||
| |imageStream|The value metadata.name as defined in the image stream to be used.| | ||
| true|string| | ||
| |imageTag|The value spec.tags.name as defined in the image stream to be used.| | ||
| true|string| | ||
| |namespace|The name of the namespace containing the image stream and image tag | ||
| to use.|false|string|openshift | ||
| |name|Identifies the resources created for this application.|false|string| | ||
| |sourceURI|The git repository URL containing the application source code.|false| | ||
| string| | ||
| |sourceRef|The branch, tag, or commit for the application source code specified | ||
| in sourceURI.|false|string| | ||
| |contextDir|The subdirectory for the application source code specified in | ||
| sourceURI, used as the context directory for the build.|false|string| | ||
| |=== | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| link:https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_reserved_characters[Reserved characters] in parameter values should be URL encoded. | ||
| ==== | ||
|
|
||
|
There was a problem hiding this comment. This heading needs a unique ID |
||
| [[example-usage-of-an-image-stream-and-image-tag]] | ||
| ==== Example | ||
| ---- | ||
| create?imageStream=nodejs&imageTag=4&name=nodejs&sourceURI=https%3A%2F%2Fgithub.com%2Fopenshift%2Fnodejs-ex.git&sourceRef=master&contextDir=%2F | ||
| ---- | ||
|
|
||
| [[create-from-url-using-a-template]] | ||
| == Using a Template | ||
|
|
||
| [[template-query-string-parameters]] | ||
| === Query String Parameters | ||
|
|
||
| [options="header"] | ||
| |=== | ||
| |Name|Description|Required|Schema|Default | ||
| |template|The value of metadata.name as defined in the template to be used.| | ||
| true|string| | ||
| |templateParamsMap|A JSON parameters map containing the template parameter name | ||
| and corresponding value you wish to override.|false|JSON| | ||
| |namespace|The name of the namespace containing the template to use.|false|string|openshift | ||
| |=== | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| link:https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_reserved_characters[Reserved characters] in parameter values should be URL encoded. | ||
| ==== | ||
|
|
||
| [[example-usage-of-a-template]] | ||
| ==== Example | ||
| ---- | ||
| create?template=nodejs-mongodb-example&templateParamsMap={"SOURCE_REPOSITORY_URL"%3A"https%3A%2F%2Fgithub.com%2Fopenshift%2Fnodejs-ex.git"} | ||
| ---- | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
seems redundant to say that it defaults to openshift when you have a whole column dedicated to the Default values
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair point. Will remove the two instances.