Gitiles
Code Review Sign In
gerrit.mcp.mirantis.com / salt-formulas / memcached / 004a8ffd91037c1a01f672de4a3931e513f045f8 / . / README.rst
blob: 93f01ef1e0dbbb8560373559e916f6e4bd3da3e1 [file] [log] [blame]
Filip Pytloune21bc772015-10-06 16:28:32 +0200[diff] [blame]1
OlgaGusarenkoebacbc22018-07-30 23:35:53 +0300[diff] [blame]2======
3Usage
4======
Filip Pytloune21bc772015-10-06 16:28:32 +0200[diff] [blame]5
Ales Komarek37cf5fc2018-01-30 22:11:02 +0100[diff] [blame]6Memcached is an in-memory key-value store for small chunks of arbitrary data
7(strings, objects) from results of database calls, API calls, or page
8rendering.
Filip Pytloune21bc772015-10-06 16:28:32 +0200[diff] [blame]9
Ales Komarek37cf5fc2018-01-30 22:11:02 +0100[diff] [blame]10Sample Metadata
Filip Pytloune21bc772015-10-06 16:28:32 +0200[diff] [blame]11===============
12
Filip Pytloune21bc772015-10-06 16:28:32 +0200[diff] [blame]13.. code-block:: yaml
14
15 memcached:
16 server:
17 enabled: true
18 cache_size: 64
Pascal Liehne5cb231b2018-03-12 22:16:44 +0100[diff] [blame]19 slabsize: 1m
Filip Pytloune21bc772015-10-06 16:28:32 +0200[diff] [blame]20 bind:
21 address: 0.0.0.0
22 port: 11211
23 protocol: tcp
24
Oleksandr Bryndzii004a8ff2018-10-24 12:48:38 +0300[diff] [blame^]25Enable/Disable tcp/udp listener
26===============================
27
28.. code-block:: yaml
29
30 memcached:
31 server:
32 enabled: true
33 cache_size: 64
34 slabsize: 2m
35 threads: 1
36 bind:
37 address: 0.0.0.0
38 port: 11211
39 proto:
40 tcp:
41 enabled: True
42 udp:
43 enabled: True
44======
45 Note:
46======
47 The following pillar option is deprecated and does not affect any functionality:
48================================================================================
49.. code-block:: yaml
50 bind:
51 protocol: tcp
Ales Komarek37cf5fc2018-01-30 22:11:02 +0100[diff] [blame]52
53References
54==========
Filip Pytloune21bc772015-10-06 16:28:32 +0200[diff] [blame]55
56* http://memcached.org/
Filip Pytloun52999ac2017-02-02 13:02:03 +0100[diff] [blame]57
Ales Komarek37cf5fc2018-01-30 22:11:02 +0100[diff] [blame]58
Filip Pytloun52999ac2017-02-02 13:02:03 +0100[diff] [blame]59Documentation and Bugs
60======================
61
OlgaGusarenkoebacbc22018-07-30 23:35:53 +0300[diff] [blame]62* http://salt-formulas.readthedocs.io/
63 Learn how to install and update salt-formulas
Filip Pytloun52999ac2017-02-02 13:02:03 +0100[diff] [blame]64
OlgaGusarenkoebacbc22018-07-30 23:35:53 +0300[diff] [blame]65* https://github.com/salt-formulas/salt-formula-memcached/issues
66 In the unfortunate event that bugs are discovered, report the issue to the
67 appropriate issue tracker. Use the Github issue tracker for a specific salt
68 formula
Filip Pytloun52999ac2017-02-02 13:02:03 +0100[diff] [blame]69
OlgaGusarenkoebacbc22018-07-30 23:35:53 +0300[diff] [blame]70* https://launchpad.net/salt-formulas
71 For feature requests, bug reports, or blueprints affecting the entire
72 ecosystem, use the Launchpad salt-formulas project
Filip Pytloun52999ac2017-02-02 13:02:03 +0100[diff] [blame]73
OlgaGusarenkoebacbc22018-07-30 23:35:53 +0300[diff] [blame]74* https://launchpad.net/~salt-formulas-users
75 Join the salt-formulas-users team and subscribe to mailing list if required
Filip Pytloun52999ac2017-02-02 13:02:03 +0100[diff] [blame]76
OlgaGusarenkoebacbc22018-07-30 23:35:53 +0300[diff] [blame]77* https://github.com/salt-formulas/salt-formula-memcached
78 Develop the salt-formulas projects in the master branch and then submit pull
79 requests against a specific formula
Filip Pytloun52999ac2017-02-02 13:02:03 +0100[diff] [blame]80
OlgaGusarenkoebacbc22018-07-30 23:35:53 +0300[diff] [blame]81* #salt-formulas @ irc.freenode.net
82 Use this IRC channel in case of any questions or feedback which is always
83 welcome