Eclipse Che Conferences/Talks/Demos, 22 Oct 2020

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Customize Your Own Online IDE with a Devfile

Description

Eclipse Che is an online IDE running in the cloud that can use VS Code extensions. In this session, attendees will learn the following:
- What is Devfile and how do you use it
- How to create a fully functional devfile. As an example I'll show how to prepare an environment to develop Quarkus applications in Eclipse Che, but it can be easily done for different languages and tools in the same way
- How to setup a developer environment by using that devfile
- What are the benefits that they can have using devfiles

Speaker(s):
Valeriy Svydenko (Red Hat, Inc.)

A

Everyone thank you for joining the session. My name is valerie sudenko. I work at red hat and I am eclipse checkout meter. So today I will present you how to customize your own online ide with the file as an online ide. We have eclipse share and I will talk a bit about it. Also I'll explain what is the file and which structure it has. I will have a demo I'll try to create a fully functional the file.

A

As an example I'll show how to prepare in an environment to develop works, applications in eclipse gm, then we will see which benefits we have use the file. The eclipse here is kubernetes native ide for developer teams. It provides kubernetes native developer workspaces and the workspaces inside here are kubernetes spots and everything has been continuous editor plugins tools all are working inside those containers and you can bring your application runtimes directly inside your workspaces.

A

The editor, which is packaged by default, is based on eclipse thea to provide vs code-like experience. There is built-in support for language server protocol and debug adapter protocol, and there is compatibility, is vs code extensions also in share. It's very easy to swap your editor. It's also possible to use eclipse disable, jupyter, netbook or even eclipse ide inside our space of eclipse here check, has two registers: the plugin registry and the file registry in the default registry.

A

You register all the workspaces that you want to have python the files, your sharpness file, java, the file and all these the files reference plugins that are living in the plugin registry. The plugin is an entity that drops vs code, extensions or tf plugins.

A

So what is the file? The file is a young file that describes and defines a developer development environment in chair here you can see the structure of the file. Fundamentally, there are three parts of the file. The first part is project. It's where you define your source code repository. That is optional. I mean, if you don't want to clone some project into your workspace. You can just skip this part.

A

The second part is components. A component can be editor where you can see the project, structure, coding or making another operations, and another type of component is plugin. It contains all development tools like language support, for example, java language server or some debugger tools, so we can bring all tooling inside the workspace and also environment.

A

It's another type of component. It could be build runtime or test environment. It depends on what you need in your development process. For example, you need one container for building an application, another one for testing and for running this part is also optional, and the last part of the file is commands that you want to bring inside the development environment and they could be command to build your application to run tests to debug it to run the application or command that you or your team, usually use when developed the application.

A

Let's take a look at the file examples. It is a simplest one. It just contains editor, which is included by default, and it has just three lines: another one example which describes developer environment to work with c-sharp application.

A

If this, it describes one project which will be cloned one plugin, which provides support for the sharp language and dev environment to build and run the application, and also a few comments to build, run and install some dependencies uh inside the environment.

A

Let's talk a bit more about the structure of the file, so the top element is api version. This section is required and it must have, and it is hard you specify which api version you are using. The next part is metadata. This section is also required and in this case name is specified.

A

As the name of this workspace. We also have the option of name prefix, in which case the system will generate the rest of the name. Using generate name means that a user can have uh multiple instances of this workspace at the same time.

A

Another part is projects. This section is optional and tells the workspace where to find the project that will be included. In this case, we are pointing to default github repository located default, git repository located on github, and you can specify multiple projects for a workspace and the type of the project can be zip file. As well, next is attributes. This part is optional and can pretty much define anything you wish in this case persist volumes mean that ephemeral mode is activated in ephemeral mode. Workspace has no pvc attached.

A

It means that unless you commit your changes to the git repo, any work done will be lost, but it makes the workspace perform better.

A

The biggest part is components, it describes elements or containers for editor for plugins and environments, and it must have attribute with name type type specified the component and it could be docker image jet plugin, edit or kubernetes or openshift, and each component can have alias. It is the name using in other places of this default. Commands can refer to this component. This attribute is optional, but it must be unique in the default if specified.

A

Another attribute from component is mount sources which makes the source code available to the container and if component has type docker image. It also should have attribute image to to it's a link to docker image, for example the on docker hub, and this image should be a bit customized for openshift specific technology.

A

uh Another attribute is endpoints and then point that the docker image exposes and the last one volumes which defines directory within the container that is available to this workspace.

A

It could be useful for folder with dependencies to don't download them each time when we build the project and the last part is commands in this section, you can define custom commands that are available to the user. Typically, this. This is where you will specify command line, commands that can be run from within the ide, rather than dropping to the command line and typing long command line and can be reused.

A

Also, we can use macros instead of hardcoded in that. In that example, we have markers for project root directory and it's a demo time in the demo. I want to I'm going to show you how to create your own, the file to work with quarkx applications.

A

A few words about quarkus quercus is a cloud native stack for writing. Java, microservices and serverless applications. It's just to be quick and let's say we would like to start the quarkus hello world, microservice application tutorial from github repository, and we need to set up an environment in eclipse chat to work with this application.

A

Here this, the github page of this application, it's quarkus quick, starts, and I also have deployed uh eclipse share into my local mini cube and to start setup, an environment. uh It's. It is easier to start with existing the file. For example, I'll choose java vertex the file.

A

And I will I'm going to open configuration window where I have the file editor and in this editor I can change this the file. So, let's start doing it step by step, let's start with projects component and we have to change location of this project. Let's copy github url of our quick carcass kickstarts and replace it as a value of location.

A

Now, let's change name of of the project.

A

uh The type is git, and also I don't want to clone all these submodulus. I just want to clone one of them, for example, it is getting getting started. I have to clone this name and add another attribute in project part. It is splash check out here. I can use autocompletion here and add name of this module.

A

Let's save the the file.

A

And go to components here. I have two components. The first one is chip login, which describes support for java language and another one is that is the dav environment.

A

I know that plugin registration registry already quarkus plugin, which provides support to work with corpus applications, and I can go to plugins view to add this plugin in plugins view, which is describes jetpack and registry. I can find the quercus.

A

Plugin corcus tools with java 11. this plugins wraps for vs code extensions. It is java extension. We have got java, debugger, vs code, corkus extension and also vs code java, test runner and I will deactivate land with support for java because it is already included in quercus plugin.

A

Let's say this changes and go back to the file editor to check if our plugin was added.

A

We can see that quarkx plugin was added into this defile and let's go uh to another component, which is dev container and let's edit it uh step by step. So what we have here, we have on sources which is true, and it works for us, because I want to have a project into invest in that container.

A

Another attribute is endpoints with port 8080. It also works for us because our application will be run on that port and we can open to check how our application looks like another attribute is memory limit. Let's we can increase it. Let's do that.

A

Another attribute is type with value. Docker image and the image is java 8, but we also have check corkus image, which provides maven gradle java 11 and the graph vm all what we need to work with corcos applications uh next attribute is alias, and this maven we can change it to carcass.

A

Okay next attribute is, and it's it describes environment variables which will be injected in that contained in this container.

A

Right now we have maven config java options and we can proceed with this variables and also we have volumes here, dot, m2 folder and it works for us, because our application is my own applications, so I don't want to rebuild.

A

I don't want to download each time dependencies when I rebuild my application. So let's try to save these changes.

A

I see the error that uh comments reference to one component. It's because I changed alias.

A

I write it quarks, but mo existed comments reference to component names. We have to change this component as well.

A

A

Okay and try to save it again,.

A

Now it's okay! So let's proceed editing the commands. Let's change! First command. As my event, package.

A

We also have to change working directory, its attribute, which describes in which directory this command should be executed in the container. We have to replace project name because right now we have caucus quick start project. Let's add it, and also this project has sub model, which is.

A

Getting started.

A

Okay, let's add it into the end and working directory is ready. Now, let's change command line, it should be maven package.

A

Okay, this command is ready. Let's change another one run. Corkus application working directory should be the same as in previous command. Let's just copy paste. It.

A

And command line should be mainland, compile.

A

A

Dev, okay and this command is ready. We can proceed with these two commands and um just remove another command which we have in that all the file, and also you can see that this the file contains the bar configuration. It describes uh configuration uh to the back application and it works for us, because our application will be run as the java process on port 505 and and then we can attach to that process and debug the application.

A

Let's say that this the file.

A

It's okay and let's click open button to start the workspace from this dev file.

A

Next workspace should be starting sliding and what happened here. It creates everything that inside the file and it creates the definition of kubernetes port. It starts to pull all images for all containers and then, when all images will be pulled, it will start done depending if you have all containers already cached, it will take a bit few times, but we still have wait a minute.

A

You can see that plugins were.

A

Instant and just need to wait when images.

A

Will be pulled.

A

We can see all locks in this window, so if something went wrong, we can see it in that part.

A

Right now, it's process over downloading plugins.

A

Pulling images.

A

And our workspace almost done almost ready.

A

So now we can see uh jetty editor here. We can open project view, for example, and see that our project is here with this module we can open some java file when we open java file, uh java language server, start installizing and let's open workspace view. In this view, we can see uh containers which we configured it's our dev container corkus is named corkus, which contains two commands maven package and run quercus application and end point esport 8080 in the plugins. We can see vs code, corkus extension here and, let's execute, run quarkus application command.

A

This command should build and compile our application.

A

It also takes some time to download all dependencies because it's first time.

A

We can open the back view to see that our debug configuration was added as well.

A

Now language server is still activating and the project is building.

A

Now we can see that uh quarkus plugin was like was activated and it is ready. We see the welcome page from that plugin and we can use java language servers to read some documentation to use autocompletion to like to write it to write some code and the code navigation and then other languages features, and now our application is ready. It is running on port 8080.

A

We can click open link to see how it looks like it's our application. Let's go to hello, endpoint.

A

And let's change the value and try to reload this page to do hot redeploy. Our changes are here. So basically, it's ready to work with corcos applications. Let's go back to our workspace.

A

And we want to share our environment with other people. I just need for that. I just need to copy this content of the file and, for example, create a gist file.

A

A

I'll add this content here and save and save it.

A

Now I can build the link to share this, the the file, the file, to start workspace. For this I will, I will use, uh hosted sheets chair, open io and I'm going to use I'm going to use factory service. I have to add f and url is my the file and, let's click this url.

A

It should start installizing another workspace by using this. The file, my new defile, which I created and environment developer environment, should be the same as I described it before. We can see that sharpen shift. Io is start analyzing new workspace. You can see logs from that from that process and it's it's ready to work on the instance.

A

That's about it. That's it about demo. Let's go back to the presentation.

A

Okay and we can see benefits of of using the file, so the file is concept that is close to define what is double space and how it runs inside share inside of cloud platform. It's easy to integrate. You can integrate the file in any kind of tools and developers can create a developer environment from this default from anywhere anytime, just calling an url to get developer environment, and also it's simple to share, so someone can customize it to a particular task and add some plugins and send it to another developers.

A

So that's some useful links where you can ask questions, contribute, reading, documentation or or try it, and thank you for joining this session. I will be happy to answer your questions. Thank you very much.

A

So there is some questions. The first one workspace definition is the file close to bins under through the standard site and other other collaborations in the community in industry to reach standards.

A

So the file has own structure and own api to to specify a developer environment, and by using this api you can define this environment and I don't think that is another standards to uh to read them and another question: how can I point to a plugin registry or the the file that is on private github account or another private location?

A

uh So if you uh have own plugin registry uh in in some private location, you can build your private registry and deploy it on on the cluster. Where chair was deployed before and point that registry to to use them for chair and then it will be available to to use to use it and about the file. You can just just copy the content of the file and share with someone some someone to to reproduce that environment on another.

A

Site, another question is: does eclipse share support diagram, creating editing frameworks like gmf in eclipse? uh Does eclipse share support diagram, creating uh if it is, it will be possible if, if it has such such plugin, which supports support gmf diagram right now, custom default plugin registry doesn't contain such plugin or ability to work with.

A

A

I think that's all and thank you again for joining the session.

A