Fuzzball Documentation
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

Admin Commands

These commands reach beyond a single user’s own catalog repositories: they set a repository’s owner kind, reload every repository in the deployment, and control which workflow templates appear in the catalog. They extend the user commands rather than replacing them.

These commands require you to be an owner of the group or organization that owns the repository or template, or a cluster administrator. The rest of the fuzzball workflow catalog source commands – import, list, get, and remove – behave the same way for administrators as for everyone else, and are documented in User Commands.

Admin Catalog Repository Commands

Owning a Repository at the Organization Level

add and import take the same --owner-kind flag, and both are documented in User Commands. What concerns an administrator is the owner kind itself: organization makes a repository’s applications visible across the whole organization rather than to one group.

$ fuzzball workflow catalog source add \
    "Official Catalog" \
    "https://github.com/example/official-catalog" \
    "main" \
    --id 22222222-2222-2222-2222-222222222222 \
    --owner-kind organization
The flag’s help text also offers provider, but the server rejects it: provider-owned catalogs are reserved for the built-in CIQ catalog. Turn that catalog on or off with spec.fuzzball.workflowCatalog.catalogs.official.enabled instead.

Restricting Repository URIs

Fuzzball clones catalog repositories from the cluster that owns them – orchestrate, or a federate cluster – so a repository URI is a network destination that cluster will connect to. URIs are therefore validated before any connection is made. The default rules are listed under Accepted Repository URIs.

These defaults need no configuration. On an operator-managed deployment, the FuzzballOrchestrate or FuzzballFederate resource’s spec.fuzzball.workflowCatalog.restrictions block tightens or deliberately relaxes them:

spec:
  fuzzball:
    workflowCatalog:
      restrictions:
        # Limit catalog repositories to these hosts. Empty accepts any public
        # host. The official catalog's host is always permitted on
        # orchestrate; on a federate cluster list it explicitly.
        allowedHosts:
          - git.internal.example.com
        # Bound the catalog files extracted from a clone (templates, values,
        # metadata, key art). Defaults to 256 MiB.
        maxCloneBytes: 268435456
        # Bound a single clone attempt. Defaults to 2m.
        cloneTimeout: 2m
        # Permit clones that resolve to private or loopback addresses.
        # Development only. Ignored on SaaS deployments.
        allowPrivateAddresses: false

A standalone or compose deployment sets the same keys under a top-level catalogRestrictions block in the orchestrate configuration file, plus rootCaFile, an additional PEM bundle to trust for catalog clones. On an operator deployment, use spec.trustedCACerts instead; certificates added there join the pod’s system trust bundle, which catalog clones already use.

Catalog clones honor the standard HTTPS_PROXY and NO_PROXY environment variables. Behind an egress proxy, every clone connects to the proxy, and that connection is not subject to the private-address rule – the proxy decides where it connects onward. The scheme, host, and redirect rules still apply to the repository itself; a repository URI may not name the proxy; and hosts excluded by NO_PROXY are dialed directly, so the address rule still applies to them. Fuzzball logs the active policy and egress mode when the cluster starts.

allowPrivateAddresses disables the address check that prevents a catalog repository from being aimed at internal services. Enable it only on an isolated development deployment. It has no effect on SaaS deployments, where it is always off.
Upgrading: catalog repositories added before this validation existed are not migrated. A repository whose URI uses http, ssh, git, or file, or whose host resolves to a private address, stops syncing and reports the reason in its sync error. Delete it and re-add it over HTTPS – or, for a private Git host on an isolated deployment, set allowPrivateAddresses.

Reloading Catalog Repositories

Reload a single repository, or every repository in the deployment at once. --all reloads all of them, not only the ones your group owns:

$ fuzzball workflow catalog source reload [--all|<SOURCE>]

Flags:

  • --all, -a: Reload all catalog repositories instead of a specific one

Example - Reload All Repositories:

$ fuzzball workflow catalog source reload --all

Configuring the Sync Schedule

Fuzzball synchronizes every catalog repository on a timer. By default the sync runs every four hours (0 */4 * * *). The schedule is deployment-wide: it applies to all catalog repositories, including the official CIQ catalog.

$ fuzzball workflow catalog source schedule --cron "0 */4 * * *"
Catalog sync schedule is now "0 */4 * * *"

Flags:

  • --cron: a standard five-field cron expression
  • --suspend: --suspend (or --suspend=true) pauses syncing; --suspend=false resumes it

Supply exactly one of the two. The command rejects both together, and rejects neither.

$ fuzzball workflow catalog source schedule --suspend
Catalog sync is suspended

$ fuzzball workflow catalog source schedule --suspend=false
Catalog sync is resumed

Suspending stops the timer only – reload still works while syncing is suspended. On an operator deployment the schedule set here survives reconciliation.

Admin Workflow Template Commands

Group and organization owners can enable or disable the templates their group or organization owns, including templates imported from their own catalog repositories, to control whether each one appears in the workflow catalog:

$ fuzzball workflow catalog enable <TEMPLATE>

$ fuzzball workflow catalog disable <TEMPLATE>

<TEMPLATE> is the template’s name or its UUID.

Example:

$ fuzzball workflow catalog disable "Hello World"

Templates from the official CIQ catalog are provider-owned and cannot be enabled or disabled this way, by any identity. Turn the whole official catalog off with spec.fuzzball.workflowCatalog.catalogs.official.enabled: false.

Disabled templates are not visible in the workflow catalog and cannot be used to create new workflows. Existing workflows created from the template are not affected.

Disable a template to withdraw it without deleting it – for an outdated or broken template, during a maintenance window, or as a step in deprecating it.