

Generic Configs

Note

Generic configs functionality is available with bosh-release v264+.

Several configuration files such as cloud config must be specified for the Director to successfully complete a deploy. Even though only cloud config is required, there are other configs like runtime config and CPI config you may want to set. Given that functionality of saving, retrieving, viewing, diffing, and listing for different configs is very similar, Director provides a consolidated CLI and API functionality to support all these actions.

Additionally, in some cases it may be useful to split cloud config and/or other configurations into multiple named files so that they can be managed and evolved separately. For example one team can be setting runtime config with IPSec addon and another team separately can manage Syslog forwarding addon. To achieve separation you can give different names (e.g. ipsec and syslog) to configs of the same type (e.g. runtime).

Director Types¶

There are three built-in types: cloud, runtime and cpi. You can interact with the Director config types just as you have been doing so far via the update-cloud-config, update-runtime-config and update-cpi-config CLI commands respectively. By using these commands you will only be able to interact with the default named config of the given type. This will be good enough in most cases but like in our example before if you need to create separate configs with different names, you need to use the update-config command. Keep in mind that if you use the config commands to interact with the built-in types, you still need to comply with the structure of the YAML file for each type.

User defined Types¶

In addition to the Director types an operator can set config of any other type using the update-config CLI command. The config file can be any file containing valid YAML. Root of the file must be a hash.

One of the use cases for providing such open ended functionality is to provide shared configuration API for supporting BOSH services instead of reimplementing something similar in each service. An upcoming example that will use this feature will be introduction of the resurrection config type that will allow operators to define custom resurrection rules, later read and interpreted by the Health Monitor.

Updating and retrieving a config¶

To add or update a config on the Director use the bosh update-config CLI command.

bosh update-config --type=my-type --name=my-configs-name configs.yml

Using environment '192.168.56.6' as client 'admin'

+ configs:
+   - name: team-a-config
+     properties:
+       ...
+   - name: team-b-config
+     properties:
+       ...

Continue? [yN]: y

Succeeded

bosh config --type=my-type --name=my-configs-name

Using environment '192.168.56.6' as client 'admin'

ID          1
Type        my-type
Name        my-configs-name
Created At  2023-10-26 16:29:47 UTC
Content     configs:
            - name: team-a-config
              properties:
              ...
            - name: team-b-config
              properties:
              ...

Listing configs¶

To list all configs use the bosh configs CLI command.

bosh configs

Using environment '192.168.56.6' as client 'admin'


ID  Type     Name              Team  Created At
1*  my-type  my-configs-name   -     2023-10-26 16:29:47 UTC
4*  my-type  my-configs-name-b -     2023-10-26 15:29:47 UTC

(*) Currently active
Only showing active configs. To see older versions use the --recent=10 option.

2 configs

Succeeded

You can also filter configs by type and/or name:

bosh configs --type=my-type --name=my-configs-name-b

Using environment '192.168.56.6' as client 'admin'


ID  Type     Name              Team  Created At
4*  my-type  my-configs-name-b -     2023-10-26 15:29:47 UTC

(*) Currently active
Only showing active configs. To see older versions use the --recent=10 option.

1 configs

Succeeded

Deleting configs¶

To delete configs use the bosh delete-config CLI command.

bosh delete-config 1

or

bosh delete-config --type=my-type --name=my-configs-name