Overriding Manifest Properties in Advanced Mode

Page last updated:

This topic describes how you can use Advanced Mode to override some manifest properties. This allows you to change properties that you cannot change through the Ops Manager UI or the Ops Manager API.

Overview

Ops Manager is an interface to the BOSH Director manifest and the runtime configs that underlie VMware Tanzu. Ops Manager does not allow you to edit the manifest and configs directly.

When you configure Ops Manager through the UI or API, you set many of the properties contained in the manifest and configs. Ops Manager sets some other properties for you, and other properties use the default values provided by VMware Tanzu or BOSH.

Use the manifest property override feature described in this topic to modify properties that cannot be modified in other ways.

Process

Follow the steps below to override manifest properties.

  1. If the property that you want to change can be modified through the Ops Manager UI or the Ops Manager API, use the UI or API to change the property.

  2. If the property cannot be modified through the Ops Manager UI or the Ops Manager API:

    1. Determine if the property can be overridden. See Overridable Properties.
    2. If the property is in the BOSH Director Manifest, see Override BOSH Director Manifest Properties.
    3. If the property is in one of the runtime configs, see Override Runtime Config Properties.

Warning: No validation is performed on the properties that you change using Advanced Mode. For example, if you enter a string where an integer is required, no error is given.

Overridable Properties

You can edit properties in the BOSH Director manifest and two of the runtime configs.

BOSH Director Manifest

In the BOSH Director manifest, you can override properties in the following sections:

  • network group
  • instance_group jobs

You cannot:

  • Edit properties in other sections of the BOSH Director manifest
  • Add or delete a network
  • Add or delete an instance group

Runtime Configs

You can edit properties in two add-ons in each of two of the runtime configs files. The table below lists these:

Runtime Config Add-on
ops_manager_dns_runtime
  • bosh_dns
  • bosh_dns_windows
ops_manager_system_metrics_runtime
  • system_metrics_agent
  • system_metrics_agent_windows

Prerequisites

Before you can override properties, you must set Ops Manager to Advanced Mode.

Warning: VMware recommends that only skilled operators use Advanced Mode in Ops Manager. If you use Advanced Mode incorrectly, you can disable or destroy your deployment.

To set Ops Manager to Advanced Mode, follow the instructions in How to Enable Advanced Mode in the Ops Manager in the Knowledge Base.

For additional information about Advanced Mode, see Advanced Mode in the Ops Manager API documentation.

Override BOSH Director Manifest Properties

To override properties in the BOSH Director manifest:

  1. Use the /api/v0/staged/director/overrides endpoint.

For more information, see Advanced Manifest Configuration in Ops Manager API documentation. This documentation also describes how to view the BOSH Director manifest, view overrides that are applied, and to delete the overrides.

Override Runtime Config Properties

To override properties in the runtime configs:

  1. Use the /api/v0/staged/director/runtime_configs/overrides endpoint.

For more information, see:

Examples of Overridable Properties

Examples of properties that customers have asked to override:

BOSH Director Manifest Example: Change the network type to dynamic

By default, the network type is set to manual. You cannot change this property through the Ops Manager UI or API. Override this by changing the value of the type property in the “Networks” block of the BOSH Director manifest.

Runtime Config Example: Change the timeout for the BOSH DNS network health check

By default, the network timeout for synchronous health checks is 1 second. You cannot cannot this property through the Ops Manager UI or API. Override this by changing the value of the health.health.synchronous_check_timeout property in the bosh-dns add-on of the ops_mananger_dns_runtime runtime config.