Wrote table configuration #80

docs/configuration_options.rst

@@ -3,8 +3,8 @@ Dynamic DynamoDB configuration
 
 The sections below describe the various options available in the Dynamic DynamoDB configuration file. See :ref:`_example_configuration_file`.
 
-Global options
---------------
+Global configuration
+--------------------
 
 **Section name:** ``[global]``
 
@@ -19,8 +19,8 @@ Option                                Type Comment
 ``circuit-breaker-timeout``           int  Timeout for the circuit breaker, in ms
 ===================================== ==== ==========================================
 
-Logging options
----------------
+Logging configuration
+---------------------
 
 **Section name:** ``[logging]``
 
@@ -30,3 +30,35 @@ Option                                Type Comment
 ``log-level``                         str  Log level (``debug``, ``info``, ``warning`` or ``error``)
 ``log-file``                          str  Path to log file. Logging to stdout if this option is not present
 ===================================== ==== ==========================================
+
+Table configuration
+-------------------
+
+**Section name:** ``[table: ^my_table$]``
+
+Important note: The table name is treated as a regular expression. That means that ``my_table`` also will match ``my_table2``, unless you express it as a valid regular expression; ``^my_table$``. This feature enables you to easily configure many tables or tables with dynamic names.
+
+========================================== ==== ==========================================
+Option                                     Type Comment
+========================================== ==== ==========================================
+``reads-upper-threshold``                  int  How many percent of the table capacity should be used before Dynamic DynamoDB scales up the read provisioning?
+``reads-lower-threshold``                  int  How many percent of the table capacity should be used before Dynamic DynamoDB scales down the read provisioning?
+``increase-reads-with``                    int  Number of units or percent we should scale up the provisioning with. Choose entity with ``increase-reads-unit``.
+``decrease-reads-with``                    int  Number of units or percent we should scale down the provisioning with. Choose entity with ``decrease-reads-unit``.
+``increase-reads-unit``                    str  Set if we should scale up in ``units`` or ``percent``
+``decrease-reads-unit``                    str  Set if we should scale down in ``units`` or ``percent``
+``min-provisioned-reads``                  int  Minimum number of read units for the table
+``max-provisioned-reads``                  int  Maximum number of read units for the table
+``writes-upper-threshold``                 int  How many percent of the table capacity should be used before Dynamic DynamoDB scales up the write provisioning?
+``writes-lower-threshold``                 int  How many percent of the table capacity should be used before Dynamic DynamoDB scales down the write provisioning?
+``increase-writes-with``                   int  Number of units or percent we should scale up the provisioning with. Choose entity with ``increase-writes-unit``.
+``decrease-writes-with``                   int  Number of units or percent we should scale down the provisioning with. Choose entity with ``decrease-writes-unit``.
+``increase-writes-unit``                   str  Set if we should scale up in ``units`` or ``percent``
+``decrease-writes-unit``                   str  Set if we should scale down in ``units`` or ``percent``
+``min-provisioned-writes``                 int  Minimum number of write units for the table
+``max-provisioned-writes``                 int  Maximum number of write units for the table
+``maintenance-windows``                    str  Force Dynamic DynamoDB to operate within maintenance windows. E.g. ``22:00-23:59,00:00-06:00``
+``allow-scaling-down-reads-on-0-percent``  bool Allow down scaling of read units when 0% is used.
+``allow-scaling-down-writes-on-0-percent`` bool Allow down scaling of write units when 0% is used.
+``always-decrease-rw-together``            bool Restric scale down to only happen when both reads AND writes are in need of scaling down. Set this to ``true`` to minimize down scaling.
+========================================== ==== ==========================================

docs/example_configuration.rst

@@ -87,7 +87,7 @@ This is a full example of a Dynamic DynamoDB configuration file.
     #allow-scaling-down-reads-on-0-percent: true
     #allow-scaling-down-writes-on-0-percent: true
 
-    # Restric scale down to only happend when BOTH reads AND writes are in need
+    # Restric scale down to only happen when BOTH reads AND writes are in need
     # of scaling down. Set this to "true" to minimize down scaling.
     #always-decrease-rw-together: true