Install Source Controller

This topic tells you how to install Source Controller from the Tanzu Application Platform (commonly known as TAP) package repository.

Note

Follow the steps in this topic if you do not want to use a profile to install Source Controller. For more information about profiles, see Components and installation profiles.

Prerequisites

Before installing Source Controller:

• Complete all prerequisites to install Tanzu Application Platform. For more information, see Prerequisites.
• Install cert-manager on the cluster. For more information, see Install cert-manager.

Install

To install Source Controller:

1. List version information for the package by running:

   tanzu package available list controller.source.apps.tanzu.vmware.com --namespace tap-install
   

   For example:

   $ tanzu package available list controller.source.apps.tanzu.vmware.com --namespace tap-install
   - Retrieving package versions for controller.source.apps.tanzu.vmware.com...
     NAME                                     VERSION  RELEASED-AT
     controller.source.apps.tanzu.vmware.com  0.3.1    2022-01-23 19:00:00 -0500 -05
     controller.source.apps.tanzu.vmware.com  0.3.2    2022-02-21 19:00:00 -0500 -05
     controller.source.apps.tanzu.vmware.com  0.3.3    2022-03-03 19:00:00 -0500 -05
     controller.source.apps.tanzu.vmware.com  0.4.1    2022-06-09 19:00:00 -0500 -05
   

2. (Optional) Gather the values schema:

   tanzu package available get controller.source.apps.tanzu.vmware.com/VERSION-NUMBER --values-schema --namespace tap-install
   

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

   For example:

   tanzu package available get controller.source.apps.tanzu.vmware.com/0.4.1 --values-schema --namespace tap-install
   
   Retrieving package details for controller.source.apps.tanzu.vmware.com/0.4.1...
   KEY               DEFAULT  TYPE    DESCRIPTION
   aws_iam_role_arn           string  Optional: The AWS IAM Role ARN to attach to the Source Controller service account
   ca_cert_data               string  Optional: PEM Encoded certificate data for image registries with private CA.
   

3. (Optional) Create a file named source-controller-values.yaml to override the default installation settings. You can configure the following fields:

   • ca_cert_data: Enables Source Controller to connect to image registries that use self-signed or private certificate authorities. If a certificate error x509: certificate signed by unknown authority occurs, use this option to trust additional certificate authorities.

     To provide a custom certificate, add the PEM-encoded CA certificate data to source-controller-values.yaml. For example:

     ca_cert_data: |
         -----BEGIN CERTIFICATE-----
         MIICpTCCAYUCBgkqhkiG9w0BBQ0wMzAbBgkqhkiG9w0BBQwwDgQIYg9x6gkCAggA
         ...
         9TlA7A4FFpQqbhAuAVH6KQ8WMZIrVxJSQ03c9lKVkI62wQ==
         -----END CERTIFICATE-----
     

   • aws_iam_role_arn: Annotates the Source Controller service with an AWS Identity and Access Management (IAM) role. This allows Source Controller to pull images from Amazon Elastic Container Registry (ECR).

     To add the AWS IAM role Amazon Resource Name (ARN) to the Source Controller service, add the ARN to source-controller-values.yaml. For example:

     aws_iam_role_arn: "eks.amazonaws.com/role-arn: arn:aws:iam::112233445566:role/source-controller-manager"
     

4. Install the package by running:

   tanzu package install source-controller \
     --package controller.source.apps.tanzu.vmware.com \
     --version VERSION-NUMBER \
     --namespace tap-install \
     --values-file VALUES-FILE
   

   Where:

   • VERSION-NUMBER is the version of the package listed in step 1 above.
   • VALUES-FILE is the path to the file created in step 3.

   For example:

   $ tanzu package install source-controller
       --package controller.source.apps.tanzu.vmware.com
       --version 0.4.1
       --namespace tap-install
       --values-file source-controller-values.yaml
   
   \ Installing package 'controller.source.apps.tanzu.vmware.com'
   | Getting package metadata for 'controller.source.apps.tanzu.vmware.com'
   | Creating service account 'source-controller-default-sa'
   | Creating cluster admin role 'source-controller-default-cluster-role'
   | Creating cluster role binding 'source-controller-default-cluster-rolebinding'
   | Creating secret 'source-controller-default-values'
   | Creating package resource
   - Waiting for 'PackageInstall' reconciliation for 'source-controller'
   - 'PackageInstall' resource install status: Reconciling
   
    Added installed package 'source-controller'
   

5. Verify the package installation by running:

   tanzu package installed get source-controller -n tap-install
   

   For example:

   tanzu package installed get source-controller -n tap-install
   - Retrieving installation details for source-controller...
   NAME:                    source-controller
   PACKAGE-NAME:            controller.source.apps.tanzu.vmware.com
   PACKAGE-VERSION:         0.4.1
   STATUS:                  Reconcile succeeded
   CONDITIONS:              [{ReconcileSucceeded True  }]
   USEFUL-ERROR-MESSAGE:
   

   Verify that STATUS is Reconcile succeeded:

   kubectl get pods -n source-system
   

   For example:

   $ kubectl get pods -n source-system
   NAME                                        READY   STATUS    RESTARTS   AGE
   source-controller-manager-f68dc7bb6-4lrn6   1/1     Running   0          100s
   

   Verify that STATUS is Running.