|Application |Application is the name of application the component needs to be part of
|CPU |The minimum and maximum CPU a component can consume
|Ignore |Consider the .odoignore file for push and watch
|=======
.Available Local Parameters:
|=======
|Application |The name of application that the component needs to be part of
|CPU |The minimum and maximum CPU a component can consume
|Ignore |Whether to consider the `.odoignore` file for push and watch
|MaxCPU |The maximum CPU a component can consume
|MaxMemory |The maximum memory a component can consume
|Memory |The minimum and maximum memory a component can consume
|MinCPU |The minimum CPU a component can consume
|MinMemory |The minimum memory a component is provided
|Name |The name of the component
|Ports |Ports to be opened in the component
|Project |The name of the project that the component is part of
|Ref |Git ref to use for creating component from git source
|SourceLocation |The path indicates the location of binary file or git source
|SourceType |Type of component source - git/binary/local
|Storage |Storage of the component
|Type |The type of component
|Url |The URL to access the component
|=======
== create
Create a configuration describing a component to be deployed on {product-title}. If a component name is not provided, it is autogenerated.
By default, builder images are used from the current namespace. To explicitly supply a namespace, use: `odo create namespace/name:version`. If a version is not specified, the version defaults to `latest`.
Use `odo catalog list` to see a full list of component types that can be deployed.
.Example using create
----
# Create new Node.js component with the source in current directory.
odo create nodejs
# A specific image version may also be specified
odo create nodejs:latest
# Create new Node.js component named 'frontend' with the source in './frontend' directory
odo create nodejs frontend --context ./frontend
# Create a new Node.js component of version 6 from the 'openshift' namespace
odo create nodejs --min-memory 150Mi --max-memory 300 Mi
# Passing cpu limits
odo create nodejs --cpu 2
odo create nodejs --min-cpu 200m --max-cpu 2
----
== delete
Delete an existing component.
.Example using delete
----
# Delete component named 'frontend'.
odo delete frontend
odo delete frontend --all
----
== describe
Describe the given component.
.Example using describe
----
# Describe nodejs component
odo describe nodejs
----
== link
Link a component to a service or component.
.Example using link
----
# Link the current component to the 'my-postgresql' service
odo link my-postgresql
# Link component 'nodejs' to the 'my-postgresql' service
odo link my-postgresql --component nodejs
# Link current component to the 'backend' component (backend must have a single exposed port)
odo link backend
# Link component 'nodejs' to the 'backend' component
odo link backend --component nodejs
# Link current component to port 8080 of the 'backend' component (backend must have port 8080 exposed)
odo link backend --port 8080
----
Link adds the appropriate secret to the environment of the source component. The source component can then consume the entries of the secret as environment variables. If the source component is not provided, the current active component is assumed.
== list
List all the components in the current application.
.Example using list
----
# List all components in the application
odo list
----
== log
Retrieve the log for the given component.
.Example using log
----
# Get the logs for the nodejs component
odo log nodejs
----
== login
Log in to the cluster.
.Example using login
----
# Log in interactively
odo login
# Log in to the given server with the given certificate authority file
Modify `odo` specific configuration settings within the global preference file.
.Example using preference
----
# For viewing the current preferences
odo preference view
# Set a preference value in the global preference
odo preference set UpdateNotification false
odo preference set NamePrefix "app"
odo preference set Timeout 20
# Unset a preference value in the global preference
odo preference unset UpdateNotification
odo preference unset NamePrefix
odo preference unset Timeout
----
[NOTE]
====
By default, the path to the global preference file is `~/.odo/preferece.yaml` and it is stored in the environment variable `GLOBALODOCONFIG`. You can set up a custom path by setting the value of the environment variable to a new preference path, for example `GLOBALODOCONFIG="new_path/preference.yaml"`
====
.Available Parameters:
|=======
|NamePrefix |The default prefix is the current directory name. Use this value to set a default name prefix.
|Timeout |The timeout (in seconds) for {product-title} server connection checks.
|UpdateNotification |Controls whether an update notification is shown.
|=======
== project
Perform project operations.
.Example using project
----
# Set the active project
odo project set
# Create a new project
odo project create myproject
# List all the projects
odo project list
# Delete a project
odo project delete myproject
# Get the active project
odo project get
----
== push
Push source code to a component.
.Example using push
----
# Push source code to the current component
odo push
# Push data to the current component from the original source.
odo push
# Push source code in ~/mycode to component called my-component
odo push my-component --context ~/mycode
----
== service
Perform service catalog operations.
.Example using service
----
# Create new postgresql service from service catalog using dev plan and name my-postgresql-db.
odo service create dh-postgresql-apb my-postgresql-db --plan dev -p postgresql_user=luke -p postgresql_password=secret
