openshift-cli-import-docker-compose man page

openshift cli import docker-compose — Import a docker-compose.yml project into OpenShift (experimental)

Synopsis

openshift cli import docker-compose [Options]

Description

Import a Docker Compose file as OpenShift objects

Docker Compose files offer a container centric build and deploy pattern for simple applications. This command will transform a provided docker-compose.yml application into its OpenShift equivalent. During transformation fields in the compose syntax that are not relevant when running on top of a containerized platform will be ignored and a warning printed.

The command will create objects unless you pass the -o yaml or --as-template flags to generate a configuration file for later use.

Experimental: This command is under active development and may change without notice.

Options

--as-template=""

If set, generate a template with the provided name

--dry-run=false

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

-f, --filename=[]

Filename, directory, or URL to docker-compose.yml file to use

--generator="docker-compose/v1"

The name of the API generator to use.

-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

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

--azure-container-registry-config=""

Path to the file container Azure container registry configuration information.

--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

  # Import a docker-compose.yml file into OpenShift
  openshift cli import docker-compose -f ./docker-compose.yml
  
  # Turn a docker-compose.yml file into a template
  openshift cli import docker-compose -f ./docker-compose.yml -o yaml --as-template

See Also

openshift-cli-import(1),

History

June 2016, Ported from the Kubernetes man-doc generator

Referenced By

openshift-cli-import(1).

Openshift CLI User Manuals June 2016