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
This change contains
* update for Overview section
* replaces title image with animated gif
* puts badges in simple line instead of table
* adds New and Noteworthy section for new release
* updates capitalizations in titles
Signed-off-by: Denis Golovin <dgolovin@redhat.com>
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.
9
8
10
-
## Overview
9
+
* Demo: https://youtube.com/watch?v=m0wBKuKDYO0
11
10
12
-
A Visual Studio Code extension for interacting with Red Hat OpenShift cluster. This extension is currently in Preview Mode and supports only Java and Node.js components. We will be supporting other languages in the future releases.
To start local instance of OpenShift cluster, developers can use the following options:
18
+
*[CodeReadyContainers](https://cloud.redhat.com/openshift/install/crc/installer-provisioned) - run single node local OpenShift 4.x cluster
19
+
*[minishift](https://github.com/minishift/minishift/releases) / [CDK](https://developers.redhat.com/products/cdk/download/) - run single node local OpenShift 3.x cluster
19
20
20
-
### Running OpenShift Clusters
21
+
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).
21
22
22
-
To run the instance of OpenShift cluster locally, developers can use the following:
23
+
If developers can not run local OpenShift cluster the extension can work with remote one from various Red Hat products:
24
+
*[Red Hat OpenShift Container Platform](https://www.openshift.com/products/container-platform) - build, deploy and manage your applications across cloud- and on-premise infrastructure
25
+
*[Red Hat OpenShift Dedicated](https://www.openshift.com/products/dedicated/) - single-tenant, high-availability Kubernetes clusters in the public cloud
26
+
*[Microsoft Azure Red Hat OpenShift](https://www.openshift.com/products/azure-openshift) - fully managed Red Hat OpenShift service on Microsoft Azure
27
+
*[Red Hat OpenShift Online](https://www.openshift.com/products/online/) - the fastest way for developers to build, host and scale applications in the public cloud
* OpenShift 3.x - [minishift](https://github.com/minishift/minishift/releases) / [CDK](https://developers.redhat.com/products/cdk/download/). 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).
29
+
When working with [OpenShift Online](https://www.openshift.com/products/online/) 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).
26
30
27
-
The extension also supports OpenShift running on Azure, AWS.
31
+
## New and Noteworthy
28
32
29
-
Currently all clusters are supported, but with some limitations for OpenShift Online Pro where additional storage might be required to create more than two components.
33
+
### Debug Support for Local Node.js and Java Components
30
34
31
-
## WARNING !!! Breaking Changes
35
+
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 pallet and context menu for Component nodes in OpenShift Application Explorer view.
32
36
33
-
This release `0.1.1` contains breaking changes mentioned below.
37
+
#### Debug Node.js Component
34
38
35
-
* The Components created with previous versions(<=0.0.23) will no longer be visible in OpenShift Application Explorer view.
36
-
* The Extension will prompt the user to specify the context folder when creating new Components and then add selected folder to workspace.
37
-
* New Component, Url and Storage objects are created locally in context folder and not immediately pushed to the cluster.
39
+
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.
38
40
39
-
> **Please follow the [migration](https://github.com/redhat-developer/vscode-openshift-tools/wiki/Migration-to-v0.1.0) guide to resolve any possible issues.**
In case of any queries, please use the [Feedback & Question](#Feedback-&-Questions) section.
43
+
#### Debug Java Component
42
44
43
-
## Commands and features
45
+
To debug a Java Component Java Language Support and Java Debugger Extensions required. OpenShift Connector extension will request to install missing extension before it starts Debugger for a Java Component.
`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.
48
52
@@ -60,7 +64,7 @@ In case of any queries, please use the [Feedback & Question](#Feedback-&-Questio
60
64
*`OpenShift: Open Console Dashboard` - Opens the OpenShift webconsole URL.
61
65
*`OpenShift: Create` - Creates an OpenShift resource using `.json` or `.yaml` file location from an active editor.
62
66
63
-
#### Actions available for an OpenShift Cluster Project
67
+
#### Actions Available for an OpenShift Cluster Project
64
68
65
69
*`Project -> New Component` - Create a new Component from the Project.
66
70
* git - Use a git repository as the source for the Component.
@@ -69,7 +73,7 @@ In case of any queries, please use the [Feedback & Question](#Feedback-&-Questio
69
73
*`Project -> New Service` - Perform Service Catalog operations when it is enabled.
70
74
*`Project -> Delete` - Delete an existing Project.
71
75
72
-
#### Actions available for an Application in a Project
76
+
#### Actions Available for an Application in a Project
73
77
74
78
*`Application -> New Component` - Create a new Component inside the selected Application.
75
79
* git - Use a git repository as the source for the Component.
@@ -79,7 +83,7 @@ In case of any queries, please use the [Feedback & Question](#Feedback-&-Questio
79
83
*`Application -> Describe` - Describe the given Application in terminal window.
80
84
*`Application -> Delete` - Delete an existing Application.
81
85
82
-
#### Actions available for a Component in an Application
86
+
#### Actions Available for a Component in an Application
83
87
84
88
##### Components can be in 3 stages:
85
89
@@ -102,15 +106,14 @@ In case of any queries, please use the [Feedback & Question](#Feedback-&-Questio
102
106
*`Component -> Watch` - Watch for changes, update Component on change. This is not supported for git based components.
103
107
*`Component -> Undeploy` - Undeploys a Component from the cluster. The component still resides in the local config.
104
108
*`Component -> Delete` - Delete an existing Component from the cluster and removes the local config also.
105
-
*`Component -> Debug` - Debug Java or Node.js Component.
109
+
*`Component -> Debug` - Debug local Java or Node.js Component.
106
110
107
-
#### Actions for a Not Pushed Component
111
+
#### Actions for a not Pushed Component
108
112
109
113
*`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
114
*`Component -> Push` - Push the source code to a Component.
111
115
*`Component -> Delete` - Delete an existing Component from the local config.
112
116
113
-
114
117
#### Actions for a no context Component
115
118
116
119
*`Component -> Describe` - Describe the given Component in terminal window.
@@ -152,9 +155,9 @@ In case of any queries, please use the [Feedback & Question](#Feedback-&-Questio
152
155
*`OpenShift Connector: Show Channel On Output` - Show OpenShift Connector output channel when new text added to output stream
153
156
*`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
154
157
155
-
###Dependencies
158
+
## Dependencies
156
159
157
-
####CLI Tools
160
+
### CLI Tools
158
161
159
162
This extension uses two CLI tools to interact with OpenShift cluster:
@@ -163,7 +166,7 @@ This extension uses two CLI tools to interact with OpenShift cluster:
163
166
> If `oc` and `odo` tools are located in a directory from `PATH` environment variable they will be used automatically.
164
167
The extension will detect these dependencies and prompt the user to install if they are missing or have not supported version - choose `Download & Install` when you see an notification for the missing tool.
165
168
166
-
####Extensions
169
+
### Extensions
167
170
168
171
This extension depends on Kubernetes Extension from Microsoft which is going to be installed automatically along with OpenShift Connector Extension. Latter is using Kubernetes Extension public API to show
169
172
OpenShift specific resources like Projects, Routes, Deployment Configs, Image Streams and Templates in Kubernetes Clusters View. Those resources are visible only for OpenShift clusters.
@@ -174,24 +177,36 @@ OpenShift Connector extension also provides ```Use Project``` command to switch
174
177
175
178
**NOTE:** This extension is in Preview mode. The extension support for OpenShift is strictly experimental - assumptions may break, commands and behavior may change!
176
179
177
-
## Release notes
180
+
## Breaking Changes Between Previous Releases
181
+
182
+
### Updating from release 0.0.23 or earlier
183
+
184
+
* The Components created with previous versions(<=0.0.23) will no longer be visible in OpenShift Application Explorer view.
185
+
* The Extension will prompt the user to specify the context folder when creating new Components and then add selected folder to workspace.
186
+
* New Component, Url and Storage objects are created locally in context folder and not immediately pushed to the cluster.
187
+
188
+
> **Please follow the [migration](https://github.com/redhat-developer/vscode-openshift-tools/wiki/Migration-to-v0.1.0) guide to resolve any possible issues.**
189
+
190
+
In case of any queries, please use the [Feedback & Question](#Feedback-&-Questions) section.
191
+
192
+
## Release Notes
178
193
179
194
See the [change log](CHANGELOG.md).
180
195
181
-
Contributing
182
-
============
196
+
# Contributing
197
+
183
198
This is an open source project open to anyone. This project welcomes contributions and suggestions!
184
199
185
200
For information on getting started, refer to the [CONTRIBUTING instructions](CONTRIBUTING.md).
186
201
187
202
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).
188
203
189
-
Feedback & Questions
190
-
====================
204
+
# Feedback & Questions
205
+
191
206
If you discover an issue please file a bug and we will fix it as soon as possible.
192
207
* File a bug in [GitHub Issues](https://github.com/redhat-developer/vscode-openshift-tools/issues).
193
208
* Chat with us on [Gitter](https://gitter.im/redhat-developer/openshift-connector).
0 commit comments