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
***Project**: A project is your source code, tests, and libraries organized in a separate single unit
4
+
***Application**: An application is a program designed for end users. An application consists of multiple microservices or components that work individually to build the entire application. Examples of applications: e-Shop, Hotel Reservation System, Online Booking
5
+
***Component**: A component is a set of Kubernetes resources which host code or data. Each component can be run and deployed separately. Examples of components: Warehouse API Backend, Inventory API, Web Frontend, Payment Backend
6
+
***Service**: A service is software that your component links to or depends on. Examples of services: MariaDB, MySQL
7
+
***Devfile**: A devfile is a portable YAML file containing the definition of a component and its related URLs, storages and services.
8
+
9
+
#### Commands in OpenShift Application Explorer View
10
+
11
+
*`Log in to cluster` - Log in to your cluster and save login for subsequent use.
12
+
* Credentials : Log in to the given cluster with the given credentials.
13
+
* Token : Login using bearer token for authentication to the API server.
14
+
*`Open Console Dashboard` - Open the OpenShift Developer Console in default browser.
15
+
*`New Project` - Create new Project inside the OpenShift Cluster.
16
+
*`Log out` - Log out of the current OpenShift Cluster.
17
+
*`About` - Provide the information about the OpenShift tools.
18
+
*`Show Output Channel` - Show commands running under the hood and their output.
19
+
*`Create` - Create an OpenShift resource using `.json` or `.yaml` file location from an active editor.
20
+
21
+
#### Commands for a Project in Application Explorer
22
+
23
+
*`New Component` - Create a new Component in the Project.
24
+
*`Delete` - Delete an existing Project.
25
+
*`Change Active Project` - Change active Project displayed in OpenShift Application View.
26
+
27
+
#### Commands for a Component in Components View
28
+
29
+
Actions available in Components View
30
+
31
+
*`Import from Git` - Deploy a git repository directly on OpenShift using a guided workflow
32
+
*`New Component` - Create a component from the available registries.
33
+
34
+
Commands available in context for the compenent
35
+
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.
37
+
*`Stop Dev` - Stop the dev command workflow and resources are cleaned, hence the application is not running on the cluster
38
+
*`Show Dev Terminal` - Directly opens the VSCode terminal where the dev command is running.
39
+
*`Describe` - Describe the given Component in terminal window or inside a webview editor.
40
+
*`Show Log` - Retrieve the log for the given Component in the terminal or inside a webview editor (can be changed in VSCode Settings)
41
+
*`Follow Log` - Follow logs for the given Component in the terminal or inside a webview editor (can be changed in VSCode Settings)
42
+
*`Open in Browser` - Open the exposed URL in default browser.
43
+
*`Deploy` - Deploys a Component on the cluster by first building the images of the containers to deploy, then by deploying the Kubernetes resources necessary to deploy the components.
44
+
*`Undeploy` - Undeploys a Component from the cluster. The component still resides in the local config.
45
+
*`Debug` - Start the component in debug mode
46
+
*`Reveal in Explorer` - Show Component's context folder in Explorer view
47
+
48
+
**NOTE:** Currently we support creation of one component per folder. Multiple components from a folder might be supported in
49
+
future releases.
50
+
51
+
## Extension Configuration Settings
52
+
*`OpenShift Toolkit: Show Channel On Output` - Show OpenShift Toolkit output channel when new text added to output stream
53
+
*`OpenShift Toolkit: Output verbosity level` - Output verbosity level (value between 0 and 9) for OpenShift Create, Push and Watch commands in output channel and terminal view
54
+
*`OpenShift Toolkit: 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
55
+
*`OpenShift Toolkit: 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
56
+
*`OpenShift Toolkit: CRC Executable Location` - Provide the path where OpenShift Local is installed.
57
+
*`OpenShift Toolkit: CRC Pull Secret Path` - Provide the path where the pull secret file is present.
58
+
*`OpenShift Toolkit: CRC Cpu Cores` - Number of CPU cores to allocate to the OpenShift cluster as selected during the first run.
59
+
*`OpenShift Toolkit: CRC Memory Allocation` - MiB of memory to allocate to the OpenShift cluster as selected during the first run.
60
+
61
+
## View OpenShift Resources
62
+
63
+
This Extension uses Kubernetes Extension API to show OpenShift specific resources like Projects, Routes, Deployment Configs, Image Streams, Templates and others in Kubernetes Clusters View.
64
+
65
+
OpenShift Toolkit extension provides ```Use Project``` command to switch between OpenShift Projects. It is available for Project items in Kubernetes Clusters View.
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:
77
+
78
+
*[Red Hat Authentication](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-redhat-account)
@@ -38,29 +37,29 @@ OpenShift Toolkit extension provides an end-to-end developer experience for Red
38
37
39
38
The OpenShift Toolkit extension provides multiple views to the user once it is launched.
40
39
41
-
1.**Application Explorer View**: Showcases the cluster connected to and the resources present in the cluster. The cluster URL, Project, Deployment and Deployment Configs are shown in the tree view.
40
+
<code>1. Application Explorer View</code>: Showcases the cluster connected to and the resources present in the cluster. The cluster URL, Project, Deployment and Deployment Configs are shown in the tree view.
42
41
43
-
2.**Components View**: Displays the components created and also the actions associated with the component based on the state in which it is( running or stopped). Allows user to create components from local workspace or directly from git repository.
42
+
<code>2. Components View</code>: Displays the components created and also the actions associated with the component based on the state in which it is( running or stopped). Allows user to create components from local workspace or directly from git repository.
44
43
45
-
3.**Devfile Registries View**: Contains the [Default Devfile Registry](https://registry.devfile.io/viewer) to browse and create components from the devfile stacks provided. Users can their own custom registry to the view and create components.
44
+
<code>3. Devfile Registries View</code>: Contains the [Default Devfile Registry](https://registry.devfile.io/viewer) to browse and create components from the devfile stacks provided. Users can their own custom registry to the view and create components.
46
45
47
-
4.**Debug Sessions View**: Once the debug session is active, the associate component is displayed in this view.
46
+
<code>4. Debug Sessions View</code>: Once the debug session is active, the associate component is displayed in this view.
48
47
49
48
## Provision new OpenShift Cluster
50
49
51
50
The extension provides users with multiple ways to provision an instance of OpenShift to get started. Click on _Add OpenShift Cluster_ which opens webview to select the way to get connected with a new OpenShift instance.
52
51
53
-
1.**Red Hat OpenShift Developer Sandbox**
52
+
<pre>Red Hat OpenShift Developer Sandbox</pre>
54
53
55
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.
56
55
57
-
2.**Local instance of OpenShift**
56
+
<pre>Local instance of OpenShift</pre>
58
57
59
58
The extension allows the developers to provision a local instance of OpenShift cluster using the guided workfflow from the extension. It runs [OpenShift Local](https://crc.dev/crc/) which provides a single node local OpenShift 4.x cluster.
60
59
61
60
- Please follow this [guide](README.crc-workflow.md) to understand the guided workflow to provision OpenShift locally.
62
61
63
-
3.**Provision Hybrid Cloud**
62
+
<pre>Provision Hybrid Cloud</pre>
64
63
65
64
To install OpenShift Container Platform 4 in the public cloud, in your datacenter or on your laptop please visit [Red Hat Hybrid Cloud console](https://console.redhat.com/openshift/create). Here are different scenarios to try OpenShift:
66
65
@@ -86,99 +85,8 @@ In the Devfile Registries view, there is an action to `Open Registry View` which
86
85
## Commands and Features
87
86
88
87
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.
89
-
### Core Concepts
90
-
91
-
***Project**: A project is your source code, tests, and libraries organized in a separate single unit
92
-
***Application**: An application is a program designed for end users. An application consists of multiple microservices or components that work individually to build the entire application. Examples of applications: e-Shop, Hotel Reservation System, Online Booking
93
-
***Component**: A component is a set of Kubernetes resources which host code or data. Each component can be run and deployed separately. Examples of components: Warehouse API Backend, Inventory API, Web Frontend, Payment Backend
94
-
***Service**: A service is software that your component links to or depends on. Examples of services: MariaDB, MySQL
95
-
***Devfile**: A devfile is a portable YAML file containing the definition of a component and its related URLs, storages and services.
96
-
97
-
#### Commands in OpenShift Application Explorer View
98
-
99
-
*`Log in to cluster` - Log in to your cluster and save login for subsequent use.
100
-
* Credentials : Log in to the given cluster with the given credentials.
101
-
* Token : Login using bearer token for authentication to the API server.
102
-
*`Open Console Dashboard` - Open the OpenShift Developer Console in default browser.
103
-
*`New Project` - Create new Project inside the OpenShift Cluster.
104
-
*`Log out` - Log out of the current OpenShift Cluster.
105
-
*`About` - Provide the information about the OpenShift tools.
106
-
*`Show Output Channel` - Show commands running under the hood and their output.
107
-
*`Create` - Create an OpenShift resource using `.json` or `.yaml` file location from an active editor.
108
-
109
-
#### Commands for a Project in Application Explorer
110
-
111
-
*`New Component` - Create a new Component in the Project.
112
-
*`Delete` - Delete an existing Project.
113
-
*`Change Active Project` - Change active Project displayed in OpenShift Application View.
114
-
115
-
#### Commands for a Component in Components View
116
-
117
-
Actions available in Components View
118
-
119
-
*`Import from Git` - Deploy a git repository directly on OpenShift using a guided workflow
120
-
*`New Component` - Create a component from the available registries.
121
-
122
-
Commands available in context for the compenent
123
-
124
-
*`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.
125
-
*`Stop Dev` - Stop the dev command workflow and resources are cleaned, hence the application is not running on the cluster
126
-
*`Show Dev Terminal` - Directly opens the VSCode terminal where the dev command is running.
127
-
*`Describe` - Describe the given Component in terminal window or inside a webview editor.
128
-
*`Show Log` - Retrieve the log for the given Component in the terminal or inside a webview editor (can be changed in VSCode Settings)
129
-
*`Follow Log` - Follow logs for the given Component in the terminal or inside a webview editor (can be changed in VSCode Settings)
130
-
*`Open in Browser` - Open the exposed URL in default browser.
131
-
*`Deploy` - Deploys a Component on the cluster by first building the images of the containers to deploy, then by deploying the Kubernetes resources necessary to deploy the components.
132
-
*`Undeploy` - Undeploys a Component from the cluster. The component still resides in the local config.
133
-
*`Debug` - Start the component in debug mode
134
-
*`Reveal in Explorer` - Show Component's context folder in Explorer view
135
-
136
-
**NOTE:** Currently we support creation of one component per folder. Multiple components from a folder might be supported in
137
-
future releases.
138
-
## Extension Configuration Settings
139
-
*`OpenShift Toolkit: Show Channel On Output` - Show OpenShift Toolkit output channel when new text added to output stream
140
-
*`OpenShift Toolkit: Output verbosity level` - Output verbosity level (value between 0 and 9) for OpenShift Create, Push and Watch commands in output channel and terminal view
141
-
*`OpenShift Toolkit: 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
142
-
*`OpenShift Toolkit: 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
143
-
*`OpenShift Toolkit: CRC Executable Location` - Provide the path where OpenShift Local is installed.
144
-
*`OpenShift Toolkit: CRC Pull Secret Path` - Provide the path where the pull secret file is present.
145
-
*`OpenShift Toolkit: CRC Cpu Cores` - Number of CPU cores to allocate to the OpenShift cluster as selected during the first run.
146
-
*`OpenShift Toolkit: CRC Memory Allocation` - MiB of memory to allocate to the OpenShift cluster as selected during the first run.
147
-
148
-
## View OpenShift Resources
149
-
150
-
This Extension uses Kubernetes Extension API to show OpenShift specific resources like Projects, Routes, Deployment Configs, Image Streams, Templates and others in Kubernetes Clusters View.
151
-
152
-
OpenShift Toolkit extension provides ```Use Project``` command to switch between OpenShift Projects. It is available for Project items in Kubernetes Clusters View.
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:
164
-
165
-
*[Red Hat Authentication](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-redhat-account)
> `oc` and `odo` tools for Windows, Linux and macOS are included into extension package. Once the extension is installed, it is ready to use.
176
-
177
-
Follow the links below for additional information:
178
-
179
-
*[Understanding odo](https://odo.dev/)
180
-
*[Devfile ecosystem](https://devfile.io/)
181
88
89
+
For more detail information around specific commands and dependences, please read the [extension commands](README.commands.md) guide.
182
90
## Release Notes
183
91
184
92
See the [change log](CHANGELOG.md).
@@ -204,4 +112,4 @@ MIT, See [LICENSE](LICENSE) for more information.
204
112
205
113
## Data and telemetry
206
114
207
-
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-commons#how-to-disable-telemetry-reporting
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
0 commit comments