Install Application Accelerator

This topic tells you how to install Application Accelerator 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 Application Accelerator. For more information about profiles, see About Tanzu Application Platform components and profiles.

Prerequisites

Before installing Application Accelerator:

Install

To install Application Accelerator:

  1. List version information for the package by running:

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

    For example:

    $ tanzu package available list accelerator.apps.tanzu.vmware.com --namespace tap-install
    
    - Retrieving package versions for accelerator.apps.tanzu.vmware.com...
      NAME                               VERSION  RELEASED-AT
      accelerator.apps.tanzu.vmware.com  1.4.0    2022-12-08 12:00:00 -0500 EST
    
  2. (Optional) View the changes you can make to the default installation settings by running:

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

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

    For example:

    $ tanzu package available get accelerator.apps.tanzu.vmware.com/1.4.0 \
        --values-schema \
        --namespace tap-install
    

    For more information about values schema options, see the properties listed in Configure properties and resource use later.

  3. Create a file named app-accelerator-values.yaml using the following example code:

    server:
      service_type: "LoadBalancer"
      watched_namespace: "accelerator-system"
    samples:
      include: true
    
  4. Edit the values in your app-accelerator-values.yaml if needed, or leave the default values. You can add values you want from Configure properties and resource use.

  5. Install the package by running:

    tanzu package install app-accelerator \
      --package accelerator.apps.tanzu.vmware.com \
      --version VERSION-NUMBER \
      --namespace tap-install \
      --values-file app-accelerator-values.yaml
    

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

    For example:

    $ tanzu package install app-accelerator \
        --package accelerator.apps.tanzu.vmware.com \
        --version 1.4.0 \
        --namespace tap-install \
        --values-file app-accelerator-values.yaml
    
    - Installing package 'accelerator.apps.tanzu.vmware.com'
    | Getting package metadata for 'accelerator.apps.tanzu.vmware.com'
    | Creating service account 'app-accelerator-tap-install-sa'
    | Creating cluster admin role 'app-accelerator-tap-install-cluster-role'
    | Creating cluster role binding 'app-accelerator-tap-install-cluster-rolebinding'
    | Creating secret 'app-accelerator-tap-install-values'
    - Creating package resource
    - Package install status: Reconciling
    
     Added installed package 'app-accelerator' in namespace 'tap-install'
    
  6. Verify the package install by running:

    tanzu package installed get app-accelerator -n tap-install
    

    For example:

    $ tanzu package installed get app-accelerator -n tap-install
    
    | Retrieving installation details for cc...
    NAME:                    app-accelerator
    PACKAGE-NAME:            accelerator.apps.tanzu.vmware.com
    PACKAGE-VERSION:         1.4.0
    STATUS:                  Reconcile succeeded
    CONDITIONS:              [{ReconcileSucceeded True  }]
    USEFUL-ERROR-MESSAGE:
    

    Verify that STATUS is Reconcile succeeded.

  7. To see the IP address for the Application Accelerator API when the server.service_type is set to LoadBalancer, run:

    kubectl get service -n accelerator-system
    

    This lists an external IP address for use with the --server-url Tanzu CLI flag for the Accelerator plug-in generate & generate-from-local command.

For how to troubleshoot installation issues, see Troubleshoot Application Accelerator.

Configure properties and resource use

When you install the Application Accelerator, you can configure the following optional properties from within your app-accelerator-values.yaml configuration file:

Property Default Description
registry.secret_ref reg-creds The secret used for accessing the registry where the App-Accelerator images are located
server.service_type ClusterIP The service type for the acc-ui-server service including LoadBalancer, NodePort, or ClusterIP
server.watched_namespace accelerator-system The namespace the server watches for accelerator resources
server.engine_invocation_url http://acc-engine.accelerator-system.svc.cluster.local/invocations The URL to use for invoking the accelerator engine
engine.service_type ClusterIP The service type for the acc-engine service including LoadBalancer, NodePort, or ClusterIP
engine.max_direct_memory_size 32M The maximum size for the Java -XX:MaxDirectMemorySize setting
samples.include True Option to include the bundled sample Accelerators in the installation
ingress.include False Option to include the ingress configuration in the installation
ingress.enable_tls False Option to include TLS for the ingress configuration
domain tap.example.com Top-level domain to use for ingress configuration, default is shared.ingress_domain
tls.secret_name tls The name of the secret
tls.namespace tanzu-system-ingress The namespace for the secret
telemetry.retain_invocation_events_for_no_days 30 The number of days to retain recorded invocation events resources
telemetry.record_invocation_events true The system records each engine invocation when generating files for an accelerator?
git_credentials.secret_name git-credentials The name to use for the secret storing Git credentials for accelerators
git_credentials.username null The user name to use in secret storing Git credentials for accelerators
git_credentials.password null The password to use in secret storing Git credentials for accelerators
git_credentials.ca_file null The CA certificate data to use in secret storing Git credentials for accelerators
managed_resources.enable false Whether to enable the App used to control managed accelerator resources
managed_resources.git.url none Required if managed_resources are enabled. Git repository URL containing manifests for managed accelerator resources
managed_resources.git.ref origin/main Required if managed_resources are enabled. Git ref to use for repository containing manifests for managed accelerator resources
managed_resources.git.sub_path null Git subPath to use for repository containing manifests for managed accelerator resources
managed_resources.git.secret_ref git-credentials Secret name to use for repository containing manifests for managed accelerator resources

VMware recommends that you do not override the default setting for registry.secret_ref, server.engine_invocation_url, or engine.service_type. These properties are only used to configure non-standard installations.

The following table is the resource use configurations for the components of Application Accelerator.

Component Resource requests Resource limits
acc-controller CPU: 100m
memory: 20Mi
CPU: 100m
memory: 30Mi
acc-server CPU: 100m
memory:20Mi
CPU: 100m
memory: 30Mi
acc-engine CPU: 500m
memory: 1Gi
CPU: 500m
memory: 2Gi
check-circle-line exclamation-circle-line close-line
Scroll to top icon