Creating applications using the CLI

To create an application from a Git repository in a local directory:

To create an application from a remote Git repository:

To create an application from a private remote Git repository:

You can use a subdirectory of your source code repository by specifying a --context-dir flag. To create an application from a remote Git repository and a context subdirectory:

Also, when specifying a remote URL, you can specify a Git branch to use by appending #<branch_name> to the end of the URL:

If a Jenkins file exists in the root or specified context directory of the source repository when creating a new application, OKD generates a pipeline build strategy. Otherwise, it generates a source build strategy.

Override the build strategy by setting the --strategy flag to either pipeline or source.

If you use the source build strategy, new-app attempts to determine the language builder to use by the presence of certain files in the root or specified context directory of the repository:

After a language is detected, new-app searches the OKD server for image stream tags that have a supports annotation matching the detected language, or an image stream that matches the name of the detected language. If a match is not found, new-app searches the Docker Hub registry for an image that matches the detected language based on name.

You can override the image the builder uses for a particular source repository by specifying the image, either an image stream or container specification, and the repository with a ~ as a separator. Note that if this is done, build strategy detection and language detection are not carried out.

For example, to use the myproject/my-ruby imagestream with the source in a remote repository:

To use the openshift/ruby-20-centos7:latest container image stream with the source in a local repository:

Create an application from the Docker Hub MySQL image, for example:

Create an application using an image in a private registry, specify the full container image specification:

Create an application from an existing image stream and optional image stream tag:

When creating an application based on a template, use the -p|--param argument to set parameter values that are defined by the template:

You can store your parameters in a file, then use that file with --param-file when instantiating a template. If you want to read the parameters from standard input, use --param-file=-. The following is an example file called helloworld.params:

Reference the parameters in the file when instantiating a template:

When generating applications from a template, source, or an image, you can use the -e|--env argument to pass environment variables to the application container at run time:

The variables can also be read from file using the --env-file argument. The following is an example file called postgresql.env:

Read the variables from the file:

Additionally, environment variables can be given on standard input by using --env-file=-:

When generating applications from a template, source, or an image, you can use the --build-env argument to pass environment variables to the build container at run time:

The variables can also be read from a file using the --build-env-file argument. The following is an example file called ruby.env:

Read the variables from the file:

Additionally, environment variables can be given on standard input by using --build-env-file=-:

When generating applications from source, images, or templates, you can use the -l|--label argument to add labels to the created objects. Labels make it easy to collectively select, configure, and delete objects associated with the application.

To see a dry-run of running the new-app command, you can use the -o|--output argument with a yaml or json value. You can then use the output to preview the objects that are created or redirect it to a file that you can edit. After you are satisfied, you can use oc create to create the OKD objects.

To output new-app artifacts to a file, run the following:

Edit the file:

Create a new application by referencing the file:

Objects created by new-app are normally named after the source repository, or the image used to generate them. You can set the name of the objects produced by adding a --name flag to the command:

Normally, new-app creates objects in the current project. However, you can create objects in a different project by using the -n|--namespace argument:

The new-app command allows creating multiple applications specifying multiple parameters to new-app. Labels specified in the command line apply to all objects created by the single command. Environment variables apply to all components created from source or images.

To create an application from a source repository and a Docker Hub image:

The new-app command allows deploying multiple images together in a single pod. To specify which images to group together, use the + separator. The --group command line argument can also be used to specify the images that should be grouped together. To group the image built from a source repository with other images, specify its builder image in the group:

To deploy an image built from source and an external image together:

To search for images, templates, and other inputs for the oc new-app command, add the --search and --list flags. For example, to find all of the images or templates that include PHP: