The Unified and Autonomous Development Platform
Derive server url from ingress host if available
Robin Shen1499230be64f
diff --git a/server-core/src/main/java/io/onedev/server/OneDev.java b/server-core/src/main/java/io/onedev/server/OneDev.javaindex c1451c0df7..d76921d518 100644--- a/server-core/src/main/java/io/onedev/server/OneDev.java+++ b/server-core/src/main/java/io/onedev/server/OneDev.java@@ -19,7 +19,6 @@ import javax.inject.Inject;import org.apache.commons.lang3.StringUtils;import org.apache.commons.lang3.SystemUtils;import org.apache.wicket.request.Url;-import org.apache.wicket.request.Url.StringMode;import org.eclipse.jgit.util.FS.FileStoreAttributes;import org.slf4j.Logger;import org.slf4j.LoggerFactory;@@ -45,6 +44,7 @@ import io.onedev.server.persistence.SessionManager;import io.onedev.server.persistence.annotation.Sessional;import io.onedev.server.security.SecurityUtils;import io.onedev.server.util.ServerConfig;+import io.onedev.server.util.UrlUtils;import io.onedev.server.util.Version;import io.onedev.server.util.init.InitStage;import io.onedev.server.util.init.ManualConfig;@@ -110,8 +110,10 @@ public class OneDev extends AbstractPlugin implements Serializable {List<ManualConfig> manualConfigs = dataManager.init();if (!manualConfigs.isEmpty()) {- String serverUrl = StringUtils.stripEnd(guessServerUrl(false).toString(StringMode.FULL), "/");- logger.warn("Please set up the server at " + serverUrl);+ if (getIngressUrl() != null)+ logger.warn("Please set up the server at " + getIngressUrl());+ else+ logger.warn("Please set up the server at " + guessServerUrl(false));initStage = new InitStage("Server Setup", manualConfigs);initStage.waitForFinish();@@ -139,20 +141,35 @@ public class OneDev extends AbstractPlugin implements Serializable {initStage = null;}- public Url guessServerUrl(boolean ssh) {+ @Nullable+ public String getIngressUrl() {+ String ingressHost = System.getenv("ingress_host");+ if (ingressHost != null) {+ boolean ingressTLS = Boolean.parseBoolean(System.getenv("ingress_tls"));+ if (ingressTLS)+ return UrlUtils.toString(buildServerUrl(ingressHost, "https", 443));+ else+ return UrlUtils.toString(buildServerUrl(ingressHost, "http", 80));+ } else {+ return null;+ }+ }++ public String guessServerUrl(boolean ssh) {Url serverUrl = null;- String serviceHost = System.getenv("ONEDEV_SERVICE_HOST");- if (serviceHost != null) { // we are running inside Kubernetes+ String k8sService = System.getenv("k8s_service");+ if (k8sService != null) { // we are running inside KubernetesCommandline kubectl = new Commandline("kubectl");- kubectl.addArgs("get", "service", "onedev", "-o",+ kubectl.addArgs("get", "service", k8sService, "-o","jsonpath={.status.loadBalancer.ingress[0].ip}");AtomicReference<String> externalIpRef = new AtomicReference<>(null);kubectl.execute(new LineConsumer() {@Overridepublic void consume(String line) {- externalIpRef.set(line);+ if (StringUtils.isNotBlank(line))+ externalIpRef.set(line);}}, new LineConsumer() {@@ -167,66 +184,10 @@ public class OneDev extends AbstractPlugin implements Serializable {String externalIp = externalIpRef.get();if (externalIp != null) {- kubectl.clearArgs();- kubectl.addArgs("get", "service", "onedev", "-o",- "jsonpath={range .spec.ports[*]}{.name} {.port}{'\\n'}{end}");- AtomicReference<Integer> httpPortRef = new AtomicReference<>(null);- AtomicReference<Integer> httpsPortRef = new AtomicReference<>(null);- AtomicReference<Integer> sshPortRef = new AtomicReference<>(null);- kubectl.execute(new LineConsumer() {-- @Override- public void consume(String line) {- String protocol = StringUtils.substringBefore(line, " ");- int port = Integer.parseInt(StringUtils.substringAfter(line, " "));- if (protocol.equals("http"))- httpPortRef.set(port);- else if (protocol.equals("https"))- httpsPortRef.set(port);- else if (protocol.equals("ssh"))- sshPortRef.set(port);- }-- }, new LineConsumer() {-- @Override- public void consume(String line) {- logger.warn(line);- }-- }).checkReturnCode();-- Integer sshPort = sshPortRef.get();- Integer httpPort = httpPortRef.get();- Integer httpsPort = httpsPortRef.get();-- if (ssh) {- if (sshPort != null)- serverUrl = buildServerUrl(externalIp, "ssh", sshPort);- } else if (httpsPort != null) {- serverUrl = buildServerUrl(externalIp, "https", httpsPort);- } else {- serverUrl = buildServerUrl(externalIp, "http", httpPort);- }-- if (serverUrl == null) {- String httpPortEnv = System.getenv("ONEDEV_SERVICE_PORT_HTTP");- String httpsPortEnv = System.getenv("ONEDEV_SERVICE_PORT_HTTPS");- String sshPortEnv = System.getenv("ONEDEV_SERVICE_PORT_SSH");-- httpPort = httpPortEnv!=null?Integer.valueOf(httpPortEnv):null;- httpsPort = httpsPortEnv!=null?Integer.valueOf(httpsPortEnv):null;- sshPort = sshPortEnv!=null?Integer.valueOf(sshPortEnv):null;-- if (ssh) {- if (sshPort != null)- serverUrl = buildServerUrl(externalIp, "ssh", sshPort);- } else if (httpsPort != null) {- serverUrl = buildServerUrl(externalIp, "https", httpsPort);- } else {- serverUrl = buildServerUrl(externalIp, "http", httpPort);- }- }+ if (ssh)+ serverUrl = buildServerUrl(externalIp, "ssh", 22);+ else+ serverUrl = buildServerUrl(externalIp, "http", 80);}}@@ -263,7 +224,7 @@ public class OneDev extends AbstractPlugin implements Serializable {serverUrl = buildServerUrl(host, "http", serverConfig.getHttpPort());}- return serverUrl;+ return UrlUtils.toString(serverUrl);}private Url buildServerUrl(String host, String protocol, int port) {diff --git a/server-core/src/main/java/io/onedev/server/maintenance/DefaultDataManager.java b/server-core/src/main/java/io/onedev/server/maintenance/DefaultDataManager.javaindex 0bfef0bc44..6a98d83313 100644--- a/server-core/src/main/java/io/onedev/server/maintenance/DefaultDataManager.java+++ b/server-core/src/main/java/io/onedev/server/maintenance/DefaultDataManager.java@@ -15,8 +15,6 @@ import javax.inject.Singleton;import javax.validation.Validator;import org.apache.shiro.authc.credential.PasswordService;-import org.apache.wicket.request.Url;-import org.apache.wicket.request.Url.StringMode;import org.joda.time.DateTime;import org.joda.time.format.DateTimeFormat;import org.quartz.CronScheduleBuilder;@@ -31,7 +29,6 @@ import io.onedev.commons.loader.Listen;import io.onedev.commons.loader.ManagedSerializedForm;import io.onedev.commons.utils.ExceptionUtils;import io.onedev.commons.utils.FileUtils;-import io.onedev.commons.utils.StringUtils;import io.onedev.server.OneDev;import io.onedev.server.entitymanager.RoleManager;import io.onedev.server.entitymanager.SettingManager;@@ -99,7 +96,7 @@ public class DefaultDataManager implements DataManager, Serializable {this.passwordService = passwordService;this.roleManager = roleManager;}-+@SuppressWarnings({"serial"})@Transactional@Override@@ -147,20 +144,35 @@ public class DefaultDataManager implements DataManager, Serializable {Setting setting = settingManager.getSetting(Key.SYSTEM);SystemSetting systemSetting = null;- Url webServerUrl = OneDev.getInstance().guessServerUrl(false);++ String ingressUrl = OneDev.getInstance().getIngressUrl();if (setting == null || setting.getValue() == null) {systemSetting = new SystemSetting();- systemSetting.setServerUrl(StringUtils.stripEnd(webServerUrl.toString(StringMode.FULL), "/"));- } else if (!validator.validate(setting.getValue()).isEmpty()) {+ if (ingressUrl != null) {+ systemSetting.setServerUrl(ingressUrl);+ settingManager.saveSystemSetting(systemSetting);+ systemSetting = null;+ } else {+ systemSetting.setServerUrl(OneDev.getInstance().guessServerUrl(false));+ }+ } else {systemSetting = (SystemSetting) setting.getValue();+ if (ingressUrl != null)+ systemSetting.setServerUrl(ingressUrl);+ if (validator.validate(systemSetting).isEmpty())+ systemSetting = null;}+if (systemSetting != null) {Collection<String> excludedProps = Sets.newHashSet("gravatarEnabled");if (Bootstrap.isInDocker()) {excludedProps.add("gitConfig");excludedProps.add("curlConfig");}+ if (ingressUrl != null)+ excludedProps.add("serverUrl");+manualConfigs.add(new ManualConfig("Specify System Setting", null,systemSetting, excludedProps) {@@ -180,8 +192,7 @@ public class DefaultDataManager implements DataManager, Serializable {setting = settingManager.getSetting(Key.SSH);if (setting == null || setting.getValue() == null) {SshSetting sshSetting = new SshSetting();- Url sshServerUrl = OneDev.getInstance().guessServerUrl(true);- sshSetting.setServerUrl(StringUtils.stripEnd(sshServerUrl.toString(StringMode.FULL), "/"));+ sshSetting.setServerUrl(OneDev.getInstance().guessServerUrl(true));sshSetting.setPemPrivateKey(SshKeyUtils.generatePEMPrivateKey());settingManager.saveSshSetting(sshSetting);diff --git a/server-core/src/main/java/io/onedev/server/rest/SettingResource.java b/server-core/src/main/java/io/onedev/server/rest/SettingResource.javaindex 5ffba527bc..80e4d1ac80 100644--- a/server-core/src/main/java/io/onedev/server/rest/SettingResource.java+++ b/server-core/src/main/java/io/onedev/server/rest/SettingResource.java@@ -16,6 +16,7 @@ import javax.ws.rs.core.Response;import org.apache.shiro.authz.UnauthorizedException;+import io.onedev.server.OneDev;import io.onedev.server.entitymanager.SettingManager;import io.onedev.server.model.support.administration.BackupSetting;import io.onedev.server.model.support.administration.GlobalBuildSetting;@@ -33,6 +34,7 @@ import io.onedev.server.model.support.administration.jobexecutor.JobExecutor;import io.onedev.server.model.support.administration.notificationtemplate.NotificationTemplateSetting;import io.onedev.server.model.support.administration.sso.SsoConnector;import io.onedev.server.rest.annotation.Api;+import io.onedev.server.rest.jersey.InvalidParamException;import io.onedev.server.security.SecurityUtils;import io.onedev.server.web.page.layout.ContributedAdministrationSetting;@@ -200,6 +202,10 @@ public class SettingResource {public Response setSystemSetting(@NotNull SystemSetting systemSetting) {if (!SecurityUtils.isAdministrator())throw new UnauthorizedException();+ String ingressUrl = OneDev.getInstance().getIngressUrl();+ if (ingressUrl != null && !ingressUrl.equals(systemSetting.getServerUrl()))+ throw new InvalidParamException("Server URL can only be \"" + ingressUrl + "\"");+settingManager.saveSystemSetting(systemSetting);return Response.ok().build();}diff --git a/server-core/src/main/java/io/onedev/server/util/UrlUtils.java b/server-core/src/main/java/io/onedev/server/util/UrlUtils.javaindex 64b85ea9e9..061a710c2b 100644--- a/server-core/src/main/java/io/onedev/server/util/UrlUtils.java+++ b/server-core/src/main/java/io/onedev/server/util/UrlUtils.java@@ -5,6 +5,8 @@ import java.nio.charset.StandardCharsets;import java.util.regex.Pattern;import org.apache.http.client.utils.URIBuilder;+import org.apache.wicket.request.Url;+import org.apache.wicket.request.Url.StringMode;import org.apache.wicket.util.encoding.UrlDecoder;import org.apache.wicket.util.encoding.UrlEncoder;@@ -66,4 +68,8 @@ public class UrlUtils {}}+ public static String toString(Url url) {+ return StringUtils.stripEnd(url.toString(StringMode.FULL), "/");+ }+}diff --git a/server-core/src/main/java/io/onedev/server/web/page/admin/systemsetting/SystemSettingPage.html b/server-core/src/main/java/io/onedev/server/web/page/admin/systemsetting/SystemSettingPage.htmlindex ebe02fc702..a3e7325018 100644--- a/server-core/src/main/java/io/onedev/server/web/page/admin/systemsetting/SystemSettingPage.html+++ b/server-core/src/main/java/io/onedev/server/web/page/admin/systemsetting/SystemSettingPage.html@@ -1,6 +1,15 @@<wicket:extend><div class="card"><div class="card-body">+ <wicket:enclosure child="ingressUrl">+ <div class="form-group">+ <label class="name control-label">+ <span>Server URL</span> <span class="text-danger">*</span>+ </label>+ <input wicket:id="ingressUrl" type="text" class="form-control" disabled="disabled">+ <div class="text-muted form-text">This is derived from ingress setting, and can not be changed</div>+ </div>+ </wicket:enclosure><form wicket:id="form" class="leave-confirm"><div wicket:id="editor" class="mb-4"></div><input type="submit" class="btn btn-primary dirty-aware" value="Save Setting">diff --git a/server-core/src/main/java/io/onedev/server/web/page/admin/systemsetting/SystemSettingPage.java b/server-core/src/main/java/io/onedev/server/web/page/admin/systemsetting/SystemSettingPage.javaindex ddf57dc9ed..743422cc6d 100644--- a/server-core/src/main/java/io/onedev/server/web/page/admin/systemsetting/SystemSettingPage.java+++ b/server-core/src/main/java/io/onedev/server/web/page/admin/systemsetting/SystemSettingPage.java@@ -7,6 +7,8 @@ import java.util.HashSet;import org.apache.wicket.Component;import org.apache.wicket.markup.html.basic.Label;import org.apache.wicket.markup.html.form.Form;+import org.apache.wicket.markup.html.form.TextField;+import org.apache.wicket.model.Model;import org.apache.wicket.request.mapper.parameter.PageParameters;import io.onedev.commons.bootstrap.Bootstrap;@@ -29,6 +31,9 @@ public class SystemSettingPage extends AdministrationPage {SystemSetting systemSetting = OneDev.getInstance(SettingManager.class).getSystemSetting();+ String ingressUrl = OneDev.getInstance().getIngressUrl();+ add(new TextField<String>("ingressUrl", Model.of(ingressUrl)).setVisible(ingressUrl != null));+Form<?> form = new Form<Void>("form") {@Override@@ -46,6 +51,9 @@ public class SystemSettingPage extends AdministrationPage {excludedProps.add("gitConfig");excludedProps.add("curlConfig");}+ if (OneDev.getInstance().getIngressUrl() != null)+ excludedProps.add("serverUrl");+form.add(BeanContext.edit("editor", systemSetting, excludedProps, true));add(form);diff --git a/server-product/helm/templates/NOTES.txt b/server-product/helm/templates/NOTES.txtnew file mode 100644index 0000000000..f501716181--- /dev/null+++ b/server-product/helm/templates/NOTES.txt@@ -0,0 +1,13 @@+{{- if .Values.maintenance -}}+Now in maintenance mode+{{- else if .Values.ingress.host }}+{{- if .Values.ingress.tls }}+OneDev can be accessed at url "https://{{ .Values.ingress.host }}" when ready+{{- else }}+OneDev can be accessed at url "http://{{ .Values.ingress.host }}" when ready+{{- end }}+{{- else }}+OneDev can be accessed at url "http://<OneDev external ip>" when ready.+OneDev external ip can be dispalyed via below command:+kubectl get service {{ include "onedev.fullname" . }} -n {{ .Release.Namespace }}+{{- end }}diff --git a/server-product/helm/templates/deployment.yaml b/server-product/helm/templates/deployment.yamlindex 7bb100ec84..dbb0de8da3 100644--- a/server-product/helm/templates/deployment.yaml+++ b/server-product/helm/templates/deployment.yaml@@ -40,6 +40,14 @@ spec:- containerPort: 6610- containerPort: 6611env:+ - name: k8s_service+ value: {{ include "onedev.fullname" . }}+ {{- if .Values.ingress.host }}+ - name: ingress_host+ value: {{ .Values.ingress.host }}+ {{- end }}+ - name: ingress_tls+ value: {{ .Values.ingress.tls }}- name: hibernate_dialectvalue: org.hibernate.dialect.MySQL5InnoDBDialect- name: hibernate_connection_driver_class