Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] New Web UI #116

Merged
merged 1 commit into from
Mar 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ authentication:
authorizationEndpoint:
jwkEndpoint:
redirectUrl:
redirectWebUrl:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

where/how is this property used?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the web UI is started independently, you can specify the redirect path.

By default, this configuration does not need to be specified.

userIdField:
scopes:
- s1
Expand Down Expand Up @@ -89,15 +90,16 @@ authentication:

The authentication happens with the pre-defined users from the configuration
file. To define the preset user use the following section.
Please note that 'privileges' can only be a combination of 'ADMIN', 'USER', and 'API', with '_' used for segmentation.

```
presetUsers:
user1:
password: <password>
privileges: "lb_admin, lb_user"
privileges: ADMIN_USER
user2:
password: <password>
privileges: "lb_api"
privileges: API
```

Also provide a random key pair in RSA format.
Expand Down Expand Up @@ -146,9 +148,9 @@ LDAP Authorization is also supported by adding user attribute configs in file.
```
# Roles should be in regex format
authorization:
admin: 'lb_admin'
user: 'lb_user'
api: 'lb_api'
admin: (.*)ADMIN(.*)
user: (.*)USER(.*)
api: (.*)API(.*)
ldapConfigPath: '<ldap_config_path>'
```

Expand Down
69 changes: 64 additions & 5 deletions gateway-ha/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
<properties>
<environments>development</environments>
<app.main.class>io.trino.gateway.ha.HaGatewayLauncher</app.main.class>
<frontend.project.name>webapp</frontend.project.name>

<!-- dependency versions -->
<dep.activejdbc.version>2.3</dep.activejdbc.version>
Expand Down Expand Up @@ -208,11 +209,6 @@
</exclusions>
</dependency>

<dependency>
<groupId>io.dropwizard</groupId>
<artifactId>dropwizard-views</artifactId>
</dependency>

<dependency>
<groupId>io.dropwizard.metrics</groupId>
<artifactId>metrics-core</artifactId>
Expand Down Expand Up @@ -552,6 +548,69 @@
</configuration>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<executions>
<execution>
<id>copy static</id>
<goals>
<goal>copy-resources</goal>
</goals>
<phase>generate-resources</phase>
<configuration>
<outputDirectory>src/main/resources/static</outputDirectory>
<overwrite>true</overwrite>
<resources>
<resource>
<directory>${project.basedir}/../${frontend.project.name}/dist</directory>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>

<plugin>
<groupId>com.github.eirslett</groupId>
<artifactId>frontend-maven-plugin</artifactId>
<version>1.12.1</version>
<configuration>
<workingDirectory>${project.basedir}/../${frontend.project.name}</workingDirectory>
</configuration>
<executions>
<execution>
<id>install node and pnpm</id>
<goals>
<goal>install-node-and-pnpm</goal>
</goals>
<configuration>
<nodeVersion>v18.9.1</nodeVersion>
<pnpmVersion>8.6.12</pnpmVersion>
</configuration>
</execution>
<execution>
<id>install</id>
<goals>
<goal>pnpm</goal>
</goals>
<phase>generate-resources</phase>
<configuration>
<arguments>install --ignore-scripts</arguments>
</configuration>
</execution>
<execution>
<id>build</id>
<goals>
<goal>pnpm</goal>
</goals>
<configuration>
<arguments>run build</arguments>
</configuration>
</execution>
</executions>
</plugin>

<plugin>
<groupId>org.javalite</groupId>
<artifactId>db-migrator-maven-plugin</artifactId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@

import io.dropwizard.assets.AssetsBundle;
import io.dropwizard.core.setup.Bootstrap;
import io.dropwizard.views.common.ViewBundle;
import io.trino.gateway.baseapp.BaseApp;
import io.trino.gateway.ha.config.HaGatewayConfiguration;

Expand All @@ -31,8 +30,8 @@ public HaGatewayLauncher(String... basePackages)
public void initialize(Bootstrap<HaGatewayConfiguration> bootstrap)
{
super.initialize(bootstrap);
bootstrap.addBundle(new ViewBundle<>());
bootstrap.addBundle(new AssetsBundle("/assets", "/assets", null, "assets"));
bootstrap.addBundle(new AssetsBundle("/static/assets", "/assets", null, "assets"));
bootstrap.addBundle(new AssetsBundle("/static", "/logo.svg", "logo.svg", "logo.svg"));
}

public static void main(String[] args)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ public class HaGatewayConfiguration
private RoutingRulesConfiguration routingRules = new RoutingRulesConfiguration();
private AuthenticationConfiguration authentication;
private AuthorizationConfiguration authorization;
private Map<String, UserConfiguration> presetUsers = new HashMap();
private Map<String, UserConfiguration> presetUsers = new HashMap<>();
private Map<String, String> pagePermissions = new HashMap<>();
private BackendStateConfiguration backendState;
private ClusterStatsConfiguration clusterStatsConfiguration;
private List<String> extraWhitelistPaths = new ArrayList<>();
Expand Down Expand Up @@ -117,6 +118,16 @@ public void setPresetUsers(Map<String, UserConfiguration> presetUsers)
this.presetUsers = presetUsers;
}

public Map<String, String> getPagePermissions()
{
return this.pagePermissions;
}

public void setPagePermissions(Map<String, String> pagePermissions)
{
this.pagePermissions = pagePermissions;
}

public BackendStateConfiguration getBackendState()
{
return this.backendState;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ public class OAuthConfiguration
private String redirectUrl;
private String userIdField;
private List<String> audiences;
private String redirectWebUrl;

public OAuthConfiguration(String issuer, String clientId, String clientSecret, String tokenEndpoint, String authorizationEndpoint, String jwkEndpoint, List<String> scopes, String redirectUrl, String userIdField, List<String> audiences)
{
Expand Down Expand Up @@ -143,4 +144,14 @@ public void setAudiences(List<String> audiences)
{
this.audiences = audiences;
}

public String getRedirectWebUrl()
{
return this.redirectWebUrl;
}

public void setRedirectWebUrl(String redirectWebUrl)
{
this.redirectWebUrl = redirectWebUrl;
}
}
116 changes: 116 additions & 0 deletions gateway-ha/src/main/java/io/trino/gateway/ha/domain/Result.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.trino.gateway.ha.domain;

import com.fasterxml.jackson.annotation.JsonProperty;
import jakarta.ws.rs.core.Response;

import java.io.Serial;
import java.io.Serializable;

public class Result<T>
implements Serializable
{
@Serial
private static final long serialVersionUID = 1L;

public static final int SUCCESS = 200;

public static final int FAIL = 500;

@JsonProperty
private int code;

@JsonProperty
private String msg;

@JsonProperty
private T data;

public static <T> Result<T> ok()
{
return restResult(null, SUCCESS, "Successful.");
}

public static <T> Result<T> ok(T data)
{
return restResult(data, SUCCESS, "Successful.");
}

public static <T> Result<T> ok(String msg)
{
return restResult(null, SUCCESS, msg);
}

public static <T> Result<T> ok(String msg, T data)
{
return restResult(data, SUCCESS, msg);
}

public static <T> Result<T> fail(String msg)
{
return restResult(null, FAIL, msg);
}

public static <T> Result<T> fail(Response.Status status)
{
return restResult(null, status.getStatusCode(), status.getReasonPhrase());
}

private static <T> Result<T> restResult(T data, int code, String msg)
{
Result<T> r = new Result<>();
r.setCode(code);
r.setData(data);
r.setMsg(msg);
return r;
}

public static <T> Boolean isSuccess(Result<T> ret)
{
return Result.SUCCESS == ret.getCode();
}

public Result() {}

public int getCode()
{
return code;
}

public void setCode(int code)
{
this.code = code;
}

public String getMsg()
{
return msg;
}

public void setMsg(String msg)
{
this.msg = msg;
}

public T getData()
{
return data;
}

public void setData(T data)
{
this.data = data;
}
}
72 changes: 72 additions & 0 deletions gateway-ha/src/main/java/io/trino/gateway/ha/domain/TableData.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.trino.gateway.ha.domain;

import com.fasterxml.jackson.annotation.JsonProperty;

import java.io.Serial;
import java.io.Serializable;
import java.util.List;

public class TableData<T>
ytwp marked this conversation as resolved.
Show resolved Hide resolved
implements Serializable
{
@Serial
private static final long serialVersionUID = 1L;

/**
* Total number of table data
*/
@JsonProperty
private long total;

/**
* page data
*/
@JsonProperty
private List<T> rows;

public TableData(List<T> list, long total)
{
this.rows = list;
this.total = total;
}

public static <T> TableData<T> build(List<T> list, long total)
{
return new TableData<>(list, total);
}

public TableData() {}

public long getTotal()
{
return total;
}

public void setTotal(long total)
{
this.total = total;
}

public List<T> getRows()
{
return rows;
}

public void setRows(List<T> rows)
{
this.rows = rows;
}
}
Loading
Loading