install-components.md

Installing individual packages

You can install Tanzu Application Platform through predefined profiles or through individual packages. This page provides links to install instructions for each of the individual packages. For more information about installing through profiles, see About Tanzu Application Platform package and profiles.

Installing individual Tanzu Application Platform packages is useful if you do not want to use a profile to install packages or if you want to install additional packages after installing a profile. Before installing the packages, be sure to complete the prerequisites, configure and verify the cluster, accept the EULA, and install the Tanzu CLI with any required plug-ins. For more information, see Prerequisites.

Install pages for individual Tanzu Application Platform packages

• Install API portal
• Install Application Accelerator
• Install Application Live View
• Install Application Single Sign-On
• Install cert-manager, Contour, and FluxCD
• Install Cloud Native Runtimes
• Install Convention Service
• Install default roles for Tanzu Application Platform
• Install Developer Conventions
• Install Learning Center for Tanzu Application Platform
• Install Out of the Box Templates
• Install Out of the Box Supply Chain with Testing
• Install Out of the Box Supply Chain with Testing and Scanning
• Install Service Bindings
• Install Services Toolkit
• Install Source Controller
• Install Spring Boot Conventions
• Install Supply Chain Choreographer
• Install Supply Chain Security Tools - Store
• Install Supply Chain Security Tools - Policy Controller
• Install Supply Chain Security Tools - Scan
• Install Tanzu Application Platform GUI
• Install Tanzu Build Service
• Install Tekton

Verify the installed packages

Use the following procedure to verify that the packages are installed.

1. List the installed packages by running:

   tanzu package installed list --namespace tap-install

   For example:

   $ tanzu package installed list --namespace tap-install
   \ Retrieving installed packages...
   NAME                     PACKAGE-NAME                                       PACKAGE-VERSION  STATUS
   api-portal               api-portal.tanzu.vmware.com                        1.0.3            Reconcile succeeded
   app-accelerator          accelerator.apps.tanzu.vmware.com                  1.0.0            Reconcile succeeded
   app-live-view            appliveview.tanzu.vmware.com                       1.0.2            Reconcile succeeded
   appliveview-conventions  build.appliveview.tanzu.vmware.com                 1.0.2            Reconcile succeeded
   cartographer             cartographer.tanzu.vmware.com                      0.1.0            Reconcile succeeded
   cloud-native-runtimes    cnrs.tanzu.vmware.com                              1.0.3            Reconcile succeeded
   convention-controller    controller.conventions.apps.tanzu.vmware.com       0.4.2            Reconcile succeeded
   developer-conventions    developer-conventions.tanzu.vmware.com             0.3.0-build.1    Reconcile succeeded
   grype-scanner            grype.scanning.apps.tanzu.vmware.com               1.0.0            Reconcile succeeded
   image-policy-webhook     image-policy-webhook.signing.apps.tanzu.vmware.com 1.1.2            Reconcile succeeded
   metadata-store           metadata-store.apps.tanzu.vmware.com               1.0.2            Reconcile succeeded
   ootb-supply-chain-basic  ootb-supply-chain-basic.tanzu.vmware.com           0.5.1            Reconcile succeeded
   ootb-templates           ootb-templates.tanzu.vmware.com                    0.5.1            Reconcile succeeded
   scan-controller          scanning.apps.tanzu.vmware.com                     1.0.0            Reconcile succeeded
   service-bindings         service-bindings.labs.vmware.com                   0.5.0            Reconcile succeeded
   services-toolkit         services-toolkit.tanzu.vmware.com                  0.6.0            Reconcile succeeded
   source-controller        controller.source.apps.tanzu.vmware.com            0.2.0            Reconcile succeeded
   sso4k8s-install          sso.apps.tanzu.vmware.com                          1.0.0-beta.2-31  Reconcile succeeded
   tap-gui                  tap-gui.tanzu.vmware.com                           0.3.0-rc.4       Reconcile succeeded
   tekton-pipelines         tekton.tanzu.vmware.com                            0.30.0           Reconcile succeeded
   tbs                      buildservice.tanzu.vmware.com                      1.5.0            Reconcile succeeded

Set up developer namespaces to use installed packages

To create a Workload for your application using the registry credentials specified, run these commands to add credentials and Role-Based Access Control (RBAC) rules to the namespace that you plan to create the Workload in:

1. Add read/write registry credentials to the developer namespace by running:

   tanzu secret registry add registry-credentials --server REGISTRY-SERVER --username REGISTRY-USERNAME --password REGISTRY-PASSWORD --namespace YOUR-NAMESPACE

   Where:

   • YOUR-NAMESPACE is the name that you want to use for the developer namespace. For example, use default for the default namespace.
   • REGISTRY-SERVER is the URL of the registry. For Dockerhub, this must be https://index.docker.io/v1/. Specifically, it must have the leading https://, the v1 path, and the trailing /. For GCR, this is gcr.io. Based on the information used in Installing the Tanzu Application Platform Package and Profiles, you can use the same registry server as in ootb_supply_chain_basic - registry - server.
   • REGISTRY-PASSWORD is the password of the registry. For GCR or Google Artifact Registry, this must be the concatenated version of the JSON key. For example: "$(cat ~/gcp-key.json)".

   Note: If you observe the following issue with the above command:

   panic: runtime error: invalid memory address or nil pointer dereference
   [signal SIGSEGV: segmentation violation code=0x1 addr=0x128 pc=0x2bcce00]

   Use kubectl to create the secret:

   kubectl create secret docker-registry registry-credentials --docker-server=REGISTRY-SERVER --docker-username=REGISTRY-USERNAME --docker-password=REGISTRY-PASSWORD -n YOUR-NAMESPACE

2. Add secrets, a service account to execute the supply chain, and RBAC rules to authorize the service account to the developer namespace by running:

   cat <<EOF | kubectl -n YOUR-NAMESPACE apply -f -
   apiVersion: v1
   kind: Secret
   metadata:
     name: tap-registry
     annotations:
       secretgen.carvel.dev/image-pull-secret: ""
   type: kubernetes.io/dockerconfigjson
   data:
     .dockerconfigjson: e30K
   ---
   apiVersion: v1
   kind: ServiceAccount
   metadata:
     name: default
   secrets:
     - name: registry-credentials
   imagePullSecrets:
     - name: registry-credentials
     - name: tap-registry
   ---
   apiVersion: rbac.authorization.k8s.io/v1
   kind: RoleBinding
   metadata:
     name: default-permit-deliverable
   roleRef:
     apiGroup: rbac.authorization.k8s.io
     kind: ClusterRole
     name: deliverable
   subjects:
     - kind: ServiceAccount
       name: default
   ---
   apiVersion: rbac.authorization.k8s.io/v1
   kind: RoleBinding
   metadata:
     name: default-permit-workload
   roleRef:
     apiGroup: rbac.authorization.k8s.io
     kind: ClusterRole
     name: workload
   subjects:
     - kind: ServiceAccount
       name: default
   EOF

3. Perform one of the following actions to give developers namespace-level access and view access to appropriate cluster-level resources:

   • Use the tanzu rbac plug-in to grant app-viewer and app-editor roles to an identity provider group by running:

     tanzu rbac binding add -g GROUP-FOR-APP-VIEWER -n YOUR-NAMESPACE -r app-viewer
     tanzu rbac binding add -g GROUP-FOR-APP-EDITOR -n YOUR-NAMESPACE -r app-editor

     Where:

     • YOUR-NAMESPACE is the name that you want to use for the developer namespace
     • GROUP-FOR-APP-VIEWER is the user group from the upstream identity provider that requires access to app-viewer resources on the current namespace and cluster
     • GROUP-FOR-APP-EDITOR is the user group from the upstream identity provider that requires access to app-editor resources on the current namespace and cluster

     For more information about tanzu rbac, see Bind a user or group to a default role.

     VMware recommends creating a user group in your identity provider's grouping system for each developer namespace, and then adding the users accordingly.

     Depending on your identity provider, you might need to take further action to federate user groups appropriately with your cluster. For an example of how to set up Azure Active Directory (AD) with your cluster, see Integrating Azure Active Directory.

   • Apply the RBAC policy by running:

     cat <<EOF | kubectl -n YOUR-NAMESPACE apply -f -
     apiVersion: rbac.authorization.k8s.io/v1
     kind: RoleBinding
     metadata:
       name: dev-permit-app-viewer
     roleRef:
       apiGroup: rbac.authorization.k8s.io
       kind: ClusterRole
       name: app-viewer
     subjects:
       - kind: Group
         name: GROUP-FOR-APP-VIEWER
         apiGroup: rbac.authorization.k8s.io
     ---
     apiVersion: rbac.authorization.k8s.io/v1
     kind: ClusterRoleBinding
     metadata:
       name: YOUR-NAMESPACE-permit-app-viewer
     roleRef:
       apiGroup: rbac.authorization.k8s.io
       kind: ClusterRole
       name: app-viewer-cluster-access
     subjects:
       - kind: Group
         name: GROUP-FOR-APP-VIEWER
         apiGroup: rbac.authorization.k8s.io
     ---
     apiVersion: rbac.authorization.k8s.io/v1
     kind: RoleBinding
     metadata:
       name: dev-permit-app-editor
     roleRef:
       apiGroup: rbac.authorization.k8s.io
       kind: ClusterRole
       name: app-editor
     subjects:
       - kind: Group
         name: GROUP-FOR-APP-EDITOR
         apiGroup: rbac.authorization.k8s.io
     ---
     apiVersion: rbac.authorization.k8s.io/v1
     kind: ClusterRoleBinding
     metadata:
       name: YOUR-NAMESPACE-permit-app-editor
     roleRef:
       apiGroup: rbac.authorization.k8s.io
       kind: ClusterRole
       name: app-editor-cluster-access
     subjects:
       - kind: Group
         name: GROUP-FOR-APP-EDITOR
         apiGroup: rbac.authorization.k8s.io
     EOF

     Where:

     • YOUR-NAMESPACE is the name that you want to use for the developer namespace
     • GROUP-FOR-APP-VIEWER is the user group from the upstream identity provider that requires access to app-viewer resources on the current namespace and cluster
     • GROUP-FOR-APP-EDITOR is the user group from the upstream identity provider that requires access to app-editor resources on the current namespace and cluster

     VMware recommends creating a user group in your identity provider's grouping system for each developer namespace, and then adding the users accordingly.

     Depending on your identity provider, you might need to take further action to federate user groups appropriately with your cluster. For an example of how to set up Azure AD with your cluster, see Integrating Azure Active Directory.

     VMware recommends using your identity provider's user groups system to grant access to a group of developers, rather than granting roles directly to individuals. For an example of how to set up Azure AD with your cluster, see Integrating Azure Active Directory.

4. (Optional) Log in as a non-admin user, such as a developer, to see the effects of RBAC after the bindings are applied.