From 2ed6968c0a859c31f33f6754edce17a58d4a17cc Mon Sep 17 00:00:00 2001 From: Chris Pitman Date: Sun, 21 Oct 2018 13:54:38 -0400 Subject: [PATCH] Document snake_case conversion by ansible operator --- doc/ansible/user-guide.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/ansible/user-guide.md b/doc/ansible/user-guide.md index ef100454591..efb33ccef90 100644 --- a/doc/ansible/user-guide.md +++ b/doc/ansible/user-guide.md @@ -111,6 +111,9 @@ Defining the spec for an Ansible Operator can be done entirely in Ansible. The Ansible Operator will simply pass all key value pairs listed in the Custom Resource spec field along to Ansible as [variables](https://docs.ansible.com/ansible/2.5/user_guide/playbooks_variables.html#passing-variables-on-the-command-line). +The names of all variables in the spec field are converted to snake_case +by the operator before running ansible. For example, `serviceAccount` in +the spec becomes `service_account` in ansible. It is recommended that you perform some type validation in Ansible on the variables to ensure that your application is receiving expected input.