Skip to content

Commit e006ccd

Browse files
authored
update readme contents (#2892)
Signed-off-by: Mohit Suman <[email protected]>
1 parent d033ae4 commit e006ccd

File tree

3 files changed

+25
-12
lines changed

3 files changed

+25
-12
lines changed

README.commands.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@
88

99
#### Commands in OpenShift Application Explorer View
1010

11+
* Show the `Default kubeconfig` file and open the file in the editor.
1112
* `Log in to cluster` - Log in to your cluster and save login for subsequent use.
1213
* Credentials : Log in to the given cluster with the given credentials.
1314
* Token : Login using bearer token for authentication to the API server.
1415
* `Open Console Dashboard` - Open the OpenShift Developer Console in default browser.
1516
* `New Project` - Create new Project inside the OpenShift Cluster.
17+
* `Open Helm Charts` - Browse the catalog to discover and install Helm Charts on cluster.
1618
* `Log out` - Log out of the current OpenShift Cluster.
1719
* `About` - Provide the information about the OpenShift tools.
1820
* `Show Output Channel` - Show commands running under the hood and their output.
@@ -33,7 +35,8 @@ Actions available in Components View
3335

3436
Commands available in context for the compenent
3537

36-
* `Start Dev` - The application has been built and deployed to the cluster and the application is port-forwarded for local accessibility. The extension will watch for changes in the current directory and rebuild the application when changes are detected.
38+
* `Start Dev` - The application has been built and deployed to the OpenShift/Kubernetes cluster and the application is port-forwarded for local accessibility. The extension will watch for changes in the current directory and rebuild the application when changes are detected.
39+
* `Start Dev on Podman` - Run the above start dev workflow for applications deployed on Podman.
3740
* `Stop Dev` - Stop the dev command workflow and resources are cleaned, hence the application is not running on the cluster
3841
* `Show Dev Terminal` - Directly opens the VSCode terminal where the dev command is running.
3942
* `Describe` - Describe the given Component in terminal window or inside a webview editor.
@@ -44,6 +47,7 @@ Commands available in context for the compenent
4447
* `Undeploy` - Undeploys a Component from the cluster. The component still resides in the local config.
4548
* `Debug` - Start the component in debug mode
4649
* `Reveal in Explorer` - Show Component's context folder in Explorer view
50+
* `Delete Component Configuration` - Remove the devfile.yaml file from component folder and also from component view.
4751

4852
**NOTE:** Currently we support creation of one component per folder. Multiple components from a folder might be supported in
4953
future releases.
@@ -73,7 +77,7 @@ OpenShift Toolkit extension provides ```Use Project``` command to switch between
7377

7478
### Extensions
7579

76-
When installing the extension directly from the VSCode marketplace all the dependencies are installed automatically. For disconnected environments,before installing the extension download and install dependencies in the order listed below:
80+
When installing the extension directly from the VSCode marketplace all the dependencies are installed automatically. For Disconnected Environments, before installing the extension, please download and install dependencies in the order listed below:
7781

7882
* [Red Hat Authentication](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-redhat-account)
7983
* [YAML Extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml)
@@ -83,11 +87,12 @@ When installing the extension directly from the VSCode marketplace all the depen
8387

8488
This extension uses two CLI tools to interact with OpenShift cluster:
8589
* OKD CLI client tool - [oc](https://mirror.openshift.com/pub/openshift-v4/clients/ocp/4.9.5/)
86-
* odo - [odo](https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/v3.0.0/)
90+
* odo - [odo](https://odo.dev/docs/introduction)
8791

8892
> `oc` and `odo` tools for Windows, Linux and macOS are included into extension package. Once the extension is installed, it is ready to use.
8993
9094
Follow the links below for additional information:
9195

9296
* [Understanding odo](https://odo.dev/)
9397
* [Devfile ecosystem](https://devfile.io/)
98+
* [Red Hat Developer Sandbox](https://developers.redhat.com/developer-sandbox)

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,13 @@
2121
The OpenShift Toolkit extends Visual Studio Code to provide all of the power and convenience of IDEs for developing cloud-native Kubernetes applications, without leaving the comfort of your IDE. For a developer to run the local code on an OpenShift instance, test & debug it and deploy it on production without worrying about the complexities around different K8s tools.
2222

2323
OpenShift Toolkit extension provides an end-to-end developer experience for Red Hat® OpenShift®. Using this extension:
24-
- Developers can easily create, deploy and live debug container applications running on OpenShift.
25-
- Create [devfile](https://devfile.io) based components directly from _Devfile Registries View_
26-
- Deploy git repositories directly on OpenShift through _Import from Git_ guided workflow
24+
- Developers can easily create, deploy and live debug container applications running on OpenShift, podman and Hybrid cloud.
25+
- Browse & Install [Helm Charts](https://helm.sh/) on to the cluster directly from IDE.
26+
- Create [devfile](https://devfile.io) based components directly from _Devfile Registries View_.
27+
- Deploy git repositories directly on OpenShift through _Import from Git_ guided workflow.
2728
- Developers can view and edit Resources YAML manifests, and view logs for pods, deployments, and deployment configs.
28-
- Run local instance of OpenShift 4.11.7 using [OpenShift Local](https://crc.dev/crc/) directly from IDE
29-
- Connect & Provision free [Developer Sandbox for Red Hat OpenShift](https://developers.redhat.com/developer-sandbox) instance from IDE
29+
- Run local instance of OpenShift 4.x using [OpenShift Local](https://crc.dev/crc/) directly from IDE
30+
- Connect & Provision free [Developer Sandbox for Red Hat OpenShift](https://developers.redhat.com/developer-sandbox) instance without leaving the IDE
3031

3132
![ screencast ](https://raw.githubusercontent.com/redhat-developer/vscode-openshift-tools/main/images/gif/create-component-demo.gif)
3233
## Getting Started
@@ -51,7 +52,7 @@ The extension provides users with multiple ways to provision an instance of Open
5152

5253
<pre>Red Hat OpenShift Developer Sandbox</pre>
5354

54-
The extension allows users free access to the [Developer Sandbox for Red Hat OpenShift](https://developers.redhat.com/developer-sandbox/get-started). From `Add Cluster View`, users can provision and connect to dev sandbox instance using the guided workflow. The sandbox provides you with a private OpenShift environment in a shared, multi-tenant OpenShift cluster that is pre-configured with a set of developer tools.
55+
The extension allows users FREE access to the [Developer Sandbox for Red Hat OpenShift](https://developers.redhat.com/developer-sandbox/get-started). From `Add Cluster View`, users can provision and connect to dev sandbox instance using the guided workflow. The sandbox provides you with a private OpenShift environment in a shared, multi-tenant OpenShift cluster that is pre-configured with a set of developer tools.
5556

5657
<pre>Local instance of OpenShift</pre>
5758

@@ -82,6 +83,12 @@ Users can directly deploy the git repo code on top of OpenShift/Kubernetes clust
8283
In the Devfile Registries view, there is an action to `Open Registry View` which opens a webview to browse devfile stacks consisting of supported registries. Users can create components directly from any selected stack and deploy on OpenShift
8384

8485
![ screencast ](https://raw.githubusercontent.com/redhat-developer/vscode-openshift-tools/main/images/walkthrough/showRegistries.gif)
86+
87+
### **Install Helm Charts on cluster**
88+
89+
Browse the catalog to discover and install [Helm Charts](https://helm.sh/) on cluster, directly from VSCode.
90+
91+
![ screencast ](https://raw.githubusercontent.com/redhat-developer/vscode-openshift-tools/main/images/walkthrough/helm.gif)
8592
## Commands and Features
8693

8794
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.
@@ -112,5 +119,5 @@ MIT, See [LICENSE](LICENSE) for more information.
112119

113120
## Data and telemetry
114121

115-
The Red Hat OpenShift Toolkit for Visual Studio Code collects anonymous [usage data](USAGE_DATA.md) and sends 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. This extension respects the `redhat.telemetry.enabled` setting which you can learn more about at https://github.com/redhat-developer/vscode-redhat-telemetry#how-to-disable-telemetry-reporting.
122+
The Red Hat OpenShift Toolkit for Visual Studio Code collects anonymous [usage data](USAGE_DATA.md) and sends 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. This extension respects the `redhat.telemetry.enabled` setting which you can learn more about at https://github.com/redhat-developer/vscode-redhat-telemetry#how-to-disable-telemetry-reporting.
116123
Note that this extension also abides by Visual Studio Code's telemetry level: if `telemetry.telemetryLevel` is set to off, then no telemetry events will be sent to Red Hat, even if `redhat.telemetry.enabled` is set to true. If `telemetry.telemetryLevel` is set to `error` or `crash`, only events containing an error or errors property will be sent to Red Hat.

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "vscode-openshift-connector",
33
"displayName": "OpenShift Toolkit",
44
"description": "Fast iterative application development on Red Hat OpenShift and Kubernetes",
5-
"version": "1.3.0",
5+
"version": "1.4.0",
66
"license": "MIT",
77
"publisher": "redhat",
88
"author": "Red Hat",
@@ -41,7 +41,8 @@
4141
"debuggers",
4242
"K8s",
4343
"Cloud",
44-
"podman"
44+
"podman",
45+
"Helm"
4546
],
4647
"icon": "images/openshift_extension.png",
4748
"main": "./out/src/extension",

0 commit comments

Comments
 (0)