Skip to main content
Version: 1.1

Overview of Packages

Packages provide a delivery method for installing and/or bootstrapping clusters with software. There are two forms of packages:

  • Global Helm Packagesโ€”these are globally scoped and applied to all workspace clusters.
  • Helm Packageโ€”these are scoped to a specific workspace and the clusters contained in it.

Wayfinder uses packages to maintain its own package installations, but Wayfinder platform and workspace admins can also use them as building blocks to install software in their clusters.

Package definitions and releasesโ€‹

A release is an installation instance. Package definitions include cluster label selectors (MatchLabels and/or MatchExpressions) to filter on the cluster labels within the associated workspace, and then create a Release object that binds the package to an installation instance.

For more information, see:

View packages and releasesโ€‹

To view packages and associated releases:

  1. Run the following:

    • To view helm packages, run wf get helm.
    • To view release objects, run wf get helmreleases

    For example:

    # View the helm packages
    $ wf get helm
    gke-certificates Success 12d

    # View the release objects
    $ wf get helmreleases
    gke-certificates Success 12d

Package internalsโ€‹

How packages workโ€‹

Under the hood on every cluster Flux is installed in the adminstrative namespace wf-manager. We preload during installation with a number of HelmRepositories along side Wayfinder our maintained collection of charts.

Using Flux to deployโ€‹

You can use Flux, but it requires some prep on the workspace end. Currently we do not distribute a Role that permits assigning either a user or a robot account the ability to drop in resource types for Flux. We do this on purpose, as out of the box flux isn't suited for multi-tenant environments without being ammended.

All releases under the Flux are via the controllers service account, which by requirements is cluster scoped.