Skip to content

Commit

Permalink
Add Getting Started > Basics documentation (redhat-developer#4914)
Browse files Browse the repository at this point in the history
* Add Getting Started > Basics documentation

* Better structure the doc

* Changes

* Fix content

* Remove K8s content

* Simplify the doc

* Cosmetic changes

* Fix grammar
  • Loading branch information
valaparthvi authored and anandrkskd committed Jul 27, 2021
1 parent abff22d commit 35a46a9
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 12 deletions.
37 changes: 26 additions & 11 deletions website/docs/getting-started/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,34 @@ sidebar_position: 3
---
# odo concepts

odo abstracts Kubernetes concepts into developer focussed terminology. In this document, we will take a look at each of these concepts and also their Kubernetes equivalent.
odo abstracts Kubernetes concepts into a developer friendly terminology; in this document, we will take a look at these terminologies.

### Concepts
#### Application
An application in odo is a classic application developed with a [cloud-native approach](https://www.redhat.com/en/topics/cloud-native-apps) that is used to perform a particular task.

Examples of applications: Online Video Streaming, Hotel Reservation System, Online Shopping.

#### Component
* Application
* Project
* Context
* URL
* Storage
* Service
* Devfile
In the cloud-native architecture, an application is a collection of small, independent, and loosely coupled components; an odo component is one of these components.

### Component vs. Application
Examples of components: API Backend, Web Frontend, Payment Backend.

### odo services vs. Kubernetes services
#### Project
A project helps achieve multi-tenancy: several applications can be run in the same cluster by different teams in different projects.

#### Context
A context is the directory on the system that contains the source code, tests, libraries and odo specific config files for a single component.

#### URL
A URL exposes a component to be accessed from outside the cluster.

#### Storage
A storage is a persistent storage in the cluster: it persists the data across restarts and rebuilds of a component.

#### Service
A service is an external application that a component can connect to or depend on to gain an additional functionality.

Example of services: MySQL, Redis.

#### Devfile
A devfile is a portable YAML file containing the definition of a component and its related URLs, storages and services. See [Devfile](../architecture/devfile.md) to know more about devfile.
2 changes: 1 addition & 1 deletion website/docs/getting-started/installation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: Installation
sidebar_position: 4
---
---

0 comments on commit 35a46a9

Please sign in to comment.