new package manager - sveltos

[oliverbaehler]

Tell us more.

Hello 👋

I am an enduser of projectsveltos and I am opening this discussion on behalf of the active community for sveltos.

What's it about?

Sveltos (Not related to sveltekit) is a collection of controllers which address the use-case, where administrators want to distribute Kubernetes manifests across a lot of Kubernetes Clusters (similiar to Argo ApplicationSets). However we have more integrations regarding events across clusters and the general agility to template and control deployments on cluster basis. The closest implementation is Fleet from Rancher.

However Sveltos is designed to work with CAPI clusters and is designed as a generic extension for any large cluster-scale environments.

Why Renovate

Similiar to ArgoCD and FluxCD, Sveltos has a Gitops (addon-controller) eco-system. In essence, that's where the manifests are distributed across Clusters. The following example, displays a profile which is distributed across all clusters in the env production:

---
apiVersion: config.projectsveltos.io/v1beta1
kind: ClusterProfile
metadata:
  name: deploy-calico
spec:
  clusterSelector:
    matchSelector:
      env: production
  helmCharts:
  - repositoryURL:    https://projectcalico.docs.tigera.io/charts
    repositoryName:   projectcalico
    chartName:        projectcalico/tigera-operator
    chartVersion:     v3.24.5
    releaseName:      calico
    releaseNamespace: tigera-operator
    helmChartAction:  Install
    values: |
      installation:
        calicoNetwork:
          ipPools:
          {{ range $cidr := .Cluster.spec.clusterNetwork.pods.cidrBlocks }}
            - cidr: {{ $cidr }}
              encapsulation: VXLAN
          {{ end }}

These Helm-Charts are distributed across all registered clusters with a GitOps-Approach. What I as an enduser would love, is to have automated updates for helm versions used for Profiles. Svelots has also other resources, such as Eventtriggers, which rollout resources in an event-driven fashion:

---
apiVersion: lib.projectsveltos.io/v1beta11
kind: EventTrigger
metadata:
  name: service-policy
spec:
  sourceClusterSelector:
    matchLabels:
      env: production
  destinationClusterSelector:
    matchLabels:
      dep: eng
  eventSourceName: load-balancer-service
  oneForEvent: true
  helmCharts:
  - repositoryURL:    https://kyverno.github.io/kyverno/
    repositoryName:   kyverno
    chartName:        kyverno/kyverno
    chartVersion:     v3.2.5
    releaseName:      kyverno-latest
    releaseNamespace: kyverno
    helmChartAction:  Install

Conclusion

Sveltos is an additional GitOps-Tool for Kubernetes which would greatly benefit from having a manager in the renovate ecosystem :)

[oliverbaehler]

PR is already drafted, since implementation is straightforward:

• feat(manager): add sveltos manager #30087

[github-actions[bot]]

Hi there,

You're asking us to support a new package manager. We need to know some basic information about this package manager first. Please copy/paste the new package manager questionnaire, and fill it out in full.

Once the questionnaire is filled out we'll decide if we want to support this new manager.

Good luck,

The Renovate team

[oliverbaehler]

New package manager questionnaire

Did you read our documentation on adding a package manager?

• I've read the adding a package manager documentation.

Basics

What's the name of the package manager?

sveltos

What language(s) does this package manager support?

helm

How popular is this package manager?

300 Github Stars

Does this language have other (competing?) package managers?

• Yes argocd, fluxcd, however these are scoped to their manifest CRDs, which can't be used for sveltos.
• No.

What are the big selling points for this package manager?

We can again refer to argocd and fluxcd. While these two are the biggest names in the GitOps-Space, Sveltos is a third solution which addresses large scale cluster-operations and tries to simplify manifest distribution for Kubernetes administrators.

As with the other technologies, Sveltos has it's own CRDs used to define Manifests which are used to define packages and manifests which are then distributed to n-clusters. Within these manifests we are mainly looking to be able to have an update-mechanism for the helm-releases mentioned (similar to argocd's approach).

Detecting package files

What kind of package files, and names, does this package manager use?

It uses YAML files which contain Profile-Definitions (Sveltos CRDs).

Which fileMatch pattern(s) should Renovate use?

Renovate should not provide a default-filematch. Similiar to any Kubernetes-Renovate implementation, the endusers have to define the YAML files via fileMatch, which hold the Sveltos-Definitions.

Do many users need to extend the fileMatch pattern for custom file names?

• Yes, as mentioned above. There's no default file for sveltos and the files can be managed by the endusers however they wish.
• No.

Is the fileMatch pattern going to get many "false hits" for files that have nothing to do with package management?

If not configured properly it's likely. However we provide examples on the manager how to make usefule filematches (eg. directory with Sveltos-CRDs and specific file-nameing-patterns).

Parsing and Extraction

Can package files have "local" links to each other that need to be resolved?

Package file parsing method

The package files should be:

• Parsed together (in serial).
• Parsed independently.

Which format/syntax does the package file use?

• JSON
• TOML
• YAML
• Custom (explain below)

How should we parse the package files?

• Off the shelf parser.
• Using regex.
• Custom-parsed line by line.
• Other.

Does the package file have different "types" of dependencies?

• Yes, production and development dependencies.
• No, all dependencies are treated the same.

List all the sources/syntaxes of dependencies that can be extracted

The three CRDs EventTrigger, ClusterProfile and Profile all implement the same spec to define helm-charts, which can be provided as list:

kind: ClusterProfile/Profile/EventTrigger
metadata:
  name: prometheus-grafana
spec:
  clusterSelector:
    matchLabels:
      env: fv
  helmCharts:
  - repositoryURL:    https://prometheus-community.github.io/helm-charts
    repositoryName:   prometheus-community
    chartName:        prometheus-community/prometheus
    chartVersion:     23.4.0
    releaseName:      prometheus
    releaseNamespace: prometheus
    helmChartAction:  Install
  - repositoryURL:    https://grafana.github.io/helm-charts
    repositoryName:   grafana
    chartName:        grafana/grafana
    chartVersion:     6.58.9
    releaseName:      grafana
    releaseNamespace: grafana
    helmChartAction:  Install

For all the resources the relevant map path is .spec.helmCharts

Describe which types of dependencies above are supported and which will be implemented in future

Currently we are relying on Helm and that's also the biggest focus. The framework also supports loose Manifests and Kustomize via FluxCD. These might be items for future features but currently out of scope.

Versioning

What versioning scheme does the package file(s) use?

Helm versions are expressed as x.y.z, where x is the major version, y is the minor version, and z is the patch version, following Semantic Versioning terminology.

https://helm.sh/docs/topics/version_skew/#supported-versions

Does this versioning scheme support range constraints, like ^1.0.0 or 1.x?

• Supports range constraints (for example: ^1.0.0 or 1.x), See https://helm.sh/docs/chart_best_practices/dependencies/#versions
• No.

Lookup

Is a new datasource required?

• Yes, provide details.
• No, uses docker and helm

Will users want (or need to) set a custom host or custom registry for Renovate's lookup?

• Yes, provide details.
• No

Where can Renovate find the custom host/registry?

• No custom host or registry is needed.
• In the package file(s), provide details.
• In some other file inside the repository, provide details.
• User needs to configure Renovate where to find the information, provide details.

Are there any constraints in the package files that Renovate should use in the lookup procedure?

• Yes, there are constraints on the parent language (for example: supports only Python v3.x), provide details.
• Yes, there are constraints on the parent platform (for example: only supports Linux, Windows, etc.), provide details.
• Yes, some other kind of constraint, provide details.
• No constraints.

Will users need the ability to configure language or other constraints using Renovate config?

• Yes, provide details.
• No.

Artifacts

Does the package manager use a lock file or checksum file?

• Yes, uses lock file.
• Yes, uses checksum file.
• Yes, uses lock file and checksum file.
• No lock file or checksum.

Is the locksum or checksum mandatory?

• Yes, locksum is mandatory.
• Yes, checksum is mandatory.
• Yes, lock file and checksum are mandatory.
• No mandatory locksum or checksum.
• Package manager does not use locksums or checksums.

If lockfiles or checksums are used: what tool and exact commands should Renovate use to update one (or more) package versions in a dependency file?

Package manager cache

It uses the implementation used from the helm datasource, answering the questions to my best knowledge since i don't know the specific implementation.

Does the package manager use a cache?

• Yes, provide details.
• No.

If the package manager uses a cache, how can Renovate control the cache?

• Package manager does not use a cache.
• Controlled via command line interface, provide details.
• Controlled via environment variables, provide details.

Should Renovate keep a cache?

• Yes, ignore/disable the cache.
• No.

Generating a lockfile from scratch

Renovate can perform "lock file maintenance" by getting the package manager to generate a lockfile from scratch.
Can the package manager generate a lockfile from scratch?

• Yes, explain which command Renovate should use to generate the lockfile.
• No, the package manager does not generate a lockfile from scratch.
• No, the package manager does not use lockfiles.

Other

What else should we know about this package manager?

[secustor]

SGTM