X-Git-Url: https://gerrit.mcp.mirantis.com/gitweb?p=salt-formulas%2Finfluxdb.git;a=blobdiff_plain;f=README.rst;h=c79788f4bd6c856dfcf57007c5afa65e347a577a;hp=23b12f0004268a81814f44f55af05992278f6732;hb=363844afb06635c9194086497341ea490c5e77e2;hpb=1091d4622bc857bd8aec6148a4f90be8f5c6fdec;ds=inline diff --git a/README.rst b/README.rst index 23b12f0..c79788f 100644 --- a/README.rst +++ b/README.rst @@ -54,6 +54,21 @@ need to ensure that directories exist: meta: dir: '/opt/influxdb/meta' +InfluxDB server with customized parameters for the data service: + +.. code-block:: yaml + + influxdb: + server: + enabled: true + data: + max_series_per_database: 20000000 + cache_max_memory_size: 524288000 + cache_snapshot_memory_size: 26214400 + cache_snapshot_write_cold_duration: "5m" + compact_full_write_cold_duration: "2h"2h" + max_values_per_tag: 5000 + Single-node influxdb with an admin user: .. code-block:: yaml @@ -108,6 +123,30 @@ Single-node influxdb with new databases: enabled: true name: mydb2 +Manage the retention policies for a database: + +.. code-block:: yaml + + influxdb: + server: + database: + mydb1: + enabled: true + name: mydb1 + retention_policy: + - name: rp_db1 + duration: 30d + replication: 1 + is_default: true + +Where default values are: + +* name = autogen +* duration = INF +* replication = 1 +* is_default: false + + Here is how to manage grants on database: .. code-block:: yaml @@ -191,7 +230,74 @@ Deploy influxdb apt repository (using linux formula): source: 'deb https://repos.influxdata.com/${linux:system:os} ${linux:system:dist} stable' key_url: 'https://repos.influxdata.com/influxdb.key' +InfluxDB client for configuring databases, users and retention policies: + +.. code-block:: yaml + + influxdb: + client: + enabled: true + server: + protocol: http + host: 127.0.0.1 + port: 8086 + user: admin + password: foobar + user: + user1: + enabled: true + admin: true + name: username1 + database: + mydb1: + enabled: true + name: mydb1 + retention_policy: + - name: rp_db1 + duration: 30d + replication: 1 + is_default: true + grant: + username1_mydb1: + enabled: true + user: username1 + database: mydb1 + privilege: all + Read more ========= * https://influxdata.com/time-series-platform/influxdb/ + +Documentation and Bugs +====================== + +To learn how to install and update salt-formulas, consult the documentation +available online at: + + http://salt-formulas.readthedocs.io/ + +In the unfortunate event that bugs are discovered, they should be reported to +the appropriate issue tracker. Use Github issue tracker for specific salt +formula: + + https://github.com/salt-formulas/salt-formula-influxdb/issues + +For feature requests, bug reports or blueprints affecting entire ecosystem, +use Launchpad salt-formulas project: + + https://launchpad.net/salt-formulas + +You can also join salt-formulas-users team and subscribe to mailing list: + + https://launchpad.net/~salt-formulas-users + +Developers wishing to work on the salt-formulas projects should always base +their work on master branch and submit pull request against specific formula. + + https://github.com/salt-formulas/salt-formula-influxdb + +Any questions or feedback is always welcome so feel free to join our IRC +channel: + + #salt-formulas @ irc.freenode.net