mirror of
https://github.com/redhat-developer/odo.git
synced 2025-10-19 03:06:19 +03:00
b471f4b6de
* Update main title in README * Remove extra colon character * Remove horizontal rules in README Headings should suffice. * Display demo video in README This way, users can have a chance to have a quick preview of odo.
79 lines
4.7 KiB
Markdown
79 lines
4.7 KiB
Markdown
`odo` - Fast, Iterative and Simplified container-based application development
|
|
---
|
|
|
|
[](https://github.com/redhat-developer/odo/releases/latest)
|
|
|
|
[](https://odo.dev/godoc)
|
|
[](https://app.netlify.com/sites/odo-docusaurus-preview/deploys)
|
|
|
|
|
|
|
|
### Overview
|
|
|
|
`odo` is a fast, and iterative CLI tool for container-based application development.
|
|
It is an implementation of the open [Devfile](https://devfile.io/) standard, supporting [Podman](https://podman.io/), [Kubernetes](https://kubernetes.io/) and [OpenShift](https://www.redhat.com/en/technologies/cloud-computing/openshift).
|
|
|
|
**Why use `odo`?**
|
|
|
|
* **Easy onboarding:** By auto-detecting the project source code, you can easily get started with `odo`.
|
|
* **No cluster needed**: With Podman support, having a Kubernetes cluster is not required to get started with `odo`. Using a common abstraction, `odo` can run your application on Podman, Kubernetes or OpenShift.
|
|
* **Fast:** Spend less time maintaining your application deployment infrastructure and more time coding. Immediately have your application running each time you save.
|
|
* **Standalone:** `odo` is a standalone tool that communicates directly with the container orchestrator API.
|
|
* **No configuration needed:** There is no need to dive into complex Kubernetes YAML configuration files. `odo` abstracts those concepts away and lets you focus on what matters most: code.
|
|
* **Containers first:** We provide first class support for Podman, Kubernetes and OpenShift. Choose your favourite container orchestrator and develop your application.
|
|
* **Easy to learn:** Simple syntax and design centered around concepts familiar to developers, such as projects, applications, and components.
|
|
|
|
Learn more about the features provided by `odo` on [odo.dev](https://odo.dev/docs/overview/features).
|
|
|
|
### Demo
|
|
|
|
[//]: # (URL obtained using the preview URL generated by GitHub from the source video in /docs/website/static/video/odo-preview-with-podman.hd.webm - see https://github.blog/2021-05-13-video-uploads-available-github/)
|
|
[odo demo.webm](https://github.com/redhat-developer/odo/assets/593208/815f77a2-be43-4763-961b-204c88fb2cce)
|
|
|
|
### Installing `odo`
|
|
|
|
Please check the [installation guide on odo.dev](https://odo.dev/docs/overview/installation/).
|
|
|
|
### Official documentation
|
|
|
|
Visit [odo.dev](https://odo.dev/) to learn more about odo.
|
|
|
|
### Community, discussion, contribution, and support
|
|
|
|
#### Chat
|
|
|
|
All of our developer and user discussions happen in the [#odo channel on the official Kubernetes Slack](https://kubernetes.slack.com/archives/C01D6L2NUAG).
|
|
|
|
If you haven't already joined the Kubernetes Slack, you can [invite yourself here](https://slack.k8s.io/).
|
|
|
|
Ask questions, inquire about odo or even discuss a new feature.
|
|
|
|
#### Issues
|
|
|
|
If you find an issue with `odo`, please [file it here](https://github.com/redhat-developer/odo/issues).
|
|
|
|
#### Contributing
|
|
|
|
* Code: We are currently working on updating our code contribution guide.
|
|
* Documentation: To contribute to the documentation, please have a look at our [Documentation Guide](https://github.com/redhat-developer/odo/wiki).
|
|
|
|
We are an open community who welcomes any concerns, changes or ideas for `odo`! Come join the chat and hang out, ask or give feedback and just generally have a good time.
|
|
|
|
#### Meetings
|
|
|
|
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 team calls together with sprint dates in the [google calendar](https://calendar.google.com/calendar/embed?src=gi0s0v5ukfqkjpnn26p6va3jfc%40group.calendar.google.com) ([iCal format](https://calendar.google.com/calendar/ical/gi0s0v5ukfqkjpnn26p6va3jfc%40group.calendar.google.com/public/basic.ics)).
|
|
|
|
### Legal
|
|
|
|
#### License
|
|
|
|
Unless otherwise stated (ex. `/vendor` files), all code is licensed under the [Apache 2.0 License](LICENSE).
|
|
|
|
#### Usage data
|
|
|
|
When `odo` is ran for the first time, you will be asked to opt in to Red Hat's telemetry collection program.
|
|
|
|
With your approval, `odo` will collect pseudonymized usage data and send it to Red Hat servers to help improve our products and services. Read our [privacy statement](https://developers.redhat.com/article/tool-data-collection) to learn more about it. For the specific data being collected and to configure this data collection process, see [Usage data](USAGE_DATA.md).
|