Skip to content

Commit b9ba202

Browse files
author
iru
authored
docs: add DR
1 parent bc7840a commit b9ba202

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

DecisionRecord.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# DecisionRecord
2+
3+
> A [Decision record (DR)](https://github.com/joelparkerhenderson/decision-record) is a way to initiate, debate, and archive an important choice, along with its context and consequences.
4+
5+
Some ideas that would fit in the DR
6+
- global refactorings
7+
- current known limitations
8+
- ...
9+
10+
**Note: Currently, this DR apply to all Terraform Modules (AWS,GCP and Azure)**
11+
12+
<br/>
13+
14+
## 2022 - Remove configuration buckets
15+
16+
Previously [CloudConnector configuration file](https://charts.sysdig.com/charts/cloud-connector/#configuration) was stored on each cloud storage service.
17+
In order to spin as least resources as possible on customer's infra, we decided to inline this configuration with a base64-encoded `env` var.
18+
19+
- pros
20+
- less resources on customer
21+
- cons
22+
- modifying configuration (the most common use-case is to lower logs for troubleshooting purpose) is more complicated for the customer
23+
24+
25+
## 2021 - Terraform Modules version pinned to `latest`
26+
27+
Because we're in fast cycle-releases (v0.x), we don't support backward compatibility and want customer to use latest version.
28+
That's why in Github snippets, and Sysig Secure snippets, we don't use the `version` attirubte of the terraform modules.
29+
30+
Still, customer wants to pin the terraform module version, they can do so, by using
31+
32+
```terraform
33+
module "secure-for-cloud" {
34+
source = "sysdiglabs/secure-for-cloud/aws"
35+
version = "0.9.6"
36+
...
37+
}
38+
```
39+
40+
Upgrade guideliness are offered in main READMEs.
41+
42+
43+
## 2021 - CloudConnector image version pinned to `latest`
44+
45+
Not discussed the pro/cons, but currently
46+
47+
- pros
48+
- if we fix somethiing in cloud-connector customer just has to restart the compute service
49+
- cons
50+
- if required, there is no easy way of pinning the cloud-connector version
51+
52+
**Possible future actions**
53+
- Expose a variable throught he examples to let customer select cloud-connector version? This can also be done in runtime modifying compute service defintion.

0 commit comments

Comments
 (0)