Skip to content

Latest commit

 

History

History
140 lines (99 loc) · 4.45 KB

troubleshooting-gitops.hbs.md

File metadata and controls

140 lines (99 loc) · 4.45 KB

Troubleshoot Tanzu GitOps Reference Implementation (RI)

This topic tells you how to troubleshoot Tanzu GitOps Reference Implementation (commonly known as RI).

Tanzu Sync application error

After the Tanzu Sync application is installed in the cluster, the main resource to check is the sync app in the tanzu-sync namespace:

kubectl -n tanzu-sync get app/sync --template='\{{.status.usefulErrorMessage}}'

Example error:

kapp: Error: waiting on reconcile packageinstall/tap (packaging.carvel.dev/v1alpha1) namespace: tap-install:
  Finished unsuccessfully (Reconcile failed:  (message: Error (see .status.usefulErrorMessage for details)))

This indicates that the resource packageinstall/tap in the namespace tap-install failed. See the following section for the solution details.

Tanzu Application Platform install error

After the Tanzu Sync application is installed in the cluster, the Tanzu Application Platform starts to install. The resource to check is the Tanzu Application Platform package install in the tap-install namespace:

kubectl -n tap-install get packageinstall/tap --template='\{{.status.usefulErrorMessage}}'

Common errors

You might encounter one of the following errors:

Given data value is not declared in schema

Error: Reconciliation fails with Given data value is not declared in schema

^ Reconcile failed:  (message: ytt: Error: Overlaying data values (in following order: tap-install/.tanzu-managed/version.yaml, additional data values):
One or more data values were invalid
====================================

Given data value is not declared in schema
tap-values.yaml:
    |
  1 | shared:
    |

    = found: shared
    = expected: a map item with the key named "tap_install" (from tap-install/.tanzu-managed/schema--tap-sensitive-values.yaml:3)

Problem: The values files were not generated according to the expected schema.

Solution: Ensure both non-sensitive and sensitive Tanzu Application Platform values files to adhere to the schema described in configure values.

Incorrect values example:

shared:
  ingress_domain: example.vmware.com

Correct values example:

tap_install:
  values:
    ingress_domain: example.vmware.com

ExternalSecret not found

Error: Reconciliation of ExternalSecret fails with secret not found

Example:

kubectl describe ExternalSecret install-registry-dockerconfig -n tanzu-sync

Status:
  Conditions:
    Last Transition Time:  2023-07-20T08:14:04Z
    Message:               could not get secret data from provider
    Reason:                SecretSyncedError
    Status:                False
    Type:                  Ready
Events:
  Type     Reason        Age                   From              Message
  ----     ------        ----                  ----              -------
  Warning  UpdateFailed  12s (x15 over 6m14s)  external-secrets  secret not found

  • Problem 1: Incorrect secret reference

    Solution 1: Ensure the references in tanzu-sync/app/values/tanzu-sync-vault-values.yaml and cluster-config/values/tap-install-vault-values.yaml are correct.

  • Problem 2: Incorrect configuration of the secret engine for Vault

    Solution 2: Validate and update the version of the Vault secrets engine configuration to v1 or v2. By default, v2 is chosen.

    Update tanzu-sync/app/values/tanzu-sync-vault-values.yaml:

    ---
secrets:
  eso:
    vault:
      ...
      version: "v1" # v1 or v2

    Update cluster-config/values/tap-install-vault-values.yaml:

    ---
tap_install:
  secrets:
    eso:
      vault:
        ...
        version: "v1" # v1 or v2

Error occurs when deleting Kubernetes authentication

Problem: The following error occurs when deleting Kubernetes authentication:

./tanzu-sync/vault/scripts/setup/delete-kubernetes-auth.sh
flag provided but not defined: -path

Cause: The command to disable vault authentication is incorrect.

Solution: Update the command vault auth disable -path=$CLUSTER_NAME kubernetes to vault auth disable $CLUSTER_NAME in the file ./tanzu-sync/vault/scripts/setup/delete-kubernetes-auth.sh