Failed component cleanup during VCF 9.1 installation or upgrade
search cancel

Failed component cleanup during VCF 9.1 installation or upgrade

book

Article ID: 441333

calendar_today

Updated On:

Products

VMware Cloud Foundation VMware vSphere Foundation

Issue/Introduction

This article outlines the specific scenarios within a VMware Cloud Foundation (VCF) 9.1 deployment or upgrade where failed components must be cleaned up before retrying operations. Manual cleanup is required in the following instances:

  • Duplicate Component Imports: Instances where the same 9.0 component is imported twice require removal.
  • Imported component is no longer upgradable: Fresh redeployment of 9.1 VCF Automation, 9.1 Log Management or 9.1 Identity Broker is required instead of upgrading from 9.0 to 9.1. 
  • Incorrect FQDN Configuration: Scenarios where a component was deployed with an incorrect FQDN, requiring a full redeployment with the correct FQDN.
  • VCFA 9.1 Redeployment: Applicable when a VCFA 9.1 instance encounters critical issues requiring a fresh deployment.

Environment

  • VCF 9.1
  • VVF 9.1

Resolution

Table of Contents

Preparatory Information

  • VSP refers to VCF Management Services.
  • This script can be run from any system with Python3 installed that has network access to the Fleet and VCF Management Services components. In a VCF environment, it is recommended to execute the script from SDDC Manager.
  • A failed upgrade entry remains visible after cleaning up of a component. But this entry does not block upgrade tasks and can be safely ignored.



  • Replace placeholder FQDNs such as <fleet-lcm-fqdn> with actual values. Retrieve values from the VCF Operations UI -> Build -> Lifecycle -> VCF Management -> Components (e.g. vsp.example.com for <vcf-services-runtime-fqdn>).

Running the Script

The commands required to list and cleanup a component vary depending on the component type. The steps below detail the correct syntax to execute the script.

Warning: Prior to the cleanup, verify a backup of all critical component data exists, such as logs or database backups.

  1. Identity Broker (VIDB)

    1. VIDB 9.1 with VCF SSO Configured

      1. Cleanup of Identity Broker 9.1 with SSO configured is not supported.
      2. Delete the existing SSO configuration before the component cleanup, refer Delete a VCF Single Sign-On Configuration for more information.

    2. VIDB 9.1 without VCF SSO Configured

      Note: This action completely removes the VIDB solution from VCF Fleet.

      1. List the VIDB component

        python cleanup_component.py list vsp-component --fleet-fqdn <fleet-lcm-fqdn> --vcf-services-runtime-fqdn <vcf-services-runtime-fqdn> --vcf-services-runtime-username [email protected]

      2. Clean up the VIDB component

        python cleanup_component.py delete vsp-component --component-id <vsp-component-id> --fleet-fqdn <fleet-lcm-fqdn> --vcf-services-runtime-fqdn <vcf-services-runtime-fqdn> --vcf-services-runtime-username [email protected]

    3. VIDB 9.0  (Remove a previously imported VIDB 9.0 instance from VCF 9.1 Fleet Lifecycle)

      Note: This action cleans component details from the VCF Fleet Lifecycle, VCF SSO continues to function, and the existing 9.0 VIDB cluster remains intact.

      1. List VIDB component
        python cleanup_component.py list vsp-component --fleet-fqdn <fleet-lcm-fqdn> --vcf-services-runtime-fqdn <vcf-services-runtime-fqdn> --vcf-services-runtime-username [email protected]

        Note: Enter the password of vmware-system-user for [email protected] account as both the accounts have the same password.

      2. Clean up VIDB component
        python cleanup_component.py delete vsp-component --component-id <vsp-component-id> --fleet-fqdn <fleet-lcm-fqdn> --vcf-services-runtime-fqdn <vcf-services-runtime-fqdn> --vcf-services-runtime-username [email protected]

         

  2. Log Management


    1. Log Management 9.1

      Note: This will completely remove the Log Management solution from VCF Fleet.

      1. List the Log Management component

        python cleanup_component.py list vsp-component --fleet-fqdn <fleet-lcm-fqdn> --vcf-services-runtime-fqdn <vcf-services-runtime-fqdn> --vcf-services-runtime-username [email protected]

      2. Clean up the Log Management component

        python cleanup_component.py delete vsp-component --component-id <vsp-component-id> --fleet-fqdn <fleet-lcm-fqdn> --vcf-services-runtime-fqdn <vcf-services-runtime-fqdn> --vcf-services-runtime-username [email protected]

    2. Operations for Logs 9.0   (Remove a previously imported Operations For Logs 9.0 instance from VCF 9.1 Fleet Lifecycle)    

      Note: This action cleans component details from the VCF Fleet Lifecycle, the existing Operations for Logs instance continues to function.

      1. List Operations for Logs component

        python cleanup_component.py list vsp-component --fleet-fqdn <fleet-lcm-fqdn> --vcf-services-runtime-fqdn <vcf-services-runtime-fqdn> --vcf-services-runtime-username [email protected]

      2. Clean up Operations for Logs component

        python cleanup_component.py delete vsp-component --component-id <vsp-component-id> --fleet-fqdn <fleet-lcm-fqdn> --vcf-services-runtime-fqdn <vcf-services-runtime-fqdn> --vcf-services-runtime-username [email protected]

  3. VCF Automation

    Note:     VCF Automation Upgrade Failure cleanup is not supported, Contact support for assistance with cleaning up VCF Automation upgrade failures. The procedure below applies only to scenarios where the existing VCFA 9.1 instance encounters critical issues requiring a fresh deployment.

    1. VCF Automation 9.1

      Note:
      This will completely remove the VCF Automation solution from VCF Fleet.
      This script requires execution as the root user inside the SDDC Manager virtual machine.

      1. VCF Automation and Migration Service Engine

        Remove VCF Automation and the Migration Service Engine before removing VCF Automation VCF Services Runtime.

        1. List components deployed on VCF Services Runtime
          python cleanup_component.py list vsp-component --fleet-fqdn <fleet-lcm-fqdn> --vcf-services-runtime-fqdn <vcf-services-runtime-fqdn> --vcf-services-runtime-username [email protected]

          Note: Enter the password of vmware-system-user for [email protected] account as both the accounts have the same password.

        2. Clean up component deployed on the VCF Automation VCF Services Runtime

          python cleanup_component.py delete vsp-component --component-id <vsp-component-id> --fleet-fqdn <fleet-lcm-fqdn> --vcf-services-runtime-fqdn <vcf-services-runtime-fqdn> --vcf-services-runtime-username [email protected] --vcfa-vcf-services-runtime-fqdn <vcfa-vcf-services-runtime-fqdn> --vcfa-vcf-services-runtime-username <vcfa-vcf-services-runtime-username>
      2. VCF Automation VCF Services Runtime

        Warning: Deleting a VCF Services Runtime requires this script to be executed as the root user inside the SDDC Manager virtual machine.

        1. List VCF Services Runtime
          python cleanup_component.py list vsp-cluster --fleet-fqdn <fleet-lcm-fqdn> --vcf-services-runtime-fqdn <vcf-services-runtime-fqdn> --vcf-services-runtime-username [email protected]

          Note:  Enter the password of vmware-system-user for [email protected] account as both the accounts have the same password.

        2. Clean up VCF Services Runtime
          python cleanup_component.py delete vsp-cluster --component-id <vsp-cluster-id> --fleet-fqdn <fleet-lcm-fqdn> --vcf-services-runtime-fqdn <vcf-services-runtime-fqdn> --vcf-services-runtime-username [email protected] --vcenter-username <vcenter-username>

          Note: Replace <vcenter-username> with SSO Administrator account, eg. [email protected]

    2. VCF Automation 9.0 (Remove a previously imported VCF Automation 9.0 instance from VCF 9.1 Fleet Lifecycle)

      Note: This action cleans component details from the VCF Fleet Lifecycle, the existing VCF Automation 9.0 cluster and configuration remain intact.

      1. List VCF Automation 9.0 component

        python cleanup_component.py list vsp-component --fleet-fqdn <fleet-lcm-fqdn> --vcf-services-runtime-fqdn <vcf-services-runtime-fqdn> --vcf-services-runtime-username [email protected]

      2. Clean up VCF Automation 9.0 component

        python cleanup_component.py delete vsp-component --component-id <vsp-component-id> --fleet-fqdn <fleet-lcm-fqdn> --vcf-services-runtime-fqdn <vcf-services-runtime-fqdn> --vcf-services-runtime-username [email protected]

Additional Information

Attachments

cleanup_component.py get_app
Powered by Wolken Software