Skip to content

Latest commit

 

History

History
75 lines (55 loc) · 5.69 KB

README.md

File metadata and controls

75 lines (55 loc) · 5.69 KB
Raw

Description

The cf-language-server-buildpack, based on java-buildpack, is a Cloud Foundry buildpack for running JVM-based language servers wrapper together with language servers adhering to the language server protocol. The language servers are supported by configuration of custom components providing download of software together with creation of configuration environment variables per language.

Requirements

There should be an available end point, org and space in CloudFoundry to deploy there the server as a Java application.

Usage

To use this buildpack specify the URI of the repository when pushing the language servers wrapper application to Cloud Foundry:

$ cf push <APP-NAME> -p <ARTIFACT> -b https://github.com/SAP/cf-language-server-buildpack.git

The language servers wrapper application for the push can be taken from: https://github.com/SAP/cloud-language-servers-container

Known Issues

  • Each language server implementation is provided via component in the buildpack. It is currently not extensible from the outside.
  • The configuration of each language server is based on enviroment variables which is a limited format.
  • The location of the language server implementations to be downloaded by the buildpack is not final.

How to obtain support

For bugs, questions and ideas for enhancement please open an issue in github.

To-Do (upcoming changes)

  • Add support for more language server implementations such as es6, eslint, scala, etc.
  • Configuration to support multiple server instances in parallel.
  • Support for language server implementation coming from behind a firewall.

How to contribute new language server

Each language server is represented in the buildpack as a component. The components are described in components.yml. A component is composed by a configuration, resources folder and a site that has several versions of the packaged server.

The configuration is structured a yml format and contain the following attributes:

  • Repository of packaged server versions
  • Version of the packaged server to be used
  • Working directory for the server
  • Execution command
  • Communication properties such as protocol and ports An example of the component yml file could be found here.

The resources folder should contain any resources that should be part of the container when it is created for the use of the specific language server such as execution scripts, configuration files, etc'. For example see: language_server_bin_exec_jdt.

The component site repository contains version list under /index.yml, static file (Since component repository is a static Web site it can be easily deployed to CF as a static application via static build pack) and your server as a zip. To deploy your own component repository adjust version url to your own application name and "push" static CF application to CF space of your choice. See for example https://lsp-component-java.cfapps.eu10.hana.ondemand.com/index.yml. It holds several versions with their URL. The packaged server is a tar.gz with internal folder content and inside the executables.

To run component application in the build pack add script, see for example https://github.com/SAP/cf-language-server-buildpack/blob/master/lib/java_buildpack/framework/language_server_node_cdx.rb notice that the language should be added as supported language in the manifest.yml file in the container repository. see for example https://github.com/SAP/cloud-language-servers-container/blob/master/manifest.yaml - lspservers.

Currently Java and NodeJS implementation for language servers are supported. If need to implement new language server in NodeJS consider https://github.com/Microsoft/vscode-languageserver-node as a starting point.

Stages in buildpack release

Phase 1 - Update the repository with the new changes

  1. Bring the changes to the master brnach or any other branch of this repository
  2. Make sure that each component yml file point to the desired version
  3. In the pom.xml under project>version : update to the version number - increment by one (example : from 0.0.1 to 0.0.2).

Phase 2 - depoly to nexus releases

  1. Go to xmake nove in link: https://prod-build10300.wdf.sap.corp/job/devx/job/DevX-cf-language-server-buildpack-SP-REL-common_indirectshipment/build?delay=0sec
  2. Press Build with Parameters and fill in the following: Choose build mode: Stage and Promte Treeish: master(or other desired branch) leave the rest empty and press build.
  3. Wait to see that the build succeeded.
  4. You can find your newly created version in https://nexusrel.wdf.sap.corp:8443/nexus/#nexus-search;quick~language-server-buildpack make sure you have sap-devx-language-server-buildpack-{your version}.git.zip file under your version number.

Phase 3 - deploy to CF

  1. Go to Jass Project ls_buildpack_deploy : https://jaas.wdf.sap.corp:30437/job/ls_buildpack_deploy/
  2. Press Build with Parameters and fill in the parameters.
  3. Press build and wait to see that the build succeeded.
  4. You can enter your space in cf and check that {APP_NAME}-{your version} was deployed.

Congratulations! you just deployed new version of cf-language-server-buildpack now you can consume it by updating your destention to point to the app newly created buildpack (make sure it will point https://{you app genrete url}/ls-buildpack.git)

License

This buildpack is released under version 2.0 of the Apache License.