Correct comment for OSDPS 'Play' object

This change fixes the terminology used to describe the 'Play' object of the OpenStackDataPlaneService. This object is not an in-line 'playbook', but rather an individual Ansible 'Play'. The two are differentiated by their type. A Ansible Playbook is a list of Plays, where a Play is a dictionary object as per: https://github.com/ansible/ansible/blob/10f9b8e6554e024e3561170153b8e7fde5e7e4fb/test/units/playbook/test_play.py\#L48 Signed-off-by: Brendan Shephard <[email protected]>
bshephar · May 23, 2024 · 76f6eb9 · 76f6eb9
1 parent c85db45
commit 76f6eb9
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/api/v1beta1/openstackdataplaneservice_types.go b/api/v1beta1/openstackdataplaneservice_types.go
@@ -70,7 +70,9 @@ type OpenStackDataPlaneServiceSpec struct {
 	// +kubebuilder:validation:Optional
 	TLSCert *OpenstackDataPlaneServiceCert `json:"tlsCert,omitempty" yaml:"tlsCert,omitempty"`
 
-	// Play is an inline playbook contents that ansible will run on execution.
+	// Play is inline Ansible Play contents that ansible will run on execution.
+	// An Ansible Play should be in Dictionary format as per:
+	// https://github.com/ansible/ansible/blob/10f9b8e6554e024e3561170153b8e7fde5e7e4fb/test/units/playbook/test_play.py#L48
 	Play string `json:"play,omitempty"`
 
 	// Playbook is a path to the playbook that ansible will run on this execution