You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-19Lines changed: 22 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
## Overview
6
6
7
-
OpenShift Connector extension provides an end-to-end developer experience for Red Hat OpenShift. Using this extension developers can easily create, deploy and live debug applications running on OpenShift.
7
+
OpenShift Connector extension provides an end-to-end developer experience for Red Hat® OpenShift®. Using this extension, developers can easily create, deploy and live debug applications running on OpenShift.
8
8
9
9
* Demo: https://youtube.com/watch?v=m0wBKuKDYO0
10
10
@@ -44,7 +44,7 @@ When working with [OpenShift Online](https://www.openshift.com/products/online/)
44
44
45
45
### Commands Available in OpenShift Application Explorer View
46
46
47
-
#### Commands for Cluster
47
+
#### Commands for a Cluster
48
48
49
49
*`OpenShift: Log in to cluster` - Log in to your server and save login for subsequent use.
50
50
* Credentials : Log in to the given server with the given credentials.
@@ -61,7 +61,7 @@ When working with [OpenShift Online](https://www.openshift.com/products/online/)
61
61
#### Commands for a Project
62
62
63
63
*`Project -> New Component` - Create a new Component from the Project.
64
-
* git - Use a git repository as the source for the Component.
64
+
* git - Use a git repository as a source for the Component.
65
65
* binary - Use binary file as a source for the Component
66
66
* local - Use local directory as a source for the Component.
67
67
*`Project -> New Service` - Perform Service Catalog operations when it is enabled.
@@ -70,7 +70,7 @@ When working with [OpenShift Online](https://www.openshift.com/products/online/)
70
70
#### Commands for an Application
71
71
72
72
*`Application -> New Component` - Create a new Component inside the selected Application.
73
-
* git - Use a git repository as the source for the Component.
73
+
* git - Use a git repository as a source for the Component.
74
74
* binary - Use binary file as a source for the Component
75
75
* local - Use local directory as a source for the Component.
76
76
*`Application -> New Service` - Perform Service Catalog operations when it is enabled.
@@ -82,39 +82,39 @@ When working with [OpenShift Online](https://www.openshift.com/products/online/)
82
82
Components can be in 3 stages:
83
83
84
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.
85
+
* not pushed - When the components are in local config but NOT deployed into the cluster.
86
86
* no context - When there is no context folder associated with the component in the workspace.
87
87
88
88
Components in different states have different set of commands available.
89
89
90
-
##### Command for a Pushed Component
90
+
##### Commands for a `Pushed` Component
91
91
92
92
*`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.
93
93
*`Component -> New Storage` - Create Storage and mount to a Component. Push the component to reflect the changes on the cluster.
94
-
*`Component -> Describe` - Describe the given Component in terminal window.
95
-
*`Component -> Show Log` - Retrieve the log for the given Component.
96
-
*`Component -> Follow Log` - Follow logs for the given Component.
94
+
*`Component -> Describe` - Describe the given Component in terminal window or inside a webview editor.
95
+
*`Component -> Show Log` - Retrieve the log for the given Component or inside a webview editor
96
+
*`Component -> Follow Log` - Follow logs for the given Component or inside a webview editor
97
97
*`Component -> Link Component` - Link Component to another Component.
98
98
*`Component -> Link Service` - Link Component to a Service.
99
99
*`Component -> Unlink` - Unlink Component from Component/Service.
100
-
*`Component -> Open in Browser` - Open the exposed URL in browser.
100
+
*`Component -> Open in Browser` - Open the exposed URL in default browser.
101
101
*`Component -> Push` - Push the source code to a Component.
102
102
*`Component -> Watch` - Watch for changes, update Component on change. This is not supported for git based components.
103
103
*`Component -> Undeploy` - Undeploys a Component from the cluster. The component still resides in the local config.
104
104
*`Component -> Delete` - Delete an existing Component from the cluster and removes the local config also.
105
105
*`Component -> Debug` - Debug local Java or Node.js Component.
106
106
107
-
##### Commands for a not Pushed Component
107
+
##### Commands for a `not pushed` Component
108
108
109
109
*`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
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.
111
+
*`Component -> Describe` - Describe the given Component in terminal window or inside a webview editor.
112
112
*`Component -> Push` - Push the source code to a Component.
113
113
*`Component -> Delete` - Delete an existing Component from the local config.
114
114
115
-
##### Commands for a no context Component
115
+
##### Commands for a `no context` Component
116
116
117
-
*`Component -> Describe` - Describe the given Component in terminal window.
117
+
*`Component -> Describe` - Describe the given Component in terminal window or inside a webview editor.
118
118
*`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
119
*`Component -> Delete` - Delete an existing Component from the local config.
120
120
@@ -135,7 +135,10 @@ Components in different states have different set of commands available.
135
135
136
136
**NOTE:** Currently we support creation of one component per folder. Multiple components from a folder might be supported in future releases.
137
137
138
-
#### Debug Support for Local Node.js and Java Components
138
+
#### Debug Support
139
+
140
+
* Supports Local Node.js and Java Components
141
+
* Does not support git and binary based components
139
142
140
143
'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
144
@@ -177,8 +180,8 @@ To debug a Java Component, Java Language Support and Java Debugger Extensions ar
177
180
### CLI Tools
178
181
179
182
This extension uses two CLI tools to interact with OpenShift cluster:
* OpenShift Do tool - [odo](http://mirror.openshift.com/pub/openshift-v4/clients/odo/v1.2.1/)
182
185
183
186
> `oc` and `odo` tools for Windows, Linux and macOS are included into extension package. Once the extension is installed it is ready to use.
184
187
@@ -195,7 +198,7 @@ OpenShift Connector extension also provides ```Use Project``` command to switch
195
198
196
199
## Breaking Changes Between Previous Releases
197
200
198
-
### Updating from release 0.0.23 or earlier
201
+
### Updating from release `0.0.23` or earlier
199
202
200
203
* The Components created with previous versions(<=0.0.23) will no longer be visible in OpenShift Application Explorer view.
201
204
* The Extension will prompt the user to specify the context folder when creating new Components and then add selected folder to workspace.
@@ -215,7 +218,7 @@ This is an open source project open to anyone. This project welcomes contributio
215
218
216
219
For information on getting started, refer to the [CONTRIBUTING instructions](CONTRIBUTING.md).
217
220
218
-
Download the most recent `openshift-connector-<version>.vsix` file and install it by following the instructions [here](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix). Stable releases are archived [here](https://download.jboss.org/jbosstools/adapters/snapshots/vscode-openshift-tools/?C=M;O=D).
221
+
Download the most recent `openshift-connector-<version>.vsix` file from the [release](https://github.com/redhat-developer/vscode-openshift-tools/releases)and install it by following the instructions [here](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix). Stable releases are archived [here](https://download.jboss.org/jbosstools/adapters/snapshots/vscode-openshift-tools/?C=M;O=D).
0 commit comments