gimlet-io / capacitor Goto Github PK

not everyone is on Flux 2.2, aka v2beta2

Ability to force a reconciliation of a kustomization/source or helm release.

flux reconsile

Right now if a HelmRelease is reconcinling, we show it as if it would be in an error state

We should look for this condition and introduce a reconciling widget state accordingly.

Cannot force reconcile due to RBAC issues

[capacitor-7d4f94bbb-s5zfv/capacitor] time="2024-02-07T12:04:36Z" level=info msg="annotating OCIRepository capacitor in flux-system namespace"

[capacitor-7d4f94bbb-s5zfv/capacitor] time="2024-02-07T12:04:36Z" level=error msg="ocirepositories.source.toolkit.fluxcd.io \"capacitor\" is forbidden: User \"system:serviceaccount:flux-system:capacitor\" cannot patch resource \"ocirepositories\" in API group \"source.toolkit.fluxcd.io\" in the namespace \"flux-system\""

We have this on the Deployment level, Pods should have a toolbar to be able to do that

Implementation hint:
This could be a list of filters / selectors in the log and describe overlay.

• Display the logs and the output of the kubectl describe commands in overlays

The toolbar is missing. There is a guard in code that requires a deployment to be present.

It is ignorant about other deployment types.

The task is to display Flux deployments in the footer with the Logs and Describe button.

We should make a custom (simplified version of the Service.jsx) component to display the pods on the panel.

v2beta1 HelmRelease is deprecated, upgrade to v2beta2

Capacitor loads in 16 seconds in a cluster with 20 HelmRelease, 49 Kustomization and 150 deployed services.
Capacitor loads in 110 seconds in a cluster with ~50 HelmRelease, ~300 Kustomization and ~500 deployed services.

Ideas:

• filter on the backend, make namespace selector mandatory
• load by data type: service list, pods, configmaps etc. With skeleton loader
• or both of the above

There are places where we show GitRepositories, Kustomizations and HelmReleases in widgets.

The goal is that if the user clicks this widget, the GitRepo / Kustomization / HelmRelease is shown in the footer.

• FluxState should get a new field HelmReleases https://github.com/gimlet-io/capacitor/blob/main/pkg/flux/types.go#L10
• SideBar should get an new nav item: Helm Releases as the second option, right after Kustomizations https://github.com/gimlet-io/capacitor/blob/main/web/src/Footer.js#L39
  • Navigating to Helm Releases should display Helm Releases like we display Kustomizations
• /api/services endpoint should return services that are created by Helm
  • How to get Kubernetes resources deployed by Helm is implemented in Helm and best visible in the helm status $RELEASE_NAME --show-resources command. The source code of the command shows how it is done: https://github.com/helm/helm/blob/main/pkg/action/status.go#L58.

People use Kubernetes annotations to store meta data on deployed services.

Gimlet favors https://github.com/laszlocph/osca annotations, but Capacitor should have a configuration option to support any set of annotations.

There are two types of metadata according to Capacitor:

• Annotations to determine the deployed version

  • An annotation that shows what source code version is deployed v1alpha1.opensca.dev/version.sha
  • In what repository: v1alpha1.opensca.dev/vcs.owner and v1alpha1.opensca.dev/vcs.name
  • With a direct link to the version: v1alpha1.opensca.dev/version.link

• Annotations that hold external links
  Annotations like in https://github.com/laszlocph/osca#external-references
  This is an arbitrary map of on-screen labels and annotations names in the Capacitor configuration, so Capacitor can render it.

To quickly view error ones.

We display relative dates, like a deploy happened "1 minute ago".
But this is only refreshed on page load.

We need to keep them up to date. Maybe with a timer that has a tick to keep these up to date.
Probably there is a react solution to this other then rerender the whole page.

A debugging perspective for the flux events, with quick filters on namespace, flux resource (type)

Most times you don’t care to see all the Flux resources nor pods, just latest events to have confirmation that latest commit was synced and nothing broke.

Based on event type Info or Warning we can highlight when stuff breaks.

Like flux events. https://github.com/fluxcd/flux2/blob/main/cmd/flux/events.go

Let's add installation steps that are using a HelmRelease resource and pushed to an OCI repository.

This way installation is adding a Kustomization resource that points to the OCI repository.

Some clusters don't have helm-controller installed. Capacitor fails to start.

• List ConfigMaps and Secrets that are referenced from a deployment.

• Once the user clicks them, open an overlay where the output of the kubectl describe configmap/secret xx command is shown.