Skip to content

Commit 9512ec8

Browse files
virtualrootvirtualroot
committed
bump structurizr to 2024.03.03
Signed-off-by: Alejandro Lazaro <[email protected]>
1 parent 0329b00 commit 9512ec8

File tree

5 files changed

+60
-16
lines changed

5 files changed

+60
-16
lines changed

‎.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
repos:
22
- repo: https://github.com/norwoodj/helm-docs
3-
rev: v1.11.0
3+
rev: v1.13.1
44
hooks:
55
- id: helm-docs
66
args:

‎charts/structurizr/Chart.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ keywords:
1111
sources:
1212
- https://structurizr.com/help/on-premises
1313

14-
version: 0.2.1
15-
appVersion: "3194"
14+
version: 0.3.0
15+
appVersion: "2024.03.03"

‎charts/structurizr/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# structurizr
22

3-
![Version: 0.2.1](https://img.shields.io/badge/Version-0.2.1-informational?style=flat-square) ![AppVersion: 3194](https://img.shields.io/badge/AppVersion-3194-informational?style=flat-square)
3+
![Version: 0.3.0](https://img.shields.io/badge/Version-0.3.0-informational?style=flat-square) ![AppVersion: 2024.03.03](https://img.shields.io/badge/AppVersion-2024.03.03-informational?style=flat-square)
44

55
The Structurizr Helm chart deploys Structurizr On premise flavor. Structurizr is a web-based rendering tool designed to help software development teams create software architecture diagrams and documentation.
66

@@ -13,6 +13,7 @@ The Structurizr Helm chart deploys Structurizr On premise flavor. Structurizr is
1313
| autoscaling.maxReplicas | int | `100` | |
1414
| autoscaling.minReplicas | int | `1` | |
1515
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
16+
| env | list | `[]` | List of environment variables to be set for the Structurizr pod. |
1617
| fullnameOverride | string | `""` | |
1718
| image.pullPolicy | string | `"IfNotPresent"` | |
1819
| image.repository | string | `"structurizr/onpremises"` | |
@@ -25,27 +26,26 @@ The Structurizr Helm chart deploys Structurizr On premise flavor. Structurizr is
2526
| ingress.hosts[0].paths[0].path | string | `"/"` | |
2627
| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | |
2728
| ingress.tls | list | `[]` | |
29+
| log4j2 | string | `""` | Configuration settings for the logging system using Log4j2. |
2830
| nameOverride | string | `""` | |
2931
| nodeSelector | object | `{}` | |
3032
| podAnnotations | object | `{}` | |
3133
| podSecurityContext | object | `{}` | |
32-
| replicaCount | int | `1` | Specify the number of replicas |
34+
| properties | string | `""` | Custom properties configuration for Structurizr. |
35+
| replicaCount | int | `1` | Specify the number of replicas. |
3336
| resources | object | `{}` | |
37+
| roles | string | `""` | Specifies user roles for Structurizr. |
38+
| saml | string | `""` | SAML identity provider metadata configuration for Structurizr authentication. |
3439
| securityContext | object | `{}` | |
3540
| service.port | int | `8080` | |
3641
| service.type | string | `"ClusterIP"` | |
3742
| serviceAccount.annotations | object | `{}` | |
3843
| serviceAccount.create | bool | `true` | |
3944
| serviceAccount.name | string | `""` | |
40-
| tolerations | list | `[]` | Tolerations for pod assignment. Useful for nodes with taints. |
41-
| volumes | list | `[]` | List of additional volumes to be added to the pods. |
45+
| tolerations | list | `[]` | |
46+
| users | string | `""` | Specifies user credentials for Structurizr. |
4247
| volumeMounts | list | `[]` | Specifies where to mount the volumes in the pod. |
43-
| properties | string | (multi-line string) | Custom properties configuration for Structurizr. |
44-
| users | string | (multi-line string) | Specifies user credentials for Structurizr. |
45-
| roles | string | (multi-line string) | Specifies user roles for Structurizr. |
46-
| saml | string | (multi-line string) | SAML identity provider metadata configuration for Structurizr authentication. |
47-
| log4j2 | string | (multi-line string) | Configuration settings for the logging system using Log4j2. |
48-
| env | list | `[]` | List of environment variables to be set for the Structurizr pod. |
48+
| volumes | list | `[]` | List of additional volumes to be added to the pods. |
4949

5050
## Additional Configuration Details:
5151

‎charts/structurizr/README.md.gotmpl

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,47 @@
66

77
{{ template "chart.valuesSection" . }}
88

9+
## Additional Configuration Details:
10+
11+
### `volumes` and `volumeMounts`:
12+
You can define additional volumes to attach to the pod and specify where they are mounted. For example:
13+
14+
```yaml
15+
volumes:
16+
- name: my-storage
17+
persistentVolumeClaim:
18+
claimName: my-pvc
19+
volumeMounts:
20+
- name: my-storage
21+
mountPath: /path/in/container
22+
```
23+
24+
### `properties`, `users`, `roles`, and `saml-idp-metadata`:
25+
These fields allow you to define multi-line strings for configurations. For instance, `properties` can be used to set Structurizr-specific configurations:
26+
27+
```yaml
28+
properties: |
29+
structurizr.redis.password=${REDIS_PASSWORD}
30+
structurizr.authentication=saml
31+
```
32+
Similar patterns can be used for `users`, `roles`, and `saml-idp-metadata` fields.
33+
34+
### `env`:
35+
You can specify additional environment variables for the Structurizr application. For instance:
36+
37+
```yaml
38+
env:
39+
- name: STRUCTURIZR_DATA_DIRECTORY
40+
value: "/usr/local/structurizr"
41+
```
42+
This can be useful to configure aspects of Structurizr using environment variables.
43+
944
## TODO
1045

1146
- [ ] Encryption
1247
- [ ] Authentication
1348
- [ ] File
1449
- [ ] LDAP
15-
- [ ] SAML
50+
- [x] SAML
1651
- [ ] Redis sessions
17-
- [ ] Bucket data
52+
- [ ] Bucket data

‎charts/structurizr/values.yaml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# -- Specify the number of replicas
1+
# -- Specify the number of replicas.
22
replicaCount: 1
33

44
image:
@@ -78,8 +78,10 @@ nodeSelector: {}
7878

7979
tolerations: []
8080

81+
# -- Affinity settings for pod assignment.
8182
affinity: {}
8283

84+
# -- List of additional volumes to be added to the pods.
8385
volumes: []
8486
# - name: my-storage
8587
# persistentVolumeClaim:
@@ -91,12 +93,14 @@ volumes: []
9193
# bucketName: "structurizr-google-storage-bucket-name"
9294
# mountOptions: "implicit-dirs"
9395

96+
# -- Specifies where to mount the volumes in the pod.
9497
volumeMounts: []
9598
# - name: my-storage
9699
# mountPath: /path/in/container
97100
# - name: structurizr-bucket
98101
# mountPath: /usr/local/structurizr
99102

103+
# -- Custom properties configuration for Structurizr.
100104
properties: |
101105
# # Your properties content goes here...
102106
# structurizr.redis.password=${REDIS_PASSWORD}
@@ -105,23 +109,28 @@ properties: |
105109
# structurizr.safeMode=false
106110
# # and so on...
107111

112+
# -- Specifies user credentials for Structurizr.
108113
users: |
109114
# # Your users content goes here...
110115
# {username}={hashed password}
111116
# # and so on...
112117

118+
# -- Specifies user roles for Structurizr.
113119
roles: |
114120
# # Your roles content goes here...
115121
# {username}={role1},{role2},{role3}
116122
# # and so on...
117123

124+
# -- SAML identity provider metadata configuration for Structurizr authentication.
118125
saml: |
119126
# # Your saml-idp-metadata.xml configuration goes here...
120127

128+
# -- Configuration settings for the logging system using Log4j2.
121129
log4j2: |
122130
# # Your log4j2 configuration goes here...
123131
# # See: https://github.com/structurizr/onpremises/blob/main/structurizr-onpremises/src/main/resources/log4j2.properties
124132

133+
# -- List of environment variables to be set for the Structurizr pod.
125134
env: []
126135
# - name: STRUCTURIZR_DATA_DIRECTORY
127136
# value: "/usr/local/structurizr"

0 commit comments

Comments
 (0)