feature(appliance): UI installs Sourcegraph again by jdpleiness · Pull Request #63996 · sourcegraph/sourcegraph-public-snapshot

jdpleiness · 2024-07-22T23:31:43Z

The appliance UI creates a configMap that triggers our reconciler to install Sourcegraph.

Refactored React app to remove "demo" code where possible
Added status functionality to get the status of deployments, statefulsets, or persistent volume claims.
Fix small code issue where FromInt was deprecated
Add reconciliation loop for the appliance backing configMap

Install:

❯ k get pods
NAME                                         READY   STATUS    RESTARTS      AGE
blobstore-568d57d477-k5vrh                   1/1     Running   0             15m
codeinsights-db-0                            2/2     Running   0             15m
codeintel-db-0                               2/2     Running   0             15m
gitserver-0                                  1/1     Running   1 (14m ago)   14m
grafana-0                                    1/1     Running   0             15m
indexed-search-0                             2/2     Running   0             15m
pgsql-0                                      2/2     Running   0             15m
precise-code-intel-worker-6fd4d6c8d5-4rjbc   1/1     Running   1 (14m ago)   15m
precise-code-intel-worker-6fd4d6c8d5-6fjdw   1/1     Running   1 (14m ago)   15m
prometheus-6cd94d7485-4cx7n                  1/1     Running   0             15m
redis-cache-f4dc7d6b8-2tp5v                  2/2     Running   0             15m
redis-store-5d6fcc9c84-7sj8v                 2/2     Running   0             15m
repo-updater-9f695b7d5-r28t7                 1/1     Running   5 (14m ago)   15m
searcher-0                                   1/1     Running   0             15m
sourcegraph-frontend-64cc4458cd-4vdwq        1/1     Running   0             15m
sourcegraph-frontend-64cc4458cd-gd7bf        1/1     Running   0             15m
symbols-0                                    1/1     Running   0             13m
syntect-server-6d5d55fb4f-tgbsc              1/1     Running   0             15m
worker-66b4cd79b5-zw844                      1/1     Running   1 (13m ago)   15m

Test plan

Unit tests where applicable and tested locally via UI and local cluster

Changelog

jdpleiness · 2024-07-23T00:45:59Z

+		currentTasks, progress := calculateProgress(installTasks())

+		installProgress := struct {


This is here so we don't get a null pointer ref in the frontend for now. Ultimately this needs to be generated/updated on every call.

Is this basically stubbing the progress bar, as a stepping stone? If so let's leave a comment saying that's what it does. I am totally on board with getting the steel thread working and punting a more-accurate progress bar into follow-on backlog issues.

Yeah just a stub for now. Based on the meeting yesterday we can either fully mock this or hopefully tie it in to work in a follow up.

jdpleiness · 2024-07-23T00:46:37Z

+		//TODO(jdpleiness) check form for value if this should be set or not
+		a.sourcegraph.SetLocalDevMode()


We need to read in our db connection strings and other info like localDevMode here

In yesterday's team meeting, IIRC we punted remote DBs past the very first release. Let's create a follow-on issue for that.

re: Dev mode, IMO this code makes it too easy to accidentally never configure resources for real users. What if we conditionalize this line behind an env var check (e.g. APPLIANCE_DEV_MODE), and create a follow on issue to restore the dev-mode form field?

jdpleiness · 2024-07-23T00:47:07Z

 	dep.Spec.Strategy.RollingUpdate = &appsv1.RollingUpdateDeployment{
-		MaxSurge:       pointers.Ptr(intstr.FromInt(2)),
-		MaxUnavailable: pointers.Ptr(intstr.FromInt(0)),
+		MaxSurge:       pointers.Ptr(intstr.FromInt32(2)),


Just sneaking in some quick fixes for deprecation warnings here

jdpleiness · 2024-07-23T00:47:44Z

+	r.Handle("/api/v1/appliance/status", a.getStatusJSONHandler()).Methods("GET")
+	r.Handle("/api/v1/appliance/status", a.postStatusJSONHandler()).Methods("POST")
+	r.Handle("/api/v1/appliance/install/progress", a.getInstallProgressJSONHandler()).Methods("GET")
+	r.Handle("/api/v1/appliance/maintenance/status", a.getMaintenanceStatusHandler()).Methods("GET")


Updated URIs to look a little cleaner

jdpleiness · 2024-07-23T00:48:52Z

+
+// IsObjectReady checks if a k8s object is ready, with the definition of ready depending on the object type.
+// Supported resource types are StatefulSets, Deployments, and PersistentVolumeClaims.
+func IsObjectReady(obj client.Object) (bool, error) {


We can use this to get a good idea if our services are ready in order to update the progress bar in the UI. Still need to write up the loops to iterate over our services though

craigfurman

Amazing to see the installation going again! When I ran this locally, I could get it to install all resources, which eventually converged to healthy, but the progress bar never left 0% 🤔

Not sure if just my local environment or a real bug, let's pair on this later. Maybe, the desired end state is that success page we talked about, with a big "I'm ready" button that causes the ingress to flip for the first time? Presumably this would be backed by a new status to represent "first install done, waiting for admin acknowledgement" (maybe "awaiting-admin-post-first-install")? I think something to that effect was proposed yesterday.

craigfurman · 2024-07-23T09:23:30Z

+		currentTasks, progress := calculateProgress(installTasks())

+		installProgress := struct {


Is this basically stubbing the progress bar, as a stepping stone? If so let's leave a comment saying that's what it does. I am totally on board with getting the steel thread working and punting a more-accurate progress bar into follow-on backlog issues.

craigfurman · 2024-07-23T09:25:27Z

+		//TODO(jdpleiness) check form for value if this should be set or not
+		a.sourcegraph.SetLocalDevMode()


In yesterday's team meeting, IIRC we punted remote DBs past the very first release. Let's create a follow-on issue for that.

re: Dev mode, IMO this code makes it too easy to accidentally never configure resources for real users. What if we conditionalize this line behind an env var check (e.g. APPLIANCE_DEV_MODE), and create a follow on issue to restore the dev-mode form field?

craigfurman

We split the step after the progress bar into a follow-on: https://linear.app/sourcegraph/issue/REL-291/wait-for-admin-ui-integrates-with-backend

🚀

Great work!

The appliance UI creates a `configMap` that triggers our reconciler to install Sourcegraph. - Refactored React app to remove "demo" code where possible - Added `status` functionality to get the status of deployments, statefulsets, or persistent volume claims. - Fix small code issue where `FromInt` was deprecated - Add reconciliation loop for the appliance backing `configMap` Install: ```shell ❯ k get pods NAME READY STATUS RESTARTS AGE blobstore-568d57d477-k5vrh 1/1 Running 0 15m codeinsights-db-0 2/2 Running 0 15m codeintel-db-0 2/2 Running 0 15m gitserver-0 1/1 Running 1 (14m ago) 14m grafana-0 1/1 Running 0 15m indexed-search-0 2/2 Running 0 15m pgsql-0 2/2 Running 0 15m precise-code-intel-worker-6fd4d6c8d5-4rjbc 1/1 Running 1 (14m ago) 15m precise-code-intel-worker-6fd4d6c8d5-6fjdw 1/1 Running 1 (14m ago) 15m prometheus-6cd94d7485-4cx7n 1/1 Running 0 15m redis-cache-f4dc7d6b8-2tp5v 2/2 Running 0 15m redis-store-5d6fcc9c84-7sj8v 2/2 Running 0 15m repo-updater-9f695b7d5-r28t7 1/1 Running 5 (14m ago) 15m searcher-0 1/1 Running 0 15m sourcegraph-frontend-64cc4458cd-4vdwq 1/1 Running 0 15m sourcegraph-frontend-64cc4458cd-gd7bf 1/1 Running 0 15m symbols-0 1/1 Running 0 13m syntect-server-6d5d55fb4f-tgbsc 1/1 Running 0 15m worker-66b4cd79b5-zw844 1/1 Running 1 (13m ago) 15m ``` ## Test plan Unit tests where applicable and tested locally via UI and local cluster  ## Changelog

jdpleiness added 3 commits July 22, 2024 18:28

add rec loop for cfgmap

4714843

UI installs sourcegraph

8e7fe19

replace deprecated fromint call

7e27417

jdpleiness added the no-changelog Exclude this PR from the next changelog. label Jul 22, 2024

cla-bot Bot added the cla-signed label Jul 22, 2024

jdpleiness added 6 commits July 22, 2024 19:36

bazel cfg

2a546b7

remove unused status items

548a07a

reenable auth

5245f50

fix formatting

7d12c70

fix go mod

5c24013

fix bazel for react

e355bb7

jdpleiness requested a review from craigfurman July 23, 2024 00:43

jdpleiness commented Jul 23, 2024

View reviewed changes

craigfurman reviewed Jul 23, 2024

View reviewed changes

jdpleiness marked this pull request as ready for review July 23, 2024 14:08

craigfurman approved these changes Jul 23, 2024

View reviewed changes

jdpleiness merged commit 37cf4a7 into main Jul 23, 2024

jdpleiness deleted the jdp/appliance/07-22-appliance-install branch July 23, 2024 15:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature(appliance): UI installs Sourcegraph again#63996

feature(appliance): UI installs Sourcegraph again#63996
jdpleiness merged 9 commits into
mainfrom
jdp/appliance/07-22-appliance-install

jdpleiness commented Jul 22, 2024 •

edited

Loading

Uh oh!

jdpleiness Jul 23, 2024

Uh oh!

craigfurman Jul 23, 2024

Uh oh!

jdpleiness Jul 23, 2024

Uh oh!

jdpleiness Jul 23, 2024

Uh oh!

craigfurman Jul 23, 2024

Uh oh!

jdpleiness Jul 23, 2024

Uh oh!

jdpleiness Jul 23, 2024

Uh oh!

jdpleiness Jul 23, 2024

Uh oh!

craigfurman left a comment

Uh oh!

craigfurman Jul 23, 2024

Uh oh!

craigfurman Jul 23, 2024

Uh oh!

craigfurman left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		currentTasks, progress := calculateProgress(installTasks())

		installProgress := struct {

		//TODO(jdpleiness) check form for value if this should be set or not
		a.sourcegraph.SetLocalDevMode()

Conversation

jdpleiness commented Jul 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test plan

Changelog

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

craigfurman left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

craigfurman left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jdpleiness commented Jul 22, 2024 •

edited

Loading