BlueGit

timfa bluegit

Files

bluegit / internal / server / admin_runner.go

admin_runner.go

admin_runner.go 7.4 KiB Download Raw
1package server
2
3import (
4 "context"
5 "gitlab.com/Timfa/bluegit/internal/store"
6 "html/template"
7 "net/http"
8 "path/filepath"
9 "strconv"
10 "strings"
11 "time"
12
13 "gitlab.com/Timfa/bluegit/internal/i18n"
14 "gitlab.com/Timfa/bluegit/internal/runnercfg"
15 "gitlab.com/Timfa/bluegit/internal/update"
16)
17
18// Beheer van de ingebouwde runner (Steve) door de sitebeheerder: dezelfde
19// instellingen en hetzelfde scherm als de webinterface van bluegit-runner.
20// UI op /admin/runner, API op /api/v1/admin/runner/... (beheerder-token).
21// Pauze is een drain: lopende jobs lopen af, nieuwe blijven queued (of
22// gaan naar een andere runner). De self-update wacht alleen op running
23// jobs, dus een gepauzeerde runner houdt een update niet tegen.
24
25func (s *Server) runnerSettingsFile() *runnercfg.File {
26 dir := s.StateDir
27 if dir == "" {
28 dir = s.StoragePath()
29 }
30 return &runnercfg.File{Path: filepath.Join(dir, "runner-settings.json")}
31}
32
33func (s *Server) builtinDefaults() runnercfg.Settings {
34 d := runnercfg.Defaults()
35 if s.Cfg.CI.Concurrency > 0 {
36 d.Concurrency = s.Cfg.CI.Concurrency
37 }
38 return d
39}
40
41func (s *Server) runnerWorkDir() string {
42 if p := s.StoragePath(); p != "" {
43 return p
44 }
45 return s.StateDir
46}
47
48// ApplyRunnerSettings laadt de opgeslagen instellingen en zet ze live.
49// Aan te roepen bij het starten, nadat Runner gezet is.
50func (s *Server) ApplyRunnerSettings() error {
51 if s.Runner == nil {
52 return nil
53 }
54 if s.Runner.Jobs == nil {
55 s.Runner.Jobs = &runnercfg.Tracker{}
56 }
57 st, err := s.runnerSettingsFile().Load(s.builtinDefaults())
58 if err != nil {
59 return err
60 }
61 return s.applyBuiltin(st)
62}
63
64func (s *Server) applyBuiltin(st runnercfg.Settings) error {
65 if s.Runner == nil {
66 return nil
67 }
68 over, err := st.Overrides(filepath.Join(s.runnerWorkDir(), "runner"), s.Cfg.CI.ImageOverrides())
69 if err != nil {
70 return err
71 }
72 s.Runner.Configure(st, over)
73 return nil
74}
75
76// RunnerMaintenance voert elke 10 minuten het opruimbeleid uit.
77func (s *Server) RunnerMaintenance(ctx context.Context) {
78 t := time.NewTicker(10 * time.Minute)
79 defer t.Stop()
80 for {
81 select {
82 case <-ctx.Done():
83 return
84 case <-t.C:
85 if s.Runner == nil {
86 continue
87 }
88 st, _ := s.runnerSettingsFile().Load(s.builtinDefaults())
89 runnercfg.Cleanup(ctx, s.Cfg.CI.Docker, st, s.Runner.Jobs, filepath.Join(s.runnerWorkDir(), "cache"))
90 }
91 }
92}
93
94func (s *Server) builtinStatus() runnercfg.Status {
95 docker := runnercfg.PingDocker(context.Background(), s.Cfg.CI.Docker)
96 st := runnercfg.Status{
97 Kind: "builtin", ServerURL: s.Cfg.BaseURL,
98 Online: s.Runner != nil && docker.Reachable, LastContact: time.Now(),
99 Docker: docker,
100 }
101 if s.Runner != nil {
102 st.Name = s.Runner.BuiltinName()
103 }
104 if s.StateDir != "" {
105 if u, err := update.ReadStatus(s.StateDir); err == nil && u.SHA != "" {
106 st.Version = shortSHA(u.SHA)
107 }
108 }
109 return st
110}
111
112func (s *Server) runnerAdmin() *runnercfg.Handler {
113 return &runnercfg.Handler{
114 Prefix: "/admin/runner",
115 APIBase: "/api/v1/admin/runner",
116 File: s.runnerSettingsFile(),
117 Default: s.builtinDefaults(),
118 Tracker: s.builtinTracker(),
119 WorkDir: s.runnerWorkDir(),
120 BasePresets: s.Cfg.CI.ImageOverrides(),
121 Apply: s.applyBuiltin,
122 Status: s.builtinStatus,
123 DocsURL: "/help/runners#ingebouwde-runner",
124 Lang: s.langOf,
125 Auth: func(w http.ResponseWriter, r *http.Request, write bool) bool {
126 if strings.HasPrefix(r.URL.Path, "/api/") {
127 if !apiUser(r).InstanceAdmin {
128 writeJSON(w, http.StatusForbidden, map[string]string{"message": "instance admin only"})
129 return false
130 }
131 } else if ok, _ := s.adminOnly(w, r); !ok {
132 return false
133 }
134 if s.Runner == nil {
135 http.Error(w, s.tr(r, "rui.ciOff"), http.StatusNotFound)
136 return false
137 }
138 return true
139 },
140 CSRF: func(r *http.Request) (string, string) { return "csrf", s.who(r).Session.CSRF },
141 CheckCSRF: func(r *http.Request) bool {
142 p := s.who(r)
143 return p.OK && r.FormValue("csrf") != "" && r.FormValue("csrf") == p.Session.CSRF
144 },
145 Layout: func(w http.ResponseWriter, r *http.Request, lang i18n.Lang, title string, body template.HTML) {
146 v := s.view(w, r, title)
147 v.Page = "adminrunner"
148 v.Wide = true
149 v.RunnerUI = body
150 rs, _ := s.Store.ListRunners(r.Context(), store.RunnerGlobal, 0)
151 v.RunnerList = runnerViews(rs)
152 v.NewRunnerToken = s.takeRunnerOnce(w, r, "/admin")
153 s.render(w, "adminrunner", v)
154 },
155 }
156}
157
158func (s *Server) builtinTracker() *runnercfg.Tracker {
159 if s.Runner == nil {
160 return &runnercfg.Tracker{}
161 }
162 if s.Runner.Jobs == nil {
163 s.Runner.Jobs = &runnercfg.Tracker{}
164 }
165 return s.Runner.Jobs
166}
167
168func (s *Server) apiAdminRunnerStatus(w http.ResponseWriter, r *http.Request) {
169 s.runnerAdmin().APIStatus(w, r)
170}
171func (s *Server) apiAdminRunnerSettings(w http.ResponseWriter, r *http.Request) {
172 s.runnerAdmin().APISettings(w, r)
173}
174func (s *Server) apiAdminRunnerJobs(w http.ResponseWriter, r *http.Request) {
175 s.runnerAdmin().APIJobs(w, r)
176}
177func (s *Server) apiAdminRunnerPause(w http.ResponseWriter, r *http.Request) {
178 s.runnerAdmin().APIPause(true)(w, r)
179}
180func (s *Server) apiAdminRunnerResume(w http.ResponseWriter, r *http.Request) {
181 s.runnerAdmin().APIPause(false)(w, r)
182}
183
184// mountRunnerAdmin hangt de UI-routes op. De API zit in apiCatalog.
185func (s *Server) mountRunnerAdmin(mux *http.ServeMux) {
186 h := &lazyRunnerAdmin{s: s}
187 for _, p := range []string{"GET /admin/runner", "POST /admin/runner/settings", "POST /admin/runner/recommend", "POST /admin/runner/presets", "POST /admin/runner/presets/delete", "POST /admin/runner/pause", "POST /admin/runner/resume"} {
188 mux.Handle(p, h)
189 }
190}
191
192// lazyRunnerAdmin bouwt de handler per verzoek: s.Runner wordt pas na Handler() gezet.
193type lazyRunnerAdmin struct{ s *Server }
194
195func (l *lazyRunnerAdmin) ServeHTTP(w http.ResponseWriter, r *http.Request) {
196 m := http.NewServeMux()
197 l.s.runnerAdmin().Mount(m, false)
198 m.ServeHTTP(w, r)
199}
200
201// ---- globale runners (beheer) ----
202
203func (s *Server) globalRunnerGuard(w http.ResponseWriter, r *http.Request) bool {
204 if ok, _ := s.adminOnly(w, r); !ok {
205 return false
206 }
207 return s.csrfOK(w, r)
208}
209
210const globalBack = "/admin/runner#global"
211
212func (s *Server) globalRunnerToken(w http.ResponseWriter, r *http.Request) {
213 if !s.globalRunnerGuard(w, r) {
214 return
215 }
216 plain, err := s.Store.CreateRunnerRegToken(r.Context(), store.RunnerGlobal, 0, s.who(r).User.ID)
217 if err != nil {
218 s.redirect(w, r, globalBack, "", s.trErr(r, err))
219 return
220 }
221 s.setRunnerOnce(w, "/admin", plain)
222 s.redirect(w, r, globalBack, s.tr(r, "runner.tokenMade"), "")
223}
224
225func (s *Server) globalRunnerID(r *http.Request) int64 {
226 id, _ := strconv.ParseInt(r.FormValue("id"), 10, 64)
227 return id
228}
229
230func (s *Server) globalRunnerDelete(w http.ResponseWriter, r *http.Request) {
231 if !s.globalRunnerGuard(w, r) {
232 return
233 }
234 if err := s.revokeRunner(r.Context(), store.RunnerGlobal, 0, s.globalRunnerID(r), false); err != nil {
235 s.redirect(w, r, globalBack, "", s.revokeErr(r, err))
236 return
237 }
238 s.redirect(w, r, globalBack, s.tr(r, "runner.revoked"), "")
239}
240
241func (s *Server) globalRunnerUpdate(w http.ResponseWriter, r *http.Request) {
242 if !s.globalRunnerGuard(w, r) {
243 return
244 }
245 var name *string
246 var paused *bool
247 if n := strings.TrimSpace(r.FormValue("name")); n != "" {
248 name = &n
249 }
250 if p := r.FormValue("paused"); p != "" {
251 b := p == "1"
252 paused = &b
253 }
254 if _, err := s.Store.UpdateRunner(r.Context(), store.RunnerGlobal, 0, s.globalRunnerID(r), name, paused); err != nil {
255 s.redirect(w, r, globalBack, "", s.trErr(r, err))
256 return
257 }
258 s.redirect(w, r, globalBack, s.tr(r, "flash.saved"), "")
259}