Skip to content

Commit

Permalink
chore: 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mlhiter committed Nov 13, 2024
1 parent b8e7100 commit a596932
Show file tree
Hide file tree
Showing 12 changed files with 52 additions and 15 deletions.
24 changes: 23 additions & 1 deletion extensions/ide/vscode/devbox/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,26 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how

## [Unreleased]

- Initial release
## [1.0.0] - 2024-11-13

### Added

- Devbox basic management: Create(in web page),Delete(delete local ssh config),Open,Refresh,State.
- Network panel,Database panel: View network and database information,open network port in browser or vscode integrated browser,copy database connection string.
- Adapt to dark theme.
- custom your own API Region and Zone.
- Delete devbox in web page will delete local ssh config.

### Fixed

- windows file authority issue cause connection error.
- Connection error caused by `Remote-SSH` custom ssh config path.

### Changed

- update ssh config file format.

### Security

- Replace `child_process` with `execa` to avoid security issues.
- Deal with path traversal attack.
41 changes: 28 additions & 13 deletions extensions/ide/vscode/devbox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,51 +4,66 @@ Sailos Devbox is a remote development&production environment that helps you deve

This plugin support connection and management of Devbox.

> Note: Currently, only connections are supported, management will be supported later.
> Note: Currently, only connections and simple devbox management are supported, other functions(including amazing AI features integrated with sailos natively) will be supported next version.
## Features

- Remote environment is based on Kubernetes, it has the advantages of K8S's environment.
- Zero-configuration, no need to configure the environment, just connect to the Devbox.
- Preset popular languages and frameworks make it easy to get started with development.
- It has all the features of the editor, such as VSCode and Cursor.
- Support local port forwarding and public port export.

## Usage

### 1. Connect to the remote environment

Login to the [Sailos Devbox](https://usw.sailos.io/) and create new Devbox.
Login to the [Sailos Devbox](https://usw.sailos.io/) and create a new Devbox.

![create](https://raw.githubusercontent.com/mlhiter/typora-images/master/create-page.png)
![create](screenshot/create.png)

Then you can connect to the Devbox by your own IDE in the list page.

![list](https://raw.githubusercontent.com/mlhiter/typora-images/master/CleanShot%202024-09-27%20at%2015.44.57%402x.png)
![list](screenshot/list.png)

After that, you can use the Devbox just like your local environment.

### 2. Develop your project just like your local environment.

![dev](https://raw.githubusercontent.com/mlhiter/typora-images/master/img_v3_02f2_eb75e0b8-6eab-43e5-b383-6a953e7286eg.jpg)
![dev](screenshot/dev.png)

### 3. Get your port export result

You can use local port forwarding supported by VSCode or Cursor to get your own page.

![port-forward](https://raw.githubusercontent.com/mlhiter/typora-images/master/CleanShot%202024-09-27%20at%2015.10.37%402x.png)
![port-forward](screenshot/port-forward.png)

![port-forward-result](https://raw.githubusercontent.com/mlhiter/typora-images/master/CleanShot%202024-09-27%20at%2015.50.18%402x.png)
![port-forward-result](screenshot/port-forward-result.png)

If you want to **share your port (maybe a page or an API) with others**,you can update your network config in Sailos Devbox Website to export your port **in public network**.

you can update a public port or there is **a preset default public export port**(Different runtime has a different default public export port).

![update-network](https://raw.githubusercontent.com/mlhiter/typora-images/master/CleanShot%202024-09-27%20at%2015.54.36%402x.png)
![update-network](screenshot/update-network.png)

## Requirements
## Managements

### 1. basic

You can do some simple management operations or give us feedback in the Devbox list page.

> Note: Delete devbox only influence local ssh config, will not delete remote devbox.
You need to install `Remote - SSH` extension in your IDE firstly.
![manage](screenshot/manage.png)

## Known Issues
### 2. Network and Database panel

You can view the network and database(all your databases in your namespace) of the Devbox in the Network and Database panel.

![network](screenshot/network.png)
![database](screenshot/database.png)

## Requirements

- Management function is not supported yet.
- Local port forwarding only supports same port forwarding. such as devbox's 8080->localhost:8080.
1. You need to install `Remote - SSH` extension in your IDE firstly.
2. You need `a SSH client` in your local environment.
2 changes: 1 addition & 1 deletion extensions/ide/vscode/devbox/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "devbox-aio",
"displayName": "Devbox",
"description": "help code for cloud devbox in sailos/sealos",
"version": "0.9.14",
"version": "1.0.0",
"keywords": [
"devbox",
"remote development",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added extensions/ide/vscode/devbox/screenshot/dev.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added extensions/ide/vscode/devbox/screenshot/list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a596932

Please sign in to comment.