From 301563aec048c3cca1d9b3ca5bbc4423c187e88b Mon Sep 17 00:00:00 2001 From: Mohit Suman Date: Tue, 23 May 2023 03:02:16 +0530 Subject: [PATCH] update readme contents Signed-off-by: Mohit Suman --- README.commands.md | 11 ++++++++--- README.md | 21 ++++++++++++++------- package.json | 5 +++-- 3 files changed, 25 insertions(+), 12 deletions(-) diff --git a/README.commands.md b/README.commands.md index 2c1b8bce8..2bbffb38f 100644 --- a/README.commands.md +++ b/README.commands.md @@ -8,11 +8,13 @@ #### Commands in OpenShift Application Explorer View +* Show the `Default kubeconfig` file and open the file in the editor. * `Log in to cluster` - Log in to your cluster and save login for subsequent use. * Credentials : Log in to the given cluster with the given credentials. * Token : Login using bearer token for authentication to the API server. * `Open Console Dashboard` - Open the OpenShift Developer Console in default browser. * `New Project` - Create new Project inside the OpenShift Cluster. +* `Open Helm Charts` - Browse the catalog to discover and install Helm Charts on cluster. * `Log out` - Log out of the current OpenShift Cluster. * `About` - Provide the information about the OpenShift tools. * `Show Output Channel` - Show commands running under the hood and their output. @@ -33,7 +35,8 @@ Actions available in Components View Commands available in context for the compenent - * `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. + * `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. + * `Start Dev on Podman` - Run the above start dev workflow for applications deployed on Podman. * `Stop Dev` - Stop the dev command workflow and resources are cleaned, hence the application is not running on the cluster * `Show Dev Terminal` - Directly opens the VSCode terminal where the dev command is running. * `Describe` - Describe the given Component in terminal window or inside a webview editor. @@ -44,6 +47,7 @@ Commands available in context for the compenent * `Undeploy` - Undeploys a Component from the cluster. The component still resides in the local config. * `Debug` - Start the component in debug mode * `Reveal in Explorer` - Show Component's context folder in Explorer view + * `Delete Component Configuration` - Remove the devfile.yaml file from component folder and also from component view. **NOTE:** Currently we support creation of one component per folder. Multiple components from a folder might be supported in future releases. @@ -73,7 +77,7 @@ OpenShift Toolkit extension provides ```Use Project``` command to switch between ### Extensions -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: +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: * [Red Hat Authentication](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-redhat-account) * [YAML Extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) @@ -83,7 +87,7 @@ When installing the extension directly from the VSCode marketplace all the depen This extension uses two CLI tools to interact with OpenShift cluster: * OKD CLI client tool - [oc](https://mirror.openshift.com/pub/openshift-v4/clients/ocp/4.9.5/) -* odo - [odo](https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/v3.0.0/) +* odo - [odo](https://odo.dev/docs/introduction) > `oc` and `odo` tools for Windows, Linux and macOS are included into extension package. Once the extension is installed, it is ready to use. @@ -91,3 +95,4 @@ Follow the links below for additional information: * [Understanding odo](https://odo.dev/) * [Devfile ecosystem](https://devfile.io/) +* [Red Hat Developer Sandbox](https://developers.redhat.com/developer-sandbox) diff --git a/README.md b/README.md index 996221088..158c41e3b 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,13 @@ 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. OpenShift Toolkit extension provides an end-to-end developer experience for Red Hat® OpenShift®. Using this extension: - - Developers can easily create, deploy and live debug container applications running on OpenShift. - - Create [devfile](https://devfile.io) based components directly from _Devfile Registries View_ - - Deploy git repositories directly on OpenShift through _Import from Git_ guided workflow + - Developers can easily create, deploy and live debug container applications running on OpenShift, podman and Hybrid cloud. + - Browse & Install [Helm Charts](https://helm.sh/) on to the cluster directly from IDE. + - Create [devfile](https://devfile.io) based components directly from _Devfile Registries View_. + - Deploy git repositories directly on OpenShift through _Import from Git_ guided workflow. - Developers can view and edit Resources YAML manifests, and view logs for pods, deployments, and deployment configs. - - Run local instance of OpenShift 4.11.7 using [OpenShift Local](https://crc.dev/crc/) directly from IDE - - Connect & Provision free [Developer Sandbox for Red Hat OpenShift](https://developers.redhat.com/developer-sandbox) instance from IDE + - Run local instance of OpenShift 4.x using [OpenShift Local](https://crc.dev/crc/) directly from IDE + - Connect & Provision free [Developer Sandbox for Red Hat OpenShift](https://developers.redhat.com/developer-sandbox) instance without leaving the IDE ![ screencast ](https://raw.githubusercontent.com/redhat-developer/vscode-openshift-tools/main/images/gif/create-component-demo.gif) ## Getting Started @@ -51,7 +52,7 @@ The extension provides users with multiple ways to provision an instance of Open 
Red Hat OpenShift Developer Sandbox
-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. +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. 
Local instance of OpenShift
@@ -82,6 +83,12 @@ Users can directly deploy the git repo code on top of OpenShift/Kubernetes clust 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 ![ screencast ](https://raw.githubusercontent.com/redhat-developer/vscode-openshift-tools/main/images/walkthrough/showRegistries.gif) + +### **Install Helm Charts on cluster** + +Browse the catalog to discover and install [Helm Charts](https://helm.sh/) on cluster, directly from VSCode. + +![ screencast ](https://raw.githubusercontent.com/redhat-developer/vscode-openshift-tools/main/images/walkthrough/helm.gif) ## Commands and Features 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` ⌘⇧P on macOS or `Ctrl+Shift+P` ⌃⇧P 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. ## Data and telemetry -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. +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. 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. diff --git a/package.json b/package.json index 0d776d835..f07fe8ca7 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "vscode-openshift-connector", "displayName": "OpenShift Toolkit", "description": "Fast iterative application development on Red Hat OpenShift and Kubernetes", - "version": "1.3.0", + "version": "1.4.0", "license": "MIT", "publisher": "redhat", "author": "Red Hat", @@ -41,7 +41,8 @@ "debuggers", "K8s", "Cloud", - "podman" + "podman", + "Helm" ], "icon": "images/openshift_extension.png", "main": "./out/src/extension",