odo

README

Odo - OpenShift do

What's Odo?

Odo (OpenShift do...) is a CLI tool that provides developers with fast and automated source code deployments. Odo supplements iterative development by using the power of OpenShift's Source-to-Image with the stableness of Kubernetes. Developers can immediately start coding while Odo builds, pushes and deploys the application in the background.

Features

• Multiple languages: Odo supports Node.JS, Ruby, .Net Core, Perl, PHP, Python and Java (including popular runtimes such as WildFly / JBoss EAP, Vert.x, Spring Boot etc.).
• Speed: Building your source code immediately after saving and deployed to your cluster.
• Reproducible: Allows for easy reproducibility by using tightly versioned Docker containers for your source code environment.
• Deployability: Easily deploy a new version, or have Odo automatically build and re-deploy your code on each change.
• Support for multiple components and microservices: Deploy only what you need. For example, having both a Ruby and a JavaScript application side-by-side.
• Serverless: No requirement for running a server to automate tasks. Odo talks to OpenShift directly through an API.
• Instant feedback: Deploy while making edits to files, showing direct and instant feedback.

Documentation

Documentation can be found below:

• Installation
• Getting Started
• Development

Installation

Automated installation

The quickest way to install Odo is through our bash script, which will automatically detect your operating system and install odo accordingly!

curl -L https://github.com/redhat-developer/odo/raw/master/scripts/install.sh | bash

macOS

# Binary installation
sudo curl -L https://github.com/redhat-developer/odo/releases/download/v0.0.13/odo-darwin-amd64 -o /usr/local/bin/odo && sudo chmod +x /usr/local/bin/odo

# Alternative, compressed tarball installation
sudo sh -c 'curl -L https://github.com/redhat-developer/odo/releases/download/v0.0.13/odo-darwin-amd64.gz | gzip -d > /usr/local/bin/odo; chmod +x /usr/local/bin/odo'

Linux

# Binary installation
sudo curl -L https://github.com/redhat-developer/odo/releases/download/v0.0.13/odo-linux-amd64 -o /usr/local/bin/odo && sudo chmod +x /usr/local/bin/odo

# Alternative, compressed tarball installation
sudo sh -c 'curl -L https://github.com/redhat-developer/odo/releases/download/v0.0.13/odo-linux-amd64.gz | gzip -d > /usr/local/bin/odo; chmod +x /usr/local/bin/odo'

Windows

1. Download the odo-windows-amd64.exe.gz file from the GitHub releases page.
2. Extract the file
3. Add the location of extracted binary to your PATH environment variable by following this Wiki page.

Other methods

For a list of other methods such as installing the latest mastery binary, or specific OS installations, visit our installation page.

Getting started with Odo

Wanted to get started? Follow the instructions below or our Katacoda tutorial:

Requirements

• minishift or an OpenShift environment 3.9.0+, the best way to deploy a development environment is using Minishift.
• oc If you do not have it, there's an excellent guide on the OpenShift site on how to install the latest client.

Deploying a Node.js application using Odo

For a quick tutorial on how Odo works, follow the instructions below! Otherwise, we have an excellent Katacoda tutorial or an in-depth getting started guide.

# Download the latest release!
$ curl -L https://github.com/redhat-developer/odo/raw/master/scripts/install.sh | bash

# Start your development environment
$ minishift start

# Download the Node.JS example directory
$ git clone https://github.com/openshift/nodejs-ex
$ cd nodejs-ex

# Create new nodejs component
$ odo create nodejs

# Now let's deploy your application!
$ odo push

# Last, we'll create a way to access the application
$ odo url create
nodejs - nodejs-myproject.192.168.42.147.nip.io

# Test it / visit the URL
$ curl nodejs-myproject.192.168.42.147.nip.io

Community, Discussion, Contribution and Support

Chat: We have a public channel #Odo on chat.openshift.io.

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

Contributing: Want to become a contributor and submit your own code? Have a look at our development guide.

Glossary

• Application: Is, well, your application! It consists of multiple microservices or components, that work individually to build the entire application.
• Component: can be thought of as a microservice. Multiple components will make up an application. A component will have different attributes like storage, etc. Multiple component types are currently supported, like nodejs, perl, php, python, ruby, etc.

CLI Structure

odo --alsologtostderr --log_backtrace_at --log_dir --logtostderr --skip-connection-check --stderrthreshold --v --vmodule : Odo (Openshift Do)
    app --short : Perform application operations
        create : Create an application
        delete --force : Delete the given application
        describe : Describe the given application
        get --short : Get the active application
        list : List all applications in the current project
        set : Set application as active
    catalog : Catalog related operations
        list : List all available component & service types.
            components : List all components available.
            services : Lists all available services
        search : Search available component & service types.
            component : Search component type in catalog
            service : Search service type in catalog
    component --short : Components of application.
        get --short : Get currently active component
        set : Set active component.
    create --binary --git --local --port : Create a new component
    delete --force : Delete an existing component
    describe : Describe the given component
    link --component : Link target component to source component
    list : List all components in the current application
    log --follow : Retrieve the log for the given component.
    project --short : Perform project operations
        create : Create a new project
        delete --force : Delete a project
        get --short : Get the active project
        list : List all the projects
        set --short : Set the current active project
    push --local : Push source code to a component
    service : Perform service catalog operations
        create : Create a new service
        delete --force : Delete an existing service
        list : List all services in the current application
    storage : Perform storage operations
        create --component --path --size : Create storage and mount to a component
        delete --force : Delete storage from component
        list --all --component : List storage attached to a component
        mount --component --path : mount storage to a component
        unmount --component : Unmount storage from the given path or identified by its name, from the current component
    update --binary --git --local : Update the source code path of a component
    url : Expose component to the outside world
        create --application --component --port : Create a URL for a component
        delete --component --force : Delete a URL
        list --application --component : List URLs
    utils : Utilities for completion, terminal commands and modifying Odo configurations
        completion : Output shell completion code
        config : Modifies configuration settings
            set : Set a value in odo config file
            view : View current configuration values
        terminal : Add Odo terminal support to your development environment
    version : Print the client version information
    watch : Watch for changes, update component on change

*_autogenerated_