Chapter 40. Create from URL

40.1. 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 Configuring the Create From URL Namespace Whitelist.

You can define custom buttons.

Run on OpenShift Buttons

These buttons leverage a defined URL pattern with an appropriate query string. The user is prompted to select the project. Then, the Create from URL workflow continues.

40.2. Using an Image Stream and Image Tag

40.2.1. Query String Parameters

NameDescriptionRequiredSchemaDefault

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

Reserved characters in parameter values should be URL encoded.

40.2.1.1. Example

 create?imageStream=nodejs&imageTag=4&name=nodejs&sourceURI=https%3A%2F%2Fgithub.com%2Fopenshift%2Fnodejs-ex.git&sourceRef=master&contextDir=%2F

40.3. Using a Template

40.3.1. Query String Parameters

NameDescriptionRequiredSchemaDefault

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

Reserved characters in parameter values should be URL encoded.

40.3.1.1. Example

 create?template=nodejs-mongodb-example&templateParamsMap={"SOURCE_REPOSITORY_URL"%3A"https%3A%2F%2Fgithub.com%2Fopenshift%2Fnodejs-ex.git"}