Compare commits
11 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| d50248531c | |||
| 4007f54279 | |||
| 88172ade29 | |||
| 478ae6284a | |||
| fcc80b32d5 | |||
| 4aa4f17c42 | |||
| a0ea13955e | |||
| 2a08a8cd8e | |||
| 375b5ed2f7 | |||
| 6a699d4341 | |||
| d9315322fc |
@@ -50,6 +50,14 @@ it just created, never a server something else already bootstrapped first.
|
||||
that needs a live look at another object (e.g. "does this teamRef exist")
|
||||
is a status condition, not an admission rejection — keeps v1 to a
|
||||
controller-only deployment with no cert-manager/webhook dependency.
|
||||
- **Never manages external exposure/ingress for `TerdutServer`, in any
|
||||
form — a permanent non-goal, not a staged one.** The operator creates a
|
||||
plain `ClusterIP` Service (§4.1) and stops there: no `Ingress`, no
|
||||
Gateway API `HTTPRoute`, no Istio `VirtualService`, nothing. Some
|
||||
installs won't expose `TerdutServer` outside the cluster at all; others
|
||||
will use whichever of those mechanisms already fits their cluster. That
|
||||
choice belongs to whoever deploys it, not to this operator — see
|
||||
`examples/networking` for worked (but not operator-managed) examples.
|
||||
|
||||
## 2. The README's open questions, resolved
|
||||
|
||||
@@ -145,11 +153,10 @@ spec:
|
||||
image:
|
||||
repository: git.ryuvia.com/niklas/terdut-server
|
||||
tag: v0.9.3
|
||||
replicas: 1 # terdut-server is not horizontally-scale-tested; keep the field, default 1
|
||||
replicas: 2 # default since terdut-server v0.36.0's advisory locks; see TerdutServerSpec.Replicas
|
||||
networking:
|
||||
hostname: terdut.example.com
|
||||
servicePort: 8080
|
||||
gatewayListener: "" # same semantics as chart's networking.listener
|
||||
database:
|
||||
dsn: "postgres://terdut@terdut-postgres:5432/terdut?sslmode=require" # mutually exclusive with postgresClusterRef
|
||||
passwordSecretRef: {name: terdut.terdut-postgres.credentials.postgresql.acid.zalan.do, key: password}
|
||||
@@ -188,6 +195,20 @@ spec:
|
||||
# selector: # required, and only meaningful, when from: Selector
|
||||
# matchLabels:
|
||||
# terdut.ryuvia.com/allowed: "true"
|
||||
# Pod-level customization of the Deployment -- all optional, direct corev1
|
||||
# passthrough throughout (see PodSpec's own doc comment). A representative
|
||||
# subset:
|
||||
pod:
|
||||
resources:
|
||||
requests: {cpu: 100m, memory: 128Mi}
|
||||
limits: {memory: 256Mi}
|
||||
tolerations:
|
||||
- key: dedicated
|
||||
operator: Equal
|
||||
value: terdut
|
||||
effect: NoSchedule
|
||||
disruptionBudget:
|
||||
minAvailable: 1 # mutually exclusive with maxUnavailable
|
||||
status:
|
||||
conditions: [...] # Ready, DatabaseReady, Bootstrapped
|
||||
observedGeneration: 3
|
||||
@@ -214,6 +235,25 @@ per-name allowlist (no "and only these teams") — namespace-level consent is
|
||||
the right granularity here, same reasoning as `ListenerSet`: the namespace
|
||||
is the tenancy boundary, not the object.
|
||||
|
||||
`spec.pod` is pod-level customization of the Deployment, all optional and
|
||||
directly reusing corev1 types wherever corev1 already models the knob
|
||||
exactly (`tolerations`, `affinity`, `topologySpreadConstraints`,
|
||||
`resources`, `securityContext`/`containerSecurityContext`, `extraEnv`/
|
||||
`extraEnvFrom`, `extraVolumes`/`extraVolumeMounts`, `imagePullSecrets`) —
|
||||
no custom wrapper buys anything for any of these, matching how
|
||||
CloudNativePG and the Zalando postgres-operator both expose the same
|
||||
knobs. `affinity` is pure user-supplied passthrough, not a
|
||||
toggle-plus-generated-default the way a multi-replica-aware operator's
|
||||
pod anti-affinity typically is: even though `replicas` now defaults to 2
|
||||
(terdut-server v0.36.0's advisory locks made that safe, §4.1's own
|
||||
illustrative YAML comment), this operator still never auto-generates
|
||||
affinity of its own. `spec.pod.disruptionBudget` is the one field here that isn't a
|
||||
straight PodTemplateSpec knob — when set, the controller reconciles a
|
||||
`PodDisruptionBudget` selecting this `TerdutServer`'s pods; clearing it
|
||||
deletes any it previously created (§7). `minAvailable`/`maxUnavailable`
|
||||
are mutually exclusive, `+kubebuilder:validation:XValidation`-guarded the
|
||||
same way as `spec.database`'s own `dsn`/`postgresClusterRef` rule.
|
||||
|
||||
### 4.2 `TerdutTeam`
|
||||
|
||||
```yaml
|
||||
@@ -591,9 +631,15 @@ when nothing ever crosses into a tenant namespace in the first place.
|
||||
## 7. Ownership, status, garbage collection
|
||||
|
||||
- Every generated object that lives in the *same* namespace as the CR that
|
||||
caused it (Deployment, Service, webhook Secret) carries a standard
|
||||
`metav1.OwnerReference` — GC handles these, no finalizer needed. The two
|
||||
credential Secrets from §6 are the one exception: they live in the
|
||||
caused it (Deployment, Service, webhook Secret, and `TerdutServer`'s own
|
||||
PodDisruptionBudget) carries a standard `metav1.OwnerReference` — GC
|
||||
handles these, no finalizer needed. PodDisruptionBudget is the one
|
||||
member of that list that's conditionally created/deleted rather than
|
||||
always present: it exists only while `spec.pod.disruptionBudget` is set,
|
||||
and the controller deletes it itself the moment that field is cleared
|
||||
(it doesn't wait on GC for that case, only for the `TerdutServer` being
|
||||
deleted outright). The two credential Secrets from §6 are the one
|
||||
exception to OwnerReference-based cleanup generally: they live in the
|
||||
operator's own namespace regardless of where their owning CR lives, so
|
||||
`OwnerReference` doesn't apply (cross-namespace) and cleanup instead runs
|
||||
through that CR's finalizer directly, alongside the server-side DELETE
|
||||
@@ -640,10 +686,10 @@ documented and tested operationally:
|
||||
|
||||
- The operator's own ServiceAccount needs, per namespace it's granted:
|
||||
`get/list/watch/create/update/patch/delete` on `Deployments`, `Services`
|
||||
it owns, and `get/list/watch` on `postgresql.acid.zalan.do` (optional,
|
||||
degrade gracefully if absent per §8), plus cluster-wide `get/list` on
|
||||
`Namespace` (labels only, for `allowedTeams: {from: Selector}` evaluation
|
||||
— §4.1, §4.6).
|
||||
and `PodDisruptionBudgets` it owns, and `get/list/watch` on
|
||||
`postgresql.acid.zalan.do` (optional, degrade gracefully if absent per
|
||||
§8), plus cluster-wide `get/list` on `Namespace` (labels only, for
|
||||
`allowedTeams: {from: Selector}` evaluation — §4.1, §4.6).
|
||||
- **Two different `Secret` scopes, not one — corrected from an earlier draft
|
||||
of this section.** That earlier draft said `Secret` access was "scoped to
|
||||
the operator's own namespace only... nowhere else," reasoning that with
|
||||
@@ -784,6 +830,14 @@ what it was, a separate install, until someone deletes it.
|
||||
a one-off exercise.
|
||||
- Gitops-managed team *membership* (see §4.2).
|
||||
- Automatic Deployment restart on upstream Postgres credential rotation.
|
||||
- `spec.pod.priorityClassName`, pod-label passthrough beyond
|
||||
`spec.pod.annotations`, and a HorizontalPodAutoscaler for `TerdutServer`
|
||||
— all considered alongside §4.1's `spec.pod` and left out of that round.
|
||||
An HPA no longer contradicts anything now that `spec.replicas` defaults
|
||||
to 2 (terdut-server v0.36.0's advisory locks), but it is still a
|
||||
separate, not-yet-made decision: a fixed replica count has no scaling
|
||||
metric, min/max bounds, or cooldown behaviour to get right, and nobody
|
||||
has asked for it yet.
|
||||
- Admission webhooks / CEL-only validation limits (e.g. verifying a
|
||||
`teamRef` exists at admission time rather than surfacing it as a status
|
||||
condition after the fact).
|
||||
|
||||
+10
-8
@@ -72,15 +72,17 @@ New commits build forward over the old ones; no git history rewrite.
|
||||
individual keys, so there's nothing to undo there regardless.
|
||||
- RBAC: read-only watch on `postgresql.acid.zalan.do`, degrading gracefully
|
||||
if that CRD isn't installed (§8, §9).
|
||||
- Shipped, scoped down from §8's full ambition in two ways, both called out
|
||||
in code rather than silently dropped: no live watch on the Zalando-
|
||||
- Shipped, scoped down from §8's full ambition in one way, called out in
|
||||
code rather than silently dropped: no live watch on the Zalando-
|
||||
generated credentials Secret for rotation (relies on the periodic resync
|
||||
to notice eventually, higher latency than a watch); no Gateway API
|
||||
`HTTPRoute` creation from `spec.networking.hostname`/`gatewayListener`
|
||||
(needs the Gateway API types as a new dependency, and nothing about
|
||||
proving a `TerdutServer` boots and bootstraps a real server depends on
|
||||
external ingress existing). Both are near-term follow-ups, not deferred
|
||||
to a later stage.
|
||||
to notice eventually, higher latency than a watch). A near-term
|
||||
follow-up, not deferred to a later stage.
|
||||
- External exposure (a Gateway API `HTTPRoute` from
|
||||
`spec.networking.hostname`) was originally sketched here too, as a
|
||||
second near-term follow-up alongside the one above. It's since become an
|
||||
explicit, permanent non-goal instead (DESIGN.md §1): the operator will
|
||||
never manage ingress/exposure for `TerdutServer` in any form. See
|
||||
`examples/networking` for how to do that yourself.
|
||||
- `envtest` covering Deployment/Service reconciliation and both database
|
||||
paths — the Zalando path needs that CRD's schema vendored into the test
|
||||
environment (there's no real `postgres-operator` controller in `envtest`,
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
package v1alpha1
|
||||
|
||||
import (
|
||||
corev1 "k8s.io/api/core/v1"
|
||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
"k8s.io/apimachinery/pkg/runtime"
|
||||
"k8s.io/apimachinery/pkg/util/intstr"
|
||||
)
|
||||
|
||||
// SecretKeyRef names one data key inside a Secret. Every use of this type in
|
||||
@@ -29,33 +31,28 @@ type ImageSpec struct {
|
||||
Tag string `json:"tag"`
|
||||
}
|
||||
|
||||
// NetworkingSpec is how this TerdutServer is reached from outside the
|
||||
// cluster.
|
||||
//
|
||||
// hostname/gatewayListener describe the intended Gateway API HTTPRoute
|
||||
// (matching charts/terdut-server's own templates/httpproxy.yaml, despite its
|
||||
// name — that chart carries a Gateway API HTTPRoute, not a Contour
|
||||
// HTTPProxy), but creating that HTTPRoute isn't implemented yet: it needs
|
||||
// the Gateway API types as a new dependency, and nothing about proving a
|
||||
// TerdutServer boots and bootstraps a real server depends on external
|
||||
// ingress existing. Tracked as a near-term follow-up, not deferred to a
|
||||
// later ROADMAP.md stage the way Deployment/database/bootstrap once were.
|
||||
// NetworkingSpec configures terdut-server itself and the plain ClusterIP
|
||||
// Service the operator creates in front of it. It does not expose
|
||||
// TerdutServer outside the cluster in any way, and never will (DESIGN.md
|
||||
// §1 -- a permanent non-goal, not a staged one): exposing it is entirely up
|
||||
// to whoever deploys it -- a Gateway API HTTPRoute, a plain Ingress, an
|
||||
// Istio VirtualService, or nothing at all if it should stay cluster-
|
||||
// internal. See examples/networking for worked examples against the
|
||||
// Service this creates.
|
||||
type NetworkingSpec struct {
|
||||
// hostname the HTTPRoute will carry once it exists.
|
||||
// hostname is terdut-server's own public URL (TERDUT_PUBLIC_URL) --
|
||||
// used for absolute links terdut-server generates itself
|
||||
// (notifications, OIDC redirect URIs), not read by this operator for
|
||||
// anything ingress-related. Set it to whatever hostname your own
|
||||
// exposure mechanism, if any, actually serves this on.
|
||||
// +optional
|
||||
Hostname string `json:"hostname,omitempty"`
|
||||
|
||||
// servicePort is both the Service's port and the HTTPRoute's backend
|
||||
// port once it exists. Defaults to 8080, matching the chart's own
|
||||
// service.port default.
|
||||
// servicePort is both the container's port and the ClusterIP Service's
|
||||
// port. Defaults to 8080, matching the chart's own service.port default.
|
||||
// +kubebuilder:default=8080
|
||||
// +optional
|
||||
ServicePort int32 `json:"servicePort,omitempty"`
|
||||
|
||||
// gatewayListener is the HTTPRoute's sectionName once it exists. Empty
|
||||
// attaches to every matching listener, including plaintext HTTP.
|
||||
// +optional
|
||||
GatewayListener string `json:"gatewayListener,omitempty"`
|
||||
}
|
||||
|
||||
// PostgresClusterRef names a Zalando postgres-operator `postgresql` CR
|
||||
@@ -190,6 +187,109 @@ type AllowedTeams struct {
|
||||
Namespaces AllowedTeamsNamespaces `json:"namespaces,omitempty"`
|
||||
}
|
||||
|
||||
// PodDisruptionBudgetSpec configures an optional PodDisruptionBudget for
|
||||
// this TerdutServer's Deployment. Exactly one of minAvailable or
|
||||
// maxUnavailable may be set, matching policyv1.PodDisruptionBudgetSpec's own
|
||||
// upstream rule (both wrap intstr.IntOrString unchanged here -- this is pure
|
||||
// passthrough, not reshaped) and mirroring DatabaseSpec's own
|
||||
// dsn/postgresClusterRef mutual-exclusion pattern. Clearing this field
|
||||
// deletes any PodDisruptionBudget the controller previously created for this
|
||||
// TerdutServer (DESIGN.md §7).
|
||||
// +kubebuilder:validation:XValidation:rule="(has(self.minAvailable) ? 1 : 0) + (has(self.maxUnavailable) ? 1 : 0) == 1",message="exactly one of minAvailable or maxUnavailable must be set"
|
||||
type PodDisruptionBudgetSpec struct {
|
||||
// minAvailable -- mutually exclusive with maxUnavailable.
|
||||
// +optional
|
||||
MinAvailable *intstr.IntOrString `json:"minAvailable,omitempty"`
|
||||
|
||||
// maxUnavailable -- mutually exclusive with minAvailable.
|
||||
// +optional
|
||||
MaxUnavailable *intstr.IntOrString `json:"maxUnavailable,omitempty"`
|
||||
}
|
||||
|
||||
// PodSpec is pod-level customization of the Deployment this TerdutServer
|
||||
// creates. Fields here directly reuse corev1 types wherever corev1 already
|
||||
// models the knob exactly, rather than wrapping (unlike SecretKeyRef's own
|
||||
// "wrap only when a round-trip through a different type buys something"
|
||||
// standard would suggest at first glance -- none of these do: Tolerations,
|
||||
// Affinity, TopologySpreadConstraints, Resources, SecurityContext, EnvVar,
|
||||
// EnvFromSource, Volume, VolumeMount and LocalObjectReference are all passed
|
||||
// straight through to the pod template with no added semantics, matching how
|
||||
// CloudNativePG and the Zalando postgres-operator both expose the same
|
||||
// knobs).
|
||||
type PodSpec struct {
|
||||
// annotations are merged onto the pod template's own metadata.
|
||||
// Operator-managed labels (labelsFor) are never touched by this field.
|
||||
// +optional
|
||||
Annotations map[string]string `json:"annotations,omitempty"`
|
||||
|
||||
// +optional
|
||||
NodeSelector map[string]string `json:"nodeSelector,omitempty"`
|
||||
|
||||
// +optional
|
||||
Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
|
||||
|
||||
// affinity covers node affinity, pod affinity and pod anti-affinity in
|
||||
// one field -- even though replicas now defaults to 2 (see
|
||||
// TerdutServerSpec.Replicas's own doc comment), this operator still
|
||||
// never generates a default anti-affinity of its own the way a
|
||||
// multi-replica-aware operator typically would, so this stays pure
|
||||
// user-supplied passthrough, not a toggle-plus-generated-default.
|
||||
// +optional
|
||||
Affinity *corev1.Affinity `json:"affinity,omitempty"`
|
||||
|
||||
// +optional
|
||||
TopologySpreadConstraints []corev1.TopologySpreadConstraint `json:"topologySpreadConstraints,omitempty"`
|
||||
|
||||
// resources applied to the main terdut-server container. Unset today --
|
||||
// this field closes a pre-existing gap, not a behavior change for
|
||||
// anyone not setting it.
|
||||
// +optional
|
||||
Resources corev1.ResourceRequirements `json:"resources,omitempty"`
|
||||
|
||||
// securityContext is pod-level.
|
||||
// +optional
|
||||
SecurityContext *corev1.PodSecurityContext `json:"securityContext,omitempty"`
|
||||
|
||||
// containerSecurityContext applies to the main terdut-server container
|
||||
// only -- not wait-for-postgres, which runs a stock postgres image this
|
||||
// operator doesn't control the entrypoint of. No implicit defaults are
|
||||
// merged underneath it.
|
||||
// +optional
|
||||
ContainerSecurityContext *corev1.SecurityContext `json:"containerSecurityContext,omitempty"`
|
||||
|
||||
// serviceAccountName. Defaults to "default", same as any pod that
|
||||
// doesn't set it.
|
||||
// +optional
|
||||
ServiceAccountName string `json:"serviceAccountName,omitempty"`
|
||||
|
||||
// extraEnv is appended after the fixed env vars buildEnv produces.
|
||||
// +optional
|
||||
ExtraEnv []corev1.EnvVar `json:"extraEnv,omitempty"`
|
||||
|
||||
// +optional
|
||||
ExtraEnvFrom []corev1.EnvFromSource `json:"extraEnvFrom,omitempty"`
|
||||
|
||||
// extraVolumes are added to the pod spec; pair with extraVolumeMounts to
|
||||
// actually mount one on the main container.
|
||||
// +optional
|
||||
ExtraVolumes []corev1.Volume `json:"extraVolumes,omitempty"`
|
||||
|
||||
// extraVolumeMounts are added to the main terdut-server container only
|
||||
// -- not wait-for-postgres.
|
||||
// +optional
|
||||
ExtraVolumeMounts []corev1.VolumeMount `json:"extraVolumeMounts,omitempty"`
|
||||
|
||||
// +optional
|
||||
ImagePullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"`
|
||||
|
||||
// disruptionBudget, when set, causes the controller to reconcile a
|
||||
// policyv1.PodDisruptionBudget selecting this TerdutServer's pods.
|
||||
// Removing this field deletes any PodDisruptionBudget the controller
|
||||
// previously created.
|
||||
// +optional
|
||||
DisruptionBudget *PodDisruptionBudgetSpec `json:"disruptionBudget,omitempty"`
|
||||
}
|
||||
|
||||
// TerdutServerSpec defines the desired state of TerdutServer.
|
||||
//
|
||||
// The operator creates and owns every TerdutServer it manages (DESIGN.md
|
||||
@@ -201,10 +301,14 @@ type TerdutServerSpec struct {
|
||||
// +required
|
||||
Image ImageSpec `json:"image"`
|
||||
|
||||
// replicas. terdut-server is not horizontally-scale-tested; keep this
|
||||
// at its default of 1 unless you've verified otherwise -- the sweeper
|
||||
// and the notifier are unsynchronised singletons.
|
||||
// +kubebuilder:default=1
|
||||
// replicas. Defaults to 2: terdut-server v0.36.0 put the sweeper, the
|
||||
// notifier and the migration runner each behind a Postgres advisory
|
||||
// lock, and gave incident creation its own conflict resolution, so
|
||||
// more than one replica no longer double-pages, races a migration, or
|
||||
// drops a webhook payload. image.tag must be v0.36.0 or newer for
|
||||
// that to hold -- an older terdut-server has none of these guards,
|
||||
// and this field does not check the tag for you.
|
||||
// +kubebuilder:default=2
|
||||
// +optional
|
||||
Replicas int32 `json:"replicas,omitempty"`
|
||||
|
||||
@@ -237,6 +341,11 @@ type TerdutServerSpec struct {
|
||||
// this CRD's schema doesn't need a breaking change to grow it later.
|
||||
// +optional
|
||||
AllowedTeams AllowedTeams `json:"allowedTeams,omitempty"`
|
||||
|
||||
// pod is pod-level customization of the Deployment this TerdutServer
|
||||
// creates (DESIGN.md §4.1).
|
||||
// +optional
|
||||
Pod PodSpec `json:"pod,omitempty"`
|
||||
}
|
||||
|
||||
// Condition types this controller sets on TerdutServer.
|
||||
|
||||
@@ -27,6 +27,42 @@ type TerdutTeamOIDC struct {
|
||||
OwnerGroup string `json:"ownerGroup,omitempty"`
|
||||
}
|
||||
|
||||
// TerdutTeamInvite requests a standing invite link into this team, minted
|
||||
// with the team's own team-scoped credential — requireTeamOwner already
|
||||
// treats that credential as owner-equivalent for every /invites route
|
||||
// (ratified, not a gap, as of terdut-server's SERVICE-ACCOUNTS.md). This is
|
||||
// the real answer to "how does a human ever get a first login on a
|
||||
// password-only, operator-managed install" (terdut-server#23): no signup_mode
|
||||
// flip, no admin token, just a link redeemed the same way anyone else's
|
||||
// invite would be.
|
||||
type TerdutTeamInvite struct {
|
||||
// enabled mints (and keeps refreshed ahead of terdut-server's own fixed
|
||||
// 7-day TTL) an invite link while true. Flipping it back to false
|
||||
// revokes the current one server-side rather than leaving it to expire
|
||||
// on its own.
|
||||
// +optional
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
|
||||
// role is what the invite grants: member or owner. Defaults to member —
|
||||
// owner by default would make every invite link a standing
|
||||
// administrative credential for the team, a much bigger blast radius
|
||||
// than "let a human see the queue".
|
||||
// +optional
|
||||
// +kubebuilder:validation:Enum=member;owner
|
||||
// +kubebuilder:default=member
|
||||
Role string `json:"role,omitempty"`
|
||||
|
||||
// maxUses bounds how many times this link may be redeemed before it
|
||||
// stops working, mirroring terdut-server's own 1-100 range
|
||||
// (POST /api/teams/{teamID}/invites). Defaults to 1: a link meant for
|
||||
// one specific person, not a standing door.
|
||||
// +optional
|
||||
// +kubebuilder:validation:Minimum=1
|
||||
// +kubebuilder:validation:Maximum=100
|
||||
// +kubebuilder:default=1
|
||||
MaxUses int64 `json:"maxUses,omitempty"`
|
||||
}
|
||||
|
||||
// TerdutTeamSpec defines the desired state of TerdutTeam.
|
||||
type TerdutTeamSpec struct {
|
||||
// serverRef names the TerdutServer this team belongs to.
|
||||
@@ -43,6 +79,9 @@ type TerdutTeamSpec struct {
|
||||
|
||||
// +optional
|
||||
OIDC TerdutTeamOIDC `json:"oidc,omitempty"`
|
||||
|
||||
// +optional
|
||||
Invite TerdutTeamInvite `json:"invite,omitempty"`
|
||||
}
|
||||
|
||||
// Condition reasons this controller sets.
|
||||
@@ -62,6 +101,19 @@ const (
|
||||
ReasonTeamAdopted = "Adopted"
|
||||
)
|
||||
|
||||
// Condition reasons for spec.invite reconciliation (TerdutTeamInvite). Not
|
||||
// surfaced on the Ready condition itself — an invite is a convenience, not
|
||||
// a dependency anything else in this team's own readiness waits on — but
|
||||
// recorded as Events and readable via `kubectl describe`.
|
||||
const (
|
||||
// ReasonInviteMinted: spec.invite.enabled is true and status.inviteSecretRef
|
||||
// is populated and live.
|
||||
ReasonInviteMinted = "InviteMinted"
|
||||
// ReasonInviteRevoked: spec.invite.enabled flipped back to false and the
|
||||
// server-side invite was revoked (or there was nothing to revoke).
|
||||
ReasonInviteRevoked = "InviteRevoked"
|
||||
)
|
||||
|
||||
// TerdutTeamStatus defines the observed state of TerdutTeam.
|
||||
type TerdutTeamStatus struct {
|
||||
// +listType=map
|
||||
@@ -87,6 +139,17 @@ type TerdutTeamStatus struct {
|
||||
// +optional
|
||||
ServerEndpoint string `json:"serverEndpoint,omitempty"`
|
||||
|
||||
// inviteSecretRef is this team's current invite link, if spec.invite.enabled.
|
||||
// Unlike credentialsSecretRef, this lives in the TerdutTeam's OWN
|
||||
// namespace, not the operator's: an invite is bounded, limited-use, and
|
||||
// meant for this namespace's own human operators to read and hand out,
|
||||
// not a durable high-privilege credential — same shape as
|
||||
// TerdutAlertSource's status.webhookURLSecretRef, not TerdutServer's
|
||||
// cross-namespace credentialsSecretRef. Nil whenever spec.invite.enabled
|
||||
// is false or unset.
|
||||
// +optional
|
||||
InviteSecretRef *LocalSecretRef `json:"inviteSecretRef,omitempty"`
|
||||
|
||||
// +optional
|
||||
ObservedGeneration int64 `json:"observedGeneration,omitempty"`
|
||||
}
|
||||
|
||||
@@ -5,8 +5,10 @@
|
||||
package v1alpha1
|
||||
|
||||
import (
|
||||
corev1 "k8s.io/api/core/v1"
|
||||
"k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
"k8s.io/apimachinery/pkg/runtime"
|
||||
"k8s.io/apimachinery/pkg/util/intstr"
|
||||
)
|
||||
|
||||
// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
|
||||
@@ -210,6 +212,128 @@ func (in *OIDCSpec) DeepCopy() *OIDCSpec {
|
||||
return out
|
||||
}
|
||||
|
||||
// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
|
||||
func (in *PodDisruptionBudgetSpec) DeepCopyInto(out *PodDisruptionBudgetSpec) {
|
||||
*out = *in
|
||||
if in.MinAvailable != nil {
|
||||
in, out := &in.MinAvailable, &out.MinAvailable
|
||||
*out = new(intstr.IntOrString)
|
||||
**out = **in
|
||||
}
|
||||
if in.MaxUnavailable != nil {
|
||||
in, out := &in.MaxUnavailable, &out.MaxUnavailable
|
||||
*out = new(intstr.IntOrString)
|
||||
**out = **in
|
||||
}
|
||||
}
|
||||
|
||||
// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PodDisruptionBudgetSpec.
|
||||
func (in *PodDisruptionBudgetSpec) DeepCopy() *PodDisruptionBudgetSpec {
|
||||
if in == nil {
|
||||
return nil
|
||||
}
|
||||
out := new(PodDisruptionBudgetSpec)
|
||||
in.DeepCopyInto(out)
|
||||
return out
|
||||
}
|
||||
|
||||
// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
|
||||
func (in *PodSpec) DeepCopyInto(out *PodSpec) {
|
||||
*out = *in
|
||||
if in.Annotations != nil {
|
||||
in, out := &in.Annotations, &out.Annotations
|
||||
*out = make(map[string]string, len(*in))
|
||||
for key, val := range *in {
|
||||
(*out)[key] = val
|
||||
}
|
||||
}
|
||||
if in.NodeSelector != nil {
|
||||
in, out := &in.NodeSelector, &out.NodeSelector
|
||||
*out = make(map[string]string, len(*in))
|
||||
for key, val := range *in {
|
||||
(*out)[key] = val
|
||||
}
|
||||
}
|
||||
if in.Tolerations != nil {
|
||||
in, out := &in.Tolerations, &out.Tolerations
|
||||
*out = make([]corev1.Toleration, len(*in))
|
||||
for i := range *in {
|
||||
(*in)[i].DeepCopyInto(&(*out)[i])
|
||||
}
|
||||
}
|
||||
if in.Affinity != nil {
|
||||
in, out := &in.Affinity, &out.Affinity
|
||||
*out = new(corev1.Affinity)
|
||||
(*in).DeepCopyInto(*out)
|
||||
}
|
||||
if in.TopologySpreadConstraints != nil {
|
||||
in, out := &in.TopologySpreadConstraints, &out.TopologySpreadConstraints
|
||||
*out = make([]corev1.TopologySpreadConstraint, len(*in))
|
||||
for i := range *in {
|
||||
(*in)[i].DeepCopyInto(&(*out)[i])
|
||||
}
|
||||
}
|
||||
in.Resources.DeepCopyInto(&out.Resources)
|
||||
if in.SecurityContext != nil {
|
||||
in, out := &in.SecurityContext, &out.SecurityContext
|
||||
*out = new(corev1.PodSecurityContext)
|
||||
(*in).DeepCopyInto(*out)
|
||||
}
|
||||
if in.ContainerSecurityContext != nil {
|
||||
in, out := &in.ContainerSecurityContext, &out.ContainerSecurityContext
|
||||
*out = new(corev1.SecurityContext)
|
||||
(*in).DeepCopyInto(*out)
|
||||
}
|
||||
if in.ExtraEnv != nil {
|
||||
in, out := &in.ExtraEnv, &out.ExtraEnv
|
||||
*out = make([]corev1.EnvVar, len(*in))
|
||||
for i := range *in {
|
||||
(*in)[i].DeepCopyInto(&(*out)[i])
|
||||
}
|
||||
}
|
||||
if in.ExtraEnvFrom != nil {
|
||||
in, out := &in.ExtraEnvFrom, &out.ExtraEnvFrom
|
||||
*out = make([]corev1.EnvFromSource, len(*in))
|
||||
for i := range *in {
|
||||
(*in)[i].DeepCopyInto(&(*out)[i])
|
||||
}
|
||||
}
|
||||
if in.ExtraVolumes != nil {
|
||||
in, out := &in.ExtraVolumes, &out.ExtraVolumes
|
||||
*out = make([]corev1.Volume, len(*in))
|
||||
for i := range *in {
|
||||
(*in)[i].DeepCopyInto(&(*out)[i])
|
||||
}
|
||||
}
|
||||
if in.ExtraVolumeMounts != nil {
|
||||
in, out := &in.ExtraVolumeMounts, &out.ExtraVolumeMounts
|
||||
*out = make([]corev1.VolumeMount, len(*in))
|
||||
for i := range *in {
|
||||
(*in)[i].DeepCopyInto(&(*out)[i])
|
||||
}
|
||||
}
|
||||
if in.ImagePullSecrets != nil {
|
||||
in, out := &in.ImagePullSecrets, &out.ImagePullSecrets
|
||||
*out = make([]corev1.LocalObjectReference, len(*in))
|
||||
copy(*out, *in)
|
||||
}
|
||||
if in.DisruptionBudget != nil {
|
||||
in, out := &in.DisruptionBudget, &out.DisruptionBudget
|
||||
*out = new(PodDisruptionBudgetSpec)
|
||||
(*in).DeepCopyInto(*out)
|
||||
}
|
||||
}
|
||||
|
||||
// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PodSpec.
|
||||
func (in *PodSpec) DeepCopy() *PodSpec {
|
||||
if in == nil {
|
||||
return nil
|
||||
}
|
||||
out := new(PodSpec)
|
||||
in.DeepCopyInto(out)
|
||||
return out
|
||||
}
|
||||
|
||||
// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
|
||||
func (in *PostgresClusterRef) DeepCopyInto(out *PostgresClusterRef) {
|
||||
*out = *in
|
||||
@@ -643,6 +767,7 @@ func (in *TerdutServerSpec) DeepCopyInto(out *TerdutServerSpec) {
|
||||
in.Notify.DeepCopyInto(&out.Notify)
|
||||
in.OIDC.DeepCopyInto(&out.OIDC)
|
||||
in.AllowedTeams.DeepCopyInto(&out.AllowedTeams)
|
||||
in.Pod.DeepCopyInto(&out.Pod)
|
||||
}
|
||||
|
||||
// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TerdutServerSpec.
|
||||
@@ -709,6 +834,21 @@ func (in *TerdutTeam) DeepCopyObject() runtime.Object {
|
||||
return nil
|
||||
}
|
||||
|
||||
// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
|
||||
func (in *TerdutTeamInvite) DeepCopyInto(out *TerdutTeamInvite) {
|
||||
*out = *in
|
||||
}
|
||||
|
||||
// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TerdutTeamInvite.
|
||||
func (in *TerdutTeamInvite) DeepCopy() *TerdutTeamInvite {
|
||||
if in == nil {
|
||||
return nil
|
||||
}
|
||||
out := new(TerdutTeamInvite)
|
||||
in.DeepCopyInto(out)
|
||||
return out
|
||||
}
|
||||
|
||||
// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
|
||||
func (in *TerdutTeamList) DeepCopyInto(out *TerdutTeamList) {
|
||||
*out = *in
|
||||
@@ -776,6 +916,7 @@ func (in *TerdutTeamSpec) DeepCopyInto(out *TerdutTeamSpec) {
|
||||
*out = *in
|
||||
out.ServerRef = in.ServerRef
|
||||
out.OIDC = in.OIDC
|
||||
out.Invite = in.Invite
|
||||
}
|
||||
|
||||
// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TerdutTeamSpec.
|
||||
@@ -803,6 +944,11 @@ func (in *TerdutTeamStatus) DeepCopyInto(out *TerdutTeamStatus) {
|
||||
*out = new(SecretKeyRef)
|
||||
**out = **in
|
||||
}
|
||||
if in.InviteSecretRef != nil {
|
||||
in, out := &in.InviteSecretRef, &out.InviteSecretRef
|
||||
*out = new(LocalSecretRef)
|
||||
**out = **in
|
||||
}
|
||||
}
|
||||
|
||||
// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TerdutTeamStatus.
|
||||
|
||||
@@ -6,8 +6,8 @@ type: application
|
||||
# These fields decide nothing: `make helm-package` passes --version and
|
||||
# --app-version from the release tag (same reasoning as terdut-server's own
|
||||
# chart). They're for whoever reads the tree before a tag exists.
|
||||
version: 0.1.2
|
||||
appVersion: "v0.1.2"
|
||||
version: 0.4.0
|
||||
appVersion: "v0.4.0"
|
||||
|
||||
keywords:
|
||||
- kubernetes
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -63,6 +63,47 @@ spec:
|
||||
create rule, via TEAM-LOOKUP.md).
|
||||
minLength: 1
|
||||
type: string
|
||||
invite:
|
||||
description: |-
|
||||
TerdutTeamInvite requests a standing invite link into this team, minted
|
||||
with the team's own team-scoped credential — requireTeamOwner already
|
||||
treats that credential as owner-equivalent for every /invites route
|
||||
(ratified, not a gap, as of terdut-server's SERVICE-ACCOUNTS.md). This is
|
||||
the real answer to "how does a human ever get a first login on a
|
||||
password-only, operator-managed install" (terdut-server#23): no signup_mode
|
||||
flip, no admin token, just a link redeemed the same way anyone else's
|
||||
invite would be.
|
||||
properties:
|
||||
enabled:
|
||||
description: |-
|
||||
enabled mints (and keeps refreshed ahead of terdut-server's own fixed
|
||||
7-day TTL) an invite link while true. Flipping it back to false
|
||||
revokes the current one server-side rather than leaving it to expire
|
||||
on its own.
|
||||
type: boolean
|
||||
maxUses:
|
||||
default: 1
|
||||
description: |-
|
||||
maxUses bounds how many times this link may be redeemed before it
|
||||
stops working, mirroring terdut-server's own 1-100 range
|
||||
(POST /api/teams/{teamID}/invites). Defaults to 1: a link meant for
|
||||
one specific person, not a standing door.
|
||||
format: int64
|
||||
maximum: 100
|
||||
minimum: 1
|
||||
type: integer
|
||||
role:
|
||||
default: member
|
||||
description: |-
|
||||
role is what the invite grants: member or owner. Defaults to member —
|
||||
owner by default would make every invite link a standing
|
||||
administrative credential for the team, a much bigger blast radius
|
||||
than "let a human see the queue".
|
||||
enum:
|
||||
- member
|
||||
- owner
|
||||
type: string
|
||||
type: object
|
||||
oidc:
|
||||
description: |-
|
||||
TerdutTeamOIDC binds which identity-provider groups grant membership and
|
||||
@@ -171,6 +212,24 @@ spec:
|
||||
- key
|
||||
- name
|
||||
type: object
|
||||
inviteSecretRef:
|
||||
description: |-
|
||||
inviteSecretRef is this team's current invite link, if spec.invite.enabled.
|
||||
Unlike credentialsSecretRef, this lives in the TerdutTeam's OWN
|
||||
namespace, not the operator's: an invite is bounded, limited-use, and
|
||||
meant for this namespace's own human operators to read and hand out,
|
||||
not a durable high-privilege credential — same shape as
|
||||
TerdutAlertSource's status.webhookURLSecretRef, not TerdutServer's
|
||||
cross-namespace credentialsSecretRef. Nil whenever spec.invite.enabled
|
||||
is false or unset.
|
||||
properties:
|
||||
name:
|
||||
description: name is the Secret's name.
|
||||
minLength: 1
|
||||
type: string
|
||||
required:
|
||||
- name
|
||||
type: object
|
||||
observedGeneration:
|
||||
format: int64
|
||||
type: integer
|
||||
|
||||
@@ -58,6 +58,18 @@ rules:
|
||||
verbs:
|
||||
- create
|
||||
- patch
|
||||
- apiGroups:
|
||||
- policy
|
||||
resources:
|
||||
- poddisruptionbudgets
|
||||
verbs:
|
||||
- create
|
||||
- delete
|
||||
- get
|
||||
- list
|
||||
- patch
|
||||
- update
|
||||
- watch
|
||||
- apiGroups:
|
||||
- terdut.ryuvia.com
|
||||
resources:
|
||||
|
||||
@@ -51,4 +51,8 @@ spec:
|
||||
allowedTeams:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
{{- with .Values.terdutServer.pod }}
|
||||
pod:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
@@ -233,12 +233,19 @@ terdutServer:
|
||||
## Required when terdutServer.enabled.
|
||||
# tag: ""
|
||||
|
||||
replicas: 1
|
||||
## Safe above 1 since terdut-server v0.36.0 (image.tag above must be that or
|
||||
## newer): the sweeper, notifier and migration runner are each behind a
|
||||
## Postgres advisory lock, and incident creation resolves its own insert
|
||||
## conflict, matching this CRD's own spec.replicas default.
|
||||
replicas: 2
|
||||
|
||||
networking:
|
||||
## Required when terdutServer.enabled -- the hostname a future
|
||||
## HTTPRoute will carry (see NetworkingSpec's own doc comment: creating
|
||||
## that HTTPRoute isn't implemented yet).
|
||||
## Required when terdutServer.enabled -- terdut-server's own public
|
||||
## URL, used for absolute links it generates itself (notifications,
|
||||
## OIDC redirect URIs). This chart/operator never creates any
|
||||
## ingress/HTTPRoute for it -- see examples/networking in the repo for
|
||||
## how to expose the Service this chart's TerdutServer CR causes to
|
||||
## be created, if you want to expose it at all.
|
||||
# hostname: ""
|
||||
servicePort: 8080
|
||||
|
||||
@@ -270,3 +277,19 @@ terdutServer:
|
||||
|
||||
# allowedTeams: {}
|
||||
|
||||
## Pod-level customization of the Deployment this TerdutServer creates --
|
||||
## see api/v1alpha1/terdutserver_types.go's PodSpec for the full shape
|
||||
## (nodeSelector, tolerations, affinity, topologySpreadConstraints,
|
||||
## securityContext, containerSecurityContext, serviceAccountName,
|
||||
## extraEnv/extraEnvFrom, extraVolumes/extraVolumeMounts,
|
||||
## imagePullSecrets, disruptionBudget). All optional; resources is the
|
||||
## one most installs will want to set, since the container otherwise
|
||||
## runs with no requests/limits at all:
|
||||
# pod:
|
||||
# resources:
|
||||
# requests:
|
||||
# cpu: 100m
|
||||
# memory: 128Mi
|
||||
# limits:
|
||||
# memory: 256Mi
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -60,6 +60,47 @@ spec:
|
||||
create rule, via TEAM-LOOKUP.md).
|
||||
minLength: 1
|
||||
type: string
|
||||
invite:
|
||||
description: |-
|
||||
TerdutTeamInvite requests a standing invite link into this team, minted
|
||||
with the team's own team-scoped credential — requireTeamOwner already
|
||||
treats that credential as owner-equivalent for every /invites route
|
||||
(ratified, not a gap, as of terdut-server's SERVICE-ACCOUNTS.md). This is
|
||||
the real answer to "how does a human ever get a first login on a
|
||||
password-only, operator-managed install" (terdut-server#23): no signup_mode
|
||||
flip, no admin token, just a link redeemed the same way anyone else's
|
||||
invite would be.
|
||||
properties:
|
||||
enabled:
|
||||
description: |-
|
||||
enabled mints (and keeps refreshed ahead of terdut-server's own fixed
|
||||
7-day TTL) an invite link while true. Flipping it back to false
|
||||
revokes the current one server-side rather than leaving it to expire
|
||||
on its own.
|
||||
type: boolean
|
||||
maxUses:
|
||||
default: 1
|
||||
description: |-
|
||||
maxUses bounds how many times this link may be redeemed before it
|
||||
stops working, mirroring terdut-server's own 1-100 range
|
||||
(POST /api/teams/{teamID}/invites). Defaults to 1: a link meant for
|
||||
one specific person, not a standing door.
|
||||
format: int64
|
||||
maximum: 100
|
||||
minimum: 1
|
||||
type: integer
|
||||
role:
|
||||
default: member
|
||||
description: |-
|
||||
role is what the invite grants: member or owner. Defaults to member —
|
||||
owner by default would make every invite link a standing
|
||||
administrative credential for the team, a much bigger blast radius
|
||||
than "let a human see the queue".
|
||||
enum:
|
||||
- member
|
||||
- owner
|
||||
type: string
|
||||
type: object
|
||||
oidc:
|
||||
description: |-
|
||||
TerdutTeamOIDC binds which identity-provider groups grant membership and
|
||||
@@ -168,6 +209,24 @@ spec:
|
||||
- key
|
||||
- name
|
||||
type: object
|
||||
inviteSecretRef:
|
||||
description: |-
|
||||
inviteSecretRef is this team's current invite link, if spec.invite.enabled.
|
||||
Unlike credentialsSecretRef, this lives in the TerdutTeam's OWN
|
||||
namespace, not the operator's: an invite is bounded, limited-use, and
|
||||
meant for this namespace's own human operators to read and hand out,
|
||||
not a durable high-privilege credential — same shape as
|
||||
TerdutAlertSource's status.webhookURLSecretRef, not TerdutServer's
|
||||
cross-namespace credentialsSecretRef. Nil whenever spec.invite.enabled
|
||||
is false or unset.
|
||||
properties:
|
||||
name:
|
||||
description: name is the Secret's name.
|
||||
minLength: 1
|
||||
type: string
|
||||
required:
|
||||
- name
|
||||
type: object
|
||||
observedGeneration:
|
||||
format: int64
|
||||
type: integer
|
||||
|
||||
@@ -52,6 +52,18 @@ rules:
|
||||
verbs:
|
||||
- create
|
||||
- patch
|
||||
- apiGroups:
|
||||
- policy
|
||||
resources:
|
||||
- poddisruptionbudgets
|
||||
verbs:
|
||||
- create
|
||||
- delete
|
||||
- get
|
||||
- list
|
||||
- patch
|
||||
- update
|
||||
- watch
|
||||
- apiGroups:
|
||||
- terdut.ryuvia.com
|
||||
resources:
|
||||
|
||||
@@ -31,3 +31,12 @@ spec:
|
||||
timeout: 15m
|
||||
severity: critical
|
||||
passwordLogin: true
|
||||
# Pod-level customization, all optional -- see PodSpec in
|
||||
# api/v1alpha1/terdutserver_types.go for the full shape (tolerations,
|
||||
# affinity, topologySpreadConstraints, securityContext,
|
||||
# serviceAccountName, extraEnv/extraVolumes, imagePullSecrets,
|
||||
# disruptionBudget, ...). Example:
|
||||
# pod:
|
||||
# resources:
|
||||
# requests: {cpu: 100m, memory: 128Mi}
|
||||
# limits: {memory: 256Mi}
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
metadata:
|
||||
name: terdut-demo-postgres
|
||||
name: terdut-operator-demo-postgres
|
||||
type: Opaque
|
||||
stringData:
|
||||
password: demo-not-a-real-password
|
||||
@@ -18,9 +18,9 @@ stringData:
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: terdut-demo-postgres
|
||||
name: terdut-operator-demo-postgres
|
||||
labels:
|
||||
app: terdut-demo-postgres
|
||||
app: terdut-operator-demo-postgres
|
||||
spec:
|
||||
replicas: 1
|
||||
# Recreate, not RollingUpdate: emptyDir means a new pod starts with an
|
||||
@@ -30,27 +30,32 @@ spec:
|
||||
type: Recreate
|
||||
selector:
|
||||
matchLabels:
|
||||
app: terdut-demo-postgres
|
||||
app: terdut-operator-demo-postgres
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: terdut-demo-postgres
|
||||
app: terdut-operator-demo-postgres
|
||||
spec:
|
||||
containers:
|
||||
- name: postgres
|
||||
image: postgres:17-alpine
|
||||
# Partial, deliberately: the official image's entrypoint needs to
|
||||
# start as root to chown the data directory before it drops
|
||||
# start as root to chown/chmod the data directory before it drops
|
||||
# privileges itself (gosu, to the postgres user) -- forcing
|
||||
# runAsNonRoot here would just refuse to start the container. A
|
||||
# "restricted" PodSecurity namespace warns on that gap rather
|
||||
# than blocking (confirmed server-side against this operator's
|
||||
# own dev cluster), which is an acceptable tradeoff for Postgres
|
||||
# that exists only to be thrown away with the rest of this demo.
|
||||
# runAsNonRoot would just refuse to start the container, and
|
||||
# dropping all capabilities (an earlier version of this file did)
|
||||
# takes CAP_CHOWN/CAP_FOWNER away from that same root user, which
|
||||
# is a different way of breaking the identical startup step:
|
||||
# confirmed the hard way, as `chmod: /var/run/postgresql:
|
||||
# Operation not permitted` in a real pod's logs, not caught by
|
||||
# `kubectl apply --dry-run=server` -- that only checks admission
|
||||
# policy, never whether the container actually boots. A
|
||||
# "restricted" PodSecurity namespace warns on the remaining gap
|
||||
# (no runAsNonRoot) rather than blocking, which is an acceptable
|
||||
# tradeoff for Postgres that exists only to be thrown away with
|
||||
# the rest of this demo.
|
||||
securityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
capabilities:
|
||||
drop: ["ALL"]
|
||||
seccompProfile:
|
||||
type: RuntimeDefault
|
||||
ports:
|
||||
@@ -64,7 +69,7 @@ spec:
|
||||
- name: POSTGRES_PASSWORD
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: terdut-demo-postgres
|
||||
name: terdut-operator-demo-postgres
|
||||
key: password
|
||||
volumeMounts:
|
||||
- name: data
|
||||
@@ -81,10 +86,10 @@ spec:
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: terdut-demo-postgres
|
||||
name: terdut-operator-demo-postgres
|
||||
spec:
|
||||
selector:
|
||||
app: terdut-demo-postgres
|
||||
app: terdut-operator-demo-postgres
|
||||
ports:
|
||||
- name: postgres
|
||||
port: 5432
|
||||
|
||||
@@ -2,27 +2,32 @@
|
||||
# this directory (teams, escalation rules, dead man's switches, alert
|
||||
# sources) references it by name.
|
||||
#
|
||||
# networking.hostname is accepted but not yet acted on: creating the
|
||||
# HTTPRoute for it isn't implemented yet (api/v1alpha1/terdutserver_types.go,
|
||||
# NetworkingSpec's own doc comment) -- this TerdutServer is reachable from
|
||||
# outside the cluster only by port-forwarding its Service, same name as
|
||||
# this object (see README.md).
|
||||
# The operator never creates any ingress/HTTPRoute for this TerdutServer --
|
||||
# that's a permanent non-goal (DESIGN.md §1, NetworkingSpec's own doc
|
||||
# comment), not a missing feature. This demo reaches it only by
|
||||
# port-forwarding its Service, same name as this object (see README.md);
|
||||
# see ../networking for worked examples of exposing it yourself instead.
|
||||
apiVersion: terdut.ryuvia.com/v1alpha1
|
||||
kind: TerdutServer
|
||||
metadata:
|
||||
name: terdut-demo
|
||||
name: terdut-operator-demo
|
||||
spec:
|
||||
image:
|
||||
repository: git.ryuvia.com/niklas/terdut-server
|
||||
tag: v0.33.2
|
||||
# v0.34.0: fixes callerMayManageServiceAccount so an instance-scoped
|
||||
# service account can adopt/rotate a key on a team-scoped account it
|
||||
# didn't just create in the same call -- without this, terdutteam-*
|
||||
# can wedge permanently on exactly the crash-window race this demo
|
||||
# hit live (niklas/terdut-operator#3).
|
||||
tag: v0.34.0
|
||||
replicas: 1
|
||||
networking:
|
||||
hostname: terdut-demo.example
|
||||
hostname: terdut-operator-demo.example
|
||||
servicePort: 8080
|
||||
database:
|
||||
dsn: "postgres://terdut@terdut-demo-postgres:5432/terdut?sslmode=disable"
|
||||
dsn: "postgres://terdut@terdut-operator-demo-postgres:5432/terdut?sslmode=disable"
|
||||
passwordSecretRef:
|
||||
name: terdut-demo-postgres
|
||||
name: terdut-operator-demo-postgres
|
||||
key: password
|
||||
sweeper:
|
||||
staleAfter: 6h
|
||||
|
||||
@@ -7,11 +7,17 @@ kind: TerdutTeam
|
||||
metadata:
|
||||
name: terdutteam-platform
|
||||
spec:
|
||||
# serverRef.namespace omitted: both this and terdut-demo (01-server.yaml)
|
||||
# serverRef.namespace omitted: both this and terdut-operator-demo (01-server.yaml)
|
||||
# live in whatever namespace you apply this directory into, which is the
|
||||
# common case and needs no allowedTeams consent on the TerdutServer side
|
||||
# (DESIGN.md §4.1, §4.6).
|
||||
serverRef:
|
||||
name: terdut-demo
|
||||
name: terdut-operator-demo
|
||||
displayName: Platform
|
||||
# No oidc block: this demo is password-login only (01-server.yaml).
|
||||
# A real invite link, minted via this team's own credential, is how
|
||||
# run-demo.sh's alice actually gets in -- no signup_mode flip, no admin
|
||||
# token (see niklas/terdut-server#23's resolution). Role/maxUses left at
|
||||
# their defaults (member, 1): one link for one person.
|
||||
invite:
|
||||
enabled: true
|
||||
|
||||
@@ -4,5 +4,11 @@ metadata:
|
||||
name: terdutteam-payments
|
||||
spec:
|
||||
serverRef:
|
||||
name: terdut-demo
|
||||
name: terdut-operator-demo
|
||||
displayName: Payments
|
||||
# No spec.invite here, deliberately: run-demo.sh joins alice to this team
|
||||
# through POST /api/teams/{teamID}/members instead (this team's own
|
||||
# credential, same owner-equivalent reach spec.invite relies on, plus her
|
||||
# user id resolved via GET /api/users), once she already has an account
|
||||
# from Platform's invite -- showing both onboarding paths this feature
|
||||
# unlocks, not just the one.
|
||||
|
||||
+51
-27
@@ -10,6 +10,14 @@ This is a demo kit, not a reference deployment: `00-postgres.yaml` runs
|
||||
Postgres with `emptyDir` storage and a password committed in this
|
||||
directory. Throw the whole namespace away when you're done.
|
||||
|
||||
**Want this fully automated instead of walking through it by hand?**
|
||||
`./run-demo.sh` does everything below itself, against a fresh (or
|
||||
already-set-up) `kind` cluster — creates the cluster, installs the
|
||||
operator, applies every CR here, signs `alice` in for real, and fires a
|
||||
few alerts. `./run-demo.sh --help` for the knobs, `./run-demo.sh
|
||||
--teardown` to tear it back down. The rest of this file is the manual
|
||||
walkthrough it automates.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- The operator and its CRDs installed and running (`make install
|
||||
@@ -18,6 +26,17 @@ directory. Throw the whole namespace away when you're done.
|
||||
throwaway resources in. A `kind` cluster is the easy choice.
|
||||
- `kubectl`, `jq`, `curl` on your path.
|
||||
|
||||
**Apply this into a namespace of its own.** Every object name in this
|
||||
directory is prefixed `terdut-operator-demo` specifically so applying it
|
||||
by mistake into some other namespace that already has unrelated objects
|
||||
doesn't collide with them -- but that only helps if this directory's own
|
||||
objects don't collide with *each other* across two applies. Applying it
|
||||
twice into two different namespaces is fine; applying it a second time
|
||||
into a namespace that already has something else named `terdut-demo` (a
|
||||
real install from following `terdut-operator`'s own repo along, say) is
|
||||
exactly the mistake this prefix exists to avoid, and it only works if you
|
||||
don't override these names yourself.
|
||||
|
||||
## Apply it
|
||||
|
||||
```sh
|
||||
@@ -40,52 +59,57 @@ kubectl get terdutservers,terdutteams,terdutescalationrules,terdutdeadmanswitche
|
||||
|
||||
The operator's own Deployment template now carries a `wait-for-postgres`
|
||||
init container (same fix as `charts/terdut-server`'s chart as of v0.33.2),
|
||||
so `terdut-demo`'s pod should come up clean even against this brand-new
|
||||
so `terdut-operator-demo`'s pod should come up clean even against this brand-new
|
||||
Postgres doing its very first boot — no `CrashLoopBackOff` expected here.
|
||||
|
||||
Once `terdut-demo`'s own `Ready` condition is `True`, everything downstream
|
||||
Once `terdut-operator-demo`'s own `Ready` condition is `True`, everything downstream
|
||||
of it should settle within a reconcile interval or two.
|
||||
|
||||
## See the web UI
|
||||
|
||||
The operator doesn't create any external exposure yet
|
||||
(`NetworkingSpec`'s own doc comment in `api/v1alpha1/terdutserver_types.go`
|
||||
— `spec.networking.hostname` is accepted but nothing acts on it), so:
|
||||
The operator never creates any external exposure for a `TerdutServer` --
|
||||
that's a permanent non-goal (DESIGN.md §1), not a missing feature, so this
|
||||
demo just reaches it the simplest way there is:
|
||||
|
||||
```sh
|
||||
kubectl -n terdut-operator-demo port-forward svc/terdut-demo 8080:8080
|
||||
kubectl -n terdut-operator-demo port-forward svc/terdut-operator-demo 8080:8080
|
||||
```
|
||||
|
||||
and open http://localhost:8080.
|
||||
and open http://localhost:8080. See `../networking` for worked examples of
|
||||
exposing it for real (Gateway API, Istio, or a plain `Ingress`) instead.
|
||||
|
||||
### First login
|
||||
|
||||
The operator's own bootstrap (DESIGN.md §6) creates the first user through
|
||||
`/api/bootstrap` and immediately mints itself a service-account token from
|
||||
it — that account has no password, so there's nothing to sign in with yet.
|
||||
`signup_mode` also defaults to `invite_only`, so open signup needs turning
|
||||
on first, using the admin token the operator generated for itself:
|
||||
it, then discards the bootstrap user's own key — nobody ever signs in as
|
||||
that account, and `signup_mode` stays `invite_only` by default. **Don't try
|
||||
to flip it via the operator's own token**: that token is a service account,
|
||||
and `/api/admin/settings` is deliberately human-only on terdut-server
|
||||
(`niklas/terdut-server#23` has the full reasoning — widening that gate was
|
||||
the wrong fix).
|
||||
|
||||
The real path in: `02-team-platform.yaml` turns on `spec.invite`, so
|
||||
Platform's own `TerdutTeam` mints a real invite link with its own
|
||||
already-working team-scoped credential (the same reach that lets it manage
|
||||
its own escalation policy, dead man's switches and integrations — owner-
|
||||
equivalent, confirmed in terdut-server's `SERVICE-ACCOUNTS.md`). Invite
|
||||
redemption bypasses `signup_mode` entirely, so this needs no admin
|
||||
credential at all:
|
||||
|
||||
```sh
|
||||
# Which namespace the operator itself runs in:
|
||||
kubectl get deploy -A -l control-plane=controller-manager
|
||||
|
||||
# The Secret holding the operator's own admin token for this TerdutServer
|
||||
# (cross-namespace from terdut-operator-demo, per DESIGN.md §7):
|
||||
secretname=$(kubectl -n terdut-operator-demo get terdutserver terdut-demo \
|
||||
-o jsonpath='{.status.credentialsSecretRef.name}')
|
||||
token=$(kubectl -n <operator-namespace-from-above> get secret "$secretname" \
|
||||
-o jsonpath='{.data.token}' | base64 -d)
|
||||
|
||||
curl -X PUT http://localhost:8080/api/admin/settings \
|
||||
-H "Authorization: Bearer $token" -H 'Content-Type: application/json' \
|
||||
-d '{"signup_mode":"open"}'
|
||||
secretname=$(kubectl -n terdut-operator-demo get terdutteam terdutteam-platform \
|
||||
-o jsonpath='{.status.inviteSecretRef.name}')
|
||||
url=$(kubectl -n terdut-operator-demo get secret "$secretname" -o jsonpath='{.data.url}' | base64 -d)
|
||||
echo "$url" # open this, or POST /api/signup with {"invite": "<the token after invite=>", ...}
|
||||
```
|
||||
|
||||
Then sign up through the UI as a normal human account. `04-escalation-platform.yaml`
|
||||
names a user `alice` at its first escalation level — sign up as `alice` if
|
||||
you want that level to mean something rather than falling through to
|
||||
on-call after 5 minutes.
|
||||
`04-escalation-platform.yaml` names a user `alice` at its first escalation
|
||||
level — sign up as `alice` if you want that level to mean something rather
|
||||
than falling through to on-call after 5 minutes. `run-demo.sh` does exactly
|
||||
this automatically (and also joins `alice` to Payments, which deliberately
|
||||
has no `spec.invite` of its own — see that file's comment for the second
|
||||
onboarding path this demonstrates).
|
||||
|
||||
## Fire some alerts
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
#
|
||||
# Prerequisites: kubectl context pointed at the demo namespace, jq, curl,
|
||||
# and (in another terminal) a running:
|
||||
# kubectl port-forward svc/terdut-demo 8080:8080
|
||||
# kubectl port-forward svc/terdut-operator-demo 8080:8080
|
||||
set -euo pipefail
|
||||
|
||||
NAMESPACE="${NAMESPACE:-}"
|
||||
|
||||
Executable
+333
@@ -0,0 +1,333 @@
|
||||
#!/usr/bin/env bash
|
||||
# Stands up the complete terdut demo (terdut-operator + every CRD kind this
|
||||
# repo ships + a working local login + a few synthetic incidents) on a kind
|
||||
# cluster, fully automated. Password login only -- this demo kit's own
|
||||
# 01-server.yaml carries no oidc: block at all, so there is nothing to
|
||||
# disable; OIDC is simply absent.
|
||||
#
|
||||
# Usage:
|
||||
# ./run-demo.sh deploy the whole demo (idempotent: safe to
|
||||
# re-run against a cluster that already has it)
|
||||
# ./run-demo.sh --teardown delete the demo namespace (and, if
|
||||
# TEARDOWN_CLUSTER=true, the kind cluster too)
|
||||
# ./run-demo.sh --help
|
||||
#
|
||||
# All of the defaults below are overridable as environment variables.
|
||||
set -euo pipefail
|
||||
|
||||
CLUSTER_NAME="${CLUSTER_NAME:-terdut-demo}"
|
||||
NAMESPACE="${NAMESPACE:-terdut-operator-demo}"
|
||||
OPERATOR_NAMESPACE="${OPERATOR_NAMESPACE:-terdut-operator-system}"
|
||||
RELEASE_NAME="${RELEASE_NAME:-terdut-operator}"
|
||||
|
||||
ALICE_USERNAME="${ALICE_USERNAME:-alice}"
|
||||
ALICE_EMAIL="${ALICE_EMAIL:-alice@terdut-demo.local}"
|
||||
DEMO_PASSWORD="${DEMO_PASSWORD:-terdut-demo-1234}"
|
||||
|
||||
BASE_URL="${BASE_URL:-http://localhost:8080}"
|
||||
LOCAL_PORT="${LOCAL_PORT:-8080}"
|
||||
|
||||
HELM_TIMEOUT="${HELM_TIMEOUT:-180s}"
|
||||
WAIT_TIMEOUT="${WAIT_TIMEOUT:-180s}"
|
||||
|
||||
TEARDOWN_CLUSTER="${TEARDOWN_CLUSTER:-false}"
|
||||
|
||||
PF_PIDFILE="${PF_PIDFILE:-/tmp/terdut-demo-port-forward.pid}"
|
||||
PF_LOGFILE="${PF_LOGFILE:-/tmp/terdut-demo-port-forward.log}"
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
CHART_DIR="$(cd "$SCRIPT_DIR/../.." && pwd)/charts/terdut-operator"
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
log() { printf '[run-demo] %s\n' "$*" >&2; }
|
||||
die() { printf '[run-demo] FAILED: %s\n' "$*" >&2; exit 1; }
|
||||
|
||||
usage() {
|
||||
cat <<EOF
|
||||
Usage: $0 [--teardown|--help]
|
||||
|
||||
Deploys (or tears down) the complete terdut demo on a kind cluster.
|
||||
See the top of this file for every overridable environment variable.
|
||||
EOF
|
||||
}
|
||||
|
||||
# Only kills a port-forward THIS invocation started, so a successful run
|
||||
# never has its background job reaped by its own exit trap.
|
||||
STARTED_PF_PID=""
|
||||
cleanup_on_failure() {
|
||||
local rc=$?
|
||||
if [ "$rc" -ne 0 ] && [ -n "$STARTED_PF_PID" ]; then
|
||||
log "run failed -- stopping the port-forward it started (pid $STARTED_PF_PID)"
|
||||
kill "$STARTED_PF_PID" 2>/dev/null || true
|
||||
fi
|
||||
exit "$rc"
|
||||
}
|
||||
trap cleanup_on_failure EXIT
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# steps
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
preflight() {
|
||||
local missing=()
|
||||
for bin in kubectl kind helm jq curl; do
|
||||
command -v "$bin" >/dev/null 2>&1 || missing+=("$bin")
|
||||
done
|
||||
if [ "${#missing[@]}" -gt 0 ]; then
|
||||
die "missing required tools on PATH: ${missing[*]}"
|
||||
fi
|
||||
}
|
||||
|
||||
ensure_kind_cluster() {
|
||||
case "$(kind get clusters 2>/dev/null)" in
|
||||
*"$CLUSTER_NAME"*)
|
||||
log "kind cluster '$CLUSTER_NAME' already exists, skipping creation" ;;
|
||||
*)
|
||||
log "creating kind cluster '$CLUSTER_NAME'"
|
||||
kind create cluster --name "$CLUSTER_NAME" ;;
|
||||
esac
|
||||
kubectl config use-context "kind-${CLUSTER_NAME}" >/dev/null
|
||||
}
|
||||
|
||||
install_operator() {
|
||||
log "installing terdut-operator into namespace $OPERATOR_NAMESPACE"
|
||||
helm upgrade --install "$RELEASE_NAME" "$CHART_DIR" \
|
||||
--namespace "$OPERATOR_NAMESPACE" --create-namespace \
|
||||
--wait --timeout "$HELM_TIMEOUT" \
|
||||
|| die "helm install of terdut-operator did not become ready"
|
||||
}
|
||||
|
||||
apply_demo() {
|
||||
log "creating namespace $NAMESPACE"
|
||||
kubectl create namespace "$NAMESPACE" --dry-run=client -o yaml | kubectl apply -f - >/dev/null
|
||||
log "applying demo CRs (00-09) into $NAMESPACE"
|
||||
kubectl apply -n "$NAMESPACE" -k "$SCRIPT_DIR" >/dev/null
|
||||
}
|
||||
|
||||
wait_for_ready() {
|
||||
local objects=(
|
||||
"terdutserver/terdut-operator-demo"
|
||||
"terdutteam/terdutteam-platform"
|
||||
"terdutteam/terdutteam-payments"
|
||||
"terdutescalationrule/terdutescalationrule-platform"
|
||||
"terdutescalationrule/terdutescalationrule-payments"
|
||||
"terdutdeadmanswitch/terdutdeadmanswitch-platform"
|
||||
"terdutdeadmanswitch/terdutdeadmanswitch-payments"
|
||||
"terdutalertsource/terdutalertsource-platform"
|
||||
"terdutalertsource/terdutalertsource-payments"
|
||||
)
|
||||
local obj
|
||||
for obj in "${objects[@]}"; do
|
||||
log "waiting for $obj to become Ready"
|
||||
kubectl wait --for=condition=Ready --timeout "$WAIT_TIMEOUT" -n "$NAMESPACE" "$obj" >/dev/null \
|
||||
|| die "timed out waiting for $obj -- try: kubectl describe -n $NAMESPACE $obj"
|
||||
done
|
||||
}
|
||||
|
||||
start_port_forward() {
|
||||
# A stale pidfile from an earlier run would otherwise collide with us on
|
||||
# $LOCAL_PORT -- if that pid is still alive, stop it first.
|
||||
if [ -f "$PF_PIDFILE" ]; then
|
||||
local old_pid
|
||||
old_pid="$(cat "$PF_PIDFILE" 2>/dev/null || true)"
|
||||
if [ -n "$old_pid" ] && kill -0 "$old_pid" 2>/dev/null; then
|
||||
log "stopping stale port-forward from a previous run (pid $old_pid)"
|
||||
kill "$old_pid" 2>/dev/null || true
|
||||
sleep 1
|
||||
fi
|
||||
rm -f "$PF_PIDFILE"
|
||||
fi
|
||||
|
||||
log "starting port-forward svc/terdut-operator-demo ${LOCAL_PORT}:8080"
|
||||
kubectl -n "$NAMESPACE" port-forward svc/terdut-operator-demo "${LOCAL_PORT}:8080" \
|
||||
>"$PF_LOGFILE" 2>&1 &
|
||||
STARTED_PF_PID=$!
|
||||
echo "$STARTED_PF_PID" > "$PF_PIDFILE"
|
||||
|
||||
local tries=0
|
||||
until curl -sf -o /dev/null "http://localhost:${LOCAL_PORT}/healthz"; do
|
||||
tries=$((tries + 1))
|
||||
if [ "$tries" -ge 30 ]; then
|
||||
die "port-forward never became ready -- see $PF_LOGFILE"
|
||||
fi
|
||||
sleep 1
|
||||
done
|
||||
log "port-forward ready (pid $STARTED_PF_PID, log $PF_LOGFILE)"
|
||||
}
|
||||
|
||||
# Redeems Platform's own invite link -- minted by its TerdutTeam
|
||||
# (02-team-platform.yaml's spec.invite.enabled, reconciled through that
|
||||
# team's own already-working team-scoped credential, which requireTeamOwner
|
||||
# already treats as owner-equivalent for /invites -- ratified, not a
|
||||
# workaround, in terdut-server's SERVICE-ACCOUNTS.md) and redeemed through
|
||||
# the ordinary signup endpoint. Invite redemption bypasses signup_mode
|
||||
# entirely (terdut-server's internal/api/signup.go), so this needs no admin
|
||||
# credential, no signup_mode flip, and no direct Postgres access at all --
|
||||
# unlike an earlier version of this script, before terdut-operator grew
|
||||
# this feature (see niklas/terdut-server#23).
|
||||
redeem_platform_invite() {
|
||||
log "reading Platform's invite link"
|
||||
local secret_name invite_url invite_token tries=0
|
||||
until secret_name="$(kubectl -n "$NAMESPACE" get terdutteam terdutteam-platform \
|
||||
-o jsonpath='{.status.inviteSecretRef.name}' 2>/dev/null)" && [ -n "$secret_name" ]; do
|
||||
tries=$((tries + 1))
|
||||
[ "$tries" -lt 30 ] || die "terdutteam-platform never reported status.inviteSecretRef -- check spec.invite.enabled and kubectl describe it"
|
||||
sleep 1
|
||||
done
|
||||
invite_url="$(kubectl -n "$NAMESPACE" get secret "$secret_name" -o jsonpath='{.data.url}' | base64 -d)"
|
||||
invite_token="${invite_url##*invite=}"
|
||||
[ -n "$invite_token" ] || die "could not parse an invite token out of $invite_url"
|
||||
|
||||
log "signing up ${ALICE_USERNAME} via Platform's invite"
|
||||
local body resp_file code
|
||||
body="$(jq -n \
|
||||
--arg u "$ALICE_USERNAME" --arg e "$ALICE_EMAIL" \
|
||||
--arg p "$DEMO_PASSWORD" --arg i "$invite_token" \
|
||||
'{username: $u, email: $e, password: $p, invite: $i}')"
|
||||
resp_file="$(mktemp)"
|
||||
code="$(curl -sS -o "$resp_file" -w '%{http_code}' \
|
||||
-X POST "${BASE_URL}/api/signup" -H 'Content-Type: application/json' -d "$body")"
|
||||
|
||||
case "$code" in
|
||||
201) log "created local account ${ALICE_USERNAME} (joined Platform)" ;;
|
||||
409) log "account ${ALICE_USERNAME} already exists, skipping (re-run detected)" ;;
|
||||
*) die "signup failed (HTTP $code): $(cat "$resp_file")" ;;
|
||||
esac
|
||||
rm -f "$resp_file"
|
||||
}
|
||||
|
||||
# redeem_platform_invite's signup already used up alice's one signup -- a
|
||||
# second POST /api/signup would just 409 on the taken username, it doesn't
|
||||
# join an existing account to another team. Payments is joined through the
|
||||
# ordinary team-scoped member endpoint instead, using that team's own
|
||||
# already-working team-scoped credential (owner-equivalent, same reach the
|
||||
# invite route above relies on) and alice's user id resolved via
|
||||
# GET /api/users -- the same lookup tdclient.GetUserByUsername does
|
||||
# operator-side. The endpoint upserts on (team_id, user_id), so this is
|
||||
# naturally idempotent across re-runs with no separate conflict handling
|
||||
# needed.
|
||||
join_payments_team() {
|
||||
log "adding ${ALICE_USERNAME} to Payments"
|
||||
local payments_id payments_secret payments_key alice_id resp_file code
|
||||
payments_id="$(kubectl -n "$NAMESPACE" get terdutteam terdutteam-payments -o jsonpath='{.status.teamID}')"
|
||||
[ -n "$payments_id" ] || die "could not read status.teamID off terdutteam-payments"
|
||||
payments_secret="$(kubectl -n "$NAMESPACE" get terdutteam terdutteam-payments \
|
||||
-o jsonpath='{.status.credentialsSecretRef.name}')"
|
||||
[ -n "$payments_secret" ] || die "terdutteam-payments has no status.credentialsSecretRef yet"
|
||||
payments_key="$(kubectl -n "$OPERATOR_NAMESPACE" get secret "$payments_secret" -o jsonpath='{.data.token}' | base64 -d)"
|
||||
|
||||
alice_id="$(curl -sS -H "Authorization: Bearer $payments_key" "${BASE_URL}/api/users" \
|
||||
| jq -r --arg u "$ALICE_USERNAME" '.[] | select(.username == $u) | .id')"
|
||||
[ -n "$alice_id" ] || die "could not resolve ${ALICE_USERNAME}'s user id via GET /api/users"
|
||||
|
||||
resp_file="$(mktemp)"
|
||||
code="$(curl -sS -o "$resp_file" -w '%{http_code}' \
|
||||
-X POST "${BASE_URL}/api/teams/${payments_id}/members" \
|
||||
-H "Authorization: Bearer $payments_key" -H 'Content-Type: application/json' \
|
||||
-d "$(jq -n --argjson id "$alice_id" '{user_id: $id, role: "member"}')")"
|
||||
[ "$code" = "204" ] || die "adding ${ALICE_USERNAME} to Payments failed (HTTP $code): $(cat "$resp_file")"
|
||||
log "added ${ALICE_USERNAME} to Payments"
|
||||
rm -f "$resp_file"
|
||||
}
|
||||
|
||||
fire_demo_alerts() {
|
||||
log "firing representative demo alerts"
|
||||
NAMESPACE="$NAMESPACE" BASE_URL="$BASE_URL" "$SCRIPT_DIR/fire-alerts.sh" platform high-cpu
|
||||
NAMESPACE="$NAMESPACE" BASE_URL="$BASE_URL" "$SCRIPT_DIR/fire-alerts.sh" platform disk-full
|
||||
NAMESPACE="$NAMESPACE" BASE_URL="$BASE_URL" "$SCRIPT_DIR/fire-alerts.sh" payments pod-crash
|
||||
}
|
||||
|
||||
print_summary() {
|
||||
cat <<EOF
|
||||
|
||||
terdut demo is up.
|
||||
|
||||
Web UI: http://localhost:${LOCAL_PORT}
|
||||
Login: ${ALICE_USERNAME} / ${DEMO_PASSWORD}
|
||||
Cluster: kind-${CLUSTER_NAME}
|
||||
Namespace: ${NAMESPACE}
|
||||
Port-forward pid: ${STARTED_PF_PID:-$(cat "$PF_PIDFILE" 2>/dev/null || echo unknown)} (log: ${PF_LOGFILE})
|
||||
stop it with: kill \$(cat ${PF_PIDFILE})
|
||||
|
||||
Fire more alerts:
|
||||
export NAMESPACE=${NAMESPACE} BASE_URL=${BASE_URL}
|
||||
./fire-alerts.sh platform high-cpu
|
||||
./fire-alerts.sh platform high-cpu resolve
|
||||
./fire-alerts.sh payments heartbeat # send repeatedly (e.g. every minute)
|
||||
# to keep a dead man's switch alive;
|
||||
# stop sending it and, 15 minutes
|
||||
# later, terdut-server opens a
|
||||
# critical incident on its own.
|
||||
|
||||
Tear down:
|
||||
$0 --teardown
|
||||
# add TEARDOWN_CLUSTER=true to also delete the kind cluster itself
|
||||
EOF
|
||||
}
|
||||
|
||||
teardown() {
|
||||
if [ -f "$PF_PIDFILE" ]; then
|
||||
local pid
|
||||
pid="$(cat "$PF_PIDFILE" 2>/dev/null || true)"
|
||||
if [ -n "$pid" ] && kill -0 "$pid" 2>/dev/null; then
|
||||
log "stopping port-forward (pid $pid)"
|
||||
kill "$pid" 2>/dev/null || true
|
||||
fi
|
||||
rm -f "$PF_PIDFILE"
|
||||
fi
|
||||
|
||||
log "deleting namespace $NAMESPACE"
|
||||
kubectl delete namespace "$NAMESPACE" --ignore-not-found --wait=true --timeout "$WAIT_TIMEOUT"
|
||||
|
||||
if [ "$TEARDOWN_CLUSTER" = "true" ]; then
|
||||
log "deleting kind cluster $CLUSTER_NAME"
|
||||
kind delete cluster --name "$CLUSTER_NAME"
|
||||
else
|
||||
log "leaving kind cluster '$CLUSTER_NAME' and the operator install in place" \
|
||||
"(set TEARDOWN_CLUSTER=true to also delete the cluster)"
|
||||
fi
|
||||
}
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# main
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
main() {
|
||||
case "${1:-}" in
|
||||
--teardown)
|
||||
preflight
|
||||
teardown
|
||||
trap - EXIT
|
||||
exit 0
|
||||
;;
|
||||
--help|-h)
|
||||
usage
|
||||
trap - EXIT
|
||||
exit 0
|
||||
;;
|
||||
"") ;;
|
||||
*)
|
||||
usage
|
||||
die "unknown argument: $1"
|
||||
;;
|
||||
esac
|
||||
|
||||
preflight
|
||||
ensure_kind_cluster
|
||||
install_operator
|
||||
apply_demo
|
||||
wait_for_ready
|
||||
start_port_forward
|
||||
redeem_platform_invite
|
||||
join_payments_team
|
||||
fire_demo_alerts
|
||||
print_summary
|
||||
|
||||
# Success: leave the port-forward running, don't let the EXIT trap kill it.
|
||||
trap - EXIT
|
||||
}
|
||||
|
||||
main "$@"
|
||||
@@ -0,0 +1,31 @@
|
||||
# Exposing a TerdutServer
|
||||
|
||||
This operator never manages external exposure/ingress for `TerdutServer`,
|
||||
in any form — a permanent non-goal (`DESIGN.md` §1), not a missing
|
||||
feature. Some installs won't expose it outside the cluster at all (see
|
||||
`examples/demo`, which just port-forwards); others will put it behind
|
||||
whatever their cluster already uses. That choice is entirely yours, not
|
||||
the operator's.
|
||||
|
||||
The only contract the operator gives you to build on: a plain `ClusterIP`
|
||||
Service, named after the `TerdutServer` CR (same name, same namespace),
|
||||
with a port named `http` (`spec.networking.servicePort`, default `8080`).
|
||||
Everything here targets exactly that Service — none of it is applied by
|
||||
`examples/demo`'s `kustomization.yaml`, and none of it depends on anything
|
||||
the operator creates beyond that one Service.
|
||||
|
||||
Pick whichever matches your cluster:
|
||||
|
||||
- **`httproute.yaml`** — a [Gateway API](https://gateway-api.sigs.k8s.io/)
|
||||
`HTTPRoute`, attached to a `Gateway` you already have.
|
||||
- **`istio-virtualservice.yaml`** — an Istio `VirtualService`, attached to
|
||||
a `Gateway` (Istio's own CRD, not Gateway API's) you already have.
|
||||
- **A plain `Ingress`** needs no example here — it's the same idea with
|
||||
one fewer layer of indirection: an `Ingress` with a single rule whose
|
||||
`backend.service.name`/`port.name` point at the `TerdutServer`'s Service
|
||||
and `http` port.
|
||||
|
||||
Remember to set `spec.networking.hostname` on the `TerdutServer` itself to
|
||||
whatever hostname you expose it on — that's not read by the operator for
|
||||
any of this, but terdut-server uses it for its own absolute links
|
||||
(notifications, OIDC redirect URIs).
|
||||
@@ -0,0 +1,21 @@
|
||||
# Gateway API HTTPRoute exposing a TerdutServer through a Gateway you
|
||||
# already have (not something this operator creates or watches -- see
|
||||
# ../networking/README.md). Replace terdut-operator-demo and the Gateway
|
||||
# reference/hostname with your own; terdut-operator-demo matches
|
||||
# ../demo/01-server.yaml, if you're layering this onto that demo.
|
||||
apiVersion: gateway.networking.k8s.io/v1
|
||||
kind: HTTPRoute
|
||||
metadata:
|
||||
name: terdut-operator-demo
|
||||
namespace: terdut-operator-demo
|
||||
spec:
|
||||
parentRefs:
|
||||
- name: my-gateway # an existing Gateway in this namespace (or
|
||||
# namespace: gateway-ns # a different one, if the Gateway allows it)
|
||||
sectionName: https # the listener to attach to, if it's picky
|
||||
hostnames:
|
||||
- terdut-operator-demo.example # matches networking.hostname on the CR
|
||||
rules:
|
||||
- backendRefs:
|
||||
- name: terdut-operator-demo # the Service the operator created --
|
||||
port: 8080 # same name as the TerdutServer CR
|
||||
@@ -0,0 +1,23 @@
|
||||
# Istio VirtualService exposing a TerdutServer through an Istio Gateway
|
||||
# you already have (Istio's own Gateway CRD, not Gateway API's -- not
|
||||
# something this operator creates or watches, see ../networking/README.md).
|
||||
# Replace terdut-operator-demo and the gateway reference/hostname with your
|
||||
# own; terdut-operator-demo matches ../demo/01-server.yaml, if you're
|
||||
# layering this onto that demo.
|
||||
apiVersion: networking.istio.io/v1
|
||||
kind: VirtualService
|
||||
metadata:
|
||||
name: terdut-operator-demo
|
||||
namespace: terdut-operator-demo
|
||||
spec:
|
||||
hosts:
|
||||
- terdut-operator-demo.example # matches networking.hostname on the CR
|
||||
gateways:
|
||||
- my-gateway-namespace/my-gateway # an existing istio Gateway
|
||||
http:
|
||||
- route:
|
||||
- destination:
|
||||
host: terdut-operator-demo.terdut-operator-demo.svc.cluster.local
|
||||
port:
|
||||
number: 8080 # the Service's port -- same name as the
|
||||
# TerdutServer CR, default servicePort
|
||||
@@ -8,6 +8,7 @@ import (
|
||||
|
||||
appsv1 "k8s.io/api/apps/v1"
|
||||
corev1 "k8s.io/api/core/v1"
|
||||
policyv1 "k8s.io/api/policy/v1"
|
||||
apierrors "k8s.io/apimachinery/pkg/api/errors"
|
||||
"k8s.io/apimachinery/pkg/api/meta"
|
||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
@@ -97,6 +98,7 @@ type TerdutServerReconciler struct {
|
||||
// +kubebuilder:rbac:groups="",resources=secrets,verbs=get;list;watch;create;update;patch;delete
|
||||
// +kubebuilder:rbac:groups="",resources=services,verbs=get;list;watch;create;update;patch;delete
|
||||
// +kubebuilder:rbac:groups=apps,resources=deployments,verbs=get;list;watch;create;update;patch;delete
|
||||
// +kubebuilder:rbac:groups=policy,resources=poddisruptionbudgets,verbs=get;list;watch;create;update;patch;delete
|
||||
// +kubebuilder:rbac:groups=acid.zalan.do,resources=postgresqls,verbs=get;list;watch
|
||||
// +kubebuilder:rbac:groups=events.k8s.io,resources=events,verbs=create;patch
|
||||
|
||||
@@ -137,6 +139,9 @@ func (r *TerdutServerReconciler) Reconcile(ctx context.Context, req ctrl.Request
|
||||
if err := r.reconcileService(ctx, &srv); err != nil {
|
||||
return ctrl.Result{}, err
|
||||
}
|
||||
if err := r.reconcilePodDisruptionBudget(ctx, &srv); err != nil {
|
||||
return ctrl.Result{}, err
|
||||
}
|
||||
|
||||
meta.SetStatusCondition(&srv.Status.Conditions, metav1.Condition{
|
||||
Type: terdutv1alpha1.ConditionDatabaseReady,
|
||||
@@ -246,6 +251,7 @@ func (r *TerdutServerReconciler) SetupWithManager(mgr ctrl.Manager) error {
|
||||
For(&terdutv1alpha1.TerdutServer{}).
|
||||
Owns(&appsv1.Deployment{}).
|
||||
Owns(&corev1.Service{}).
|
||||
Owns(&policyv1.PodDisruptionBudget{}).
|
||||
Named("terdutserver").
|
||||
Complete(r)
|
||||
}
|
||||
|
||||
@@ -9,15 +9,20 @@ import (
|
||||
"strconv"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
. "github.com/onsi/ginkgo/v2"
|
||||
. "github.com/onsi/gomega"
|
||||
appsv1 "k8s.io/api/apps/v1"
|
||||
corev1 "k8s.io/api/core/v1"
|
||||
policyv1 "k8s.io/api/policy/v1"
|
||||
apierrors "k8s.io/apimachinery/pkg/api/errors"
|
||||
"k8s.io/apimachinery/pkg/api/meta"
|
||||
"k8s.io/apimachinery/pkg/api/resource"
|
||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
|
||||
"k8s.io/apimachinery/pkg/types"
|
||||
"k8s.io/apimachinery/pkg/util/intstr"
|
||||
ctrl "sigs.k8s.io/controller-runtime"
|
||||
"sigs.k8s.io/controller-runtime/pkg/reconcile"
|
||||
|
||||
@@ -31,6 +36,11 @@ import (
|
||||
const (
|
||||
fakeVersionString = "test"
|
||||
errJSONKey = "error"
|
||||
// deadmanSwitchesPath is the literal path (not Printf'd like the others
|
||||
// below) shared by the exact-match collection route and the dispatcher
|
||||
// that routes into it -- goconst flags three occurrences of the same
|
||||
// string, so this is that string, once.
|
||||
deadmanSwitchesPath = "/deadman/switches"
|
||||
)
|
||||
|
||||
// fakeTerdutServer reproduces the exact stateful semantics of
|
||||
@@ -79,6 +89,14 @@ type fakeTerdutServer struct {
|
||||
nextIntegrationID int64
|
||||
integrations map[int64]map[int64]tdclient.Integration // teamID -> integrationID -> integration
|
||||
integrationDelete map[int64]bool // integrationID -> true once DELETEd, for 404-on-redelete
|
||||
|
||||
// invites/nextInviteID/inviteDelete back TerdutTeam's own invite-minting
|
||||
// feature -- no unique constraint on an invite server-side either (every
|
||||
// POST mints a brand new row, confirmed against source), same keyed-by-id
|
||||
// shape as switches/integrations.
|
||||
nextInviteID int64
|
||||
invites map[int64]map[int64]tdclient.Invite // teamID -> inviteID -> invite
|
||||
inviteDelete map[int64]bool // inviteID -> true once DELETEd, for 404-on-redelete
|
||||
}
|
||||
|
||||
func newFakeTerdutServer() (*fakeTerdutServer, *httptest.Server) {
|
||||
@@ -96,6 +114,9 @@ func newFakeTerdutServer() (*fakeTerdutServer, *httptest.Server) {
|
||||
|
||||
integrations: map[int64]map[int64]tdclient.Integration{},
|
||||
integrationDelete: map[int64]bool{},
|
||||
|
||||
invites: map[int64]map[int64]tdclient.Invite{},
|
||||
inviteDelete: map[int64]bool{},
|
||||
}
|
||||
return f, httptest.NewServer(f)
|
||||
}
|
||||
@@ -261,7 +282,26 @@ func (f *fakeTerdutServer) handleTeamSubPath(w http.ResponseWriter, r *http.Requ
|
||||
f.escalation[id] = req
|
||||
w.WriteHeader(http.StatusNoContent)
|
||||
|
||||
case rest == "/deadman/switches" && r.Method == http.MethodGet:
|
||||
case rest == deadmanSwitchesPath || strings.HasPrefix(rest, deadmanSwitchesPath+"/"):
|
||||
f.handleDeadmanSubPath(w, r, id, rest)
|
||||
|
||||
case rest == "/integrations" || strings.HasPrefix(rest, "/integrations/"):
|
||||
f.handleIntegrationSubPath(w, r, id, rest)
|
||||
|
||||
case rest == "/invites" || strings.HasPrefix(rest, "/invites/"):
|
||||
f.handleInviteSubPath(w, r, id, rest)
|
||||
|
||||
default:
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
}
|
||||
}
|
||||
|
||||
// handleDeadmanSubPath answers GET/POST /api/teams/{id}/deadman/switches and
|
||||
// PUT/DELETE .../deadman/switches/{switchID} -- split out of
|
||||
// handleTeamSubPath for the same gocyclo reason as handleIntegrationSubPath.
|
||||
func (f *fakeTerdutServer) handleDeadmanSubPath(w http.ResponseWriter, r *http.Request, id int64, rest string) {
|
||||
switch {
|
||||
case rest == deadmanSwitchesPath && r.Method == http.MethodGet:
|
||||
existing := f.switches[id]
|
||||
out := make([]tdclient.DeadmanSwitch, 0, len(existing))
|
||||
for _, s := range existing {
|
||||
@@ -269,7 +309,7 @@ func (f *fakeTerdutServer) handleTeamSubPath(w http.ResponseWriter, r *http.Requ
|
||||
}
|
||||
writeJSON(w, http.StatusOK, out)
|
||||
|
||||
case rest == "/deadman/switches" && r.Method == http.MethodPost:
|
||||
case rest == deadmanSwitchesPath && r.Method == http.MethodPost:
|
||||
var req deadmanSwitchFakeRequest
|
||||
_ = json.NewDecoder(r.Body).Decode(&req)
|
||||
f.nextSwitchID++
|
||||
@@ -324,8 +364,48 @@ func (f *fakeTerdutServer) handleTeamSubPath(w http.ResponseWriter, r *http.Requ
|
||||
f.switchDelete[switchID] = true
|
||||
w.WriteHeader(http.StatusNoContent)
|
||||
|
||||
case rest == "/integrations" || strings.HasPrefix(rest, "/integrations/"):
|
||||
f.handleIntegrationSubPath(w, r, id, rest)
|
||||
default:
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
}
|
||||
}
|
||||
|
||||
// handleInviteSubPath answers POST /api/teams/{id}/invites and
|
||||
// DELETE .../invites/{inviteID} -- split out for the same gocyclo reason as
|
||||
// handleIntegrationSubPath.
|
||||
func (f *fakeTerdutServer) handleInviteSubPath(w http.ResponseWriter, r *http.Request, id int64, rest string) {
|
||||
switch {
|
||||
case rest == "/invites" && r.Method == http.MethodPost:
|
||||
var req struct {
|
||||
Role string `json:"role"`
|
||||
MaxUses int64 `json:"max_uses"`
|
||||
}
|
||||
_ = json.NewDecoder(r.Body).Decode(&req)
|
||||
f.nextInviteID++
|
||||
inviteID := f.nextInviteID
|
||||
inv := tdclient.Invite{
|
||||
ID: inviteID, TeamID: id, Role: req.Role, MaxUses: req.MaxUses,
|
||||
ExpiresAt: time.Now().Add(7 * 24 * time.Hour),
|
||||
URL: fmt.Sprintf("https://terdut.example.invalid/signup?invite=invite-token-%d", inviteID),
|
||||
}
|
||||
if f.invites[id] == nil {
|
||||
f.invites[id] = map[int64]tdclient.Invite{}
|
||||
}
|
||||
f.invites[id][inviteID] = inv
|
||||
writeJSON(w, http.StatusCreated, inv)
|
||||
|
||||
case strings.HasPrefix(rest, "/invites/") && r.Method == http.MethodDelete:
|
||||
inviteID, ok := parseTrailingID(rest, "/invites/")
|
||||
if !ok {
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
return
|
||||
}
|
||||
if _, exists := f.invites[id][inviteID]; !exists {
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
return
|
||||
}
|
||||
delete(f.invites[id], inviteID)
|
||||
f.inviteDelete[inviteID] = true
|
||||
w.WriteHeader(http.StatusNoContent)
|
||||
|
||||
default:
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
@@ -705,6 +785,95 @@ var _ = Describe("TerdutServer Controller", func() {
|
||||
})
|
||||
})
|
||||
|
||||
Describe("spec.pod", func() {
|
||||
It("wires pod-level customization onto the right spot on the Deployment", func(ctx SpecContext) {
|
||||
fake, fakeSrv := newFakeTerdutServer()
|
||||
_ = fake
|
||||
DeferCleanup(fakeSrv.Close)
|
||||
reconciler.NewClient = func(string) *tdclient.Client { return tdclient.New(fakeSrv.URL) }
|
||||
|
||||
spec := dsnSpec()
|
||||
qty := resource.MustParse("250m")
|
||||
spec.Pod = terdutv1alpha1.PodSpec{
|
||||
Resources: corev1.ResourceRequirements{Requests: corev1.ResourceList{corev1.ResourceCPU: qty}},
|
||||
Tolerations: []corev1.Toleration{{Key: "dedicated", Operator: corev1.TolerationOpEqual, Value: "terdut", Effect: corev1.TaintEffectNoSchedule}},
|
||||
ExtraEnv: []corev1.EnvVar{{Name: "EXTRA_FLAG", Value: "on"}},
|
||||
ServiceAccountName: "terdut-server-custom",
|
||||
ExtraVolumes: []corev1.Volume{{Name: "extra-ca", VolumeSource: corev1.VolumeSource{EmptyDir: &corev1.EmptyDirVolumeSource{}}}},
|
||||
ExtraVolumeMounts: []corev1.VolumeMount{{Name: "extra-ca", MountPath: "/etc/extra-ca"}},
|
||||
}
|
||||
createServer(ctx, spec)
|
||||
reconcileOnce(ctx) // finalizer
|
||||
reconcileOnce(ctx) // Deployment/Service/PDB
|
||||
|
||||
var deploy appsv1.Deployment
|
||||
Expect(k8sClient.Get(ctx, objKey, &deploy)).To(Succeed())
|
||||
|
||||
podSpec := deploy.Spec.Template.Spec
|
||||
Expect(podSpec.Tolerations).To(ConsistOf(spec.Pod.Tolerations))
|
||||
Expect(podSpec.ServiceAccountName).To(Equal("terdut-server-custom"))
|
||||
Expect(podSpec.Volumes).To(ConsistOf(spec.Pod.ExtraVolumes))
|
||||
|
||||
main := podSpec.Containers[0]
|
||||
Expect(main.Name).To(Equal("terdut-server"))
|
||||
Expect(main.Resources).To(Equal(spec.Pod.Resources))
|
||||
Expect(main.VolumeMounts).To(ConsistOf(spec.Pod.ExtraVolumeMounts))
|
||||
Expect(main.Env).To(ContainElement(corev1.EnvVar{Name: "EXTRA_FLAG", Value: "on"}))
|
||||
|
||||
initContainer := podSpec.InitContainers[0]
|
||||
Expect(initContainer.Name).To(Equal("wait-for-postgres"))
|
||||
Expect(initContainer.VolumeMounts).To(BeEmpty(), "extraVolumeMounts must not leak onto wait-for-postgres")
|
||||
})
|
||||
})
|
||||
|
||||
Describe("spec.pod.disruptionBudget", func() {
|
||||
It("creates an owned PodDisruptionBudget when set, and deletes it once cleared", func(ctx SpecContext) {
|
||||
fake, fakeSrv := newFakeTerdutServer()
|
||||
_ = fake
|
||||
DeferCleanup(fakeSrv.Close)
|
||||
reconciler.NewClient = func(string) *tdclient.Client { return tdclient.New(fakeSrv.URL) }
|
||||
|
||||
spec := dsnSpec()
|
||||
minAvail := intstr.FromInt32(1)
|
||||
spec.Pod.DisruptionBudget = &terdutv1alpha1.PodDisruptionBudgetSpec{MinAvailable: &minAvail}
|
||||
createServer(ctx, spec)
|
||||
reconcileOnce(ctx) // finalizer
|
||||
reconcileOnce(ctx) // Deployment/Service/PDB
|
||||
|
||||
var pdb policyv1.PodDisruptionBudget
|
||||
Expect(k8sClient.Get(ctx, objKey, &pdb)).To(Succeed())
|
||||
Expect(pdb.Spec.Selector.MatchLabels).To(Equal(labelsFor(&terdutv1alpha1.TerdutServer{ObjectMeta: metav1.ObjectMeta{Name: name}})))
|
||||
Expect(pdb.Spec.MinAvailable).To(Equal(&minAvail))
|
||||
Expect(pdb.OwnerReferences).To(ContainElement(HaveField("Name", name)))
|
||||
|
||||
srv := &terdutv1alpha1.TerdutServer{}
|
||||
Expect(k8sClient.Get(ctx, objKey, srv)).To(Succeed())
|
||||
srv.Spec.Pod.DisruptionBudget = nil
|
||||
Expect(k8sClient.Update(ctx, srv)).To(Succeed())
|
||||
reconcileOnce(ctx)
|
||||
|
||||
err := k8sClient.Get(ctx, objKey, &policyv1.PodDisruptionBudget{})
|
||||
Expect(apierrors.IsNotFound(err)).To(BeTrue(), "PodDisruptionBudget should be deleted once spec.pod.disruptionBudget is cleared")
|
||||
})
|
||||
|
||||
It("rejects both minAvailable and maxUnavailable set together, and neither set", func(ctx SpecContext) {
|
||||
bothSet := dsnSpec()
|
||||
minAvail, maxUnavail := intstr.FromInt32(1), intstr.FromInt32(1)
|
||||
bothSet.Pod.DisruptionBudget = &terdutv1alpha1.PodDisruptionBudgetSpec{MinAvailable: &minAvail, MaxUnavailable: &maxUnavail}
|
||||
Expect(k8sClient.Create(ctx, &terdutv1alpha1.TerdutServer{
|
||||
ObjectMeta: metav1.ObjectMeta{Name: name + "-both", Namespace: operatorNamespace},
|
||||
Spec: bothSet,
|
||||
})).To(HaveOccurred())
|
||||
|
||||
neitherSet := dsnSpec()
|
||||
neitherSet.Pod.DisruptionBudget = &terdutv1alpha1.PodDisruptionBudgetSpec{}
|
||||
Expect(k8sClient.Create(ctx, &terdutv1alpha1.TerdutServer{
|
||||
ObjectMeta: metav1.ObjectMeta{Name: name + "-neither", Namespace: operatorNamespace},
|
||||
Spec: neitherSet,
|
||||
})).To(HaveOccurred())
|
||||
})
|
||||
})
|
||||
|
||||
Describe("deletion", func() {
|
||||
It("removes the credentials and checkpoint Secrets and the finalizer", func(ctx SpecContext) {
|
||||
fake, fakeSrv := newFakeTerdutServer()
|
||||
|
||||
@@ -37,22 +37,47 @@ func (r *TerdutServerReconciler) reconcileDeployment(
|
||||
_, err := controllerutil.CreateOrUpdate(ctx, r.Client, deploy, func() error {
|
||||
replicas := srv.Spec.Replicas
|
||||
if replicas == 0 {
|
||||
replicas = 1
|
||||
// Only reachable for a TerdutServer stored before the
|
||||
// +kubebuilder:default=2 marker existed -- the API server's own
|
||||
// CRD defaulting fills this in for anything created or updated
|
||||
// through it, so a fresh zero value here means a pre-existing
|
||||
// object that predates the default, not a deliberate "none"
|
||||
// (there is no way to request zero replicas).
|
||||
replicas = 2
|
||||
}
|
||||
labels := labelsFor(srv)
|
||||
|
||||
deploy.Spec.Replicas = &replicas
|
||||
deploy.Spec.Selector = &metav1.LabelSelector{MatchLabels: labels}
|
||||
// Recreate, not RollingUpdate: the sweeper and the notifier are
|
||||
// unsynchronised singletons inside terdut-server, and two replicas
|
||||
// overlapping during a rollout would both page for the same
|
||||
// incident (matches the chart's own deployment.yaml comment).
|
||||
deploy.Spec.Strategy = appsv1.DeploymentStrategy{Type: appsv1.RecreateDeploymentStrategyType}
|
||||
// RollingUpdate, not Recreate: terdut-server v0.36.0 put the sweeper,
|
||||
// the notifier and the migration runner each behind a Postgres
|
||||
// advisory lock, and gave incident creation its own conflict
|
||||
// resolution, so two replicas overlapping during a rollout no longer
|
||||
// double-page, race a migration, or drop a webhook payload (matches
|
||||
// the chart's own deployment.yaml comment). No explicit
|
||||
// maxUnavailable/maxSurge: left at the 25%/25% default, which rounds
|
||||
// to 0/1 at the default replicas: 2 -- already zero-downtime.
|
||||
deploy.Spec.Strategy = appsv1.DeploymentStrategy{Type: appsv1.RollingUpdateDeploymentStrategyType}
|
||||
pod := srv.Spec.Pod
|
||||
deploy.Spec.Template = corev1.PodTemplateSpec{
|
||||
ObjectMeta: metav1.ObjectMeta{Labels: labels},
|
||||
// pod.Annotations is assigned directly, not merged -- nothing
|
||||
// else sets pod-template annotations today. If a future change
|
||||
// needs the controller to set one of its own (e.g. a
|
||||
// Prometheus-scrape annotation), this needs to become a real
|
||||
// map merge with a stated precedence rather than silently
|
||||
// clobbering one side.
|
||||
ObjectMeta: metav1.ObjectMeta{Labels: labels, Annotations: pod.Annotations},
|
||||
Spec: corev1.PodSpec{
|
||||
EnableServiceLinks: new(false),
|
||||
InitContainers: []corev1.Container{waitForPostgresContainer(dbEnv)},
|
||||
EnableServiceLinks: new(false),
|
||||
NodeSelector: pod.NodeSelector,
|
||||
Tolerations: pod.Tolerations,
|
||||
Affinity: pod.Affinity,
|
||||
TopologySpreadConstraints: pod.TopologySpreadConstraints,
|
||||
SecurityContext: pod.SecurityContext,
|
||||
ServiceAccountName: pod.ServiceAccountName,
|
||||
ImagePullSecrets: pod.ImagePullSecrets,
|
||||
InitContainers: []corev1.Container{waitForPostgresContainer(dbEnv)},
|
||||
Volumes: pod.ExtraVolumes,
|
||||
Containers: []corev1.Container{{
|
||||
Name: "terdut-server",
|
||||
Image: fmt.Sprintf("%s:%s", srv.Spec.Image.Repository, srv.Spec.Image.Tag),
|
||||
@@ -61,9 +86,13 @@ func (r *TerdutServerReconciler) reconcileDeployment(
|
||||
ContainerPort: servicePort(srv),
|
||||
Protocol: corev1.ProtocolTCP,
|
||||
}},
|
||||
Env: buildEnv(srv, dbEnv),
|
||||
LivenessProbe: healthzProbe(),
|
||||
ReadinessProbe: healthzProbe(),
|
||||
Env: buildEnv(srv, dbEnv),
|
||||
EnvFrom: pod.ExtraEnvFrom,
|
||||
VolumeMounts: pod.ExtraVolumeMounts,
|
||||
Resources: pod.Resources,
|
||||
SecurityContext: pod.ContainerSecurityContext,
|
||||
LivenessProbe: healthzProbe(),
|
||||
ReadinessProbe: healthzProbe(),
|
||||
}},
|
||||
},
|
||||
}
|
||||
@@ -151,7 +180,10 @@ func healthzProbe() *corev1.Probe {
|
||||
// field-for-field (confirmed against that source, not reconstructed from
|
||||
// DESIGN.md's illustrative YAML alone) — dbEnv (TERDUT_DB_DSN, optionally
|
||||
// PGPASSWORD) comes from resolveDatabaseEnv, since which of §8's two paths
|
||||
// produced it doesn't matter past this point.
|
||||
// produced it doesn't matter past this point. spec.pod.extraEnv is appended
|
||||
// last, after every fixed var -- this is the one place that owns "what env
|
||||
// this container gets," so the escape hatch lives here rather than being
|
||||
// appended separately in reconcileDeployment.
|
||||
func buildEnv(srv *terdutv1alpha1.TerdutServer, dbEnv []corev1.EnvVar) []corev1.EnvVar {
|
||||
env := []corev1.EnvVar{{Name: "TERDUT_ADDR", Value: fmt.Sprintf(":%d", servicePort(srv))}}
|
||||
env = append(env, dbEnv...)
|
||||
@@ -230,7 +262,7 @@ func buildEnv(srv *terdutv1alpha1.TerdutServer, dbEnv []corev1.EnvVar) []corev1.
|
||||
}
|
||||
}
|
||||
|
||||
return env
|
||||
return append(env, srv.Spec.Pod.ExtraEnv...)
|
||||
}
|
||||
|
||||
func secretEnvSource(ref *terdutv1alpha1.SecretKeyRef) *corev1.EnvVarSource {
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
package controller
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
policyv1 "k8s.io/api/policy/v1"
|
||||
apierrors "k8s.io/apimachinery/pkg/api/errors"
|
||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
|
||||
|
||||
terdutv1alpha1 "git.ryuvia.com/niklas/terdut-operator/api/v1alpha1"
|
||||
)
|
||||
|
||||
// reconcilePodDisruptionBudget creates/updates the PodDisruptionBudget
|
||||
// spec.pod.disruptionBudget asks for, or deletes a previously-created one
|
||||
// when the field has been cleared -- the one conditionally-created child
|
||||
// object in this controller (Deployment/Service are unconditional). Owned
|
||||
// by srv, same plain-OwnerReference shape as Deployment/Service (DESIGN.md
|
||||
// §7): same namespace, GC handles it, no finalizer needed.
|
||||
func (r *TerdutServerReconciler) reconcilePodDisruptionBudget(ctx context.Context, srv *terdutv1alpha1.TerdutServer) error {
|
||||
pdb := &policyv1.PodDisruptionBudget{ObjectMeta: metav1.ObjectMeta{Name: srv.Name, Namespace: srv.Namespace}}
|
||||
|
||||
spec := srv.Spec.Pod.DisruptionBudget
|
||||
if spec == nil {
|
||||
if err := r.Delete(ctx, pdb); err != nil && !apierrors.IsNotFound(err) {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
_, err := controllerutil.CreateOrUpdate(ctx, r.Client, pdb, func() error {
|
||||
pdb.Spec.Selector = &metav1.LabelSelector{MatchLabels: labelsFor(srv)}
|
||||
pdb.Spec.MinAvailable = spec.MinAvailable
|
||||
pdb.Spec.MaxUnavailable = spec.MaxUnavailable
|
||||
return controllerutil.SetControllerReference(srv, pdb, r.Scheme)
|
||||
})
|
||||
return err
|
||||
}
|
||||
@@ -131,6 +131,9 @@ func (r *TerdutTeamReconciler) Reconcile(ctx context.Context, req ctrl.Request)
|
||||
if err := teamClient.SetTeamOIDCGroups(ctx, team.Status.TeamID, team.Spec.OIDC.MemberGroup, team.Spec.OIDC.OwnerGroup); err != nil {
|
||||
return ctrl.Result{}, fmt.Errorf("PUT /api/teams/%d/oidc-groups: %w", team.Status.TeamID, err)
|
||||
}
|
||||
if err := r.reconcileInvite(ctx, &team, teamClient); err != nil {
|
||||
return ctrl.Result{}, err
|
||||
}
|
||||
|
||||
meta.SetStatusCondition(&team.Status.Conditions, metav1.Condition{
|
||||
Type: terdutv1alpha1.ConditionReady,
|
||||
|
||||
@@ -4,6 +4,7 @@ import (
|
||||
"context"
|
||||
"fmt"
|
||||
"net/http/httptest"
|
||||
"time"
|
||||
|
||||
. "github.com/onsi/ginkgo/v2"
|
||||
. "github.com/onsi/gomega"
|
||||
@@ -251,6 +252,88 @@ var _ = Describe("TerdutTeam Controller", func() {
|
||||
})
|
||||
})
|
||||
|
||||
Describe("spec.invite", func() {
|
||||
It("mints a link into the TerdutTeam's own namespace, not the operator's", func(ctx SpecContext) {
|
||||
createTeam(ctx, "platform", sameNSRef())
|
||||
reconcileOnce(ctx) // finalizer
|
||||
reconcileOnce(ctx) // create+mint+apply
|
||||
|
||||
team := &terdutv1alpha1.TerdutTeam{}
|
||||
Expect(k8sClient.Get(ctx, teamKey, team)).To(Succeed())
|
||||
team.Spec.Invite.Enabled = true
|
||||
Expect(k8sClient.Update(ctx, team)).To(Succeed())
|
||||
reconcileOnce(ctx)
|
||||
|
||||
Expect(k8sClient.Get(ctx, teamKey, team)).To(Succeed())
|
||||
Expect(team.Status.InviteSecretRef).NotTo(BeNil())
|
||||
|
||||
var secret corev1.Secret
|
||||
Expect(k8sClient.Get(ctx, types.NamespacedName{
|
||||
Name: team.Status.InviteSecretRef.Name, Namespace: team.Namespace,
|
||||
}, &secret)).To(Succeed())
|
||||
Expect(string(secret.Data[inviteSecretURLKey])).To(ContainSubstring("invite="))
|
||||
Expect(string(secret.Data[inviteSecretInviteIDKey])).To(Equal("1"))
|
||||
|
||||
inv := fake.invites[team.Status.TeamID][1]
|
||||
Expect(inv.Role).To(Equal("member"), "default role")
|
||||
Expect(inv.MaxUses).To(Equal(int64(1)), "default max uses")
|
||||
})
|
||||
|
||||
It("refreshes a link that's within a day of terdut-server's 7-day TTL", func(ctx SpecContext) {
|
||||
createTeam(ctx, "platform", sameNSRef())
|
||||
reconcileOnce(ctx)
|
||||
reconcileOnce(ctx)
|
||||
|
||||
team := &terdutv1alpha1.TerdutTeam{}
|
||||
Expect(k8sClient.Get(ctx, teamKey, team)).To(Succeed())
|
||||
team.Spec.Invite.Enabled = true
|
||||
Expect(k8sClient.Update(ctx, team)).To(Succeed())
|
||||
reconcileOnce(ctx)
|
||||
|
||||
Expect(k8sClient.Get(ctx, teamKey, team)).To(Succeed())
|
||||
firstSecretName := team.Status.InviteSecretRef.Name
|
||||
var secret corev1.Secret
|
||||
Expect(k8sClient.Get(ctx, types.NamespacedName{Name: firstSecretName, Namespace: team.Namespace}, &secret)).To(Succeed())
|
||||
|
||||
// Simulate the stored link being within the refresh window of
|
||||
// expiry, the way it genuinely would be six days from now,
|
||||
// without the test waiting six days.
|
||||
secret.Data[inviteSecretExpiresAtKey] = []byte(time.Now().Add(12 * time.Hour).Format(time.RFC3339)) // inside inviteRefreshWindow
|
||||
Expect(k8sClient.Update(ctx, &secret)).To(Succeed())
|
||||
|
||||
reconcileOnce(ctx)
|
||||
|
||||
Expect(fake.inviteDelete[1]).To(BeTrue(), "the stale invite should have been revoked")
|
||||
Expect(fake.invites[team.Status.TeamID]).To(HaveKey(int64(2)), "a replacement should have been minted")
|
||||
})
|
||||
|
||||
It("revokes the invite when spec.invite.enabled flips back to false", func(ctx SpecContext) {
|
||||
createTeam(ctx, "platform", sameNSRef())
|
||||
reconcileOnce(ctx)
|
||||
reconcileOnce(ctx)
|
||||
|
||||
team := &terdutv1alpha1.TerdutTeam{}
|
||||
Expect(k8sClient.Get(ctx, teamKey, team)).To(Succeed())
|
||||
team.Spec.Invite.Enabled = true
|
||||
Expect(k8sClient.Update(ctx, team)).To(Succeed())
|
||||
reconcileOnce(ctx)
|
||||
|
||||
Expect(k8sClient.Get(ctx, teamKey, team)).To(Succeed())
|
||||
secretName := team.Status.InviteSecretRef.Name
|
||||
team.Spec.Invite.Enabled = false
|
||||
Expect(k8sClient.Update(ctx, team)).To(Succeed())
|
||||
reconcileOnce(ctx)
|
||||
|
||||
Expect(fake.inviteDelete[1]).To(BeTrue())
|
||||
Expect(k8sClient.Get(ctx, teamKey, team)).To(Succeed())
|
||||
Expect(team.Status.InviteSecretRef).To(BeNil())
|
||||
|
||||
var secret corev1.Secret
|
||||
err := k8sClient.Get(ctx, types.NamespacedName{Name: secretName, Namespace: team.Namespace}, &secret)
|
||||
Expect(err).To(HaveOccurred(), "the invite Secret should have been deleted")
|
||||
})
|
||||
})
|
||||
|
||||
Describe("deletion", func() {
|
||||
It("deletes the team server-side and removes the credentials Secret", func(ctx SpecContext) {
|
||||
createTeam(ctx, "to-delete", sameNSRef())
|
||||
|
||||
@@ -0,0 +1,149 @@
|
||||
package controller
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"strconv"
|
||||
"time"
|
||||
|
||||
corev1 "k8s.io/api/core/v1"
|
||||
apierrors "k8s.io/apimachinery/pkg/api/errors"
|
||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
"sigs.k8s.io/controller-runtime/pkg/client"
|
||||
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
|
||||
|
||||
terdutv1alpha1 "git.ryuvia.com/niklas/terdut-operator/api/v1alpha1"
|
||||
"git.ryuvia.com/niklas/terdut-operator/internal/tdclient"
|
||||
)
|
||||
|
||||
// Data keys inside the generated invite Secret, following the same naming
|
||||
// shape as TerdutAlertSource's webhookSecret*Key constants.
|
||||
const (
|
||||
inviteSecretURLKey = "url"
|
||||
inviteSecretInviteIDKey = "inviteID"
|
||||
inviteSecretExpiresAtKey = "expiresAt"
|
||||
)
|
||||
|
||||
// inviteRefreshWindow is how far ahead of expiry this controller mints a
|
||||
// replacement link, so a human reading status.inviteSecretRef never finds a
|
||||
// dead link mid-use. terdut-server's invite TTL is a fixed, unconfigurable
|
||||
// 7 days (internal/api/signup.go's inviteTTL) -- refreshing a full day
|
||||
// ahead of that leaves comfortable margin against this controller's own
|
||||
// 5-minute resync interval ever being delayed.
|
||||
const inviteRefreshWindow = 24 * time.Hour
|
||||
|
||||
func inviteSecretName(team *terdutv1alpha1.TerdutTeam) string {
|
||||
return team.Name + "-terdut-invite"
|
||||
}
|
||||
|
||||
// reconcileInvite applies spec.invite against teamClient -- this team's own
|
||||
// team-scoped credential, already owner-equivalent for every /invites route
|
||||
// (terdut-server's SERVICE-ACCOUNTS.md, ratified not accidental). Mints,
|
||||
// refreshes ahead of expiry, or revokes, entirely independent of this
|
||||
// team's own Ready condition: an invite is a convenience for onboarding a
|
||||
// human, never something anything else in this reconcile waits on.
|
||||
func (r *TerdutTeamReconciler) reconcileInvite(ctx context.Context, team *terdutv1alpha1.TerdutTeam, teamClient *tdclient.Client) error {
|
||||
if !team.Spec.Invite.Enabled {
|
||||
return r.revokeInvite(ctx, team, teamClient)
|
||||
}
|
||||
|
||||
secretName := inviteSecretName(team)
|
||||
var secret corev1.Secret
|
||||
err := r.Get(ctx, client.ObjectKey{Namespace: team.Namespace, Name: secretName}, &secret)
|
||||
switch {
|
||||
case err == nil:
|
||||
expiresAt, parseErr := time.Parse(time.RFC3339, string(secret.Data[inviteSecretExpiresAtKey]))
|
||||
if parseErr == nil && time.Until(expiresAt) > inviteRefreshWindow {
|
||||
team.Status.InviteSecretRef = &terdutv1alpha1.LocalSecretRef{Name: secretName}
|
||||
return nil // still fresh, nothing to do this reconcile
|
||||
}
|
||||
// Expired, about to expire, or unreadable: mint a replacement.
|
||||
// Revoke the old row by id first (best-effort) so a leaked old link
|
||||
// stops working immediately rather than lingering unrevoked until
|
||||
// its own TTL -- failure here is not fatal, since the replacement
|
||||
// below is what actually matters.
|
||||
if oldID, idErr := strconv.ParseInt(string(secret.Data[inviteSecretInviteIDKey]), 10, 64); idErr == nil {
|
||||
_ = teamClient.RevokeInvite(ctx, team.Status.TeamID, oldID)
|
||||
}
|
||||
return r.mintInvite(ctx, team, teamClient, secretName)
|
||||
case apierrors.IsNotFound(err):
|
||||
// Low stakes, unlike TerdutAlertSource's webhook URL: nothing
|
||||
// external holds a durable dependency on one specific invite link
|
||||
// staying stable the way an Alertmanager config depends on a
|
||||
// webhook URL -- it's read once by one human and handed out. So
|
||||
// this silently re-mints rather than failing closed the way
|
||||
// TerdutAlertSource's ReasonWebhookSecretLost does for its Secret.
|
||||
return r.mintInvite(ctx, team, teamClient, secretName)
|
||||
default:
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
func (r *TerdutTeamReconciler) mintInvite(
|
||||
ctx context.Context, team *terdutv1alpha1.TerdutTeam, teamClient *tdclient.Client, secretName string,
|
||||
) error {
|
||||
role := team.Spec.Invite.Role
|
||||
if role == "" {
|
||||
role = "member"
|
||||
}
|
||||
maxUses := team.Spec.Invite.MaxUses
|
||||
if maxUses == 0 {
|
||||
maxUses = 1
|
||||
}
|
||||
inv, err := teamClient.CreateInvite(ctx, team.Status.TeamID, role, maxUses)
|
||||
if err != nil {
|
||||
return fmt.Errorf("POST /api/teams/%d/invites: %w", team.Status.TeamID, err)
|
||||
}
|
||||
|
||||
secret := &corev1.Secret{ObjectMeta: metav1.ObjectMeta{Name: secretName, Namespace: team.Namespace}}
|
||||
if _, err := controllerutil.CreateOrUpdate(ctx, r.Client, secret, func() error {
|
||||
secret.Data = map[string][]byte{
|
||||
inviteSecretURLKey: []byte(inv.URL),
|
||||
inviteSecretInviteIDKey: []byte(strconv.FormatInt(inv.ID, 10)),
|
||||
inviteSecretExpiresAtKey: []byte(inv.ExpiresAt.Format(time.RFC3339)),
|
||||
}
|
||||
return controllerutil.SetControllerReference(team, secret, r.Scheme)
|
||||
}); err != nil {
|
||||
return err
|
||||
}
|
||||
team.Status.InviteSecretRef = &terdutv1alpha1.LocalSecretRef{Name: secretName}
|
||||
if r.Recorder != nil {
|
||||
r.Recorder.Eventf(team, nil, corev1.EventTypeNormal, terdutv1alpha1.ReasonInviteMinted, terdutv1alpha1.ReasonInviteMinted,
|
||||
"invite link minted into Secret %q", secretName)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// revokeInvite tears down spec.invite's Secret and server-side row when
|
||||
// spec.invite.enabled is false (or was never set). Same-namespace and
|
||||
// OwnerReference'd, so deleting the TerdutTeam itself already garbage-
|
||||
// collects this Secret -- this path exists for the narrower case of
|
||||
// flipping enabled back to false on an otherwise-live TerdutTeam.
|
||||
func (r *TerdutTeamReconciler) revokeInvite(ctx context.Context, team *terdutv1alpha1.TerdutTeam, teamClient *tdclient.Client) error {
|
||||
if team.Status.InviteSecretRef == nil {
|
||||
return nil
|
||||
}
|
||||
name := team.Status.InviteSecretRef.Name
|
||||
var secret corev1.Secret
|
||||
err := r.Get(ctx, client.ObjectKey{Namespace: team.Namespace, Name: name}, &secret)
|
||||
switch {
|
||||
case err == nil:
|
||||
if id, idErr := strconv.ParseInt(string(secret.Data[inviteSecretInviteIDKey]), 10, 64); idErr == nil {
|
||||
if err := teamClient.RevokeInvite(ctx, team.Status.TeamID, id); err != nil {
|
||||
return fmt.Errorf("DELETE /api/teams/%d/invites/%d: %w", team.Status.TeamID, id, err)
|
||||
}
|
||||
}
|
||||
if err := r.Delete(ctx, &secret); err != nil && !apierrors.IsNotFound(err) {
|
||||
return err
|
||||
}
|
||||
case !apierrors.IsNotFound(err):
|
||||
return err
|
||||
}
|
||||
|
||||
team.Status.InviteSecretRef = nil
|
||||
if r.Recorder != nil {
|
||||
r.Recorder.Eventf(team, nil, corev1.EventTypeNormal, terdutv1alpha1.ReasonInviteRevoked, terdutv1alpha1.ReasonInviteRevoked,
|
||||
"invite link revoked")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -566,3 +566,50 @@ func (c *Client) DeleteIntegration(ctx context.Context, teamID, integrationID in
|
||||
}
|
||||
return c.do(req, nil)
|
||||
}
|
||||
|
||||
// Invite is a standing link into a team (POST /api/teams/{teamID}/invites'
|
||||
// own response shape). URL carries the raw token exactly once, at creation
|
||||
// -- terdut-server never shows it again (same one-time-shown shape as an
|
||||
// integration's webhook key) -- so a caller that needs it later has to have
|
||||
// kept this response, not re-fetched it.
|
||||
type Invite struct {
|
||||
ID int64 `json:"id"`
|
||||
TeamID int64 `json:"team_id"`
|
||||
Role string `json:"role"`
|
||||
ExpiresAt time.Time `json:"expires_at"`
|
||||
MaxUses int64 `json:"max_uses"`
|
||||
URL string `json:"url,omitempty"`
|
||||
}
|
||||
|
||||
// CreateInvite calls POST /api/teams/{teamID}/invites -- owner-gated
|
||||
// (requireTeamOwner), so c must hold this team's own team-scoped
|
||||
// credential, which already satisfies that check via its synthetic owner
|
||||
// membership (terdut-server's SERVICE-ACCOUNTS.md). No conflict handling
|
||||
// needed: unlike a team or a service account, an invite has no unique name
|
||||
// to collide on -- every call mints a brand new row.
|
||||
func (c *Client) CreateInvite(ctx context.Context, teamID int64, role string, maxUses int64) (*Invite, error) {
|
||||
req, err := c.newRequest(ctx, http.MethodPost, fmt.Sprintf("/api/teams/%d/invites", teamID),
|
||||
map[string]any{"role": role, "max_uses": maxUses})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var inv Invite
|
||||
if err := c.do(req, &inv); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &inv, nil
|
||||
}
|
||||
|
||||
// RevokeInvite calls DELETE /api/teams/{teamID}/invites/{inviteID} -- same
|
||||
// credential requirement as CreateInvite. A 404 (already revoked, or never
|
||||
// existed) is the caller's to treat as success if it wants to, the same way
|
||||
// DeleteTeam's own 404 handling works -- this method itself just reports
|
||||
// whatever terdut-server said.
|
||||
func (c *Client) RevokeInvite(ctx context.Context, teamID, inviteID int64) error {
|
||||
req, err := c.newRequest(ctx, http.MethodDelete,
|
||||
fmt.Sprintf("/api/teams/%d/invites/%d", teamID, inviteID), nil)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return c.do(req, nil)
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user