Skip to content

Commit

Permalink
outposts: add better UI for showing mismatched versions (#10885)
Browse files Browse the repository at this point in the history
Signed-off-by: Jens Langhammer <[email protected]>
  • Loading branch information
BeryJu authored Aug 12, 2024
1 parent fccb805 commit bb9e679
Show file tree
Hide file tree
Showing 11 changed files with 53 additions and 19 deletions.
11 changes: 11 additions & 0 deletions authentik/admin/api/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
from authentik import __version__, get_build_hash
from authentik.admin.tasks import VERSION_CACHE_KEY, VERSION_NULL, update_latest_version
from authentik.core.api.utils import PassiveSerializer
from authentik.outposts.models import Outpost


class VersionSerializer(PassiveSerializer):
Expand All @@ -22,6 +23,7 @@ class VersionSerializer(PassiveSerializer):
version_latest_valid = SerializerMethodField()
build_hash = SerializerMethodField()
outdated = SerializerMethodField()
outpost_outdated = SerializerMethodField()

def get_build_hash(self, _) -> str:
"""Get build hash, if version is not latest or released"""
Expand All @@ -47,6 +49,15 @@ def get_outdated(self, instance) -> bool:
"""Check if we're running the latest version"""
return parse(self.get_version_current(instance)) < parse(self.get_version_latest(instance))

def get_outpost_outdated(self, _) -> bool:
"""Check if any outpost is outdated/has a version mismatch"""
any_outdated = False
for outpost in Outpost.objects.all():
for state in outpost.state:
if state.version_outdated:
any_outdated = True
return any_outdated


class VersionView(APIView):
"""Get running and latest version."""
Expand Down
2 changes: 0 additions & 2 deletions authentik/outposts/api/outposts.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
from authentik.outposts.models import (
Outpost,
OutpostConfig,
OutpostState,
OutpostType,
default_outpost_config,
)
Expand Down Expand Up @@ -182,7 +181,6 @@ def health(self, request: Request, pk: int) -> Response:
outpost: Outpost = self.get_object()
states = []
for state in outpost.state:
state: OutpostState
states.append(
{
"uid": state.uid,
Expand Down
2 changes: 1 addition & 1 deletion authentik/outposts/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,7 @@ def version_outdated(self) -> bool:
return False
if self.build_hash != get_build_hash():
return False
return parse(self.version) < OUR_VERSION
return parse(self.version) != OUR_VERSION

@staticmethod
def for_outpost(outpost: Outpost) -> list["OutpostState"]:
Expand Down
2 changes: 1 addition & 1 deletion authentik/policies/reputation/signals.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def update_score(request: HttpRequest, identifier: str, amount: int):
if not created:
reputation.score = F("score") + amount
reputation.save()
LOGGER.debug("Updated score", amount=amount, for_user=identifier, for_ip=remote_ip)
LOGGER.info("Updated score", amount=amount, for_user=identifier, for_ip=remote_ip)


@receiver(login_failed)
Expand Down
4 changes: 2 additions & 2 deletions internal/outpost/ak/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ func (a *APIController) OnRefresh() error {
func (a *APIController) getWebsocketPingArgs() map[string]interface{} {
args := map[string]interface{}{
"version": constants.VERSION,
"buildHash": constants.BUILD("tagged"),
"buildHash": constants.BUILD(""),
"uuid": a.instanceUUID.String(),
"golangVersion": runtime.Version(),
"opensslEnabled": cryptobackend.OpensslEnabled,
Expand All @@ -207,7 +207,7 @@ func (a *APIController) StartBackgroundTasks() error {
"outpost_type": a.Server.Type(),
"uuid": a.instanceUUID.String(),
"version": constants.VERSION,
"build": constants.BUILD("tagged"),
"build": constants.BUILD(""),
}).Set(1)
go func() {
a.logger.Debug("Starting WS Handler...")
Expand Down
4 changes: 2 additions & 2 deletions internal/outpost/ak/api_ws.go
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ func (ac *APIController) startWSHandler() {
"outpost_type": ac.Server.Type(),
"uuid": ac.instanceUUID.String(),
"version": constants.VERSION,
"build": constants.BUILD("tagged"),
"build": constants.BUILD(""),
}).SetToCurrentTime()
}
} else if wsMsg.Instruction == WebsocketInstructionProviderSpecific {
Expand Down Expand Up @@ -207,7 +207,7 @@ func (ac *APIController) startIntervalUpdater() {
"outpost_type": ac.Server.Type(),
"uuid": ac.instanceUUID.String(),
"version": constants.VERSION,
"build": constants.BUILD("tagged"),
"build": constants.BUILD(""),
}).SetToCurrentTime()
}
ticker.Reset(getInterval())
Expand Down
5 changes: 5 additions & 0 deletions schema.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52712,9 +52712,14 @@ components:
type: boolean
description: Check if we're running the latest version
readOnly: true
outpost_outdated:
type: boolean
description: Check if any outpost is outdated/has a version mismatch
readOnly: true
required:
- build_hash
- outdated
- outpost_outdated
- version_current
- version_latest
- version_latest_valid
Expand Down
7 changes: 7 additions & 0 deletions web/src/admin/admin-overview/cards/VersionStatusCard.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@ export class VersionStatusCard extends AdminStatusCard<Version> {
message: html`${msg(str`${value.versionLatest} is available!`)}`,
});
}
if (value.outpostOutdated) {
return Promise.resolve<AdminStatus>({
icon: "fa fa-exclamation-triangle pf-m-warning",
message: html`${msg("An outpost is on an incorrect version!")}
<a href="#/outpost/outposts">${msg("Check outposts.")}</a>`,
});
}
if (value.versionLatestValid) {
return Promise.resolve<AdminStatus>({
icon: "fa fa-check-circle pf-m-success",
Expand Down
5 changes: 4 additions & 1 deletion web/src/admin/outposts/OutpostHealth.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { getRelativeTime } from "@goauthentik/common/utils";
import { AKElement } from "@goauthentik/elements/Base";
import { PFColor } from "@goauthentik/elements/Label";
import "@goauthentik/elements/Spinner";
Expand Down Expand Up @@ -49,7 +50,9 @@ export class OutpostHealthElement extends AKElement {
<dd class="pf-c-description-list__description">
<div class="pf-c-description-list__text">
<ak-label color=${PFColor.Green} ?compact=${true}>
${this.outpostHealth.lastSeen?.toLocaleTimeString()}
${msg(
str`${getRelativeTime(this.outpostHealth.lastSeen)} (${this.outpostHealth.lastSeen?.toLocaleTimeString()})`,
)}
</ak-label>
</div>
</dd>
Expand Down
28 changes: 19 additions & 9 deletions web/src/admin/outposts/OutpostHealthSimple.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
import { DEFAULT_CONFIG } from "@goauthentik/common/api/config";
import { EVENT_REFRESH } from "@goauthentik/common/constants";
import { getRelativeTime } from "@goauthentik/common/utils";
import { AKElement } from "@goauthentik/elements/Base";
import { PFColor } from "@goauthentik/elements/Label";
import "@goauthentik/elements/Spinner";

import { msg, str } from "@lit/localize";
import { CSSResult, TemplateResult, html } from "lit";
import { customElement, property } from "lit/decorators.js";
import { customElement, property, state } from "lit/decorators.js";

import PFBase from "@patternfly/patternfly/patternfly-base.css";

Expand All @@ -17,8 +18,8 @@ export class OutpostHealthSimpleElement extends AKElement {
@property()
outpostId?: string;

@property({ attribute: false })
outpostHealth?: OutpostHealth;
@state()
outpostHealths: OutpostHealth[] = [];

@property({ attribute: false })
loaded = false;
Expand All @@ -33,7 +34,7 @@ export class OutpostHealthSimpleElement extends AKElement {
constructor() {
super();
window.addEventListener(EVENT_REFRESH, () => {
this.outpostHealth = undefined;
this.outpostHealths = [];
this.firstUpdated();
});
}
Expand All @@ -46,21 +47,30 @@ export class OutpostHealthSimpleElement extends AKElement {
})
.then((health) => {
this.loaded = true;
if (health.length >= 1) {
this.outpostHealth = health[0];
}
this.outpostHealths = health;
});
}

render(): TemplateResult {
if (!this.outpostId || !this.loaded) {
return html`<ak-spinner></ak-spinner>`;
}
if (!this.outpostHealth) {
if (!this.outpostHealths || this.outpostHealths.length === 0) {
return html`<ak-label color=${PFColor.Grey}>${msg("Not available")}</ak-label>`;
}
const outdatedOutposts = this.outpostHealths.filter((h) => h.versionOutdated);
if (outdatedOutposts.length > 0) {
return html`<ak-label color=${PFColor.Red}>
${msg(
str`${outdatedOutposts[0].version}, should be ${outdatedOutposts[0].versionShould}`,
)}</ak-label
>`;
}
const lastSeen = this.outpostHealths[0].lastSeen;
return html`<ak-label color=${PFColor.Green}>
${msg(str`Last seen: ${this.outpostHealth.lastSeen?.toLocaleTimeString()}`)}</ak-label
${msg(
str`Last seen: ${getRelativeTime(lastSeen)} (${lastSeen.toLocaleTimeString()})`,
)}</ak-label
>`;
}
}
Expand Down
2 changes: 1 addition & 1 deletion web/src/admin/outposts/OutpostListPage.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ export class OutpostListPage extends TablePage<Outpost> {
const outposts = await new OutpostsApi(DEFAULT_CONFIG).outpostsInstancesList(
await this.defaultEndpointConfig(),
);
Promise.all(
await Promise.all(
outposts.results.map((outpost) => {
return new OutpostsApi(DEFAULT_CONFIG)
.outpostsInstancesHealthList({
Expand Down

0 comments on commit bb9e679

Please sign in to comment.