openshift-cli-new-app man page

openshift cli new-app — Create a new application

Synopsis

openshift cli new-app [Options]

Description

Create a new application by specifying source code, templates, and/or images

This command will try to build up the components of an application using images, templates, or code that has a public repository. It will lookup the images on the local Docker installation (if available), a Docker registry, an integrated image stream, or stored templates.

If you specify a source code URL, it will set up a build that takes your source code and converts it into an image that can run inside of a pod. Local source must be in a git repository that has a remote repository that the server can see. The images will be deployed via a deployment configuration, and a service will be connected to the first public port of the app. You may either specify components using the various existing flags or let new-app autodetect what kind of components you have provided.

If you provide source code, a new build will be automatically triggered. You can use 'openshift cli status' to check the progress.

Options

--allow-missing-images=false

If true, indicates that referenced Docker images that cannot be found locally or in a registry should still be used.

--allow-missing-imagestream-tags=false

If true, indicates that image stream tags that don't exist should still be used.

--as-test=false

If true create this application as a test deployment, which validates that the deployment succeeds and then scales down.

--code=[]

Source code to use to build this application.

--context-dir=""

Context directory to be used for the build.

--docker-image=[]

Name of a Docker image to include in the app.

--dry-run=false

If true, show the result of the operation without performing it.

-e, --env=[]

Specify a key-value pair for an environment variable to set into each container. This doesn't apply to objects created from a template, use parameters instead.

-f, --file=[]

Path to a template file to use for the app.

--grant-install-rights=false

If true, a component that requires access to your account may use your token to install software into your project. Only grant images you trust the right to run with your token.

--group=[]

Indicate components that should be grouped together as <comp1>+<comp2>.

--image=[]

Name of an image stream to use in the app. (deprecated)

-i, --image-stream=[]

Name of an image stream to use in the app.

--insecure-registry=false

If true, indicates that the referenced Docker images are on insecure registries and should bypass certificate checking

-l, --labels=""

Label to set in all resources for this application.

-L, --list=false

List all local templates and image streams that can be used to create.

--name=""

Set name to use for generated application artifacts

--no-install=false

Do not attempt to run images that describe themselves as being installable

-o, --output=""

Output results as yaml or json instead of executing, or use name for succint output (resource/name).

--output-version=""

The preferred API versions of the output objects

-p, --param=[]

Specify a key-value pair (e.g., -p FOO=BAR) to set/override a parameter value in the template.

-S, --search=false

Search all templates, image streams, and Docker images that match the arguments provided.

--strategy=""

Specify the build strategy to use if you don't want to detect (docker|source).

--template=[]

Name of a stored template to use in the app.

Options Inherited from Parent Commands

--api-version=""

DEPRECATED: The API version to use when talking to the server

--as=""

Username to impersonate for the operation

--certificate-authority=""

Path to a cert. file for the certificate authority

--client-certificate=""

Path to a client certificate file for TLS

--client-key=""

Path to a client key file for TLS

--cluster=""

The name of the kubeconfig cluster to use

--config=""

Path to the config file to use for CLI requests.

--context=""

The name of the kubeconfig context to use

--google-json-key=""

The Google Cloud Platform Service Account JSON Key to use for authentication.

--insecure-skip-tls-verify=false

If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure

--log-flush-frequency=0

Maximum number of seconds between log flushes

--match-server-version=false

Require server version to match client version

-n, --namespace=""

If present, the namespace scope for this CLI request

--request-timeout="0"

The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.

--server=""

The address and port of the Kubernetes API server

--token=""

Bearer token for authentication to the API server

--user=""

The name of the kubeconfig user to use

Example

  # List all local templates and image streams that can be used to create an app
  openshift cli new-app --list
  
  # Create an application based on the source code in the current git repository (with a public remote)
  # and a Docker image
  openshift cli new-app . --docker-image=repo/langimage
  
  # Create a Ruby application based on the provided [image] [source code] combination
  openshift cli new-app centos/ruby-22-centos7 https://github.com/openshift/ruby-ex.git
  
  # Use the public Docker Hub MySQL image to create an app. Generated artifacts will be labeled with db=mysql
  openshift cli new-app mysql MYSQL_USER=user MYSQL_PASSWORD=pass MYSQL_DATABASE=testdb -l db=mysql
  
  # Use a MySQL image in a private registry to create an app and override application artifacts' names
  openshift cli new-app --docker-image=myregistry.com/mycompany/mysql --name=private
  
  # Create an application from a remote repository using its beta4 branch
  openshift cli new-app https://github.com/openshift/ruby-hello-world#beta4
  
  # Create an application based on a stored template, explicitly setting a parameter value
  openshift cli new-app --template=ruby-helloworld-sample --param=MYSQL_USER=admin
  
  # Create an application from a remote repository and specify a context directory
  openshift cli new-app https://github.com/youruser/yourgitrepo --context-dir=src/build
  
  # Create an application based on a template file, explicitly setting a parameter value
  openshift cli new-app --file=./example/myapp/template.json --param=MYSQL_USER=admin
  
  # Search all templates, image streams, and Docker images for the ones that match "ruby"
  openshift cli new-app --search ruby
  
  # Search for "ruby", but only in stored templates (--template, --image-stream and --docker-image
  # can be used to filter search results)
  openshift cli new-app --search --template=ruby
  
  # Search for "ruby" in stored templates and print the output as an YAML
  openshift cli new-app --search --template=ruby --output=yaml

See Also

openshift-cli(1),

History

June 2016, Ported from the Kubernetes man-doc generator

Referenced By

openshift-cli(1).

Openshift CLI User Manuals June 2016