OC(1)

🎀 NAME 🎀

hii bestie 💖 welcome to oc(1) — specifically the page for oc new-app, dated June 2016 in the header. The name-line tea is:

• oc new-app — Create a new application

✨ SYNOPSIS ✨

oc new-app [OPTIONS]

💅 DESCRIPTION 💅

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

This command will try to build up the components of an application using images, templates, or code that has a public repository. It will look up the images on the local container storage (if available), a container image registry, an integrated image stream, or stored templates. It’s giving “let me check every drawer real quick” energy 🔍💅

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 or 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 oc new-app autodetect what kind of components you have provided. Autodetect is lowkey the main character here 👑

If you provide source code, a new build will be automatically triggered. You can use 'oc status' to check the progress. fr fr, go check on it 🌸

👑 OPTIONS 👑

• --allow-missing-images=false — if this is true, it means referenced container images that cannot be found locally or in a registry should still be used. 🫶
• --allow-missing-imagestream-tags=false — if this is true, it means image stream tags that don't exist should still be used. ✨
• --allow-missing-template-keys=false — if this is true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.
• --as-deployment-config=false — if this is true, create this application as a deployment config, which allows for hooks and custom strategies. 🎀
• --as-test=false — if this is true, create this application as a test deployment, which validates that the deployment succeeds and then scales down.
• --binary=false — instead of expecting a source URL, set the build to expect binary contents. This will disable triggers. 💀
• --build-env=[] — specify a key-value pair for an environment variable to set into each build image.
• --build-env-file=[] — file containing key-value pairs of environment variables to set into each build image.
• --code=[] — source code to use to build this application. 🧚
• --context-dir="" — context directory to be used for the build.
• --dry-run=false — if this is 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.
• --env-file=[] — file containing key-value pairs of environment variables to set into each container.
• -f, --file=[] — path to a template file to use for the app.
• --grant-install-rights=false — if this is 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>.
• --ignore-unknown-parameters=false — if this is true, it will not stop processing if a provided parameter does not exist in the template.
• --image=[] — name of a container image to include in the app. Note: not specifying a registry or repository means defaults in place for client image pulls are employed. 🦋
• -i, --image-stream=[] — name of an existing image stream to use to deploy an app.
• --import-mode="" — imports the full manifest list of a tag when set to 'PreserveOriginal'. Defaults to 'Legacy'.
• --insecure-registry=false — if this is true, it means the referenced container 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 format. One of: json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file.
• --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. 🍓
• --param-file=[] — file containing parameter values to set/override in the template.
• -S, --search=false — search all templates, image streams, and container images that match the arguments provided. Note: the container images search is run on the OpenShift cluster via the ImageStreamImport API.
• -a, --show-all=false — when printing, show all resources (default hide terminated pods.)
• --show-labels=false — when printing, show all labels as the last column (default hide labels column)
• --show-managed-fields=false — if this is true, keep the managedFields when printing objects in JSON or YAML format.
• --sort-by="" — if non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. ⭐
• --source-secret="" — the name of an existing secret that should be used for cloning a private git repository.
• --strategy= — specify the build strategy to use if you don't want to detect (docker|pipeline|source). NOTICE: the pipeline strategy is deprecated; consider using Jenkinsfiles directly on Jenkins or OpenShift Pipelines. this one is important, bestie 💀
• --template=[] — name of a stored template to use in the app. 🌈

🧬 OPTIONS INHERITED FROM PARENT COMMANDS 🧬

• --as="" — username to impersonate for the operation. User could be a regular user or a service account in a namespace.
• --as-group=[] — group to impersonate for the operation; this flag can be repeated to specify multiple groups.
• --as-uid="" — UID to impersonate for the operation.
• --as-user-extra=[] — user extras to impersonate for the operation; this flag can be repeated to specify multiple values for the same key.
• --cache-dir="/homeless-shelter/.kube/cache" — default cache directory.
• --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.
• --context="" — the name of the kubeconfig context to use.
• --disable-compression=false — if this is true, opt-out of response compression for all requests to the server.
• --insecure-skip-tls-verify=false — if this is true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. 🚨
• --kubeconfig="" — path to the kubeconfig file to use for CLI requests.
• --kuberc="" — path to the kuberc file to use for preferences. This can be disabled by exporting KUBECTL_KUBERC=false feature gate or turning off the feature KUBERC=off.
• --match-server-version=false — require server version to match client version.
• -n, --namespace="" — if present, the namespace scope for this CLI request.
• --profile="none" — name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex).
• --profile-output="profile.pprof" — name of the file to write the profile to.
• --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.
• -s, --server="" — the address and port of the Kubernetes API server.
• --tls-server-name="" — server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used.
• --token="" — bearer token for authentication to the API server.
• --user="" — the name of the kubeconfig user to use.
• --warnings-as-errors=false — treat warnings received from the server as errors and exit with a non-zero exit code. 👑

🌸 EXAMPLE 🌸

ok so this is the part everyone actually came for — the receipts 💅 every single one of these is copy-pasteable, so go off bestie:

# List all local templates and image streams that can be used to create an app
oc new-app --list

# Create an application based on the source code in the current git repository (with a public remote) and a container image
oc new-app . --image=registry/repo/langimage

# Create an application myapp with Docker based build strategy expecting binary input
oc new-app  --strategy=docker --binary --name myapp

ok lowkey yes there are two spaces after new-app in that last one — that's literally how it's written, don't come for me 🙈

# Create a Ruby application based on the provided [image] [source code] combination
oc new-app centos/ruby-25-centos7 https://github.com/sclorg/ruby-ex.git

# Use the public container registry MySQL image to create an app. Generated artifacts will be labeled with db=mysql
oc 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
oc new-app --image=myregistry.com/mycompany/mysql --name=private

# Use an image with the full manifest list to create an app and override application artifacts' names
oc new-app --image=myregistry.com/mycompany/image --name=private --import-mode=PreserveOriginal

# Create an application from a remote repository using its beta4 branch
oc new-app https://github.com/openshift/ruby-hello-world#beta4

# Create an application based on a stored template, explicitly setting a parameter value
oc new-app --template=ruby-helloworld-sample --param=MYSQL_USER=admin

# Create an application from a remote repository and specify a context directory
oc new-app https://github.com/youruser/yourgitrepo --context-dir=src/build

# Create an application from a remote private repository and specify which existing secret to use
oc new-app https://github.com/youruser/yourgitrepo --source-secret=yoursecret

# Create an application based on a template file, explicitly setting a parameter value
oc new-app --file=./example/myapp/template.json --param=MYSQL_USER=admin

# Search all templates, image streams, and container images for the ones that match "ruby"
oc new-app --search ruby

# Search for "ruby", but only in stored templates (--template, --image-stream and --image
# can be used to filter search results)
oc new-app --search --template=ruby

# Search for "ruby" in stored templates and print the output as YAML
oc new-app --search --template=ruby --output=yaml

see?? told you ✨ every flag, every path, every MYSQL_USER=admin, all of it, untouched. no cap 🫶

---

👀 SEE ALSO 👀

• oc(1),

yeah it's just the one (1) reference and yes it keeps its lil trailing comma, that's how we roll 🎀

---

🦋 HISTORY 🦋

June 2016, Ported from the Kubernetes man-doc generator

a vintage. an icon. June 2016 really said "let me port this from the Kubernetes man-doc generator" and we've been eating ever since 😭👑

---

and that's the whole page bestie!! 🌈✨

this lil masterpiece comes to you courtesy of Openshift — living under the Openshift CLI User Manuals umbrella, dated way back in June 2016, page name OC(1) and all 💖

go create an app or twelve, you absolute main character 🧚💅