From Fedora Project Wiki

(How to document CSI variables in Ansible)
 
m (Minor change, its YAML that forbids tabs rather than Ansible. see https://yaml.org/faq.html)
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
== How to document CSI variables in Ansible ==




Line 16: Line 15:
         - Services a, b, c, rely on this system
         - Services a, b, c, rely on this system
         - Important other note
         - Important other note


== Special characters and other tips ==
== Special characters and other tips ==
Line 23: Line 20:
* A colon ":" is used as a variable separator. Please do not use them except as noted in the example.
* A colon ":" is used as a variable separator. Please do not use them except as noted in the example.
* A pipe "|" denotes multiple lines follow the variable separator.  
* A pipe "|" denotes multiple lines follow the variable separator.  
* Ansible does '''not''' expect tabs. Please use multiple spaces instead.
* Ansible (YAML) does '''not''' expect tabs when indending. Please use multiple spaces instead.
* To submit a patch with new CSI variables, please generate a patch from your git branch of the document you are working on by running git format-patch --> master >> name of patch. Then send email to infrastructure@lists.fedoraproject.org.
* To submit a patch with new CSI variables, please generate a patch from your git branch of the document you are working on by running git format-patch --> master >> name of patch. Then send email to infrastructure@lists.fedoraproject.org.
* Copy-pasting a patch to gmail via a web interface will affect the formatting of the patch
* Please see below code snippet for an easy way to submit a properly formatted patch via mutt from the command line.
    cat nameofyourpatch.patch | mutt -s "CSI variarables added to ...." infrastructure@lists.fedoraproject.org


If you have any questions, please feel free to ask in irc at #fedora-admin.
If you have any questions, please feel free to ask in irc at #fedora-admin.

Latest revision as of 23:18, 8 April 2020


Please use the following template to document CSI Variables in Ansible

   # These variables are moved into /etc/system_identification by the base role.
   # Groups and individual hosts should overide them with specific info.
   # See http://infrastructure.fedoraproject.org/csi/security-policy/
   
   csi_security_category:
   csi_primary_contact: Fedora Admins - admin@fedoraproject.org
   csi_purpose:
   csi_relationship: |
   
       - This system relies on x, y, z, etc
       - Services a, b, c, rely on this system
       - Important other note

Special characters and other tips

  • A colon ":" is used as a variable separator. Please do not use them except as noted in the example.
  • A pipe "|" denotes multiple lines follow the variable separator.
  • Ansible (YAML) does not expect tabs when indending. Please use multiple spaces instead.
  • To submit a patch with new CSI variables, please generate a patch from your git branch of the document you are working on by running git format-patch --> master >> name of patch. Then send email to infrastructure@lists.fedoraproject.org.
  • Copy-pasting a patch to gmail via a web interface will affect the formatting of the patch
  • Please see below code snippet for an easy way to submit a properly formatted patch via mutt from the command line.
   cat nameofyourpatch.patch | mutt -s "CSI variarables added to ...." infrastructure@lists.fedoraproject.org

If you have any questions, please feel free to ask in irc at #fedora-admin.