Skip to content

Latest commit

 

History

History
214 lines (152 loc) · 8.46 KB

README.md

File metadata and controls

214 lines (152 loc) · 8.46 KB
Raw

Fluxcd-source-controller

What this package does

The main role of the source management component is to provide a common interface for artifacts acquisition. The source API defines a set of Kubernetes objects that cluster admins and various automated operators can interact with to offload the Git and Helm repositories operations to a dedicated controller.

The source-controller is a Kubernetes operator, specialises in artifacts acquisition from external sources such as Git, Helm repositories, and S3 buckets. The source-controller implements the source.toolkit.fluxcd.io API and is a core component of the GitOps toolkit.

This documentation provides information about the specific TCE package. Please visit the TCE package management page for general information about installation, removal, troubleshooting, and other topics.

Components

This package uses flux-source-controller version 1.1.2

Fixes

Fixing valuesSchema bug in release 0.24.4.

Files

Not relevant for this particular package.

Package Limitations

You can report the bugs related with the package here

Configuration

The fluxcd-source-controller package has following configurable properties.

Value Required/Optional Description
namespace Optional Sets namespace for k8s objects where resources of source-controller will be created.
limits_cpu Optional Sets maximum usage of cpu for source-controller deployment.
limits_memory Optional Sets maximum usage of memory for source-controller deployment.
no_proxy Optional Set domains for which no proxying should be performed
https_proxy Optional Set secure proxy connection information
http_proxy Optional Set unsecure proxy connection information 
namespace: source-system
resources:
 limits_cpu: 1050m
 limits_memory: 2Gi
proxy:
 no_proxy: ""
 https_proxy: ""
 http_proxy: ""
service_port: 80

Multi-cloud configuration steps

There are none

Installation

To install FluxCD source-controller from the Tanzu Application Platform package repository:

  1. List the version information for the package by running:

    tanzu package available list fluxcd-source-controller.community.tanzu.vmware.com

    For example:

    \ Retrieving package versions for fluxcd-source-controller.community.tanzu.vmware.com...
  NAME                                                 VERSION           RELEASED-AT
  fluxcd-source-controller.community.tanzu.vmware.com  0.21.2            2022-02-07 06:14:08 -0500 -05
  fluxcd-source-controller.community.tanzu.vmware.com  0.21.3            2022-02-07 06:14:08 -0500 -05
  fluxcd-source-controller.community.tanzu.vmware.com  0.24.4+update.1   2022-02-07 06:14:08 -0500 -05
  fluxcd-source-controller.community.tanzu.vmware.com  0.33.0            2023-01-19 23:16:10 -0500 -05
  fluxcd-source-controller.community.tanzu.vmware.com  1.1.2             2023-12-01 11:00:00 -0500 -05

  2. Install the package by running:

    tanzu package install fluxcd-source-controller -p fluxcd-source-controller.community.tanzu.vmware.com -v VERSION-NUMBER

    Where:

    • VERSION-NUMBER is the version of the package listed in step 1.

    For example:

    tanzu package install fluxcd-source-controller -p fluxcd-source-controller.community.tanzu.vmware.com -v 1.1.2
\ Installing package 'fluxcd-source-controller.community.tanzu.vmware.com'
| Getting package metadata for 'fluxcd-source-controller.community.tanzu.vmware.com'
| Creating service account 'fluxcd-source-controller-default-sa'
| Creating cluster admin role 'fluxcd-source-controller-default-cluster-role'
| Creating cluster role binding 'fluxcd-source-controller-default-cluster-rolebinding'
| Creating package resource
/ Waiting for 'PackageInstall' reconciliation for 'fluxcd-source-controller'
/ 'PackageInstall' resource install status: Reconciling


 Added installed package 'fluxcd-source-controller'

  3. Verify the package install by running:

    tanzu package installed get fluxcd-source-controller

    For example:

    \ Retrieving installation details for fluxcd-source-controller...
NAME:                    fluxcd-source-controller
PACKAGE-NAME:            fluxcd-source-controller.community.tanzu.vmware.com
PACKAGE-VERSION:         1.1.2
STATUS:                  Reconcile succeeded
CONDITIONS:              [{ReconcileSucceeded True  }]
USEFUL-ERROR-MESSAGE:

    Verify that STATUS is Reconcile succeeded

    kubectl get pods -n source-system

    For example:

    NAME                                 READY   STATUS    RESTARTS   AGE
source-controller-69859f545d-ll8fj   1/1     Running   0          3m38s

    Verify that STATUS is Running

Try fluxcd-source-controller

  1. Verify all the objects are installed:

    This package creates a new namespace called source-system hosts all the elements of fluxcd

    You can verify that the main components of fluxcd-source-controller were installed by running:

    kubectl get all -n source-system
NAME                                     READY   STATUS    RESTARTS   AGE
pod/source-controller-7684c85659-2zfxb   1/1     Running   0          40m

NAME                        TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)   AGE
service/source-controller   ClusterIP   10.108.138.74   <none>        80/TCP    40m

NAME                                READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/source-controller   1/1     1            1           40m

NAME                                           DESIRED   CURRENT   READY   AGE
replicaset.apps/source-controller-7684c85659   1         1         1       40m

    You result should be really similar!

  2. You use CRDs to communicate with fluxcd-source-controller. Verify all the CRDs were installed correctly by running:

    kubectl get crds -n source-system | grep ".fluxcd.io"
buckets.source.toolkit.fluxcd.io                         2023-01-20T08:18:40Z
gitrepositories.source.toolkit.fluxcd.io                 2023-01-20T08:18:40Z
helmcharts.source.toolkit.fluxcd.io                      2023-01-20T08:18:40Z
helmrepositories.source.toolkit.fluxcd.io                2023-01-20T08:18:40Z
ocirepositories.source.toolkit.fluxcd.io                 2023-01-20T08:18:40Z

  3. Try one simple example to check that everything is working as expected:

    • To consume a GitRepository object, create the following gitrepository-sample.yaml file:

      apiVersion: source.toolkit.fluxcd.io/v1beta1
kind: GitRepository
metadata:
  name: gitrepository-sample
spec:
  interval: 1m
  url: https://github.com/stefanprodan/podinfo
  ref:
    branch: master

    • Apply the created config:

      kubectl apply -f gitrepository-sample.yaml
gitrepository.source.toolkit.fluxcd.io/gitrepository-sample created

    • Check that the Git repository was fetched correctly:

      kubectl get GitRepository
NAME                   URL                                       READY   STATUS                                                              AGE
gitrepository-sample   https://github.com/stefanprodan/podinfo   True    Fetched revision: master/132f4e719209eb10b9485302f8593fc0e680f4fc   4s

    You can find more examples here.

Documentation

For documentation specific to fluxcd-source-controller, visit the main fluxcd/source-controller repository.