odo uses the (devfile)[https://devfile.io] to store the configuration of and describe the resources like storage, services, etc. of a component. The odo create command allows you to generate this file.
To create a devfile for an existing project, you can execute
odo create with the name and type of your component (for example, nodejs or go):
nodejs is the type of the component and
mynodejs is the name of the component odo creates for you.
Note: for a list of all the supported component types, run
odo catalog list components.
If your source code exists outside of the current directory, the
--context flag can be used to specify the path. For example, if the source for the nodejs component was in a folder called
node-backend relative to the current working directory, you could run:
Both relative and absolute paths are supported.
To specify the project or app of where your component will be deployed, you can use the
For example, to create a component that is a part of the
myapp app inside the
Note: if these are not specified, they will default to the active app and project
If you do not have existing source code but wish to get up and running quickly to experiment with devfiles and components, you could use the starter projects to get started. To use a starter project, include the
--starter flag in your
odo create command.
To get a list of available starter projects for a component type, you can use the
odo catalog describe component command. For example, to get all available starter projects for the nodejs component type, run:
Then specify the desired project with the
This will download the example template corresponding to the chosen component type (in the example above,
nodejs) in your current directory (or the path provided with the
If you want to create a new component from an existing devfile, you can do so by specifying the path to the devfile with the
For example, the following command will create a component called
mynodejs, based on the devfile from GitHub:
odo create command can also be run interactively. Execute
odo create, which will guide you through a list of steps to create a component:
You will be prompted to choose the component type, name and the project for the component. You can also choose whether or not to download a starter project. Once finished, a new
devfile.yaml file should be created in the working directory.
To deploy these resources to your cluster, run