The v3 CFS API contains a number of differences and improvements over the previous v2 API. For convenience all changes are listed here.
The v3 API uses snake_case rather than camelCase for all parameters in queries and responses.
This brings the API in line with other CSM APIs.
CFS v3 supports paging through records for components, configurations, and sessions.
The response format has changed for queries listing these records.
Responses are no longer a list of records, and instead contain a key for the record type which
contains the list of records. (E.g. {"components":[]} for the components endpoint).
Responses also include a next section that is used for paging through records.
See Paging CFS Records for more information.
Some fields now have maximum sizes:
Starting in CSM 1.7, CFS v3 supports Multi-tenancy. For more information, see Managing Sensitive Tenant Information in VCS with SOPS.
Session and component records now include a logs field with a link to the ARA UI with the
appropriate filter for that session or component.
For more information, see:
Component records no longer include the state list of applied playbooks by default.
The state can requested with the state_details parameter.
In CFS v2, the configuration layer status is embedded as part of the commit field.
In CFS v3, this is no longer the case; there is a dedicated status field for each layer.
CFS Global Options control various aspects of CFS. CFS v3 includes some changes to these options.
The Default playbook option is now deprecated. It can still be read using the v3 API but can not be set using the v3 API. Any value set using the v2 API will still be usable by configurations, even v3 configurations, until the v2 API is removed.
Sessions now support a debug_on_failure option that will cause sessions that fail during Ansible
execution to remain up for a limited time so that users can exec into the
Ansible Execution Environment (AEE) container and debug
the problem.
See Troubleshoot CFS Issues for more information.
CFS v3 supports new debugging playbooks which are included by default.
This can be accessed by specifying debug_fail, debug_facts or debug_noop as the
configuration for a session if a configuration has not already been created with that name.
See Troubleshoot CFS Issues for more information.
The CFS v3 supports the creation of CFS Sources. Sources allow CFS to use configuration and inventory content from external repositories.
For more information, see: