Skip to content

Commit 13345ef

Browse files
authored
update readme with latest odo link (#1958)
Signed-off-by: Mohit Suman <[email protected]>
1 parent 392178e commit 13345ef

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,19 @@ To install OpenShift Container Platform 4 in the public cloud, in your datacente
4646

4747
**NOTE:** When working with [Red Hat OpenShift Online](http://red.ht/3bbSVso) remote cluster only one component can be created for Starter plan and Pro plan with default 2GiB storage. If you want to create multi component application you could opt in for Pro plan with bigger persistence storage (up to 150GiB).
4848

49-
## Commands and Features
49+
## Core Concepts
50+
51+
* `Project`: A project is your source code, tests, and libraries organized in a separate single unit.
52+
53+
* `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
54+
55+
* `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
56+
57+
* `Service`: A service is software that your component links to or depends on. Examples of services: MariaDB, MySQL.
58+
59+
* `Devfile`: A portable file responsible for your entire reproducable development environment.
60+
61+
## Commands and Features
5062

5163
The extension supports a number of commands to interact with OpenShift clusters and resources. The commands are accessible via the command palette (`Cmd+Shift+P` <kbd>⌘⇧P</kbd> on macOS or `Ctrl+Shift+P` <kbd>⌃⇧P</kbd> on Windows and Linux), Visual Studio Code View title buttons and tree context menus.
5264

@@ -132,7 +144,7 @@ Components in different states have different set of commands available.
132144

133145
* `Delete` - Delete a URL from a Component.
134146
* `Open URL` - Open the specific URL in Browser.
135-
* `Describe` - Describe the given URL for the component in terminal window.
147+
* `Describe` - Describe the given URL for the Component in terminal window.
136148

137149
##### Commands for a Storage
138150

@@ -146,7 +158,7 @@ Components in different states have different set of commands available.
146158
**NOTE:** Currently we support creation of one component per folder. Multiple components from a folder might be supported in
147159
future releases.
148160

149-
#### Running OpenShift Locally
161+
### Running OpenShift Locally
150162

151163
The extension provides a view to run local instance of OpenShift. To open the view use `Add OpenShift Cluster` button
152164
![ addclusterbutton ](https://raw.githubusercontent.com/redhat-developer/vscode-openshift-tools/master/images/add-cluster-button.gif)
@@ -171,7 +183,7 @@ The view provides UI to control cluster's state:
171183

172184
![ screencast ](https://raw.githubusercontent.com/redhat-developer/vscode-openshift-tools/master/images/gif/crc-webview.gif)
173185

174-
#### Debug Support
186+
### Debug Support
175187

176188
* Supports Local Node.js and Java Components
177189
* Does not support git and binary based components
@@ -224,11 +236,11 @@ To debug a Java Component, [Java Language Support](https://marketplace.visualstu
224236

225237
This extension uses two CLI tools to interact with OpenShift cluster:
226238
* OKD CLI client tool - [oc](http://red.ht/3s0jSW7)
227-
* odo - [odo](http://red.ht/2XghCvy)
239+
* odo - [odo](https://red.ht/3p7usI3)
228240

229241
> `oc` and `odo` tools for Windows, Linux and macOS are included into extension package. Once the extension is installed it is ready to use.
230242
231-
Starting from `v0.2.0` extension includes `odo` CLI tool `v2.0.0` and supports devfile in addition to S2I (software-to-image) components. Devfiles are new way of deploying a component with odo.
243+
The extension version `0.2.2` includes `odo` CLI tool `v2.0.4` and supports devfile in addition to S2I (Source-to-Image) components. Devfiles are new way of deploying a component with odo.
232244
Follow the links below for additional information:
233245

234246
* [Understanding odo](https://bit.ly/3ovRTuY)

0 commit comments

Comments
 (0)