osc / bc_osc_codeserver

BETA - Batch Connect - OSC Code Server

Batch Connect - OSC Code Server

An improved file viewer / editor for OSC OnDemand that launches a Code Server within an Owens batch job. Code Server leverages VSCode as its editor.

Prerequisites

This Batch Connect app requires the following software be installed on the compute nodes that the batch job is intended to run on (NOT the OnDemand node):

• Lmod 6.0.1+ or any other module purge and module load <modules> based CLI used to load appropriate environments within the batch job before launching Code server.
• Code Server 2.x+ available from Github: https://github.com/cdr/code-server/releases

Install

1. Use Git to clone this app and checkout the desired branch/version you want to use and place this wherever you store batch connect apps (/var/www/ood/apps/sys or ~/ondemand/dev):

   scl enable git29 -- git clone <repo>
   cd <dir>
   scl enable git29 -- git checkout <tag/branch>

2. Deploy code-server on your systems.

   # replace URL with latest release from code-server
   wget https://github.com/cdr/code-server/releases/download/3.2.0/code-server-3.2.0-linux-x86_64.tar.gz
   tar -xzf code-server-3.2.0-linux-x86_64.tar.gz

3. You will notice code-server is an executable inside that directory and can get the full path:

   $ readlink -f code-server-3.2.0-linux-x86_64.tar.gz
   /users/PZS0562/efranz/code-server-3.2.0-linux-x86_64.tar.gz

4. Update the path to the code-server binary in the script

   bc_osc_codeserver/template/script.sh.erb

   Line 27 in 3082790

   /fs/project/PZS0714/mrodgers/bin/code-server-2.1523-vsc1.38.1 \

   :

    # An arbitrary path...
   - /fs/project/PZS0714/mrodgers/bin/code-server-2.1523-vsc1.38.1 \
   + /users/PZS0562/efranz/code-server-3.2.0-linux-x86_64/code-server \
    --auth=password \
    --port="$port" \

5. Update form.yml to use the correct cluster, and any other changes as necessary to form.yml or submit.yml that is appropriate for your cluster.

Update

To update the app you would:

cd <dir>
scl enable git29 -- git fetch
scl enable git29 -- git checkout <tag/branch>

Again, you do not need to restart the app as it isn't a Passenger app.

Known Issues

• In-app installation of extensions does not work
• The authentication provided by code-server is unencrypted

Contributing

1. Fork it ( https://github.com/OSC/bc_osc_codeserver/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

bc_osc_codeserver's Issues

Interactive Apps (Atom | Visual Studio Code)

As a feature request, it would be great to have generic full suite IDE such as Atom or Visual Studio Code as an interactive application.

Fix env setup to make suitable for production release

Currently, there is extra code in the script to support having a symlink in bin of the app root to point to code server, in addition to an env var pointing to the code server binary. These should be removed.

Instead, a single env var to the code server binary should be set (setting with the default value trick if it isn't already set), and a comment above indicating that this needs to change based on where code server is deployed.

In may OnDemand depoyments the app is deployed on the local disk of the web node, unavailable to the compute nodes.

404 not found issue

Hello

I was testing code-server on our OOD but got 404 not found error.

Some reason the redirect URL has "rnode/udc-aw37-23d/26361/" twice like this;
https://rivanna-portal-dev.hpc.virginia.edu/rnode/udc-aw37-23d/26361/rnode/udc-aw37-23d/26361/

If I manually modify the URL to https://rivanna-portal-dev.hpc.virginia.edu/rnode/udc-aw37-23d/26361/, I can see VS page.
Any idea how to solve this issue?

Didn't modify the "view.html.erb"

<form action="/rnode/<%= host %>/<%= port %>/login" method="post" target="_blank">
  <input type="hidden" name="password" value="<%= password %>">
  <button class="btn btn-primary" type="submit">
    <i class="fa fa-cogs"></i> Connect to Code Server
  </button>
</form>

When I click an existing session, it went to /login but got a white page. removing "login" from URL showed VS page.

Best,
Gisoo

How to connect to a VSCode server instance from a local IDE?

I can instantiate a VSCode server and connect to it in the browser. Is it possible to connect the local VSCode to that server? -coding in the browser is not convenient and I prefer to use a local IDE with global configs.

udpate for codeserver 3.9.3

We have this module available, so let's update the app to be able to use it. Note that the form should now have a version dropdown so folks can keep using the old version.

app_code_server/3.9.3

Migrate OSC/bc_osc_codeserver to use Dynamic JavaScript.

Migrate to use Dynamic JavaScript.

Child ticket of OSC/ondemand#1657

In-app installation of extensions does not work

Will this ever get fixed?

Update Readme

Context

Looking at the install instructions for this app one sees scl being used, but I'm not sure that is still the current way this app is being used.

Questions

• Should this be updated to use lmod or rpm commands instead?
• Do we use scl still or do other sites?
• Should we just have different markdown headings to handle which method a sys-admin is deploying with?

OSC CodeServer with Slurm

Hello,

Is it possible for us to add osc codeserver while having ondemand on Slurm workload manager ?

Can't change working directory on repeated launches of app

1. Set working directory to a project
2. Launch app. Verify working directory opens. Close session.
3. Start another session, setting working directory to another project. The first project is opened.

codeserver 3.11.0 broken

It appears that the problem described in in #2 (comment) is again occurring with bc_osc_codeserver 0.4.0 and code-server >= 3.11.0 (but 3.10.2 works OK)

Originally posted by @nathanweeks in #2 (comment)

App opens incorrect URL

Hi,

When I click the blue Connect to VS Code button, the app tries to open /rnode/<%= host %>/<%= port %>/rnode/<%= host %>/<%= port %>.

If I rewrite the URL in the browser to /rnode/<%= host %>/<%= port %>?folder=/home/btsherid, then VS Code launches and seems to work fine.

I'm assuming the extra part of the URL is coming from the code of this app but I'm not sure where that is getting appended from. Any help figuring this out would be appreciated.

Thanks,
Brendan

Set the expiration of the cookie to be closer to the walltime of the job

Using the value of bc_num_hours to maybe set an env var for the job which could be the maximum cookie length

update to file picker v1.0.0

update to file picker v1.0.0 to be OOD 2.0 compatible.

Use linux host adapter instead of quick?

I know there's been discussion around using quick or using the linux host adapter to connect to owns for this app. So, let's discuss that here.