mirror of
https://github.com/redhat-developer/odo.git
synced 2025-10-19 03:06:19 +03:00
Update README and change from AsciiDoc to Markdown (#5183)
* Update README and change from AsciiDoc to Markdown * Update funny sentence Co-authored-by: Parthvi Vala <pvala@redhat.com> * Update usage data from adoc to md * Update link * Remove Changelog file since we no longer use it * Add godoc to README * Update USAGE_DATA.md Co-authored-by: Parthvi Vala <pvala@redhat.com> Co-authored-by: Parthvi Vala <pvala@redhat.com>
This commit is contained in:
Dharmit Shah
130
Changelog.md
130
Changelog.md
@@ -1,130 +0,0 @@
|
||||
# Odo Changelog
|
||||
|
||||
## Next
|
||||
|
||||
### Feature/Enhancements
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
### Tests
|
||||
|
||||
### Documentation
|
||||
|
||||
## 2.3
|
||||
|
||||
### Feature/Enhancements
|
||||
|
||||
- Added a column in odo list output to indicate components created by odo ([#4962](https://github.com/openshift/odo/pull/4962))
|
||||
- Fix description for "odo link" command ([#4930](https://github.com/openshift/odo/pull/4930))
|
||||
- Add deprecation warnings for s2i components([#4967](https://github.com/openshift/odo/issues/4967))
|
||||
- Dropping support for service catalog based services ([#4906](https://github.com/openshift/odo/pull/4906))
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- Fixed issues with non-ephemeral storage mount([#4979](https://github.com/openshift/odo/pull/4979))
|
||||
- Adding kubeconfig validation and updating tests for logged out scenario ([#4975](https://github.com/openshift/odo/issues/4975))
|
||||
|
||||
### Tests
|
||||
|
||||
- runs nightly test of main branch of odo against [SBO master branch](https://github.com/redhat-developer/service-binding-operator) ([#4942](https://github.com/openshift/odo/issues/4942))
|
||||
|
||||
### Documentation
|
||||
|
||||
- Documents steps for component creation ([#4982](https://github.com/openshift/odo/pull/4982))
|
||||
- Add Cluster setup documentation ([#4973](https://github.com/openshift/odo/pull/4973))
|
||||
|
||||
## 2.2.4
|
||||
|
||||
### Feature/Enhancements
|
||||
|
||||
- Support for `preStart` lifecycle events ([#4901](https://github.com/openshift/odo/issues/4901))
|
||||
- Do not cancel the whole execution if one of the test suite fails ([#4943](https://github.com/openshift/odo/issues/4943))
|
||||
- Allow linking using ServiceBinding without ServiceBindingOperator ([#4543](https://github.com/openshift/odo/issues/4543)).
|
||||
- Add Sonar Cloud config file: sonar-project.properties([#4900](https://github.com/openshift/odo/pull/4900))
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- Fix component create and delete help examples([#4904](https://github.com/openshift/odo/pull/4904))
|
||||
- `odo push` now displays "Waiting for component to start" only once ([4919](https://github.com/openshift/odo/pull/4919))
|
||||
- Modifies the error message to list the available starters ([#4935](https://github.com/openshift/odo/pull/4935))
|
||||
- Add language and projectType metadata in devfile for s2i components([#4911](https://github.com/openshift/odo/pull/4911))
|
||||
|
||||
### Tests
|
||||
|
||||
- Test storage + link ([#4954](https://github.com/openshift/odo/pull/4954))
|
||||
|
||||
### Documentation
|
||||
|
||||
- Add Getting Started > Basics documentation ([#4914](https://github.com/openshift/odo/pull/4914))
|
||||
- Add documentation for global configuration ([#4921](https://github.com/openshift/odo/pull/4921))
|
||||
- Add odo installation docs ([#4923](https://github.com/openshift/odo/pull/4923))
|
||||
|
||||
## 2.2.3
|
||||
|
||||
### Feature/Enhancements
|
||||
|
||||
- `odo service delete` removes Operator backed services from the Devfile only, without undeploying them from the cluster ([#4761](https://github.com/openshift/odo/pull/4761))
|
||||
- `odo service list` lists Operator backed services in Devfile and/or deployed into the cluster and their state (Pushed, Not pushed, Deleted locally) ([#4761](https://github.com/openshift/odo/pull/4761))
|
||||
- `odo push` undeploys Operator backed services marked as managed by the current devfile not present in this devfile anymore ([#4761](https://github.com/openshift/odo/pull/4761))
|
||||
- param based `odo service create` for operator backed services ([#4704](https://github.com/openshift/odo/pull/4704))
|
||||
- add `odo catalog describe service <operator> --example` ([#4821](https://github.com/openshift/odo/pull/4821))
|
||||
- `odo link` and `odo unlink` write to devfile without deploying to cluster. Deploying happens when running `odo push` ([#4819](https://github.com/openshift/odo/pull/4819))
|
||||
- `odo describe` shows linked services and components whether they are pushed or not. When deployed, it also shows environment variables or mounted files ([#4866](https://github.com/openshift/odo/pull/4866))
|
||||
- collect component type and cluster type data for telemetry ([#4763](https://github.com/openshift/odo/pull/4763))
|
||||
|
||||
### Bug Fixes
|
||||
- Update telemetry contextual properties only when it is enabled([#4870](https://github.com/openshift/odo/pull/4870))
|
||||
|
||||
- Completely move to using networking v1 and extensions v1 ingresses based on cluster support as extensions v1 ingress is deprecated ([#4853](https://github.com/openshift/odo/pull/4853))
|
||||
|
||||
## 2.2.2
|
||||
|
||||
### Feature/Enhancements
|
||||
|
||||
- Custom link name and bind-as-files option for `odo link` ([#4729](https://github.com/openshift/odo/pull/4729))
|
||||
- `odo list` now lists components created/managed by other tools ([#4742](https://github.com/openshift/odo/pull/4742))
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- Adding KUBECONFIG checks in odo catalog list components ([#4756](https://github.com/openshift/odo/pull/4756))
|
||||
- use filepath Join instead of / while constructing kubeconfig path ([#4765](https://github.com/openshift/odo/pull/4765))
|
||||
- `odo push` can deploy new services when a service is already deployed ([#4772](https://github.com/openshift/odo/pull/4772))
|
||||
- `odo env set DebugPort` doesn't work for converted devfile ([#4785](https://github.com/openshift/odo/pull/4785))
|
||||
- Sanitize Telemetry data ([#4758](https://github.com/openshift/odo/pull/4758))
|
||||
|
||||
### Tests
|
||||
|
||||
- Refactor devfile delete tests and add validity checks for delete command ([#4793](https://github.com/openshift/odo/pull/4793))
|
||||
|
||||
### Documentation
|
||||
|
||||
- Enhance usage data documentation ([#4774](https://github.com/openshift/odo/pull/4774))
|
||||
|
||||
## 2.2.1
|
||||
|
||||
### Feature/Enhancements
|
||||
|
||||
- Implement `odo catalog describe service` for operator backed services ([#4671](https://github.com/openshift/odo/pull/4671))
|
||||
- Add deprecation warning for old git style devfile registries ([#4707](https://github.com/openshift/odo/pull/4707))
|
||||
- Adds dev.odo.push.path attribute support for pushing only mentioned files ([#4588](https://github.com/openshift/odo/pull/4588))
|
||||
- Use server side apply approved ([#4648](https://github.com/openshift/odo/pull/4648))
|
||||
- Adding wait support to component deletion for devfile ([#4712](https://github.com/openshift/odo/pull/4712))
|
||||
- Collect Component type for usage data ([#4662](https://github.com/openshift/odo/pull/4662))
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- Follow devfile like conventions in generated url name to keep url short for --s2i ([#4670](https://github.com/openshift/odo/pull/4670))
|
||||
- Fix OCI-based registry migration approved kind/bug lgtm ([#4702](https://github.com/openshift/odo/pull/4702))
|
||||
- Removes invalid endpoints from the devfile on triggering url create. ([#4567](https://github.com/openshift/odo/pull/4567))
|
||||
|
||||
### Tests
|
||||
|
||||
- Automate psi ci for mac and windows ([#4460](https://github.com/openshift/odo/pull/4460))
|
||||
- Update devfile tests with OCI-based registry ([#4679](https://github.com/openshift/odo/pull/4679))
|
||||
|
||||
|
||||
### Documentation
|
||||
|
||||
- Adds a document regarding the odo.dev.push.path attributes in the devfile ([#4681](https://github.com/openshift/odo/pull/4681))
|
||||
- Add --s2i conversion related breaking changes ([#4683](https://github.com/openshift/odo/pull/4683))
|
||||
- Fix OCI-based registry migration ([#4702](https://github.com/openshift/odo/pull/4702))
|
||||
151
README.adoc
151
README.adoc
@@ -1,151 +0,0 @@
|
||||
[id="readme"]
|
||||
= `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]]
|
||||
image:https://img.shields.io/github/license/openshift/odo?style=for-the-badge[License]
|
||||
https://odo.dev/godoc[image:https://img.shields.io/badge/godoc-reference-007d9c?logo=go&logoColor=white&style=for-the-badge[]]
|
||||
https://app.netlify.com/sites/odo-docusaurus-preview/deploys[image:https://api.netlify.com/api/v1/badges/e07867b0-56a4-4905-92a9-a152ceab5f0d/deploy-status[![Netlify Status]]
|
||||
|
||||
|
||||
[[overview]]
|
||||
== 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]]
|
||||
== 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.
|
||||
|
||||
Learn more about the features provided by odo on link:https://odo.dev/docs/getting-started/features[odo.dev].
|
||||
|
||||
[[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.
|
||||
|
||||
Learn more about core concepts on link:https://odo.dev/docs/getting-started/basics[odo.dev].
|
||||
|
||||
[id="odo-supported-devfiles"]
|
||||
=== Official Devfiles
|
||||
|
||||
Devfiles describe your development environment link. link:docs/public/deploying-a-devfile-using-odo.adoc[Click here for more information on Devfile.]
|
||||
// TODO: Change this to odo.dev once migrated.
|
||||
|
||||
|
||||
|
||||
[id="odo-listing-available-images"]
|
||||
==== Listing available Devfiles
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
The list of available Devfiles is sourced from the official link:https://registry.devfile.io/viewer[devfile registry] as well as any other registries 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 14 DefaultDevfileRegistry
|
||||
----------------------------------------------------
|
||||
|
||||
[[usage-data]]
|
||||
== Usage data
|
||||
|
||||
When odo is run 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 link:https://developers.redhat.com/article/tool-data-collection[privacy statement] to learn more about it. For the specific data being collected and to configure this data collection process, see link:USAGE_DATA.adoc[Usage data].
|
||||
|
||||
[[official-documentation]]
|
||||
== Official documentation
|
||||
|
||||
Visit link:https://odo.dev/[odo.dev] to learn more about odo.
|
||||
|
||||
[[installing-odo]]
|
||||
== Installing `odo`
|
||||
|
||||
To install on Linux / Windows / macOS follow our guide located on link:https://odo.dev/docs/getting-started/installation/[odo.dev]. All released binaries and tarballs are available at link:https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/[developers.redhat.com].
|
||||
|
||||
[[deploying-your-first-application]]
|
||||
== Deploying your first application
|
||||
|
||||
// TODO: Add a link to the quickstart guide once it is in.
|
||||
The following demonstration provides an overview of deploying your first application with `odo`:
|
||||
|
||||
https://asciinema.org/a/uIcSZvdbrFKKeH2sqrLsFdXym[image:https://asciinema.org/a/uIcSZvdbrFKKeH2sqrLsFdXym.svg[asciicast]]
|
||||
|
||||
[[contributing]]
|
||||
== Community, discussion, contribution, and support
|
||||
|
||||
|
||||
=== Communication channels
|
||||
|
||||
*Discussions:*
|
||||
|
||||
* For general help and inquiries, join our link:https://groups.google.com/forum/#!forum/odo-users[odo-users Google group].
|
||||
* For any developmental discussion, use our link:https://groups.google.com/forum/#!forum/odo-dev[odo-dev Google group].
|
||||
|
||||
*Chat:*
|
||||
|
||||
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.
|
||||
|
||||
*Issues:*
|
||||
|
||||
If you have an issue with `odo`, please link:https://github.com/openshift/odo/issues[file it].
|
||||
|
||||
*Documentation Issues*:
|
||||
|
||||
- For any documentation issues on link:https://odo.dev[odo.dev] open a link:https://github.com/openshift/odo/issues/new?template=Documentation.md[GitHub issue with the documentation label].
|
||||
- If you have any documentation issues related to the link:https://docs.openshift.com[docs.openshift.com] site, file an issue in link:https://bugzilla.redhat.com/[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 link:docs/dev/development.adoc[Development Guide].
|
||||
To contribute to the documentation, please have a look at our link:https://odo.dev/docs/contributing/docs/[Documentation 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 link:https://calendar.google.com/calendar/embed?src=gi0s0v5ukfqkjpnn26p6va3jfc%40group.calendar.google.com[odo calendar] (link:https://calendar.google.com/calendar/ical/gi0s0v5ukfqkjpnn26p6va3jfc%40group.calendar.google.com/public/basic.ics[iCal format]).
|
||||
|
||||
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.
|
||||
|
||||
73
README.md
Normal file
73
README.md
Normal file
@@ -0,0 +1,73 @@
|
||||
`odo` - Developer-focused CLI for Kubernetes and OpenShift
|
||||
---
|
||||
|
||||
[](https://github.com/openshift/odo/releases/latest)
|
||||
|
||||
[](https://odo.dev/godoc)
|
||||
[](https://app.netlify.com/sites/odo-docusaurus-preview/deploys)
|
||||
|
||||
|
||||
### 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.
|
||||
|
||||
Learn more about the features provided by odo on [odo.dev](https://odo.dev/docs/getting-started/features).
|
||||
|
||||
### Core concepts
|
||||
|
||||
Learn more about core concepts of odo on [odo.dev](https://odo.dev/docs/getting-started/basics).
|
||||
|
||||
|
||||
### Usage data
|
||||
|
||||
When odo is run 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).
|
||||
|
||||
### Official documentation
|
||||
|
||||
Visit [odo.dev](https://odo.dev/) to learn more about odo.
|
||||
|
||||
### Installing `odo`
|
||||
|
||||
Please check the [installation guide on odo.dev](https://odo.dev/docs/getting-started/installation/).
|
||||
|
||||
|
||||
### 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/openshift/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://odo.dev/docs/contributing/docs/).
|
||||
|
||||
#### 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 odo calls together with sprint dates in the [odo 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)).
|
||||
@@ -1,8 +1,5 @@
|
||||
[[usage-data]]
|
||||
= Usage Data
|
||||
:toc: macro
|
||||
:toc-title:
|
||||
:toclevels: 1
|
||||
Usage Data
|
||||
---
|
||||
|
||||
If the user has consented to `odo` collecting usage data, the following data will be collected when a command is executed -
|
||||
|
||||
@@ -15,47 +12,26 @@ If the user has consented to `odo` collecting usage data, the following data wil
|
||||
|
||||
Note that these commands do not include `--help` commands. We do not collect data about help commands.
|
||||
|
||||
---
|
||||
[[enable-disable]]
|
||||
== Enable/Disable preference
|
||||
### Enable/Disable preference
|
||||
|
||||
Enable::
|
||||
#### Enable
|
||||
`odo preference set ConsentTelemetry true`
|
||||
|
||||
Disable::
|
||||
#### Disable
|
||||
`odo preference set ConsentTelemetry false`
|
||||
|
||||
Alternatively you can _disable_ telemetry by setting `ODO_DISABLE_TELEMETRY` environment variable to `true`.
|
||||
This environment variable will override the `ConsentTelemetry` value set by `odo preference`.
|
||||
|
||||
---
|
||||
Table 1. The following table describes the additional information collected by odo commands.
|
||||
The following table describes the additional information collected by odo commands.
|
||||
|
||||
|===
|
||||
|Event | Data | Type
|
||||
|
||||
|*Component Create*
|
||||
| Component Type
|
||||
| Devfile component type
|
||||
|
||||
|*Component Push*
|
||||
| Component Type
|
||||
| Devfile component type
|
||||
|
|
||||
|*Cluster Type*
|
||||
| Openshift 4/ Openshift 3/ Kubernetes
|
||||
|
||||
|*Project Create*
|
||||
| Cluster Type
|
||||
|Openshift 4/ Openshift 3/ Kubernetes
|
||||
|
||||
|*Project Set*
|
||||
| Cluster Type
|
||||
|Openshift 4/ Openshift 3/ Kubernetes
|
||||
|
||||
|*Preference Change*
|
||||
| Preference Key
|
||||
| UpdateNotification/NamePrefix/Timeout/BuildTimeout/PushTimeout/Ephemeral/ConsentTelemetry
|
||||
|===
|
||||
| :-: | :-: | :-- |
|
||||
|**Component Create** | Component Type | Devfile component type |
|
||||
|**Component Push**| Component Type| Devfile component type|
|
||||
| | **Cluster Type** | Openshift 4 / Kubernetes |
|
||||
|**Project Create**| Cluster Type |Openshift 4 / Kubernetes |
|
||||
|**Project Set**| Cluster Type |Openshift 4 / Kubernetes |
|
||||
|**Preference Change** | Preference Key| UpdateNotification/NamePrefix/Timeout/BuildTimeout/PushTimeout/Ephemeral/ConsentTelemetry |
|
||||
|
||||
|
||||
Reference in New Issue
Block a user