Persisting Custom Settings in Helm Charts for VMware Aria Automation

Products

• VMware Aria Suite

Issue/Introduction

When making configuration changes to VMware Aria Automation pods using the kubectl edit deployment command, these changes do not persist through environment restarts or upgrades. To ensure the settings are retained, modifications must be applied to the Helm chart configuration files.

Environment

VMware Aria Automation 8.x

Cause

Changes made with kubectl edit deployment only modify the live pod configuration and are not stored in the underlying Helm chart templates. When the environment is restarted or upgraded, Kubernetes redeploys the pods based on the original Helm chart definitions, overwriting the live changes.

Resolution

Prerequisites:

1. You have administrative SSH access to the VMware Aria Automation appliance with root user and password.
2. Verify that the necessary configuration settings are identified and ready to be applied.
3. You have valid backups or snapshots of the Aria Automation appliance(s).
4. You are familiar with Kubernetes, Helm, and VMware Aria Automation configurations.

Procedure:

1. Locate the Relevant Helm Chart File:

   • Navigate to the Helm chart directory on the VMware Aria Automation appliance:
      

     cd /opt/charts

2. Edit the Helm Chart Configuration:

   • Open the appropriate YAML file for the desired service. For example:
      

     vi /opt/charts/provisioning-service/templates/deployment.yaml
   • Find the section where Java options (JAVA_OPTS) or other configurations are specified. Add or modify the necessary value. For example:
      

     -Denable.remote-console-proxy=false

3. Save the Changes:

   • Save and exit the file:
      

     :wq!

4. Apply the Updated Configuration:

   • Restart the environment using the deploy.sh script to ensure the changes are applied:
      

     /opt/scripts/deploy.sh

5. Verify the Changes:

   • Check the running configuration to confirm that the updates have been applied successfully:
      

     kubectl describe deployment <deployment-name>

6. Repeat After Upgrades:

   • Note that these changes will not persist through upgrades. After upgrading VMware Aria Automation, repeat the procedure to reapply the changes.

Additional Information

• Related KB articles:
  • Cannot Establish a Remote Console Connection
• For complex configurations, consider consulting VMware Support for assistance.