Merge pull request #896 from garden-io/add-analytics-text

chore: added section on README to explain analytics
garden-io · Jun 27, 2019 · 77f80bf · 77f80bf
2 parents 31b0b8d + 4439d9c
commit 77f80bf
Show file tree

Hide file tree

Showing 4 changed files with 67 additions and 52 deletions.
diff --git a/README.md b/README.md
@@ -102,7 +102,7 @@ Overview:
 - [Reference](https://docs.garden.io/reference)—glossary, commands reference, configuration files reference, and template strings reference.
 - [FAQs](https://docs.garden.io/faqs).
 
-The [examples](https://github.com/garden-io/garden/tree/v0.9.12/examples) folder of our repository also shows a myriad of different ways to use Garden. Check out the README in each example for more information.
+The [examples](https://github.com/garden-io/garden/tree/v0.9.12/examples) folder of our repository also shows a myriad of different ways to use Garden. Check out the README in each example for more information
 
 ## How does it work?
 
@@ -178,6 +178,19 @@ Garden would not be possible without an amazing ecosystem of open-source project
 
 Garden, as a company, is also a proud member of the [CNCF](https://www.cncf.io/).
 
+## Analytics
+
+When running Garden for the first time, we'll ask you to opt in to our analytics.  
+We are trying to make Garden the best tool possible, and it's very useful for us to inform the future development of Garden with data on how it's being used.  
+
+When you opt-in we will collect information about the commands you run, the tasks getting executed, the project and operating system. We care about your privacy and we take special care to anonymize all the information. For example, we hash module names, and use randomly generated IDs to identify projects.
+
+If you change your mind and would like to update your analytics settings, please run (from within a project):
+
+```sh
+    garden config analytics-enabled true|false
+```
+
 ## License
 
 Garden is licensed according to [Mozilla Public License 2.0 (MPL-2.0)](LICENSE.md).
diff --git a/docs/reference/providers/kubernetes.md b/docs/reference/providers/kubernetes.md
@@ -140,7 +140,7 @@ Resource requests and limits for the in-cluster builder, container registry and
 
 | Type     | Required | Default                                                                                                                                                                                                                                                    |
 | -------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `object` | No       | `{"builder":{"limits":{"cpu":2000,"memory":4096},"requests":{"cpu":200,"memory":512}},"registry":{"limits":{"cpu":2000,"memory":4096},"requests":{"cpu":200,"memory":512}},"sync":{"limits":{"cpu":200,"memory":256},"requests":{"cpu":100,"memory":64}}}` |
+| `object` | No       | `{"builder":{"limits":{"cpu":4000,"memory":8192},"requests":{"cpu":200,"memory":512}},"registry":{"limits":{"cpu":2000,"memory":4096},"requests":{"cpu":200,"memory":512}},"sync":{"limits":{"cpu":500,"memory":512},"requests":{"cpu":100,"memory":64}}}` |
 
 ### `providers[].resources.builder`
 
@@ -157,15 +157,15 @@ limits/requests, but you should evaluate based on your needs.
 
 | Type     | Required | Default                                                                     |
 | -------- | -------- | --------------------------------------------------------------------------- |
-| `object` | No       | `{"limits":{"cpu":2000,"memory":4096},"requests":{"cpu":200,"memory":512}}` |
+| `object` | No       | `{"limits":{"cpu":4000,"memory":8192},"requests":{"cpu":200,"memory":512}}` |
 
 ### `providers[].resources.builder.limits`
 
 [providers](#providers) > [resources](#providers[].resources) > [builder](#providers[].resources.builder) > limits
 
 | Type     | Required | Default                      |
 | -------- | -------- | ---------------------------- |
-| `object` | No       | `{"cpu":2000,"memory":4096}` |
+| `object` | No       | `{"cpu":4000,"memory":8192}` |
 
 ### `providers[].resources.builder.limits.cpu`
 
@@ -175,7 +175,7 @@ CPU limit in millicpu.
 
 | Type     | Required | Default |
 | -------- | -------- | ------- |
-| `number` | No       | `2000`  |
+| `number` | No       | `4000`  |
 
 Example:
 
@@ -187,7 +187,7 @@ providers:
         ...
         limits:
           ...
-          cpu: 2000
+          cpu: 4000
 ```
 
 ### `providers[].resources.builder.limits.memory`
@@ -198,7 +198,7 @@ Memory limit in megabytes.
 
 | Type     | Required | Default |
 | -------- | -------- | ------- |
-| `number` | No       | `4096`  |
+| `number` | No       | `8192`  |
 
 Example:
 
@@ -210,7 +210,7 @@ providers:
         ...
         limits:
           ...
-          memory: 4096
+          memory: 8192
 ```
 
 ### `providers[].resources.builder.requests`
@@ -399,15 +399,15 @@ defaults if you have many concurrent users.
 
 | Type     | Required | Default                                                                  |
 | -------- | -------- | ------------------------------------------------------------------------ |
-| `object` | No       | `{"limits":{"cpu":200,"memory":256},"requests":{"cpu":100,"memory":64}}` |
+| `object` | No       | `{"limits":{"cpu":500,"memory":512},"requests":{"cpu":100,"memory":64}}` |
 
 ### `providers[].resources.sync.limits`
 
 [providers](#providers) > [resources](#providers[].resources) > [sync](#providers[].resources.sync) > limits
 
 | Type     | Required | Default                    |
 | -------- | -------- | -------------------------- |
-| `object` | No       | `{"cpu":200,"memory":256}` |
+| `object` | No       | `{"cpu":500,"memory":512}` |
 
 ### `providers[].resources.sync.limits.cpu`
 
@@ -417,7 +417,7 @@ CPU limit in millicpu.
 
 | Type     | Required | Default |
 | -------- | -------- | ------- |
-| `number` | No       | `200`   |
+| `number` | No       | `500`   |
 
 Example:
 
@@ -429,7 +429,7 @@ providers:
         ...
         limits:
           ...
-          cpu: 200
+          cpu: 500
 ```
 
 ### `providers[].resources.sync.limits.memory`
@@ -440,7 +440,7 @@ Memory limit in megabytes.
 
 | Type     | Required | Default |
 | -------- | -------- | ------- |
-| `number` | No       | `256`   |
+| `number` | No       | `512`   |
 
 Example:
 
@@ -452,7 +452,7 @@ providers:
         ...
         limits:
           ...
-          memory: 256
+          memory: 512
 ```
 
 ### `providers[].resources.sync.requests`
@@ -521,7 +521,7 @@ factoring in how many concurrent builds you expect and how large your images and
 
 | Type     | Required | Default                                                                                                                                  |
 | -------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
-| `object` | No       | `{"builder":{"size":10240,"storageClass":null},"registry":{"size":10240,"storageClass":null},"sync":{"size":10240,"storageClass":null}}` |
+| `object` | No       | `{"builder":{"size":20480,"storageClass":null},"registry":{"size":20480,"storageClass":null},"sync":{"size":10240,"storageClass":null}}` |
 
 ### `providers[].storage.builder`
 
@@ -533,7 +533,7 @@ Only applies when `buildMode` is set to `cluster-docker`, ignored otherwise.
 
 | Type     | Required | Default                              |
 | -------- | -------- | ------------------------------------ |
-| `object` | No       | `{"size":10240,"storageClass":null}` |
+| `object` | No       | `{"size":20480,"storageClass":null}` |
 
 ### `providers[].storage.builder.size`
 
@@ -543,7 +543,7 @@ Volume size for the registry in megabytes.
 
 | Type     | Required | Default |
 | -------- | -------- | ------- |
-| `number` | No       | `10240` |
+| `number` | No       | `20480` |
 
 ### `providers[].storage.builder.storageClass`
 
@@ -566,7 +566,7 @@ Only applies when `buildMode` is set to `cluster-docker` or `kaniko`, ignored ot
 
 | Type     | Required | Default                              |
 | -------- | -------- | ------------------------------------ |
-| `object` | No       | `{"size":10240,"storageClass":null}` |
+| `object` | No       | `{"size":20480,"storageClass":null}` |
 
 ### `providers[].storage.registry.size`
 
@@ -576,7 +576,7 @@ Volume size for the registry in megabytes.
 
 | Type     | Required | Default |
 | -------- | -------- | ------- |
-| `number` | No       | `10240` |
+| `number` | No       | `20480` |
 
 ### `providers[].storage.registry.storageClass`
 
@@ -881,8 +881,8 @@ providers:
     resources:
       builder:
         limits:
-          cpu: 2000
-          memory: 4096
+          cpu: 4000
+          memory: 8192
         requests:
           cpu: 200
           memory: 512
@@ -895,17 +895,17 @@ providers:
           memory: 512
       sync:
         limits:
-          cpu: 200
-          memory: 256
+          cpu: 500
+          memory: 512
         requests:
           cpu: 100
           memory: 64
     storage:
       builder:
-        size: 10240
+        size: 20480
         storageClass: null
       registry:
-        size: 10240
+        size: 20480
         storageClass: null
       sync:
         size: 10240