Flux Source Controller

Warning This package has been replaced by kadras-io/package-for-flux.

A Carvel package for Flux Source Controller, a source management component to provide a common interface for artifacts acquisition.

🚀  Getting Started

Prerequisites

• Kubernetes 1.26+

• Carvel kctrl CLI.

• Carvel kapp-controller deployed in your Kubernetes cluster. You can install it with Carvel kapp (recommended choice) or kubectl.

  kapp deploy -a kapp-controller -y \
    -f https://github.com/carvel-dev/kapp-controller/releases/latest/download/release.yml

Installation

Add the Kadras package repository to your Kubernetes cluster:

kctrl package repository add -r kadras-packages \
  --url ghcr.io/kadras-io/kadras-packages \
  -n kadras-packages --create-namespace

Installation without package repository

The recommended way of installing the Flux Source Controller package is via the Kadras package repository. If you prefer not using the repository, you can add the package definition directly using kapp or kubectl.

kubectl create namespace kadras-packages
kapp deploy -a flux-source-controller-package -n kadras-packages -y \
  -f https://github.com/kadras-io/package-for-flux-source-controller/releases/latest/download/metadata.yml \
  -f https://github.com/kadras-io/package-for-flux-source-controller/releases/latest/download/package.yml

Install the Flux Source Controller package:

kctrl package install -i flux-source-controller \
  -p flux-source-controller.packages.kadras.io \
  -v ${VERSION} \
  -n kadras-packages

Note You can find the ${VERSION} value by retrieving the list of package versions available in the Kadras package repository installed on your cluster.

kctrl package available list -p flux-source-controller.packages.kadras.io -n kadras-packages

Verify the installed packages and their status:

kctrl package installed list -n kadras-packages

📙  Documentation

Documentation, tutorials and examples for this package are available in the docs folder. For documentation specific to Flux Source Controller, check out fluxcd.io/docs/components/source.

🎯  Configuration

The Flux Source Controller package can be customized via a values.yml file.

resources:
  limits:
    cpu: 1000m
  limits:
    memory: 1Gi

Reference the values.yml file from the kctrl command when installing or upgrading the package.

kctrl package install -i flux-source-controller \
  -p flux-source-controller.packages.kadras.io \
  -v ${VERSION} \
  -n kadras-packages \
  --values-file values.yml

Values

The kpack package has the following configurable properties.

Configurable properties

Config	Default	Description
namespace	flux-system	The namespace where to install Flux Source Controller.
policies.include	false	Whether to include the out-of-the-box Kyverno policies to validate and secure the package installation.
resources.limits.cpu	1000m	CPU limits configuration for the source-controller Deployment.
resources.limits.memory	1Gi	Memory limits configuration for the source-controller Deployment.
service_port	80	Port configuration for the source-controller Service.
proxy.http_proxy	""	The HTTP proxy to use for network traffic.
proxy.https_proxy	""	The HTTPS proxy to use for network traffic.
proxy.no_proxy	""	A comma-separated list of hostnames, IP addresses, or IP ranges in CIDR format that should not use the proxy.
logging.level	info	Log verbosity level. Options: trace, debug, info, error.
logging.encoding	json	Log encoding format. Options: console, json.
leader_election.lease_duration	35s	Interval at which non-leader candidates will wait to force acquire leadership.
leader_election.release_on_cancel	true	Defines if the leader should step down voluntarily on controller manager shutdown.
leader_election.renew_deadline	30s	Duration that the leading controller manager will retry refreshing leadership before giving up.
leader_election.retry_period	5s	Duration the LeaderElector clients should wait between tries of actions.

🛡️  Security

The security process for reporting vulnerabilities is described in SECURITY.md.

🖊️  License

This project is licensed under the Apache License 2.0. See LICENSE for more information.

🙏  Acknowledgments

This package is inspired by the original source-controller package used in the Tanzu Community Edition project before its retirement.