odo - Developer-focused CLI for OpenShift and Kubernetes
odo- Developer-focused CLI for Kubernetes and OpenShift :toc: macro :toc-title: :toclevels: 1
https://github.com/openshift/odo/releases/latest[image:https://img.shields.io/github/v/release/openshift/odo?style=for-the-badge[GitHub release]] https://travis-ci.com/openshift/odo[image:https://img.shields.io/travis/com/openshift/odo?style=for-the-badge[Build Status]] image:https://img.shields.io/github/license/openshift/odo?style=for-the-badge[License]
[[overview]] == Overview
odois a fast, iterative, and straightforward CLI tool for developers who write, build, and deploy applications on Kubernetes and OpenShift.
Existing tools such as
ocare more operations-focused and require a deep-understanding of Kubernetes and OpenShift concepts.
odoabstracts away complex Kubernetes and OpenShift concepts for the developer.
[[key-features]] == Key features
odois designed to be simple and concise with the following key features:
[[core-concepts]] == Core concepts
Project:: A project is your source code, tests, and libraries organized in a separate single unit. Application:: An application is a program designed for end users. An application consists of multiple microservices or components that work individually to build the entire application. Examples of applications: e-Shop, Hotel Reservation System, Online Booking Component:: A component is a set of Kubernetes resources which host code or data. Each component can be run and deployed separately. Examples of components: Warehouse API Backend, Inventory API, Web Frontend, Payment Backend Service:: A service is software that your component links to or depends on. Examples of services: MariaDB, MySQL. Devfile:: A portable file responsible for your entire reproducible development environment.
[id="odo-supported-devfiles"] === Official Devfiles
Devfiles describe your development environment link. link:https://odo.dev/docs/deploying-a-devfile-using-odo/[Click here for more information on Devfile.]
.List of Devfiles which are officially supported by odo [options="header"] |=== |Language | Devfile Name | Description | Devfile Source | Supported Platform
| Java | java-maven | Upstream Maven and OpenJDK 11 | link:https://github.com/odo-devfiles/registry/blob/master/devfiles/java-maven/devfile.yaml[java-maven/devfile.yaml] | amd64
| Open Liberty microservice in Java
| link:https://github.com/odo-devfiles/registry/blob/master/devfiles/java-openliberty/devfile.yaml[java-openliberty/devfile.yaml] | amd64
| Java | java-quarkus | Upstream Quarkus with Java+GraalVM | link:https://github.com/odo-devfiles/registry/blob/master/devfiles/java-quarkus/devfile.yaml[java-quarkus/devfile.yaml] | amd64
| Java | java-springboot | Spring Boot® using Java | link:https://github.com/odo-devfiles/registry/blob/master/devfiles/java-springboot/devfile.yaml[java-springboot/devfile.yaml] | amd64
| Node.JS | nodejs | Stack with NodeJS 12 | link:https://github.com/odo-devfiles/registry/blob/master/devfiles/nodejs/devfile.yaml[nodejs/devfile.yaml] | amd64, s390x, ppc64le
|=== [id="odo-listing-available-images"] ==== Listing available Devfiles
odo registry add.
To list the available Devfiles:
$ odo catalog list components Odo Devfile Components: NAME DESCRIPTION REGISTRY java-maven Upstream Maven and OpenJDK 11 DefaultDevfileRegistry java-openliberty Open Liberty microservice in Java DefaultDevfileRegistry java-quarkus Upstream Quarkus with Java+GraalVM DefaultDevfileRegistry java-springboot Spring Boot® using Java DefaultDevfileRegistry
[[official-documentation]] == Official documentation
[[installing-odo]] == Installing
To install on Linux / Windows / macOS follow our guide located on link:https://odo.dev/docs/installing-odo[odo.dev]. All binaries and tarballs are synced between our link:https://github.com/openshift/odo/releases[GitHub releases] and link:https://mirror.openshift.com/pub/openshift-v4/clients/odo/[OpenShift mirrors].
[[deploying-your-first-application]] == Deploying your first application
Click on the tutorial below to deploy your first
link:https://odo.dev/docs/deploying-a-devfile-using-odo/[Deploying a devfile using odo]
The following demonstration provides an overview of
[[contributing]] == Community, discussion, contribution, and support
=== Communication channels
All of our developer and user discussions happen in the link:https://kubernetes.slack.com/archives/C01D6L2NUAG[#odo channel on the official Kubernetes Slack].
If you haven't already joined the Kubernetes Slack, you can link:https://slack.k8s.io/[invite yourself here].
Ask questions, inquire about odo or even discuss a new feature.
If you have an issue with
odo, please link:https://github.com/openshift/odo/issues[file it].
=== Contributing Want to become a contributor and submit your code? Please have a look at our link:https://github.com/openshift/odo/blob/master/docs/dev/development.adoc[Development Guide].
We work in 3-week sprint cycles. On a week when the sprint starts we have two planning calls:
On top of our sprint planning calls, we have our regular "odo contributors call" (biweekly on Tuesdays). This is where we discuss technical challenges and anything related to odo development.
All our calls are open to public. You are welcome to join any of our calls.
You can find the exact dates of all scheduled odo calls together with sprint dates in the link:https://calendar.google.com/calendar/embed?src=gi0s0v5ukfqkjpnn26p6va3jfc%40group.calendar.google.comodo calendar.
To participate in the calls, please join link:https://groups.google.com/forum/#!forum/odo-dev[odo-dev Google group]. When you join the group, you will automatically get invites to all odo related calls and get permissions to all necessary documents.
[[odo-roadmap]] == Roadmap for odo
Below is a roadmap for odo where 2.1, 2.2 and 2.3 are odo versions.
=== Post v2 (Before 19th Jan)
=== 2.1 Planning (19th Jan - 13th April)
odo deploycommand for initial transition from inner to outer loop
=== 2.2 Planning
=== 2.3 Planning
[[projects-using-odo]] == Projects using odo
These are some of the IDE plugins which use odo:
[[experimental-mode]] == Experimental mode
Want to try out the odo experimental mode? Please read the link:https://github.com/openshift/odo/blob/master/docs/dev/experimental-mode.adoc[document] for more information.