From 295988838b1c7a665810135371c540d4299544a0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Nicolas=20Mass=C3=A9?= <nicolas.masse@itix.fr>
Date: Fri, 1 Mar 2019 12:30:44 +0100
Subject: [PATCH] add doc

---
 CUSTOM.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 CUSTOM.md

diff --git a/CUSTOM.md b/CUSTOM.md
new file mode 100644
index 0000000..d896b6c
--- /dev/null
+++ b/CUSTOM.md
@@ -0,0 +1,35 @@
+# How to customize the behavior of this role
+
+## Speed-up the deployments
+
+Go save precious seconds during deployments, you can override the
+`threescale_cicd_throttling` variable.
+
+**WARNING:** the throttling is there to let the 3scale Admin Portal
+digest your changes. Use at your own risk!
+
+```yaml
+- hosts: threescale
+  gather_facts: no
+  vars:
+    threescale_cicd_throttling: 0
+  roles:
+  - nmasse-itix.threescale-cicd
+```
+
+## Customize the 3scale Service display name
+
+To have the 3scale Service display name generated from a different pattern
+(`ENV[name-vX.Y]` in the following example), override the `threescale_cicd_api_name`
+variable.
+
+```yaml
+- hosts: threescale
+  gather_facts: no
+  vars:
+    myenv: TEST
+    threescale_cicd_api_name: '{{ myenv }}[{{ threescale_cicd_api_default_name }}-v{{ threescale_cicd_api_version }}]'
+  roles:
+  - nmasse-itix.threescale-cicd
+```
+