cdrage / odo

OpenShift Command line for Developers

odo - Developer-focused CLI for Kubernetes and OpenShift

Overview

odo is a fast, iterative, and straightforward CLI tool for developers who write, build, and deploy applications on Kubernetes and OpenShift.

Existing tools such as kubectl and oc are more operations-focused and require a deep-understanding of Kubernetes and OpenShift concepts. odo abstracts away complex Kubernetes and OpenShift concepts for the developer.

Key features

odo is designed to be simple and concise with the following key features:

• Simple syntax and design centered around concepts familiar to developers, such as projects, applications, and components.

• Completely client based. No additional server other than Kubernetes or OpenShift is required for deployment.

• Official support for Node.js and Java components.

• Detects changes to local code and deploys it to the cluster automatically, giving instant feedback to validate changes in real time.

• Lists all the available components and services from the cluster.

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 reproducable development environment.

Official Devfiles

Devfiles describe your development environment link. Click here for more information on Devfile.

Table 1. List of Devfiles which are officially supported by odo

Language	Devfile Name	Description	Devfile Source	Supported Platform
Java	java-maven	Upstream Maven and OpenJDK 11	java-maven/devfile.yaml	amd64
Java	java-openliberty	Open Liberty microservice in Java	java-openliberty/devfile.yaml	amd64
Java	java-quarkus	Upstream Quarkus with Java+GraalVM	java-quarkus/devfile.yaml	amd64
Java	java-springboot	Spring Boot® using Java	java-springboot/devfile.yaml	amd64
Node.JS	nodejs	Stack with NodeJS 12	nodejs/devfile.yaml	amd64, s390x, ppc64le

Listing available Devfiles

Note	The list of available Devfiles is sourced from the official odo registry as well as any other registies added via 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
nodejs               Stack with NodeJS 12                   DefaultDevfileRegistry

Official documentation

• Installing odo

• Undestanding odo

• Deploying a devfile using odo

• Devfile file reference

• Debugging applications in odo

• Managing environment variables

• Configuring the odo CLI

• Architecture of odo

• odo CLI reference

• Introduction to Operators

Installing odo

To install on Linux / Windows / macOS follow our guide located on odo.dev. All binaries and tarballs are synced between our GitHub releases and OpenShift mirrors.

Deploying your first application

Click on the tutorial below to deploy your first odo application:

Deploying a devfile using odo

The following demonstration provides an overview of odo:

Community, discussion, contribution, and support

Communication channels

Discussions:

• For general help and inquiries, join our odo-users Google group.

• For any developmental discussion, use our odo-dev Google group.

Chat: Join us on Slack.

Issues: If you have an issue with odo, please file it.

Documentation Issues: If you have any documentation issues related to the docs.openshift.com site, file an issue in Bugzilla. Choose the OpenShift Container Platform product type and the Documentation component type.

Contributing

Want to become a contributor and submit your code? Please have a look at our Development Guide.

We work in 3-week sprint cycles. On a week when the sprint starts we have two planning calls:

• "Sprint Planning Preparation and Issue Triage" - on Monday

• "Sprint Planning" - on Wednesday

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 odo calendar (iCal format).

To participate in the calls, please join 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.

Projects using odo

These are some of the IDE plugins which use odo:

• VS Code Openshift Connector

• Openshift Connector for Intellij

• Codewind for Eclipse Che

Experimental mode

Want to try out the odo experimental mode? Please read the document for more information.