save unicode

Author: allburov

README.md

@@ -1,5 +1,7 @@
 # Zabbix Review and Export
-Zabbix review and export (backup) can create review mechanism to zabbix configuration or only export (backup) all hosts templates and other object.
+With Zabbix review and export (backup) you can create review mechanism and save zabbix configuration as code (Monitoring as Code)
+
+You can only export (backup) all hosts templates and other object with `zabbix-export.py` script.
 
 - [Requirements](#requirements)
 - [Make export and backup](#make-export-and-backup)
@@ -14,47 +16,48 @@ Zabbix review and export (backup) can create review mechanism to zabbix configur
 
 
 If you want use [review (or Monitoring as Code](#make-review):
-- `git`
 - [GitLab](https://gitlab.com/) - you own instance with configured [GitLab CI](https://docs.gitlab.com/ee/ci/) or cloud account
+- `git`
 
 
 ## Make export and backup
 It's simple to start use this script as backup mechanism:
 ```bash
-# git clone THIS_REPO or download archive
+# git clone THIS_REPO or download and unpack archive
 
 python -mpip install -r requirements.xml
 
+# smoke test :)
 python ./zabbix-export.py --help
 
-# backup to current folder XML and JSON
+# backup to current folder, save XML and JSON
 python ./zabbix-export.py --zabbix-url https://zabbix.example.com --zabbix-username user --zabbix-password password
 
-# backup YAML
+# backup zabbix configuration in YAML format
 python ./zabbix-export.py --save-yaml --zabbix-url https://zabbix.example.com --zabbix-username user --zabbix-password password
 
-# backup to custom folder as YAML
+# backup to custom folder in YAML format
 python ./zabbix-export.py --save-yaml --directory /home/username/path/to/zabbix-yaml --zabbix-url https://zabbix.example.com --zabbix-username user --zabbix-password password
 ```
 
 ## Make review
-If you want to make review (Moniroting as Code). Read more on habr.com: [RU](#), [EN translated](#)
+You want to make review (Moniroting as Code). Read more on habr.com: [RU](#), [EN translated](#)
 1. Fork this repository to you GitLab account or instance (e.g. `groupname/zabbix-review-export`)
-2. Create repository where will be saved XML and YAML (e.g. two repository `groupname/zabbix-xml` and `groupname/zabbix-yaml`. And do first commit (create empty `README.md`)
-3. Create two branches in this repos: `master` and `develop`. In repository `groupname/zabbix-xml` set `develop` [default branch](https://docs.gitlab.com/ee/user/project/repository/branches/#default-branch).
-4. Specify [Project Variables](https://docs.gitlab.com/ee/ci/variables/#variables) for all variables, specified on top in [.gitlab-ci.yml](./.gitlab-ci.yml)
-5. Change jobs in `.gitlab-ci.yml` and Leave the ones you need job in `.gitlab-ci.yml` and change to you environment (see commented examples block).
+2. Create repository where will be saved XML and YAML (e.g. two repositories `groupname/zabbix-xml` and `groupname/zabbix-yaml`. Do first (init) commit (create empty `README.md`).
+3. Create two branches in this repos: `master` and `develop`. In repository `groupname/zabbix-xml` set `develop` as a [default branch](https://docs.gitlab.com/ee/user/project/repository/branches/#default-branch).
+4. Specify [Project Variables](https://docs.gitlab.com/ee/ci/variables/#variables) for all variables, specified on top of [.gitlab-ci.yml](./.gitlab-ci.yml)
+5. Change jobs in `.gitlab-ci.yml` and leave the ones you need job in `.gitlab-ci.yml` and change to you environment (see commented examples block).
 6. Try to run manual job `YAML zabbix`
 7. Create merge request `develop=>master` in `zabbix-yaml`. For first time you can merge without review, it's too hard :)
 8. Configure [Schedule](https://docs.gitlab.com/ee/user/project/pipelines/schedules.html) (eg. every week)
 9. Change some host, template or other [supported objects](#supported-objects) in zabbix, run manual job and create merge request again. Enjoy!
 
 ### Notes
-Use two different repositories for XML+JSON (raw-format) and readable YAML format:
+Use two repositories for XML+JSON (raw-format) and readable YAML format:
 - `XML` + `JSON` will be useful if you want restore some object after remove or alarge number of changes.
-- `YAML` format is more suitable for people to read and review changes. Also the script removes all empty values.
+- `YAML` format is more suitable for people to read and review changes. The script removes all empty values.
 
-Also, after merge we create empty merge request `develop=>master` and receive all notifications at changes (schedule or manual jobs run).
+Create empty merge request `develop=>master` after merge and receive notifications at changes (schedule or manual jobs run) on your email.
 
 To answer for the question "Who make this changes?" you need use [Zabbix Audit](https://www.zabbix.com/documentation/4.0/manual/web_interface/frontend_sections/reports/audit). It's difficult but possible.
 
@@ -80,5 +83,8 @@ YAML change action:
 YAML change trigger expression:
 ![yaml-change-trigger-expression.png](./docs/yaml-change-trigger-expression.png)
 
+YAML link template
+![yaml-link-template.jpg](./docs/yaml-link-template.jpg)
+
 XML change templates (but we recommend use YAML for review and XML only for backup):
 ![xml-change-templates.jpg](./docs/xml-change-templates.jpg)

docs/yaml-link-template.jpg

@@ -93,13 +93,13 @@ def dumps_json(object, data, directory, key='name', save_yaml=False):
         logging.debug("Write to file '{}'".format(filename))
 
         if save_yaml:
-            txt = convert_to_object_without_none(txt)
+            txt = convert_to_yaml_without_none(txt)
 
         with open(filename, mode="w", encoding='utf-8', newline='\n') as file:
             file.write(txt)
 
 
-def convert_to_object_without_none(txt):
+def convert_to_yaml_without_none(txt):
     """
     Convert any object to OrderDict without None value
     """
@@ -108,7 +108,7 @@ def convert_to_object_without_none(txt):
     raw = remove_none(raw)
     represent_dict_order = lambda self, data: self.represent_mapping('tag:yaml.org,2002:map', data.items())  # noqa
     yaml.add_representer(OrderedDict, represent_dict_order)
-    txt = yaml.dump(raw, default_flow_style=False, width=10000)
+    txt = yaml.dump(raw, default_flow_style=False, width=10000, allow_unicode=True)
     return txt
 
 
@@ -140,7 +140,7 @@ def dump_xml(object, txt, name, directory, save_yaml=False):
     txt = txt.replace('"', '"')
 
     if save_yaml:
-        txt = convert_to_object_without_none(txt)
+        txt = convert_to_yaml_without_none(txt)
 
     logging.debug("Write to file '{}'".format(filename))
     with open(filename, mode="w", encoding='utf-8', newline='\n') as file: