Skip to content

Commit 536e501

Browse files
dgolovindgolovin
authored
Update readme for release of v0.1.5 (#1566)
Signed-off-by: Denis Golovin [email protected]
1 parent b224ca5 commit 536e501

File tree

1 file changed

+50
-43
lines changed

1 file changed

+50
-43
lines changed

‎README.md‎

Lines changed: 50 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ OpenShift Connector extension provides an end-to-end developer experience for Re
1414

1515
This extension can work with local or remote OpenShift clusters.
1616

17-
To start local instance of OpenShift cluster, developers can use the following options:
17+
To provision local instance of OpenShift cluster, developers can use the following options:
1818
* [CodeReadyContainers](https://cloud.redhat.com/openshift/install/crc/installer-provisioned) - run single node local OpenShift 4.x cluster
1919
* [minishift](https://github.com/minishift/minishift/releases) / [CDK](https://developers.redhat.com/products/cdk/download/) - run single node local OpenShift 3.x cluster
2020

2121
For detail analysis of how to setup and run local OpenShift Cluster using minishift, please follow this [wiki](https://github.com/redhat-developer/vscode-openshift-tools/wiki/Starting-Local-OpenShift-Instance).
2222

23-
If developers can not run local OpenShift cluster the extension can work with remote one from various Red Hat products:
23+
If developers can't run OpenShift cluster locally, the extension can work with remote one provisioned with one of Red Hat products:
2424
* [Red Hat OpenShift Container Platform](https://www.openshift.com/products/container-platform) - build, deploy and manage your applications across cloud- and on-premise infrastructure
2525
* [Red Hat OpenShift Dedicated](https://www.openshift.com/products/dedicated/) - single-tenant, high-availability Kubernetes clusters in the public cloud
2626
* [Microsoft Azure Red Hat OpenShift](https://www.openshift.com/products/azure-openshift) - fully managed Red Hat OpenShift service on Microsoft Azure
@@ -30,34 +30,21 @@ When working with [OpenShift Online](https://www.openshift.com/products/online/)
3030

3131
## New and Noteworthy
3232

33-
## All Required CLI Tools Included
34-
35-
This release includes binaries for all required CLI tools:
36-
* OKD CLI Client (`oc`)
37-
* OpenShift Do (`odo`)
38-
Once extension is installed it is ready to use. There is no additional configuration steps to download CLI tools binaries.
39-
40-
### Debug Support for Local Node.js and Java Components
41-
42-
This release provides new 'OpenShift: Debug' command to simplify the way to start debugging for OpenShift Components pushed to a cluster. It is an experimental feature, because it is using experimental OpenShift Do `debug` command under the hood and supports only local Java and Node.js components. The command is available from command palette and context menu for Component nodes in OpenShift Application Explorer view.
43-
44-
#### Debug Node.js Component
45-
46-
Default Visual Studio Code installation includes JavaScript/TypeScript Language Support and Debugger Extensions required to debug a Node.js Component. That means new `OpenShift: Debug` command can be used without installing any additional extensions.
47-
48-
![ screencast ](https://raw.githubusercontent.com/redhat-developer/vscode-openshift-tools/master/images/debug-node.gif)
49-
50-
#### Debug Java Component
51-
52-
To debug a Java Component, Java Language Support and Java Debugger Extensions are required. OpenShift Connector extension will prompt the user to install missing extension(s) before it starts Debugger for a Java Component.
53-
54-
![ screencast ](https://raw.githubusercontent.com/redhat-developer/vscode-openshift-tools/master/images/debug-java.gif)
33+
* Latest OpenShift Do CLI tool v1.2.1 included
34+
* Webview based viewers for `Show Log`, `Follow Log` and `Describe` commands for Component
35+
* Terminals created with OpenShift commands have meaningful names for better navigation
36+
* OpenShift Routes in k8s Clusters View have new command 'Open in Browser'
37+
* `Describe` command for Component's URL
38+
* `Describe` and `New Storage` commands for not pushed Components
39+
* `New URL` command can create secured URLs for Component
5540

5641
## Commands and Features
5742

5843
`vs-openshift-connector` supports a number of commands & actions for interacting with OpenShift clusters; these are accessible via the command menu (`Cmd+Shift+P` <kbd>⌘⇧P</kbd> on macOS or `Ctrl+Shift+P` <kbd>⌃⇧P</kbd> on Windows and Linux) and may be bound to keys in the normal way.
5944

60-
### General Commands
45+
### Commands Available in OpenShift Application Explorer View
46+
47+
#### Commands for Cluster
6148

6249
* `OpenShift: Log in to cluster` - Log in to your server and save login for subsequent use.
6350
* Credentials : Log in to the given server with the given credentials.
@@ -71,7 +58,7 @@ To debug a Java Component, Java Language Support and Java Debugger Extensions ar
7158
* `OpenShift: Open Console Dashboard` - Opens the OpenShift webconsole URL.
7259
* `OpenShift: Create` - Creates an OpenShift resource using `.json` or `.yaml` file location from an active editor.
7360

74-
#### Actions Available for an OpenShift Cluster Project
61+
#### Commands for a Project
7562

7663
* `Project -> New Component` - Create a new Component from the Project.
7764
* git - Use a git repository as the source for the Component.
@@ -80,7 +67,7 @@ To debug a Java Component, Java Language Support and Java Debugger Extensions ar
8067
* `Project -> New Service` - Perform Service Catalog operations when it is enabled.
8168
* `Project -> Delete` - Delete an existing Project.
8269

83-
#### Actions Available for an Application in a Project
70+
#### Commands for an Application
8471

8572
* `Application -> New Component` - Create a new Component inside the selected Application.
8673
* git - Use a git repository as the source for the Component.
@@ -90,15 +77,17 @@ To debug a Java Component, Java Language Support and Java Debugger Extensions ar
9077
* `Application -> Describe` - Describe the given Application in terminal window.
9178
* `Application -> Delete` - Delete an existing Application.
9279

93-
#### Actions Available for a Component in an Application
80+
#### Commands for a Component
81+
82+
Components can be in 3 stages:
9483

95-
##### Components can be in 3 stages:
84+
* pushed - When the components are deployed into the cluster.
85+
* not pushed - When are the components are in local config but NOT deployed into the cluster.
86+
* no context - When there is no context folder associated with the component in the workspace.
9687

97-
pushed - When the components are deployed into the cluster.
98-
not pushed - When are the components are in local config but NOT deployed into the cluster.
99-
no context - When there is no context folder associated with the component in the workspace.
88+
Components in different states have different set of commands available.
10089

101-
#### Actions for a Pushed Component
90+
##### Command for a Pushed Component
10291

10392
* `Component -> New URL` - Expose Component to the outside world. The URLs that are generated using this command, can be used to access the deployed Components from outside the Cluster. Push the component to reflect the changes on the cluster.
10493
* `Component -> New Storage` - Create Storage and mount to a Component. Push the component to reflect the changes on the cluster.
@@ -115,38 +104,54 @@ To debug a Java Component, Java Language Support and Java Debugger Extensions ar
115104
* `Component -> Delete` - Delete an existing Component from the cluster and removes the local config also.
116105
* `Component -> Debug` - Debug local Java or Node.js Component.
117106

118-
#### Actions for a not Pushed Component
107+
##### Commands for a not Pushed Component
119108

120109
* `Component -> New URL` - Expose Component to the outside world. The URLs that are generated using this command, can be used to access the deployed Components from outside the Cluster.
110+
* `Component -> New Storage` - Create Storage and mount to a Component. Push the component to reflect the changes on the cluster.
111+
* `Component -> Describe` - Describe the given Component in terminal window.
121112
* `Component -> Push` - Push the source code to a Component.
122113
* `Component -> Delete` - Delete an existing Component from the local config.
123114

124-
#### Actions for a no context Component
115+
##### Commands for a no context Component
125116

126117
* `Component -> Describe` - Describe the given Component in terminal window.
127-
* `Component -> Delete` - Delete an existing Component from the local config.
128118
* `Component -> Import` - If the component was created using old version of the extension (`<=0.0.23`), users can use the `Import` action to migrate to latest version and import the metadata changes.
119+
* `Component -> Delete` - Delete an existing Component from the local config.
129120

130-
#### Actions available for a URL in a Component
121+
##### Commands for a URL in a Component
131122

132123
* `URL -> Delete` - Delete a URL from a Component.
133124
* `URL -> Open URL` - Click on the icon opens the specific URL in Browser.
134125
* `URL -> Describe` - Describe the given URL for the component in terminal window.
135126

136-
137-
#### Actions available for a Storage in a Component
127+
##### Commands for a Storage
138128

139129
* `Storage -> Delete` - Delete a Storage from a Component.
140130

141-
142-
#### Actions available for a Service in an Application
131+
##### Commands for a Service
143132

144133
* `Service -> Describe` - Describe a Service Type for a selected Component
145134
* `Service -> Delete` - Delete a Service from an Application
146135

147136
**NOTE:** Currently we support creation of one component per folder. Multiple components from a folder might be supported in future releases.
148137

149-
#### Icons Representation
138+
#### Debug Support for Local Node.js and Java Components
139+
140+
'OpenShift: Debug' command simplifies the way to start debugging for OpenShift Components pushed to a cluster. It is an experimental feature, because it is using experimental OpenShift Do `debug` command under the hood and supports only local Java and Node.js components. The command is available from command palette and context menu for Component nodes in OpenShift Application Explorer view.
141+
142+
##### Debug Node.js Component
143+
144+
Default Visual Studio Code installation includes JavaScript/TypeScript Language Support and Debugger Extensions required to debug a Node.js Component. That means new `OpenShift: Debug` command can be used without installing any additional extensions.
145+
146+
![ screencast ](https://raw.githubusercontent.com/redhat-developer/vscode-openshift-tools/master/images/debug-node.gif)
147+
148+
##### Debug Java Component
149+
150+
To debug a Java Component, Java Language Support and Java Debugger Extensions are required. OpenShift Connector extension will prompt the user to install missing extension(s) before it starts Debugger for a Java Component.
151+
152+
![ screencast ](https://raw.githubusercontent.com/redhat-developer/vscode-openshift-tools/master/images/debug-java.gif)
153+
154+
## Icons for OpenShift Application Explorer View Items
150155

151156
<div><img src="https://raw.githubusercontent.com/redhat-developer/vscode-openshift-tools/master/images/title/readme/icon-login.png" width="15" height="15" /><span style="margin: 20px">Log in to Cluster</span></div>
152157
<div><img src="https://raw.githubusercontent.com/redhat-developer/vscode-openshift-tools/master/images/title/readme/icon-refresh.png" width="15" height="15" /><span style="margin: 20px">Refresh Cluster</span></div>
@@ -161,9 +166,11 @@ To debug a Java Component, Java Language Support and Java Debugger Extensions ar
161166
<div><img src="https://raw.githubusercontent.com/redhat-developer/vscode-openshift-tools/master/images/context/url-node.png" width="15" height="15" /><span style="margin: 20px">URL Resource</span></div>
162167
<div><img src="https://raw.githubusercontent.com/redhat-developer/vscode-openshift-tools/master/images/context/url-node-open.png" width="15" height="15" /><span style="margin: 20px">Open URL</span></div>
163168

164-
### Extension Configuration Settings
169+
## Extension Configuration Settings
165170
* `OpenShift Connector: Show Channel On Output` - Show OpenShift Connector output channel when new text added to output stream
166171
* `OpenShift Connector: Output verbosity level` - Output verbosity level (value between 0 and 9) for OpenShift Create, Push and Watch commands in output channel and terminal view
172+
* `OpenShift Connector: Search CLI tools in PATH locations before using included binaries` - Force extension to search for `oc` and `odo` CLI tools in PATH locations before using bundled binaries
173+
* `OpenShift Connector: Use Webview based editors to show 'Show Log', 'Follow Log' and 'Describe' commands output` - Use Webview based editors instead of Terminal view to show or follow logs
167174

168175
## Dependencies
169176

0 commit comments

Comments
 (0)