Install Spring Boot conventions

This topic tells you how to install Spring Boot conventions from the Tanzu Application Platform package repository.

Note

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

Prerequisites

Before installing Spring Boot conventions:

• Complete all prerequisites to install Tanzu Application Platform. For more information, see Prerequisites.
• Install Supply Chain Choreographer.

Install Spring Boot conventions

To install Spring Boot conventions:

1. Get the exact name and version information for the Spring Boot conventions package to install by running:

   tanzu package available list spring-boot-conventions.tanzu.vmware.com --namespace tap-install
   

   For example:

   $ tanzu package available list spring-boot-conventions.tanzu.vmware.com --namespace tap-install
   / Retrieving package versions for spring-boot-conventions.tanzu.vmware.com...
   NAME                                       VERSION           RELEASED-AT
   ...
   spring-boot-conventions.tanzu.vmware.com   1.9.0     2024-03-22T00:00:00Z
   ...
   

2. (Optional) Change the default installation settings by running:

   tanzu package available get spring-boot-conventions.tanzu.vmware.com/VERSION-NUMBER \
   --values-schema --namespace tap-install
   

   Where VERSION-NUMBER is the version of the package listed. For example: 1.11.0.

   For example:

   $ tanzu package available get spring-boot-conventions.tanzu.vmware.com/1.8.0-build.1 --values-schema --namespace tap-install
        KEY                                          DEFAULT             TYPE     DESCRIPTION
        autoConfigureActuators                       false               boolean  Enable or disable the automatic configuration of actuators on the TAP platform level
        kubernetes_distribution                                          string   Kubernetes distribution that this package is being installed on. Accepted
                                                                                  values: ['''',''openshift'']
        kubernetes_version                                               string   Optional: The Kubernetes Version. Valid values are '1.24.*', or ''
        livenessProbe.terminationGracePeriodSeconds                      number   configure a grace period for the kubelet to wait  between triggering a shut down
                                                                                  of the failed container, and then forcing the container runtime to stop that
                                                                                  container
        livenessProbe.timeoutSeconds                 1                   number   Number of seconds after which the probe times out
        livenessProbe.failureThreshold                                   number   After a probe fails failureThreshold times in a row, Kubernetes considers that
                                                                                  the overall check has failed
        livenessProbe.initialDelaySeconds            0                   number   Number of seconds after the container has started before liveness probes are
                                                                                  initiated
        livenessProbe.periodSeconds                  10                  number   How often (in seconds) to perform the probe
        livenessProbe.successThreshold               1                   number   Minimum consecutive successes for the probe to be considered successful after
                                                                                  having failed
        readinessProbe.initialDelaySeconds             0                 number   Number of seconds after the container has started before readiness probes are
                                                                                  initiated
        readinessProbe.periodSeconds                   10                number   How often (in seconds) to perform the probe
        readinessProbe.successThreshold                1                 number   Minimum consecutive successes for the probe to be considered successful after
                                                                                  having failed
        readinessProbe.terminationGracePeriodSeconds                     number   configure a grace period for the kubelet to wait between triggering a shut down
                                                                                  of the failed container, and then forcing the container runtime to stop that
                                                                                  container
        readinessProbe.timeoutSeconds                  1                 number   Number of seconds after which the probe times out
        readinessProbe.failureThreshold                                  number   After a probe fails failureThreshold times in a row, Kubernetes considers that
                                                                                  the overall check has failed
        startupProbe.periodSeconds                     10                number   How often (in seconds) to perform the probe
        startupProbe.successThreshold                  1                 number   Minimum consecutive successes for the probe to be considered successful after
                                                                                  having failed
        startupProbe.terminationGracePeriodSeconds                       number   configure a grace period for the kubelet to wait between triggering a shut down
                                                                                  of the failed container, and then forcing the container runtime to stop that
                                                                                  container
        startupProbe.timeoutSeconds                    1                 number   Number of seconds after which the probe times out
        startupProbe.failureThreshold                                    number   After a probe fails failureThreshold times in a row, Kubernetes considers that
                                                                                  the overall check has failed
        startupProbe.initialDelaySeconds               0                 number   Number of seconds after the container has started before probes are initiated
   

   For more information about configuring probes in Spring Boot conventions, see Configure liveness, readiness, and startup probes for Spring Boot applications (alpha)

3. Install the package by running:

   tanzu package install spring-boot-conventions \
    --package spring-boot-conventions.tanzu.vmware.com \
    --version VERSION-NUMBER \
    --namespace tap-install
   

   Where VERSION-NUMBER is the version of the package you listed earlier.

4. Verify you installed the package by running:

   tanzu package installed get spring-boot-conventions --namespace tap-install
   

   For example:

   tanzu package installed get spring-boot-conventions -n tap-install
   | Retrieving installation details for spring-boot-conventions...
   NAME:                    spring-boot-conventions
   PACKAGE-NAME:            spring-boot-conventions.tanzu.vmware.com
   PACKAGE-VERSION:         1.11.0
   STATUS:                  Reconcile succeeded
   CONDITIONS:              [{ReconcileSucceeded True  }]
   USEFUL-ERROR-MESSAGE:
   

   Verify that STATUS is Reconcile succeeded