Skip to main content
Redhat Developers  Logo
  • Products

    Featured

    • Red Hat Enterprise Linux
      Red Hat Enterprise Linux Icon
    • Red Hat OpenShift AI
      Red Hat OpenShift AI
    • Red Hat Enterprise Linux AI
      Linux icon inside of a brain
    • Image mode for Red Hat Enterprise Linux
      RHEL image mode
    • Red Hat OpenShift
      Openshift icon
    • Red Hat Ansible Automation Platform
      Ansible icon
    • Red Hat Developer Hub
      Developer Hub
    • View All Red Hat Products
    • Linux

      • Red Hat Enterprise Linux
      • Image mode for Red Hat Enterprise Linux
      • Red Hat Universal Base Images (UBI)
    • Java runtimes & frameworks

      • JBoss Enterprise Application Platform
      • Red Hat build of OpenJDK
    • Kubernetes

      • Red Hat OpenShift
      • Microsoft Azure Red Hat OpenShift
      • Red Hat OpenShift Virtualization
      • Red Hat OpenShift Lightspeed
    • Integration & App Connectivity

      • Red Hat Build of Apache Camel
      • Red Hat Service Interconnect
      • Red Hat Connectivity Link
    • AI/ML

      • Red Hat OpenShift AI
      • Red Hat Enterprise Linux AI
    • Automation

      • Red Hat Ansible Automation Platform
      • Red Hat Ansible Lightspeed
    • Developer tools

      • Red Hat Trusted Software Supply Chain
      • Podman Desktop
      • Red Hat OpenShift Dev Spaces
    • Developer Sandbox

      Developer Sandbox
      Try Red Hat products and technologies without setup or configuration fees for 30 days with this shared Openshift and Kubernetes cluster.
    • Try at no cost
  • Technologies

    Featured

    • AI/ML
      AI/ML Icon
    • Linux
      Linux Icon
    • Kubernetes
      Cloud icon
    • Automation
      Automation Icon showing arrows moving in a circle around a gear
    • View All Technologies
    • Programming Languages & Frameworks

      • Java
      • Python
      • JavaScript
    • System Design & Architecture

      • Red Hat architecture and design patterns
      • Microservices
      • Event-Driven Architecture
      • Databases
    • Developer Productivity

      • Developer productivity
      • Developer Tools
      • GitOps
    • Secure Development & Architectures

      • Security
      • Secure coding
    • Platform Engineering

      • DevOps
      • DevSecOps
      • Ansible automation for applications and services
    • Automated Data Processing

      • AI/ML
      • Data Science
      • Apache Kafka on Kubernetes
      • View All Technologies
    • Start exploring in the Developer Sandbox for free

      sandbox graphic
      Try Red Hat's products and technologies without setup or configuration.
    • Try at no cost
  • Learn

    Featured

    • Kubernetes & Cloud Native
      Openshift icon
    • Linux
      Rhel icon
    • Automation
      Ansible cloud icon
    • Java
      Java icon
    • AI/ML
      AI/ML Icon
    • View All Learning Resources

    E-Books

    • GitOps Cookbook
    • Podman in Action
    • Kubernetes Operators
    • The Path to GitOps
    • View All E-books

    Cheat Sheets

    • Linux Commands
    • Bash Commands
    • Git
    • systemd Commands
    • View All Cheat Sheets

    Documentation

    • API Catalog
    • Product Documentation
    • Legacy Documentation
    • Red Hat Learning

      Learning image
      Boost your technical skills to expert-level with the help of interactive lessons offered by various Red Hat Learning programs.
    • Explore Red Hat Learning
  • Developer Sandbox

    Developer Sandbox

    • Access Red Hat’s products and technologies without setup or configuration, and start developing quicker than ever before with our new, no-cost sandbox environments.
    • Explore Developer Sandbox

    Featured Developer Sandbox activities

    • Get started with your Developer Sandbox
    • OpenShift virtualization and application modernization using the Developer Sandbox
    • Explore all Developer Sandbox activities

    Ready to start developing apps?

    • Try at no cost
  • Blog
  • Events
  • Videos

Quick links: redhat.com, Customer Portal, Red Hat's developer site, Red Hat's partner site.

  • You are here

    Red Hat

    Learn about our open source products, services, and company.

  • You are here

    Red Hat Customer Portal

    Get product support and knowledge from the open source experts.

  • You are here

    Red Hat Developer

    Read developer tutorials and download Red Hat software for cloud application development.

  • You are here

    Red Hat Partner Connect

    Get training, subscriptions, certifications, and more for partners to build, sell, and support customer solutions.

Products & tools

  • Ansible.com

    Learn about and try our IT automation product.
  • Red Hat Ecosystem Catalog

    Find hardware, software, and cloud providers―and download container images―certified to perform with Red Hat technologies.

Try, buy, & sell

  • Red Hat Hybrid Cloud Console

    Access technical how-tos, tutorials, and learning paths focused on Red Hat’s hybrid cloud managed services.
  • Red Hat Store

    Buy select Red Hat products and services online.
  • Red Hat Marketplace

    Try, buy, sell, and manage certified enterprise software for container-based environments.

Events

  • Red Hat Summit and AnsibleFest

    Register for and learn about our annual open source IT industry event.

Announcing the Red Hat OpenShift extension for Visual Studio Code: Public Preview

November 28, 2018
Mohit Suman
Related topics:
ContainersDeveloper ToolsIDEsKubernetes
Related products:
Red Hat OpenShift Container Platform

Share:

Share on twitter Share on facebook Share on linkedin Share with email
  • Benefits of using the extension
  • Developer use-case
  • Demo
  • Installation
  • Dependencies
  • The extension in action
  • Contributions and Feedback

We are extremely pleased to announce that the preview release of the Red Hat OpenShift extension for Visual Studio Code is now available. You can download the OpenShift Connector extension from the marketplace or install it directly from the extension gallery in Visual Studio Code.

This article provides describes the features and benefits of the extension and provides installation details. It also provides a demo of how using the extension improves the end-to-end experience of developing and deploying Spring Boot applications to local OpenShift cluster.

Benefits of using the extension

Benefits of using the extension

Red Hat OpenShift is a container application platform that brings the power of Kubernetes and containers to the enterprise. Regardless of the applications architecture, OpenShift lets you easily and quickly build, develop, and deploy in nearly any infrastructure, public or private.

Therefore, whether it’s on-premises, in a public cloud, or hosted, you have an award-winning platform to get your next big idea to market ahead of your competition.

Using OpenShift Connector, you can interact with Red Hat OpenShift using a local instance of OpenShift clusters such as minishift/Red Hat Container Development Kit. Leveraging the OpenShift Application Explorer view, you can improve the end-to-end experience of developing applications.

The extension enables you to perform all this directly using Visual Studio Code and removes the complexity of memorizing some fairly complicated CLI commands.

Developer use-case

Developer use-case

On a developer workstation, when you load a Spring Boot project, the language support detection automatically proposes to load a Spring Boot language support extension and suggests downloading and installing the OpenShift Connector. You can install the recommended extension in Visual Studio Code.

Therefore, once the OpenShift Connector is installed, OpenShift Application View is enabled on the Explorer panel in Visual Studio Code. Then, you can access the view and connect to a running OpenShift cluster and perform the required operations.

Demo

Demo

Here is a working demo of the end-to-end experience of developing and deploying Spring Boot applications to a local OpenShift cluster using the extension. This demo aims to simplify the OpenShift experience for Visual Studio developers. For detailed installation and usage information, please refer to the readme.

https://www.youtube.com/watch?v=XIHLbUvGuFM

Note: In this Preview release, we support only Java and Node.JS components. We will be supporting other languages in future releases.

Installation

Installation

First, you will need to install Visual Studio Code 1.12.0 or later.

  • To install the extension with the latest version of Visual Studio Code, bring up the Visual Studio Code Command Palette (press F1).
  • Type install and choose Extensions: Install Extensions.
  • In the Search Extensions in Marketplace text box, type OpenShift. Find the OpenShift Connector extension published by Red Hat and click the Install button.
  • Subsequently, you should reload Visual Studio Code and there will be an OpenShift Icon in the Explorer View.

OpenShift Connector installation demo

Dependencies

Dependencies

This extension uses two CLI tools to interact with an OpenShift cluster:

  • The OpenShift client tool: oc
  • The OpenShift Do tool: odo

If oc and odo are located in a directory contained in your PATH, they will be used automatically. If they aren't present in your PATH, the extension will prompt you to download and install them.

The extension in action

The extension in action

Connecting to your OpenShift instance

  1. Start the local OpenShift instance using minishift/Red Hat Container Development Kit.
  2. After the extension is installed in Visual Studio Code, it will prompt you to download the required dependencies (oc, odo).
  3. The OpenShift Application Explorer view is activated once you click the OpenShift icon in the Explorer View.
  4. You then need to log in to the running OpenShift cluster (  - Log in to Cluster).
  5. Provide the cluster URL to connect to the running instance of OpenShift.logging in to OpenShift
  6. Now you can log in to the server using the following methods :
    • Credentials: Log in to the given server with the given credentials (basic auth).
    • Token: Log in to the given server with the given credentials (token).

OpenShift login options

7. OpenShift Application Explorer will display the OpenShift cluster in the Tree View.

8. Now you can perform the necessary operations in the connected cluster from the extension directly without looking back and forth to the command line.

Working with OpenShift

Once the extension is connected to the OpenShift clusters, you can perform operations in OpenShift and build/deploy applications. Note:  This extension currently supports a local OpenShift cluster running using minishift or Red Hat Container Development Kit.

Actions available inside an OpenShift cluster

  • OpenShift: List catalog components â€“ Lists all available component types from OpenShift's Image Builder.
  • OpenShift: List catalog services – Lists all available services, for example, MySQL.
  • OpenShift: New Project – Creates a new project inside the cluster.
  • OpenShift: About â€“ Provides information about the OpenShift tools.
  • OpenShift: Log out â€“ Logs out of the current OpenShift cluster.

Actions available for a project

  • Project -> New Application â€“ Creates a new application inside the selected project.
  • Project -> Delete â€“ Deletes an existing project.

Actions available for an application inside a project

  • Application -> New Component â€“ Creates a new component inside the selected application.
    • git – Use a git repository as the source file for the component.
    • local – Use a local directory as a source file for the component.
  • Application -> New Service â€“ Performs service catalog operations.
  • Application -> Describe â€“ Describes the given application in a terminal window.
  • Application -> Delete â€“ Deletes an existing application.

Actions available for a component in an application

  • Component -> Create URL â€“ Exposes a 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.
  • Component -> Create Storage â€“ Creates storage and mounts to a component.
  • Component -> Show Log – Retrieves the log for the given component.
  • Component -> Follow Log â€“ Follows logs for the given component.
  • Component -> Open in Browser â€“ Opens the exposed URL in a browser.
  • Component -> Push â€“ Pushes source code to a component.
  • Component -> Watch â€“ Watches for changes and updates component upon change.
  • Component -> Describe – Describes the given component in a terminal window.
  • Component -> Delete â€“ Deletes an existing component.
Contributions and Feedback

Contributions and Feedback

This is an open source project and we welcome contributions and suggestions. Follow these contributing guidelines for more details.

We are excited for you to give OpenShift Connector a try! In addition, any feedback to further improve the developer experience using OpenShift on Visual Studio Code is welcome.

Please reach out to us if you have any questions, encounter any issues, or have feature requests.

  • Have thoughts on how we can make the extension better? Simply open a new issue!
  • For more discussions, chat with us on Mattermost.

Happy Collaborating,
Red Hat Developer Tools Team

Last updated: January 12, 2024

Recent Posts

  • How to integrate vLLM inference into your macOS and iOS apps

  • How Insights events enhance system life cycle management

  • Meet the Red Hat Node.js team at PowerUP 2025

  • How to use pipelines for AI/ML automation at the edge

  • What's new in network observability 1.8

Red Hat Developers logo LinkedIn YouTube Twitter Facebook

Products

  • Red Hat Enterprise Linux
  • Red Hat OpenShift
  • Red Hat Ansible Automation Platform

Build

  • Developer Sandbox
  • Developer Tools
  • Interactive Tutorials
  • API Catalog

Quicklinks

  • Learning Resources
  • E-books
  • Cheat Sheets
  • Blog
  • Events
  • Newsletter

Communicate

  • About us
  • Contact sales
  • Find a partner
  • Report a website issue
  • Site Status Dashboard
  • Report a security problem

RED HAT DEVELOPER

Build here. Go anywhere.

We serve the builders. The problem solvers who create careers with code.

Join us if you’re a developer, software engineer, web designer, front-end designer, UX designer, computer scientist, architect, tester, product manager, project manager or team lead.

Sign me up

Red Hat legal and privacy links

  • About Red Hat
  • Jobs
  • Events
  • Locations
  • Contact Red Hat
  • Red Hat Blog
  • Inclusion at Red Hat
  • Cool Stuff Store
  • Red Hat Summit

Red Hat legal and privacy links

  • Privacy statement
  • Terms of use
  • All policies and guidelines
  • Digital accessibility

Report a website issue