mirror of
https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk.git
synced 2025-12-06 15:31:38 +01:00
Compare commits
595 Commits
v0.2.4
...
nubus/prov
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
72b35c0a6d | ||
|
|
f61640ac19 | ||
|
|
6b26e11bcc | ||
|
|
e1d15e4bc6 | ||
|
|
c63e725525 | ||
|
|
45715a2059 | ||
|
|
3ad81e6b92 | ||
|
|
a395759551 | ||
|
|
8aa1a7fa7d | ||
|
|
ce03400043 | ||
|
|
61d74966d0 | ||
|
|
97f7a1cafd | ||
|
|
49ad36ef4e | ||
|
|
7d0d6ea8d1 | ||
|
|
a46a632616 | ||
|
|
4b99357b21 | ||
|
|
f194f24845 | ||
|
|
be6806f62f | ||
|
|
fd3df7df67 | ||
|
|
6b609edc4a | ||
|
|
63f8394e04 | ||
|
|
74d444e2d6 | ||
|
|
8a2d951c3b | ||
|
|
46412d1a9e | ||
|
|
26a7641a5a | ||
|
|
671f57a809 | ||
|
|
fe923bb9cd | ||
|
|
b4570a9a87 | ||
|
|
1067e725b3 | ||
|
|
dfaf4be640 | ||
|
|
e54aaab072 | ||
|
|
b806d51311 | ||
|
|
db7f5d60bd | ||
|
|
972020f946 | ||
|
|
23ef1d557b | ||
|
|
382af1dfb9 | ||
|
|
7239df2ec1 | ||
|
|
86a328bda1 | ||
|
|
85149086ae | ||
|
|
01c5e6b359 | ||
|
|
a8692d5506 | ||
|
|
1ad35f1e12 | ||
|
|
01767d3806 | ||
|
|
7268f607a5 | ||
|
|
e52343440d | ||
|
|
c03e4a5340 | ||
|
|
c90f7c1742 | ||
|
|
ceb09bee8c | ||
|
|
890b36ecbb | ||
|
|
6ef3641d82 | ||
|
|
45e569955d | ||
|
|
0ce346b162 | ||
|
|
c07b25c4b9 | ||
|
|
e89b16a747 | ||
|
|
064a5ad246 | ||
|
|
d8f3e05e58 | ||
|
|
368fe13ddb | ||
|
|
fcf33825d5 | ||
|
|
b1d0a05a0c | ||
|
|
b0eb28bc3f | ||
|
|
1a811743df | ||
|
|
d7a127fe26 | ||
|
|
e31a0a258e | ||
|
|
742c293243 | ||
|
|
f856205afc | ||
|
|
9fa8ace80f | ||
|
|
dc39b94e88 | ||
|
|
a31c5f59a6 | ||
|
|
a899699e21 | ||
|
|
bd2d7cf748 | ||
|
|
ecb566f61e | ||
|
|
75cd077351 | ||
|
|
6202bc4719 | ||
|
|
e1e8a7f121 | ||
|
|
af711b0edb | ||
|
|
4f92001d68 | ||
|
|
58693162e6 | ||
|
|
b95fd1152a | ||
|
|
a4ff89b213 | ||
|
|
d7fbc572ca | ||
|
|
4d99bf3bf0 | ||
|
|
6e4972107e | ||
|
|
2f88752ae6 | ||
|
|
f3d8cf08ef | ||
|
|
592e17027b | ||
|
|
6570c13f3a | ||
|
|
931ed95ce1 | ||
|
|
2b48698817 | ||
|
|
b2cfa8b996 | ||
|
|
11796699bb | ||
|
|
1c6666fe45 | ||
|
|
923209b474 | ||
|
|
650c41c3f0 | ||
|
|
88ac2396e6 | ||
|
|
1d47fa681a | ||
|
|
96baa6cc15 | ||
|
|
7167055303 | ||
|
|
e0852119e8 | ||
|
|
4e56ce4073 | ||
|
|
923533d7b7 | ||
|
|
04d9372cfc | ||
|
|
02b76d3f45 | ||
|
|
36139b42f1 | ||
|
|
e6fe2a7c18 | ||
|
|
7cb2c2261b | ||
|
|
4a2801c8a0 | ||
|
|
b9ac5ecf2d | ||
|
|
fefd2f6cae | ||
|
|
2ad027082f | ||
|
|
9be3b78761 | ||
|
|
3dc648421b | ||
|
|
c7e217208c | ||
|
|
cd225703eb | ||
|
|
e9ec2f3a6e | ||
|
|
d1bd43fa95 | ||
|
|
76b7d41d5c | ||
|
|
1b748b6bf6 | ||
|
|
a943ca9a3c | ||
|
|
3be3564ec7 | ||
|
|
10ecb44aa6 | ||
|
|
79c52d014c | ||
|
|
5e3f4faade | ||
|
|
c395d35dd7 | ||
|
|
cb33a929ef | ||
|
|
f94e9c4930 | ||
|
|
5f9d015f0b | ||
|
|
7cc39647d8 | ||
|
|
8c97bcf994 | ||
|
|
5a39e8725b | ||
|
|
34d2c05959 | ||
|
|
42f63e3992 | ||
|
|
81105d1e94 | ||
|
|
a41ddd5451 | ||
|
|
8e889db63e | ||
|
|
5ebf291a4d | ||
|
|
d565c057dd | ||
|
|
50e263866b | ||
|
|
0fd4a26c71 | ||
|
|
0aa4cfb46f | ||
|
|
391d959630 | ||
|
|
9c32058fcc | ||
|
|
bc18724d70 | ||
|
|
011ad2cd6b | ||
|
|
ee99eefb72 | ||
|
|
a2b333b462 | ||
|
|
7ee9e47e82 | ||
|
|
d677ca5691 | ||
|
|
31e5cf317c | ||
|
|
410a023714 | ||
|
|
8b065fd9d7 | ||
|
|
f4b8226ea1 | ||
|
|
2023d5bce4 | ||
|
|
8807b24ce0 | ||
|
|
d4442261aa | ||
|
|
2efceef076 | ||
|
|
7ec123b9a1 | ||
|
|
3d31127a6a | ||
|
|
de190bfb7d | ||
|
|
bc6e4f8e5d | ||
|
|
a398e5aaf1 | ||
|
|
57d0f61b2c | ||
|
|
d9263c9011 | ||
|
|
d9c23bdf0b | ||
|
|
c2f62f7c94 | ||
|
|
d087b979fe | ||
|
|
b1b4c28618 | ||
|
|
a3e415d575 | ||
|
|
17fa80d20a | ||
|
|
13dcb00441 | ||
|
|
43718b8da2 | ||
|
|
47d6a8d53f | ||
|
|
8b50347bfa | ||
|
|
b525a814fc | ||
|
|
83ac645fae | ||
|
|
f2b8acfba8 | ||
|
|
49f126d169 | ||
|
|
02d04faa2a | ||
|
|
c2087efcf9 | ||
|
|
affa92cde2 | ||
|
|
d9e07ff7bd | ||
|
|
01599022f1 | ||
|
|
bc7eeb8c9d | ||
|
|
1396071865 | ||
|
|
7c9f38f06e | ||
|
|
7ebbd03bdc | ||
|
|
110ff56f74 | ||
|
|
c0fc225349 | ||
|
|
56f5e35895 | ||
|
|
ba0824bac3 | ||
|
|
250ef2bc3f | ||
|
|
d2b1f0b07b | ||
|
|
8f83261986 | ||
|
|
5d95e7ab2a | ||
|
|
ee1a337ab5 | ||
|
|
41bc09ee49 | ||
|
|
acaec3b8ac | ||
|
|
6c15dc1d66 | ||
|
|
2909e1d821 | ||
|
|
cabee0c9da | ||
|
|
c16c0ac795 | ||
|
|
6f0b1f37fc | ||
|
|
fd2a66f8f2 | ||
|
|
dd535daac0 | ||
|
|
3bcdcd06b7 | ||
|
|
f05acb57c9 | ||
|
|
bea1413b86 | ||
|
|
af63e5c18d | ||
|
|
cbb33b922d | ||
|
|
02f41a2f1a | ||
|
|
e778a59cdd | ||
|
|
67f7c05038 | ||
|
|
89c149af95 | ||
|
|
3630f583b5 | ||
|
|
a99f3389dc | ||
|
|
a49daa6fa2 | ||
|
|
db0a544155 | ||
|
|
77e32fada8 | ||
|
|
acbef3ae3e | ||
|
|
bb289d545e | ||
|
|
2d2455fdb3 | ||
|
|
0bf059e8e1 | ||
|
|
0492420d60 | ||
|
|
8f09740677 | ||
|
|
969c42a590 | ||
|
|
7daa93f061 | ||
|
|
452624ce74 | ||
|
|
b23152bb20 | ||
|
|
78993e122b | ||
|
|
87b6fcfc37 | ||
|
|
4945c13d05 | ||
|
|
08754cc527 | ||
|
|
45967c7a0b | ||
|
|
acf6816653 | ||
|
|
f8943703ed | ||
|
|
712605e4f1 | ||
|
|
a0d5fb8955 | ||
|
|
fec0d1f26a | ||
|
|
807b73c8a4 | ||
|
|
506ef4a20f | ||
|
|
306252da6f | ||
|
|
5f5a65f59d | ||
|
|
09d001b6db | ||
|
|
9aa907a909 | ||
|
|
2ad48b6fd5 | ||
|
|
6b3d99d1d1 | ||
|
|
813a2e29e9 | ||
|
|
e1f63701f1 | ||
|
|
9ff605623c | ||
|
|
db749d8b1b | ||
|
|
b30b29df8a | ||
|
|
7a145315f9 | ||
|
|
f13f39a0a0 | ||
|
|
3b557a892c | ||
|
|
41e777c81d | ||
|
|
90152bdc41 | ||
|
|
8db9bf3c99 | ||
|
|
c2e9204c56 | ||
|
|
61eb206c74 | ||
|
|
1c4db30b65 | ||
|
|
d039c65c4b | ||
|
|
18e95b7f07 | ||
|
|
0952221f90 | ||
|
|
0e1e87550f | ||
|
|
40fb9dc9fa | ||
|
|
4fe0c9feb2 | ||
|
|
006e20f06b | ||
|
|
1f7b3ca0f9 | ||
|
|
8d6503cf28 | ||
|
|
ecf0ac77f2 | ||
|
|
d342efe9a9 | ||
|
|
c21dd46289 | ||
|
|
8c378c6f91 | ||
|
|
597842a871 | ||
|
|
36bbbae579 | ||
|
|
902076c629 | ||
|
|
1b9f394489 | ||
|
|
450c434ed0 | ||
|
|
4b6a20faa4 | ||
|
|
ce38714a81 | ||
|
|
37f1eb9794 | ||
|
|
db4bfa4884 | ||
|
|
6a649cb7f0 | ||
|
|
b6ef559cde | ||
|
|
cc0daa2a22 | ||
|
|
c69c62cd45 | ||
|
|
6a26299a75 | ||
|
|
4101e91ae6 | ||
|
|
83192b7834 | ||
|
|
3b1091bb3e | ||
|
|
e67ab8f430 | ||
|
|
da731e7d5e | ||
|
|
0ea585633b | ||
|
|
fe40b7cfa1 | ||
|
|
d04a60349d | ||
|
|
94ae3da78b | ||
|
|
3ca54159f7 | ||
|
|
bf5dcda3b5 | ||
|
|
08ca525d3e | ||
|
|
dc7ce0bc4b | ||
|
|
729a1ea849 | ||
|
|
3b5493d78d | ||
|
|
6711791009 | ||
|
|
c41643ee3e | ||
|
|
2628a0e13e | ||
|
|
c8bc8b3172 | ||
|
|
24812b667c | ||
|
|
bec9a2d46b | ||
|
|
05cc82d7c5 | ||
|
|
82be996d97 | ||
|
|
d367739248 | ||
|
|
ef870ae385 | ||
|
|
466e741494 | ||
|
|
00fafb6a1b | ||
|
|
6d3e484855 | ||
|
|
845a0a3189 | ||
|
|
519db51be2 | ||
|
|
7ef3a10577 | ||
|
|
1c35ca67ce | ||
|
|
e0c6c14dca | ||
|
|
3cf348c7ae | ||
|
|
b3d45c45e1 | ||
|
|
c246edd8f9 | ||
|
|
c19bca2be0 | ||
|
|
a5f263ce48 | ||
|
|
cbe8fb2d65 | ||
|
|
8b6a4b2e88 | ||
|
|
a61d00482f | ||
|
|
0c7a77c4b6 | ||
|
|
211bee94bb | ||
|
|
b3ac0ae6d9 | ||
|
|
4c52a5aaa8 | ||
|
|
7a9ecf7b85 | ||
|
|
86b48188e1 | ||
|
|
7bbab22939 | ||
|
|
1343d6c93e | ||
|
|
735fec3b4c | ||
|
|
21b9d1d024 | ||
|
|
6dc92df2eb | ||
|
|
cac6abe251 | ||
|
|
6c1664fc0d | ||
|
|
36aa3ed7c9 | ||
|
|
23c46e7fe5 | ||
|
|
efbd814968 | ||
|
|
812eb5a439 | ||
|
|
f86a74ba10 | ||
|
|
71d11cfcd0 | ||
|
|
6aa3d386af | ||
|
|
7ac2e0f9de | ||
|
|
6f556bce70 | ||
|
|
a447c137fe | ||
|
|
47a385683c | ||
|
|
db48140f3a | ||
|
|
d7cae3b1fa | ||
|
|
7ae65a36a2 | ||
|
|
01466947cc | ||
|
|
061e588da9 | ||
|
|
b460206bd4 | ||
|
|
ea14f953a4 | ||
|
|
feed270fd7 | ||
|
|
225398b5a6 | ||
|
|
cd0e94f96f | ||
|
|
767c382091 | ||
|
|
55f6ba21dc | ||
|
|
b3c4ec5165 | ||
|
|
e231e5749d | ||
|
|
f98c48616b | ||
|
|
c460467d74 | ||
|
|
3f7faf88fb | ||
|
|
1971dfbded | ||
|
|
b50e5c982b | ||
|
|
97034a556f | ||
|
|
8b87432317 | ||
|
|
baa5827de3 | ||
|
|
1d03a6e11f | ||
|
|
08811decd9 | ||
|
|
69ea840517 | ||
|
|
ea5bd0a6b7 | ||
|
|
0d8e92fc5a | ||
|
|
d7119a656b | ||
|
|
89ae1d94ea | ||
|
|
dfc7fed325 | ||
|
|
65ce9a171b | ||
|
|
5e50ed119f | ||
|
|
d0a07997c1 | ||
|
|
985df5906f | ||
|
|
385d81b9a9 | ||
|
|
0ad043406b | ||
|
|
4a79728f01 | ||
|
|
7c56c7244f | ||
|
|
e0fce6631b | ||
|
|
899a8c5af9 | ||
|
|
6cee2c878b | ||
|
|
4359b21f1c | ||
|
|
d8b2bd3af0 | ||
|
|
8fafd906a3 | ||
|
|
fece4ace87 | ||
|
|
ab6014f8c6 | ||
|
|
fecd13612b | ||
|
|
38336d0240 | ||
|
|
9f9e4e9521 | ||
|
|
b47de62f98 | ||
|
|
9e54299917 | ||
|
|
d249d0e3ce | ||
|
|
fbe7de3c56 | ||
|
|
034e98c850 | ||
|
|
7feaadf7f8 | ||
|
|
a7fef3afff | ||
|
|
5d01f8ca46 | ||
|
|
7093022ec4 | ||
|
|
2313f75dbe | ||
|
|
af9caea726 | ||
|
|
b39986907c | ||
|
|
a02d7c6085 | ||
|
|
a046deaf17 | ||
|
|
c76e960446 | ||
|
|
535823e0a8 | ||
|
|
9966bf640e | ||
|
|
8e376bb4a5 | ||
|
|
7c0e4aa9a6 | ||
|
|
e609b75cc7 | ||
|
|
20d26a069b | ||
|
|
59d58e320e | ||
|
|
49b71aafb4 | ||
|
|
cbe514176a | ||
|
|
0898d96571 | ||
|
|
7f7c364071 | ||
|
|
fd9e04d992 | ||
|
|
86657b139a | ||
|
|
cdffbe1298 | ||
|
|
82a037ec7c | ||
|
|
1a4eced998 | ||
|
|
06dcdd78af | ||
|
|
f564efd97f | ||
|
|
16f2ac464e | ||
|
|
30405d182d | ||
|
|
785989e91d | ||
|
|
27b6796639 | ||
|
|
7756d35fa1 | ||
|
|
5afd2339c2 | ||
|
|
b7f220a6b6 | ||
|
|
fb7dba787c | ||
|
|
72e3afdffd | ||
|
|
85b8fcaab5 | ||
|
|
c3129f1443 | ||
|
|
000be8b032 | ||
|
|
da1bf3581c | ||
|
|
4d0011d957 | ||
|
|
74f9ec28e4 | ||
|
|
b1d4b2d8ea | ||
|
|
711d29e374 | ||
|
|
0ba7be2a5f | ||
|
|
d4c751d29f | ||
|
|
70744d04c6 | ||
|
|
e4e6d2d60a | ||
|
|
e42feb4c26 | ||
|
|
f12c2ed0c2 | ||
|
|
7dbcbfe723 | ||
|
|
1d8a0ccf1a | ||
|
|
e33acd33e7 | ||
|
|
74e206694e | ||
|
|
6fd655a0b1 | ||
|
|
d4c39025b6 | ||
|
|
d86f516747 | ||
|
|
4c5731e6bb | ||
|
|
6a390112da | ||
|
|
65d2642d34 | ||
|
|
55f73924df | ||
|
|
11cc708f6e | ||
|
|
b6b4972a5d | ||
|
|
2e3f5f6e53 | ||
|
|
3da2aaaed9 | ||
|
|
424317ed58 | ||
|
|
b335bc4c3b | ||
|
|
5343840bed | ||
|
|
2d5d3708f7 | ||
|
|
41dfdc0c8f | ||
|
|
ca5d5f8280 | ||
|
|
095059c7e5 | ||
|
|
1dd6582ec7 | ||
|
|
74b3d41381 | ||
|
|
a41b9a699c | ||
|
|
0b4cd739fc | ||
|
|
4372f063e0 | ||
|
|
15ad8ca7ab | ||
|
|
1884a90e6f | ||
|
|
0997f2e4a7 | ||
|
|
0f01b94aa1 | ||
|
|
892920b048 | ||
|
|
5c3568871b | ||
|
|
f22619bd8e | ||
|
|
275798c1d6 | ||
|
|
5ad25acafd | ||
|
|
437633cda6 | ||
|
|
62b767ef38 | ||
|
|
02be7c15bb | ||
|
|
9acce08139 | ||
|
|
3f8bffbcf3 | ||
|
|
98ec02f230 | ||
|
|
b340373133 | ||
|
|
6456f68b7b | ||
|
|
a37faf3b57 | ||
|
|
fbbf3f253b | ||
|
|
2703615dff | ||
|
|
85ad5ecd6d | ||
|
|
ae3d0daa11 | ||
|
|
0a17976aca | ||
|
|
ce7e5f670a | ||
|
|
917f9fb452 | ||
|
|
f46c8a9a5f | ||
|
|
c2b44da34e | ||
|
|
41b9afb364 | ||
|
|
63bdcf594b | ||
|
|
a99c088361 | ||
|
|
8d09aa02f9 | ||
|
|
1514678db0 | ||
|
|
b7254cf5dc | ||
|
|
7ab1cb5c7e | ||
|
|
0ba71f2749 | ||
|
|
77e362f6bc | ||
|
|
09079a1303 | ||
|
|
15db5dcbba | ||
|
|
d3c439038a | ||
|
|
9409ad829a | ||
|
|
a4bab4068d | ||
|
|
90019e3ef6 | ||
|
|
4835a2beec | ||
|
|
12c931fcff | ||
|
|
2f8a298925 | ||
|
|
ec3f1d96ac | ||
|
|
16c08f82c9 | ||
|
|
edb25bd765 | ||
|
|
c840608112 | ||
|
|
320da3bec3 | ||
|
|
c61b1b8281 | ||
|
|
96097e4704 | ||
|
|
5e1a7b19e2 | ||
|
|
13bcd785e8 | ||
|
|
c54bab165b | ||
|
|
836f491766 | ||
|
|
fe0e0cdce4 | ||
|
|
a74d662404 | ||
|
|
471a2fa262 | ||
|
|
5f79763e2b | ||
|
|
e120f5fb9a | ||
|
|
a799db03c4 | ||
|
|
d725b93798 | ||
|
|
e1070eeb06 | ||
|
|
c7fc187f14 | ||
|
|
89ac783dc3 | ||
|
|
882f1fbc93 | ||
|
|
b5583caec1 | ||
|
|
6d23534ee0 | ||
|
|
d2e7ac9348 | ||
|
|
2125037a3c | ||
|
|
ed7e5e428e | ||
|
|
d28a425673 | ||
|
|
a6fa846afc | ||
|
|
4380e78981 | ||
|
|
be82243966 | ||
|
|
f9886448b6 | ||
|
|
0eceb85e7d | ||
|
|
1ef4a861ac | ||
|
|
3b90533063 | ||
|
|
1349181d80 | ||
|
|
e1b84898c5 | ||
|
|
63a1e2568e | ||
|
|
ca4b1da84f | ||
|
|
ff462ab0dc | ||
|
|
4f2a8aeee4 | ||
|
|
c5ab1b81fe | ||
|
|
9d7866480c | ||
|
|
9a6d2409a6 | ||
|
|
f758293241 | ||
|
|
6321ff50a0 | ||
|
|
5fbf86b6bc | ||
|
|
6e68f7f28c | ||
|
|
41d40c9b73 | ||
|
|
cef11acbae | ||
|
|
6e5ef639c2 | ||
|
|
65b0ca5480 | ||
|
|
39565c7cfd | ||
|
|
0d374c1fea | ||
|
|
387bd8715c | ||
|
|
f219c42afa | ||
|
|
4d3bc2799c | ||
|
|
0f59736c5d | ||
|
|
7e9d39cc7f | ||
|
|
6ab4fa078b | ||
|
|
05361276c0 | ||
|
|
cda237a655 | ||
|
|
ea77d1712e | ||
|
|
2a61b5f2a6 | ||
|
|
f4dbdfb321 | ||
|
|
3d4d45f711 | ||
|
|
86fdb34735 |
19
.gitignore
vendored
19
.gitignore
vendored
@@ -2,7 +2,22 @@
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
.vscode
|
||||
.idea
|
||||
.yamllint
|
||||
|
||||
# Ignore changes to sample environments
|
||||
helmfile/environments/dev/values.yaml
|
||||
helmfile/environments/prod/values.yaml
|
||||
helmfile/environments/dev/*.yaml.gotmpl
|
||||
helmfile/environments/prod/*.yaml.gotmpl
|
||||
|
||||
# Ignore in CI generated files
|
||||
.kyverno/opendesk.yaml
|
||||
.kyverno/kyverno-test.yaml
|
||||
|
||||
# Ignore editor backup files
|
||||
*~
|
||||
|
||||
# Ignore ./log directory and *.log files
|
||||
logs
|
||||
*.log
|
||||
|
||||
# Ignore backup files, e.g. created by the script that eases the local chart development
|
||||
*.bak
|
||||
|
||||
538
.gitlab-ci.yml
538
.gitlab-ci.yml
@@ -1,26 +1,49 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
include:
|
||||
- project: "${PROJECT_PATH_GITLAB_CONFIG_TOOLING}"
|
||||
ref: "main"
|
||||
ref: "v2.3.3"
|
||||
file:
|
||||
- "ci/common/automr.yml"
|
||||
- "ci/common/lint.yml"
|
||||
- "ci/release-automation/semantic-release.yml"
|
||||
- project: "souvap/devops/sovereign-workplace-env"
|
||||
- local: "/.gitlab/generate/generate-docs.yml"
|
||||
- project: "${PROJECT_PATH_CUSTOM_ENVIRONMENT_CONFIG}"
|
||||
file: "gitlab/environments.yaml"
|
||||
ref: "main"
|
||||
- local: "/.gitlab/lint/lint-opendesk.yml"
|
||||
rules:
|
||||
- if: >
|
||||
$JOB_OPENDESK_LINTER_ENABLED == 'false' ||
|
||||
$CI_PIPELINE_SOURCE =~ 'tags|merge_request_event|web|trigger|api'
|
||||
when: "never"
|
||||
- when: "always"
|
||||
- local: "/.gitlab/lint/lint-kyverno.yml"
|
||||
rules:
|
||||
- if: >
|
||||
$JOB_OPENDESK_LINTER_ENABLED == 'false' ||
|
||||
$CI_PIPELINE_SOURCE =~ 'tags|merge_request_event|web|trigger|api'
|
||||
when: "never"
|
||||
- when: "always"
|
||||
|
||||
stages:
|
||||
- ".pre"
|
||||
- "lint"
|
||||
- "renovate"
|
||||
- "scan"
|
||||
- "automr"
|
||||
- "env-cleanup"
|
||||
- "env"
|
||||
- "pre-services-deploy"
|
||||
- "migrations-pre"
|
||||
- "basic-services-deploy"
|
||||
- "component-deploy-stage-1"
|
||||
- "component-deploy-stage-2"
|
||||
- "migrations-post"
|
||||
- "lint"
|
||||
- "tests"
|
||||
- "env-stop"
|
||||
- "generate-release-artefacts"
|
||||
- ".post"
|
||||
|
||||
variables:
|
||||
@@ -28,17 +51,24 @@ variables:
|
||||
description: "The name of namespaces to deploy to."
|
||||
value: ""
|
||||
CLUSTER:
|
||||
description: "Define which cluster to use. Cluster must be defined in gitlab/environments.yaml of
|
||||
sovereign-workplace-env included above."
|
||||
description: "Which cluster to use. Cluster must be defined in `gitlab/environments.yaml` of the
|
||||
repo that is included above using the env var `PROJECT_PATH_CUSTOM_ENVIRONMENT_CONFIG`:
|
||||
${PROJECT_PATH_CUSTOM_ENVIRONMENT_CONFIG}"
|
||||
value: "dev"
|
||||
BASE_DOMAIN:
|
||||
description: "Define the Cluster Base Domain."
|
||||
value: "souvap.cloud"
|
||||
MASTER_PASSWORD_WEB_VAR:
|
||||
description: "Optional: Provide a passphrase to be used for password generation."
|
||||
description: >
|
||||
Optional: Provide a seed to be used for generation of all internal secrets.
|
||||
Same seed will result in same secrets.
|
||||
value: ""
|
||||
ENV_STOP_BEFORE:
|
||||
description: "Stop environment/delete namespace for the deployment"
|
||||
description: "Stop environment/delete namespace for the deployment."
|
||||
value: "no"
|
||||
options:
|
||||
- "yes"
|
||||
- "no"
|
||||
DEBUG_ENABLED:
|
||||
description: "Allows to set `debug.enabled` to true for a deployment, needs to be supported by stage specific\
|
||||
configuration containting: `debug.enabled: {{ env \"DEBUG_ENABLED\" | default false }}`"
|
||||
value: "no"
|
||||
options:
|
||||
- "yes"
|
||||
@@ -49,14 +79,20 @@ variables:
|
||||
options:
|
||||
- "yes"
|
||||
- "no"
|
||||
DEPLOY_MIGRATIONS:
|
||||
description: "Deploy K8s job for migrations (pre & post)."
|
||||
value: "no"
|
||||
options:
|
||||
- "yes"
|
||||
- "no"
|
||||
DEPLOY_SERVICES:
|
||||
description: "Enable Service deployment."
|
||||
value: "no"
|
||||
options:
|
||||
- "yes"
|
||||
- "no"
|
||||
DEPLOY_UCS:
|
||||
description: "Enable Univention Corporate Server deployment."
|
||||
DEPLOY_UMS:
|
||||
description: "Enable Nubus deployment."
|
||||
value: "no"
|
||||
options:
|
||||
- "yes"
|
||||
@@ -73,14 +109,14 @@ variables:
|
||||
options:
|
||||
- "yes"
|
||||
- "no"
|
||||
DEPLOY_ELEMENT:
|
||||
description: "Enable Element deployment."
|
||||
DEPLOY_CRYPTPAD:
|
||||
description: "Enable CryptPad deployment."
|
||||
value: "no"
|
||||
options:
|
||||
- "yes"
|
||||
- "no"
|
||||
DEPLOY_KEYCLOAK:
|
||||
description: "Enable Keycloak deployment."
|
||||
DEPLOY_ELEMENT:
|
||||
description: "Enable Element deployment."
|
||||
value: "no"
|
||||
options:
|
||||
- "yes"
|
||||
@@ -127,34 +163,22 @@ variables:
|
||||
options:
|
||||
- "yes"
|
||||
- "no"
|
||||
TESTS_PROJECT_URL:
|
||||
description: "URL of the E2E-test Gitlab project API with project ID."
|
||||
# please use the following set of variables with normalized names:
|
||||
DOMAIN: "${NAMESPACE}.${CLUSTER}.${BASE_DOMAIN}"
|
||||
ISTIO_DOMAIN: "${NAMESPACE}.istio.${CLUSTER}.${BASE_DOMAIN}"
|
||||
RUN_RENOVATE:
|
||||
description: "Triggers the Renovate based check for dependency updates."
|
||||
value: "no"
|
||||
options:
|
||||
- "yes"
|
||||
- "no"
|
||||
TESTS_BRANCH:
|
||||
description: "Branch of E2E-tests on which the test pipeline is triggered"
|
||||
value: "main"
|
||||
|
||||
.deploy-common:
|
||||
cache: {}
|
||||
dependencies: []
|
||||
extends: ".environments"
|
||||
image: "registry.souvap-univention.de/souvap/tooling/images/helm:latest"
|
||||
secrets:
|
||||
SMTP_PASSWORD:
|
||||
vault:
|
||||
engine:
|
||||
name: "kv-v2"
|
||||
path: "swp"
|
||||
path: "accounts/brained/mail/relay@souvap-univention.de"
|
||||
field: "password"
|
||||
file: false
|
||||
TURN_CREDENTIALS:
|
||||
vault:
|
||||
engine:
|
||||
name: "kv-v2"
|
||||
path: "swp"
|
||||
path: "accounts/souvap-univention.de/develop/turn/secret"
|
||||
field: "credentials"
|
||||
file: false
|
||||
image: "registry.opencode.de/bmi/opendesk/components/platform-development/images/helm:1.0.1\
|
||||
@sha256:d38f41b88374e055332860018f2936db8807b763caf6089735db0484cbb2842a"
|
||||
script:
|
||||
- "cd ${CI_PROJECT_DIR}/helmfile/apps/${COMPONENT}"
|
||||
# MASTER_PASSWORD_WEB_VAR as precedence for MASTER_PASSWORD
|
||||
@@ -164,7 +188,7 @@ variables:
|
||||
fi;
|
||||
- >
|
||||
echo "Installing ${COMPONENT} into ${NAMESPACE} namespace as ${HELMFILE_ENVIRONMENT} environment on ${CLUSTER}"
|
||||
- "helmfile --namespace ${NAMESPACE} apply --suppress-diff"
|
||||
- "helmfile --namespace ${NAMESPACE} apply --suppress-diff ${ADDITIONAL_ARGS}"
|
||||
tags:
|
||||
- "docker"
|
||||
- "kubernetes"
|
||||
@@ -180,27 +204,35 @@ env-cleanup:
|
||||
needs: []
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|triggers" &&
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||
$NAMESPACE =~ /.+/ &&
|
||||
$ENV_STOP_BEFORE != "no"
|
||||
when: "always"
|
||||
when: "on_success"
|
||||
script:
|
||||
- "helmfile destroy --namespace ${NAMESPACE}"
|
||||
- "kubectl delete pvc --all --namespace ${NAMESPACE}"
|
||||
- |
|
||||
if [ "${OPENDESK_SLEDGEHAMMER_DESTROY_ENABLED}" = "yes" ]; then
|
||||
for OPENDESK_RELEASE in $(helm ls -n ${NAMESPACE} -aq); do
|
||||
helm uninstall -n ${NAMESPACE} ${OPENDESK_RELEASE};
|
||||
done
|
||||
kubectl delete pvc --all --namespace ${NAMESPACE};
|
||||
kubectl delete jobs --all --namespace ${NAMESPACE};
|
||||
kubectl delete configmaps --all --namespace ${NAMESPACE};
|
||||
else
|
||||
helmfile destroy --namespace ${NAMESPACE};
|
||||
fi
|
||||
stage: "env-cleanup"
|
||||
|
||||
env-start:
|
||||
environment:
|
||||
name: "${NAMESPACE}"
|
||||
url: "https://portal.${DOMAIN}"
|
||||
on_stop: "env-stop"
|
||||
extends: ".deploy-common"
|
||||
image: "${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/alpine/k8s:1.25.6"
|
||||
image: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/alpine/k8s:1.25.6"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|triggers" &&
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||
$NAMESPACE =~ /.+/
|
||||
when: "always"
|
||||
when: "on_success"
|
||||
script:
|
||||
- "echo \"Deploying to Environment ${NAMESPACE} in ${CLUSTER} Cluster\""
|
||||
- "kubectl create namespace ${NAMESPACE} --dry-run=client -o yaml | kubectl apply -f -"
|
||||
@@ -208,72 +240,84 @@ env-start:
|
||||
kubectl create secret
|
||||
--namespace "${NAMESPACE}"
|
||||
docker-registry external-registry
|
||||
--docker-server "external-registry.souvap-univention.de"
|
||||
--docker-username sovereign-workplace
|
||||
--docker-server "${EXTERNAL_REGISTRY}"
|
||||
--docker-username "${EXTERNAL_REGISTRY_USERNAME}"
|
||||
--docker-password "${EXTERNAL_REGISTRY_PASSWORD}"
|
||||
--dry-run=client -o yaml | kubectl apply -f -
|
||||
stage: "env"
|
||||
|
||||
policies-deploy:
|
||||
stage: "pre-services-deploy"
|
||||
extends: ".deploy-common"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||
$NAMESPACE =~ /.+/ &&
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_SERVICES != "no")
|
||||
when: "on_success"
|
||||
variables:
|
||||
COMPONENT: "services"
|
||||
ADDITIONAL_ARGS: "-l name=opendesk-otterize"
|
||||
|
||||
migrations-pre:
|
||||
stage: "migrations-pre"
|
||||
extends: ".deploy-common"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||
$NAMESPACE =~ /.+/ &&
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_MIGRATIONS != "no")
|
||||
when: "on_success"
|
||||
variables:
|
||||
COMPONENT: "migrations-pre"
|
||||
|
||||
migrations-post:
|
||||
stage: "migrations-post"
|
||||
extends: ".deploy-common"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||
$NAMESPACE =~ /.+/ &&
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_MIGRATIONS != "no")
|
||||
when: "on_success"
|
||||
variables:
|
||||
COMPONENT: "migrations-post"
|
||||
|
||||
services-deploy:
|
||||
stage: "basic-services-deploy"
|
||||
extends: ".deploy-common"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|triggers" &&
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||
$NAMESPACE =~ /.+/ &&
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_SERVICES != "no")
|
||||
when: "always"
|
||||
when: "on_success"
|
||||
variables:
|
||||
COMPONENT: "services"
|
||||
|
||||
ucs-deploy:
|
||||
stage: "component-deploy-stage-1"
|
||||
extends: ".deploy-common"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|triggers" &&
|
||||
$NAMESPACE =~ /.+/ &&
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_UCS != "no")
|
||||
when: "always"
|
||||
variables:
|
||||
COMPONENT: "univention-corporate-container"
|
||||
|
||||
provisioning-deploy:
|
||||
stage: "component-deploy-stage-2"
|
||||
extends: ".deploy-common"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|triggers" &&
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||
$NAMESPACE =~ /.+/ &&
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_UCS != "no" || $DEPLOY_PROVISIONING != "no")
|
||||
when: "always"
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_UMS != "no" || $DEPLOY_PROVISIONING != "no")
|
||||
when: "on_success"
|
||||
variables:
|
||||
COMPONENT: "provisioning"
|
||||
|
||||
keycloak-deploy:
|
||||
ums-deploy:
|
||||
stage: "component-deploy-stage-1"
|
||||
extends: ".deploy-common"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|triggers" &&
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||
$NAMESPACE =~ /.+/ &&
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_KEYCLOAK != "no")
|
||||
when: "always"
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_UMS != "no")
|
||||
when: "on_success"
|
||||
variables:
|
||||
COMPONENT: "keycloak"
|
||||
|
||||
keycloak-bootstrap-deploy:
|
||||
stage: "component-deploy-stage-1"
|
||||
extends: ".deploy-common"
|
||||
timeout: "30m"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|triggers" &&
|
||||
$NAMESPACE =~ /.+/ &&
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_KEYCLOAK != "no")
|
||||
when: "always"
|
||||
variables:
|
||||
COMPONENT: "keycloak-bootstrap"
|
||||
COMPONENT: "nubus"
|
||||
|
||||
ox-deploy:
|
||||
stage: "component-deploy-stage-1"
|
||||
@@ -281,10 +325,10 @@ ox-deploy:
|
||||
timeout: "30m"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|triggers" &&
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||
$NAMESPACE =~ /.+/ &&
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_OX != "no")
|
||||
when: "always"
|
||||
when: "on_success"
|
||||
variables:
|
||||
COMPONENT: "open-xchange"
|
||||
|
||||
@@ -293,10 +337,10 @@ ics-deploy:
|
||||
extends: ".deploy-common"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|triggers" &&
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||
$NAMESPACE =~ /.+/ &&
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_ICS != "no")
|
||||
when: "always"
|
||||
when: "on_success"
|
||||
variables:
|
||||
COMPONENT: "intercom-service"
|
||||
|
||||
@@ -305,10 +349,10 @@ xwiki-deploy:
|
||||
extends: ".deploy-common"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|triggers" &&
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||
$NAMESPACE =~ /.+/ &&
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_XWIKI != "no")
|
||||
when: "always"
|
||||
when: "on_success"
|
||||
variables:
|
||||
COMPONENT: "xwiki"
|
||||
|
||||
@@ -317,22 +361,34 @@ collabora-deploy:
|
||||
extends: ".deploy-common"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|triggers" &&
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||
$NAMESPACE =~ /.+/ &&
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_NEXTCLOUD != "no" || $DEPLOY_COLLABORA != "no")
|
||||
when: "always"
|
||||
when: "on_success"
|
||||
variables:
|
||||
COMPONENT: "collabora"
|
||||
|
||||
cryptpad-deploy:
|
||||
stage: "component-deploy-stage-1"
|
||||
extends: ".deploy-common"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||
$NAMESPACE =~ /.+/ &&
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_NEXTCLOUD != "no" || $DEPLOY_CRYPTPAD != "no")
|
||||
when: "on_success"
|
||||
variables:
|
||||
COMPONENT: "cryptpad"
|
||||
|
||||
nextcloud-deploy:
|
||||
stage: "component-deploy-stage-1"
|
||||
extends: ".deploy-common"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|triggers" &&
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||
$NAMESPACE =~ /.+/ &&
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_NEXTCLOUD != "no")
|
||||
when: "always"
|
||||
when: "on_success"
|
||||
variables:
|
||||
COMPONENT: "nextcloud"
|
||||
|
||||
@@ -341,22 +397,34 @@ openproject-deploy:
|
||||
extends: ".deploy-common"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|triggers" &&
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||
$NAMESPACE =~ /.+/ &&
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_OPENPROJECT != "no")
|
||||
when: "always"
|
||||
when: "on_success"
|
||||
variables:
|
||||
COMPONENT: "openproject"
|
||||
|
||||
openproject-bootstrap-deploy:
|
||||
stage: "component-deploy-stage-2"
|
||||
extends: ".deploy-common"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||
$NAMESPACE =~ /.+/ &&
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || ($DEPLOY_OPENPROJECT != "no" && $DEPLOY_NEXTCLOUD != "no"))
|
||||
when: "on_success"
|
||||
variables:
|
||||
COMPONENT: "openproject-bootstrap"
|
||||
|
||||
jitsi-deploy:
|
||||
stage: "component-deploy-stage-1"
|
||||
extends: ".deploy-common"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|triggers" &&
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||
$NAMESPACE =~ /.+/ &&
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_JITSI != "no")
|
||||
when: "always"
|
||||
when: "on_success"
|
||||
variables:
|
||||
COMPONENT: "jitsi"
|
||||
|
||||
@@ -365,10 +433,10 @@ element-deploy:
|
||||
extends: ".deploy-common"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|triggers" &&
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" &&
|
||||
$NAMESPACE =~ /.+/ &&
|
||||
($DEPLOY_ALL_COMPONENTS != "no" || $DEPLOY_ELEMENT != "no")
|
||||
when: "always"
|
||||
when: "on_success"
|
||||
variables:
|
||||
COMPONENT: "element"
|
||||
|
||||
@@ -377,11 +445,11 @@ env-stop:
|
||||
environment:
|
||||
name: "${NAMESPACE}"
|
||||
action: "stop"
|
||||
image: "${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/alpine/k8s:1.25.6"
|
||||
image: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/alpine/k8s:1.25.6"
|
||||
needs: []
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|triggers" && $NAMESPACE =~ /.+/
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" && $NAMESPACE =~ /.+/
|
||||
when: "manual"
|
||||
script:
|
||||
- "echo 'We do not stop the env (delete the namespace) at the moment in this stage, as deleting a branches also
|
||||
@@ -391,141 +459,233 @@ env-stop:
|
||||
variables:
|
||||
GIT_STRATEGY: "none"
|
||||
|
||||
.ums-default-password: &ums-default-password
|
||||
- |
|
||||
UMS_PASSWORDS=$( \
|
||||
kubectl -n ${NAMESPACE} get cm ums-stack-data-swp-data -o jsonpath='{.data.dev-test-users\.yaml}' \
|
||||
| yq '.properties.password' > passwords.txt \
|
||||
)
|
||||
DEFAULT_USER_PASSWORD=$( \
|
||||
awk 'NR==1{print $1}' passwords.txt \
|
||||
)
|
||||
DEFAULT_ADMIN_PASSWORD=$(
|
||||
awk 'NR==3{print $1}' passwords.txt \
|
||||
)
|
||||
|
||||
run-tests:
|
||||
extends: ".deploy-common"
|
||||
environment:
|
||||
name: "${NAMESPACE}"
|
||||
tags:
|
||||
- "docker"
|
||||
- "kubernetes"
|
||||
- "${CLUSTER}"
|
||||
stage: "tests"
|
||||
rules:
|
||||
- if: >
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|triggers" && $NAMESPACE =~ /.+/ && $RUN_TESTS == "yes"
|
||||
when: "always"
|
||||
$CI_PIPELINE_SOURCE =~ "web|schedules|trigger|api" && $NAMESPACE =~ /.+/ && $RUN_TESTS == "yes"
|
||||
when: "on_success"
|
||||
script:
|
||||
- *ums-default-password
|
||||
- |
|
||||
COMPONENTS="login or portal or profile or navigation"
|
||||
if [ "${DEPLOY_ALL_COMPONENTS}" != "no" ]; then
|
||||
COMPONENTS="${COMPONENTS} or collabora or ics or jitsi or keycloak or nextcloud or openproject or ox or ucs \
|
||||
or xwiki"
|
||||
else
|
||||
[ "${DEPLOY_COLLABORA}" != "no" ] && COMPONENTS="${COMPONENTS} or collabora"
|
||||
[ "${DEPLOY_ICS}" != "no" ] && COMPONENTS="${COMPONENTS} or ics"
|
||||
[ "${DEPLOY_JITSI}" != "no" ] && COMPONENTS="${COMPONENTS} or jitsi"
|
||||
[ "${DEPLOY_KEYCLOAK}" != "no" ] && COMPONENTS="${COMPONENTS} or keycloak"
|
||||
[ "${DEPLOY_NEXTCLOUD}" != "no" ] && COMPONENTS="${COMPONENTS} or nextcloud"
|
||||
[ "${DEPLOY_OPENPROJECT}" != "no" ] && COMPONENTS="${COMPONENTS} or openproject"
|
||||
[ "${DEPLOY_OX}" != "no" ] && COMPONENTS="${COMPONENTS} or ox"
|
||||
[ "${DEPLOY_UCS}" != "no" ] && COMPONENTS="${COMPONENTS} or ucs"
|
||||
[ "${DEPLOY_XWIKI}" != "no" ] && COMPONENTS="${COMPONENTS} or xwiki"
|
||||
fi
|
||||
curl --request POST \
|
||||
--header "Content-Type: application/json" \
|
||||
--data "{ \
|
||||
\"ref\": \"${TESTS_BRANCH}\", \
|
||||
\"token\": \"${CI_JOB_TOKEN}\", \
|
||||
\"variables\": { \
|
||||
\"url\": \"https://portal.${DOMAIN}\", \
|
||||
\"user_name\": \"${DEFAULT_USER_NAME}\", \
|
||||
\"user_password\": \"${DEFAULT_USER_PASSWORD}\", \
|
||||
\"admin_name\": \"${DEFAULT_ADMIN_NAME}\", \
|
||||
\"admin_password\": \"${DEFAULT_ADMIN_PASSWORD}\", \
|
||||
\"DEPLOY_ALL_COMPONENTS\": \"${DEPLOY_ALL_COMPONENTS}\", \
|
||||
\"DEPLOY_COLLABORA\": \"${DEPLOY_COLLABORA}\", \
|
||||
\"DEPLOY_ELEMENT\": \"${DEPLOY_ELEMENT}\", \
|
||||
\"DEPLOY_ICS\": \"${DEPLOY_ICS}\", \
|
||||
\"DEPLOY_JITSI\": \"${DEPLOY_JITSI}\", \
|
||||
\"DEPLOY_KEYCLOAK\": \"${DEPLOY_UMS}\", \
|
||||
\"DEPLOY_NEXTCLOUD\": \"${DEPLOY_NEXTCLOUD}\", \
|
||||
\"DEPLOY_OPENPROJECT\": \"${DEPLOY_OPENPROJECT}\", \
|
||||
\"DEPLOY_OX\": \"${DEPLOY_OX}\", \
|
||||
\"DEPLOY_SERVICES\": \"${DEPLOY_SERVICES}\", \
|
||||
\"DEPLOY_UCS\": \"${DEPLOY_UMS}\", \
|
||||
\"DEPLOY_XWIKI\": \"${DEPLOY_XWIKI}\", \
|
||||
\"DEPLOY_PROVISIONING\": \"${DEPLOY_PROVISIONING}\" \
|
||||
} \
|
||||
}" \
|
||||
"https://${TESTS_PROJECT_URL}/trigger/pipeline"
|
||||
|
||||
echo "Gathering passwords from UCS container ..."
|
||||
UCS_CONTAINER_NAME=$( \
|
||||
kubectl -n ${NAMESPACE} get pods --no-headers \
|
||||
--selector 'app.kubernetes.io/instance=univention-corporate-container' \
|
||||
| awk '{print $1}' \
|
||||
)
|
||||
echo "UCS_CONTAINER_NAME: ${UCS_CONTAINER_NAME}"
|
||||
DEFAULT_USER_PASSWORD=$( \
|
||||
kubectl -n ${NAMESPACE} describe pod ${UCS_CONTAINER_NAME} \
|
||||
| grep DEFAULT_ACCOUNT_USER_PASSWORD \
|
||||
| awk '{print $2}' \
|
||||
)
|
||||
DEFAULT_ADMIN_PASSWORD=$( \
|
||||
kubectl -n ${NAMESPACE} describe pod ${UCS_CONTAINER_NAME} \
|
||||
| grep DEFAULT_ACCOUNT_ADMIN_PASSWORD \
|
||||
| awk '{print $2}' \
|
||||
)
|
||||
|
||||
echo "triggering test pipeline ..."
|
||||
curl -X POST \
|
||||
-F "ref=main" \
|
||||
-F "token=${CI_JOB_TOKEN}" \
|
||||
-F "variables[url]=https://portal.${DOMAIN}" \
|
||||
-F "variables[user_name]=${DEFAULT_USER_NAME}" \
|
||||
-F "variables[user_password]=${DEFAULT_USER_PASSWORD}" \
|
||||
-F "variables[admin_name]=${DEFAULT_ADMIN_NAME}" \
|
||||
-F "variables[admin_password]=${DEFAULT_ADMIN_PASSWORD}" \
|
||||
-F "variables[components]=\"${COMPONENTS}\"" \
|
||||
https://${TESTS_PROJECT_URL}/trigger/pipeline
|
||||
|
||||
generate-release-artefacts:
|
||||
stage: "generate-release-artefacts"
|
||||
image: "registry.souvap-univention.de/souvap/tooling/images/ansible:4.10.0"
|
||||
avscan-prepare:
|
||||
stage: ".pre"
|
||||
rules:
|
||||
- if: "$JOB_RELEASE_ENABLED != 'false' && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"
|
||||
- if: >
|
||||
$JOB_AVSCAN_ENABLED != 'false' &&
|
||||
$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH &&
|
||||
$CI_PIPELINE_SOURCE =~ "push|merge_request_event"
|
||||
when: "always"
|
||||
- when: "never"
|
||||
image: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/mikefarah/yq"
|
||||
script:
|
||||
- |
|
||||
git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@${CI_SERVER_HOST}/souvap/devops/generate-deployment-artefacts
|
||||
cd generate-deployment-artefacts
|
||||
export OPENDESK_DEPLOYMENT_AUTOMATION_PATH=${CI_PROJECT_DIR}
|
||||
./artefact_generator.py
|
||||
mv ./build_artefacts ${CI_PROJECT_DIR}
|
||||
cd ..
|
||||
rm -rf generate-deployment-artefacts
|
||||
ls -l ./build_artefacts
|
||||
cat << 'EOF' > dynamic-scans.yml
|
||||
---
|
||||
stages:
|
||||
- "scan"
|
||||
|
||||
.container-clamav:
|
||||
stage: "scan"
|
||||
image: "registry.opencode.de/bmi/opendesk/components/platform-development/images/clamav-imagescan:1.0.0"
|
||||
before_script:
|
||||
- "sed -i \"/^DatabaseMirror .*$/c DatabaseMirror ${DATABASE_MIRROR}\" /etc/clamav/freshclam.conf"
|
||||
- "freshclam"
|
||||
- "mkdir /scan"
|
||||
script:
|
||||
- "export IMAGE=${EXTERNAL_REGISTRY:-${CONTAINER_REGISTRY}}/${CONTAINER_IMAGE}:${CONTAINER_TAG}"
|
||||
- "echo Pulling and scanning $IMAGE..."
|
||||
- "crane pull $IMAGE /scan/image.tar"
|
||||
- "clamscan /scan"
|
||||
variables:
|
||||
CONTAINER_IMAGE: ""
|
||||
CONTAINER_REGISTRY: ""
|
||||
CONTAINER_TAG: ""
|
||||
DATABASE_MIRROR: "https://nexus.souvap-univention.de/repository/ClamAV"
|
||||
EOF
|
||||
- >
|
||||
yq '.images
|
||||
| with_entries(.key |= "scan-" + .)
|
||||
| .[].extends=".container-clamav"
|
||||
| with(.[]; .variables.CONTAINER_IMAGE = .repository
|
||||
| .variables.CONTAINER_TAG = .tag | .variables.CONTAINER_REGISTRY = .registry)
|
||||
| del(.[].repository)
|
||||
| del(.[].tag)
|
||||
| del(.[].registry)'
|
||||
helmfile/environments/default/images.yaml
|
||||
>> dynamic-scans.yml
|
||||
artifacts:
|
||||
paths:
|
||||
- "./build_artefacts/chart-index.json"
|
||||
- "./build_artefacts/image-index.json"
|
||||
tags:
|
||||
- "docker"
|
||||
- "dynamic-scans.yml"
|
||||
|
||||
avscan-start:
|
||||
stage: "scan"
|
||||
rules:
|
||||
- if: >
|
||||
$JOB_AVSCAN_ENABLED != 'false' &&
|
||||
$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH &&
|
||||
$CI_PIPELINE_SOURCE =~ "push|merge_request_event"
|
||||
when: "always"
|
||||
- when: "never"
|
||||
trigger:
|
||||
include:
|
||||
- artifact: "dynamic-scans.yml"
|
||||
job: "avscan-prepare"
|
||||
strategy: "depend"
|
||||
|
||||
# Declare .environments which is in environments repository. In case it is not available
|
||||
# 'cache' is used because job must contain at least one key, so cache is just a dummy key.
|
||||
.environments:
|
||||
cache: {}
|
||||
|
||||
# Overwrite shared settings
|
||||
.common-semantic-release:
|
||||
image: "registry.souvap-univention.de/souvap/tooling/images/semantic-release-patched:latest"
|
||||
image: "registry.opencode.de/bmi/opendesk/components/platform-development/images/semantic-release-patched:latest"
|
||||
tags: []
|
||||
|
||||
conventional-commits-linter:
|
||||
rules:
|
||||
- if: "$CI_PIPELINE_SOURCE =~ 'tags|triggers|web|merge_request_event'"
|
||||
- if: >
|
||||
$RUN_RENOVATE == "yes" ||
|
||||
$JOB_CONVENTIONAL_COMMITS_LINTER_ENABLED == 'false' ||
|
||||
$CI_PIPELINE_SOURCE =~ 'tags|merge_request_event'
|
||||
when: "never"
|
||||
- when: "always"
|
||||
|
||||
common-yaml-linter:
|
||||
rules:
|
||||
- if: "$CI_PIPELINE_SOURCE =~ 'tags|triggers|web|merge_request_event'"
|
||||
- if: "$JOB_COMMON_YAML_LINTER_ENABLED == 'false' || $CI_PIPELINE_SOURCE =~ 'tags|web|merge_request_event'"
|
||||
when: "never"
|
||||
- when: "always"
|
||||
|
||||
reuse-linter:
|
||||
allow_failure: false
|
||||
rules:
|
||||
- if: "$CI_PIPELINE_SOURCE =~ 'tags|triggers|web|merge_request_event'"
|
||||
- if: "$JOB_REUSE_LINTER_ENABLED == 'false' || $CI_PIPELINE_SOURCE =~ 'tags|web|merge_request_event'"
|
||||
when: "never"
|
||||
- when: "always"
|
||||
|
||||
generate-release-version:
|
||||
rules:
|
||||
- if: >
|
||||
$JOB_RELEASE_ENABLED != 'false' &&
|
||||
$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH &&
|
||||
$CI_PIPELINE_SOURCE =~ "push|merge_request_event"
|
||||
when: "on_success"
|
||||
|
||||
release:
|
||||
rules:
|
||||
- if: "$JOB_RELEASE_ENABLED != 'false' && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"
|
||||
when: "always"
|
||||
- when: "never"
|
||||
- if: >
|
||||
$JOB_AVSCAN_ENABLED != 'false' &&
|
||||
$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH &&
|
||||
$CI_PIPELINE_SOURCE =~ "push|merge_request_event"
|
||||
when: "on_success"
|
||||
script:
|
||||
- >
|
||||
export RELEASE_VERSION=$(semantic-release --dry-run --branches $CI_COMMIT_REF_NAME --plugins
|
||||
"@semantic-release/gitlab" | grep -oP "Published release [0-9]+\.[0-9]+\.[0-9]+ on" |
|
||||
grep -oP "[0-9]+\.[0-9]+\.[0-9]+")
|
||||
- |
|
||||
if [ -z "${RELEASE_VERSION}" ]; then
|
||||
echo "RELEASE_VERSION=$(git describe --tags --abbrev=0 | sed s@^v@@g )"
|
||||
else
|
||||
echo "RELEASE_VERSION=${RELEASE_VERSION}"
|
||||
fi
|
||||
- |
|
||||
echo -e "\n[INFO] Writing data to helm value file..."
|
||||
cat <<EOF >helmfile/environments/default/global.generated.yaml
|
||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
global:
|
||||
systemInformation:
|
||||
releaseVersion: "v$(echo -E "$RELEASE_VERSION")"
|
||||
...
|
||||
EOF
|
||||
- |
|
||||
cat << 'EOF' > ${CI_PROJECT_DIR}/.releaserc
|
||||
{
|
||||
"branches": ["main"],
|
||||
"plugins": [
|
||||
["@semantic-release/gitlab",
|
||||
{
|
||||
"assets": [
|
||||
{ "path": "./build_artefacts/chart-index.json",
|
||||
"label": "Chart Index JSON" },
|
||||
{ "path": "./build_artefacts/image-index.json",
|
||||
"label": "Image Index JSON" },
|
||||
]
|
||||
}
|
||||
],
|
||||
"@semantic-release/gitlab",
|
||||
"@semantic-release/release-notes-generator",
|
||||
"@semantic-release/changelog",
|
||||
["@semantic-release/git", {
|
||||
"assets": ["charts/**/Chart.yaml", "CHANGELOG.md", "charts/**/README.md"],
|
||||
"assets": [
|
||||
"charts/**/Chart.yaml",
|
||||
"CHANGELOG.md",
|
||||
"charts/**/README.md",
|
||||
"helmfile/environments/default/global.generated.yaml",
|
||||
".kyverno/kyverno-test.yaml",
|
||||
"docs"
|
||||
],
|
||||
"message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
|
||||
}]
|
||||
]
|
||||
}
|
||||
EOF
|
||||
- "semantic-release"
|
||||
needs:
|
||||
- "generate-docs"
|
||||
|
||||
renovate:
|
||||
rules:
|
||||
- if: >
|
||||
$RUN_RENOVATE == "yes"
|
||||
when: "on_success"
|
||||
# The `-full` image does not install the dependencies on the fly, that is our preferred approach
|
||||
image: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/renovate/renovate:37.356-full"
|
||||
variables:
|
||||
RENOVATE_CONFIG_FILE: "${CI_PROJECT_DIR}/.renovate/config.yaml"
|
||||
RENOVATE_ENDPOINT: "${CI_API_V4_URL}"
|
||||
# Increase the renovatebot log level on stdout
|
||||
LOG_LEVEL: "DEBUG"
|
||||
script:
|
||||
- "renovate ${RENOVATE_EXTRA_FLAGS}"
|
||||
stage: "renovate"
|
||||
|
||||
...
|
||||
|
||||
14
.gitlab/common/common.yml
Normal file
14
.gitlab/common/common.yml
Normal file
@@ -0,0 +1,14 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
variables:
|
||||
OPENDESK_CI_CLI_IMAGE: "registry.opencode.de/bmi/opendesk/tooling/opendesk-ci-cli:2.4.4\
|
||||
@sha256:4120fe717071876f4c9ff128f26019d089fda158a4fb1912911e09af2fd3875f"
|
||||
OPENDESK_LINT_IMAGE: "registry.opencode.de/bmi/opendesk/components/platform-development/images/ci-lint:1.0.5\
|
||||
@sha256:60870adb64b0503d4a6efd16cef4e074b91a4ca52b48811cfcea057bcccd07e4"
|
||||
|
||||
.common:
|
||||
cache: {}
|
||||
needs: []
|
||||
tags: []
|
||||
...
|
||||
11
.gitlab/generate/generate-common.yml
Normal file
11
.gitlab/generate/generate-common.yml
Normal file
@@ -0,0 +1,11 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
include:
|
||||
- local: "/.gitlab/common/common.yml"
|
||||
|
||||
.generate-common:
|
||||
extends: ".common"
|
||||
stage: ".post"
|
||||
tags: []
|
||||
...
|
||||
20
.gitlab/generate/generate-docs.yml
Normal file
20
.gitlab/generate/generate-docs.yml
Normal file
@@ -0,0 +1,20 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
include:
|
||||
- local: "/.gitlab/generate/generate-common.yml"
|
||||
|
||||
generate-docs:
|
||||
cache:
|
||||
- key: "generate-docs-${CI_COMMIT_REF_SLUG}"
|
||||
paths:
|
||||
- "${CI_PROJECT_DIR}/docs"
|
||||
policy: "push"
|
||||
extends: ".generate-common"
|
||||
image: "${OPENDESK_CI_CLI_IMAGE}"
|
||||
rules:
|
||||
- if: "$JOB_RELEASE_ENABLED != 'false' && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"
|
||||
when: "on_success"
|
||||
script:
|
||||
- "node /app/src/index.js generate-docs -d ${CI_PROJECT_DIR}"
|
||||
...
|
||||
11
.gitlab/lint/lint-common.yml
Normal file
11
.gitlab/lint/lint-common.yml
Normal file
@@ -0,0 +1,11 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
include:
|
||||
- local: "/.gitlab/common/common.yml"
|
||||
|
||||
.lint-common:
|
||||
extends: ".common"
|
||||
stage: "lint"
|
||||
|
||||
...
|
||||
42
.gitlab/lint/lint-kyverno.yml
Normal file
42
.gitlab/lint/lint-kyverno.yml
Normal file
@@ -0,0 +1,42 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
include:
|
||||
- local: "/.gitlab/lint/lint-common.yml"
|
||||
|
||||
lint-kyverno:
|
||||
allow_failure: true
|
||||
extends: ".lint-common"
|
||||
image: "${OPENDESK_LINT_IMAGE}"
|
||||
parallel:
|
||||
matrix:
|
||||
- APP:
|
||||
- "collabora"
|
||||
- "cryptpad"
|
||||
- "element"
|
||||
- "intercom-service"
|
||||
- "jitsi"
|
||||
- "nextcloud"
|
||||
- "nubus"
|
||||
- "open-xchange"
|
||||
- "openproject"
|
||||
- "openproject-bootstrap"
|
||||
- "provisioning"
|
||||
- "services"
|
||||
- "xwiki"
|
||||
script:
|
||||
- "cd ${CI_PROJECT_DIR}/helmfile/apps/${APP}"
|
||||
- "helmfile template -e test --include-needs > ${CI_PROJECT_DIR}/.kyverno/opendesk.yaml"
|
||||
- >
|
||||
node /app/opendesk-ci-cli/src/index.js generate-kyverno-tests
|
||||
-d ${CI_PROJECT_DIR}/.kyverno
|
||||
-t required
|
||||
-s manifest
|
||||
-f opendesk.yaml
|
||||
--skip-tests true
|
||||
${APP}
|
||||
- "node /app/opendesk-ci-cli/src/index.js filter-for-kinds -f ${CI_PROJECT_DIR}/.kyverno/opendesk.yaml"
|
||||
- "cd ${CI_PROJECT_DIR}/.kyverno"
|
||||
- "kyverno test ."
|
||||
|
||||
...
|
||||
18
.gitlab/lint/lint-opendesk.yml
Normal file
18
.gitlab/lint/lint-opendesk.yml
Normal file
@@ -0,0 +1,18 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
include:
|
||||
- local: "/.gitlab/lint/lint-common.yml"
|
||||
|
||||
lint-opendesk:
|
||||
extends: ".lint-common"
|
||||
image: "${OPENDESK_CI_CLI_IMAGE}"
|
||||
rules:
|
||||
- if: >
|
||||
$RUN_RENOVATE == "yes"
|
||||
when: "never"
|
||||
- when: "always"
|
||||
script:
|
||||
- "node /app/src/index.js sort-all -d ${CI_PROJECT_DIR}/helmfile"
|
||||
- "git diff --exit-code"
|
||||
...
|
||||
16
.gitlab/merge_request_templates/Default.md
Normal file
16
.gitlab/merge_request_templates/Default.md
Normal file
@@ -0,0 +1,16 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
# Summary
|
||||
|
||||
- *describe the reason for/content of the MR*
|
||||
|
||||
# Commits
|
||||
|
||||
%{all_commits}
|
||||
|
||||
# Authors
|
||||
|
||||
%{co_authored_by}
|
||||
292
.kyverno/policies/_policies.yaml
Normal file
292
.kyverno/policies/_policies.yaml
Normal file
@@ -0,0 +1,292 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
pod:
|
||||
- name: "require-tag-and-digest"
|
||||
rule: "require-tag-and-digest"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "disallow-default-serviceaccount"
|
||||
rule: "disallow-default-serviceAccountName"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "template-imagepullsecrets"
|
||||
rule: "template-imagePullSecrets"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "disallow-latest-tag"
|
||||
rule: "disallow-latest-tag"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "disallow-latest-tag"
|
||||
rule: "require-image-tag-or-digest"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "require-imagepullpolicy"
|
||||
rule: "require-imagePullPolicy"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "require-health-and-liveness-check"
|
||||
rule: "require-health-and-liveness-check"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "template-storage"
|
||||
rule: "template-storageClassName-pod"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "PersistentVolumeClaim"
|
||||
- name: "template-storage"
|
||||
rule: "template-storageClassName-pvc"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- name: "template-storage"
|
||||
rule: "template-requests-storage-pod"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "PersistentVolumeClaim"
|
||||
- name: "template-storage"
|
||||
rule: "template-requests-storage-pvc"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- name: "require-requests-limits"
|
||||
rule: "validate-resources"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "template-image-registries"
|
||||
rule: "template-image-registries"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "require-containersecuritycontext"
|
||||
rule: "require-ro-rootfs"
|
||||
type: "optional"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "require-containersecuritycontext"
|
||||
rule: "require-no-privilege-escalation"
|
||||
type: "optional"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "require-containersecuritycontext"
|
||||
rule: "require-all-capabilities-dropped"
|
||||
type: "optional"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "require-containersecuritycontext"
|
||||
rule: "require-no-privileged"
|
||||
type: "optional"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "require-containersecuritycontext"
|
||||
rule: "require-run-as-user"
|
||||
type: "optional"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "require-containersecuritycontext"
|
||||
rule: "require-run-as-group"
|
||||
type: "optional"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "require-containersecuritycontext"
|
||||
rule: "require-seccomp-profile"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "require-containersecuritycontext"
|
||||
rule: "require-run-as-non-root"
|
||||
type: "optional"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "require-containersecuritycontext"
|
||||
rule: "require-empty-seLinuxOptions"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "require-containersecuritycontext"
|
||||
rule: "require-default-procMount"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "require-containersecuritycontext"
|
||||
rule: "restrict-sysctls"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "disallow-container-sock-mounts"
|
||||
rule: "validate-docker-sock-mount"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "disallow-container-sock-mounts"
|
||||
rule: "validate-containerd-sock-mount"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "disallow-container-sock-mounts"
|
||||
rule: "validate-crio-sock-mount"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "disallow-container-sock-mounts"
|
||||
rule: "validate-dockerd-sock-mount"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "disallow-host-namespaces"
|
||||
rule: "disallow-host-namespaces"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "disallow-host-path"
|
||||
rule: "disallow-host-path"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "disallow-host-ports"
|
||||
rule: "disallow-host-ports"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "disallow-host-process"
|
||||
rule: "disallow-host-process"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
- "Job"
|
||||
- "Pod"
|
||||
- "DaemonSet"
|
||||
- name: "template-ingress"
|
||||
rule: "template-ingressClassName"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "Ingress"
|
||||
- name: "template-ingress"
|
||||
rule: "template-tls-secretName"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "Ingress"
|
||||
- name: "template-replicas"
|
||||
rule: "template-replicas"
|
||||
type: "required"
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
- "Deployment"
|
||||
...
|
||||
80
.kyverno/policies/disallow-container-sock-mounts.yaml
Normal file
80
.kyverno/policies/disallow-container-sock-mounts.yaml
Normal file
@@ -0,0 +1,80 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
apiVersion: "kyverno.io/v1"
|
||||
kind: "ClusterPolicy"
|
||||
metadata:
|
||||
name: "disallow-container-sock-mounts"
|
||||
annotations:
|
||||
policies.kyverno.io/title: "Disallow CRI socket mounts"
|
||||
policies.kyverno.io/subject: "Pod"
|
||||
policies.kyverno.io/description: >-
|
||||
Container daemon socket bind mounts allow access to the container engine on the node.
|
||||
This access can be used for privilege escalation and to manage containers outside of Kubernetes, and hence should
|
||||
not be allowed.
|
||||
This policy validates that the sockets used for CRI engines Docker, Containerd, and CRI-O are not used.
|
||||
In addition to or replacement of this policy, preventing users from mounting the parent directories
|
||||
(/var/run and /var) may be necessary to completely prevent socket bind mounts.
|
||||
spec:
|
||||
background: true
|
||||
rules:
|
||||
- name: "validate-docker-sock-mount"
|
||||
match:
|
||||
any:
|
||||
- resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
validate:
|
||||
message: "Use of the Docker Unix socket is not allowed."
|
||||
anyPattern:
|
||||
- spec:
|
||||
=(volumes):
|
||||
- =(hostPath):
|
||||
path: "!/var/run/docker.sock"
|
||||
- spec:
|
||||
=(volumes):
|
||||
- name: "validate-containerd-sock-mount"
|
||||
match:
|
||||
any:
|
||||
- resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
validate:
|
||||
message: "Use of the Containerd Unix socket is not allowed."
|
||||
anyPattern:
|
||||
- spec:
|
||||
=(volumes):
|
||||
- =(hostPath):
|
||||
path: "!/var/run/containerd/containerd.sock"
|
||||
- spec:
|
||||
=(volumes):
|
||||
- name: "validate-crio-sock-mount"
|
||||
match:
|
||||
any:
|
||||
- resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
validate:
|
||||
message: "Use of the CRI-O Unix socket is not allowed."
|
||||
anyPattern:
|
||||
- spec:
|
||||
=(volumes):
|
||||
- =(hostPath):
|
||||
path: "!/var/run/crio/crio.sock"
|
||||
- spec:
|
||||
=(volumes):
|
||||
- name: "validate-dockerd-sock-mount"
|
||||
match:
|
||||
any:
|
||||
- resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
validate:
|
||||
message: "Use of the Docker CRI socket is not allowed."
|
||||
anyPattern:
|
||||
- spec:
|
||||
=(volumes):
|
||||
- =(hostPath):
|
||||
path: "!/var/run/cri-dockerd.sock"
|
||||
- spec:
|
||||
=(volumes):
|
||||
36
.kyverno/policies/disallow-default-serviceaccount.yaml
Normal file
36
.kyverno/policies/disallow-default-serviceaccount.yaml
Normal file
@@ -0,0 +1,36 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
apiVersion: "kyverno.io/v1"
|
||||
kind: "ClusterPolicy"
|
||||
metadata:
|
||||
name: "disallow-default-serviceaccount"
|
||||
annotations:
|
||||
policies.kyverno.io/title: "Prevent default ServiceAccount privilege escalation"
|
||||
policies.kyverno.io/subject: "Pod"
|
||||
policies.kyverno.io/description: >-
|
||||
Kubernetes automatically creates a ServiceAccount object named default for every namespace in your cluster.
|
||||
These default service accounts get no permissions by default.
|
||||
Accidental or intended assignment of permissions on the default service account results in elevated permissions
|
||||
for all pods with default service account assigned.
|
||||
This risk can be mitigated by creating a custom ServiceAccount for each application or reduce the risk by disable
|
||||
auto mounting the default service account into the pod.
|
||||
spec:
|
||||
background: true
|
||||
rules:
|
||||
- match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
name: "disallow-default-serviceAccountName"
|
||||
validate:
|
||||
message: >-
|
||||
Field serviceAccountName must be set to anything other than 'default'.
|
||||
When serviceAccountName is 'default' then automountServiceAccountToken must set to 'false' .
|
||||
anyPattern:
|
||||
- spec:
|
||||
serviceAccountName: "!default"
|
||||
- spec:
|
||||
automountServiceAccountToken: "false"
|
||||
validationFailureAction: "audit"
|
||||
...
|
||||
33
.kyverno/policies/disallow-host-namespaces.yaml
Normal file
33
.kyverno/policies/disallow-host-namespaces.yaml
Normal file
@@ -0,0 +1,33 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
apiVersion: "kyverno.io/v1"
|
||||
kind: "ClusterPolicy"
|
||||
metadata:
|
||||
name: "disallow-host-namespaces"
|
||||
annotations:
|
||||
policies.kyverno.io/title: "Disallow Host Namespaces"
|
||||
policies.kyverno.io/subject: "Pod"
|
||||
policies.kyverno.io/description: >-
|
||||
Host namespaces (Process ID namespace, Inter-Process Communication namespace, and network namespace) allow access
|
||||
to shared information and can be used to elevate privileges.
|
||||
Pods should not be allowed access to host namespaces.
|
||||
This policy ensures fields which make use of these host namespaces are unset or set to `false`.
|
||||
spec:
|
||||
background: true
|
||||
rules:
|
||||
- name: "disallow-host-namespaces"
|
||||
match:
|
||||
any:
|
||||
- resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
validate:
|
||||
message: >-
|
||||
Sharing the host namespaces is disallowed. The fields spec.hostNetwork,
|
||||
spec.hostIPC, and spec.hostPID must be unset or set to `false`.
|
||||
pattern:
|
||||
spec:
|
||||
=(hostPID): "false"
|
||||
=(hostIPC): "false"
|
||||
=(hostNetwork): "false"
|
||||
32
.kyverno/policies/disallow-host-path.yaml
Normal file
32
.kyverno/policies/disallow-host-path.yaml
Normal file
@@ -0,0 +1,32 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
apiVersion: "kyverno.io/v1"
|
||||
kind: "ClusterPolicy"
|
||||
metadata:
|
||||
name: "disallow-host-path"
|
||||
annotations:
|
||||
policies.kyverno.io/title: "Disallow hostPath"
|
||||
policies.kyverno.io/subject: "Pod,Volume"
|
||||
policies.kyverno.io/description: >-
|
||||
HostPath volumes let Pods use host directories and volumes in containers.
|
||||
Using host resources can be used to access shared data or escalate privileges and should not be allowed.
|
||||
This policy ensures no hostPath volumes are in use.
|
||||
spec:
|
||||
background: true
|
||||
rules:
|
||||
- name: "disallow-host-path"
|
||||
match:
|
||||
any:
|
||||
- resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
validate:
|
||||
message: >-
|
||||
HostPath volumes are forbidden. The field spec.volumes[*].hostPath must be unset.
|
||||
anyPattern:
|
||||
- spec:
|
||||
=(volumes):
|
||||
- X(hostPath): "null"
|
||||
- spec:
|
||||
=(volumes):
|
||||
38
.kyverno/policies/disallow-host-ports.yaml
Normal file
38
.kyverno/policies/disallow-host-ports.yaml
Normal file
@@ -0,0 +1,38 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
apiVersion: "kyverno.io/v1"
|
||||
kind: "ClusterPolicy"
|
||||
metadata:
|
||||
name: "disallow-host-ports"
|
||||
annotations:
|
||||
policies.kyverno.io/title: "Disallow hostPorts"
|
||||
policies.kyverno.io/subject: "Pod"
|
||||
policies.kyverno.io/description: >-
|
||||
Access to host ports allows potential snooping of network traffic and should not be allowed, or at minimum
|
||||
restricted to a known list. This policy ensures the `hostPort` field is unset or set to `0`.
|
||||
spec:
|
||||
background: true
|
||||
rules:
|
||||
- name: "disallow-host-ports"
|
||||
match:
|
||||
any:
|
||||
- resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
validate:
|
||||
message: >-
|
||||
Use of host ports is disallowed. The fields spec.containers[*].ports[*].hostPort
|
||||
, spec.initContainers[*].ports[*].hostPort, and spec.ephemeralContainers[*].ports[*].hostPort
|
||||
must either be unset or set to `0`.
|
||||
pattern:
|
||||
spec:
|
||||
=(ephemeralContainers):
|
||||
- =(ports):
|
||||
- =(hostPort): 0
|
||||
=(initContainers):
|
||||
- =(ports):
|
||||
- =(hostPort): 0
|
||||
containers:
|
||||
- =(ports):
|
||||
- =(hostPort): 0
|
||||
45
.kyverno/policies/disallow-host-process.yaml
Normal file
45
.kyverno/policies/disallow-host-process.yaml
Normal file
@@ -0,0 +1,45 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
apiVersion: "kyverno.io/v1"
|
||||
kind: "ClusterPolicy"
|
||||
metadata:
|
||||
name: "disallow-host-process"
|
||||
annotations:
|
||||
policies.kyverno.io/title: "Disallow hostProcess"
|
||||
policies.kyverno.io/subject: "Pod"
|
||||
policies.kyverno.io/description: >-
|
||||
Windows pods offer the ability to run HostProcess containers which enables privileged access to the Windows node.
|
||||
Privileged access to the host is disallowed in the baseline policy.
|
||||
HostProcess pods are an alpha feature as of Kubernetes v1.22.
|
||||
This policy ensures the `hostProcess` field, if present, is set to `false`.
|
||||
spec:
|
||||
background: true
|
||||
rules:
|
||||
- name: "disallow-host-process"
|
||||
match:
|
||||
any:
|
||||
- resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
validate:
|
||||
message: >-
|
||||
HostProcess containers are disallowed. The fields spec.securityContext.windowsOptions.hostProcess,
|
||||
spec.containers[*].securityContext.windowsOptions.hostProcess,
|
||||
spec.initContainers[*].securityContext.windowsOptions.hostProcess, and
|
||||
spec.ephemeralContainers[*].securityContext.windowsOptions.hostProcess must either be undefined or set to
|
||||
`false`.
|
||||
pattern:
|
||||
spec:
|
||||
=(ephemeralContainers):
|
||||
- =(securityContext):
|
||||
=(windowsOptions):
|
||||
=(hostProcess): "false"
|
||||
=(initContainers):
|
||||
- =(securityContext):
|
||||
=(windowsOptions):
|
||||
=(hostProcess): "false"
|
||||
containers:
|
||||
- =(securityContext):
|
||||
=(windowsOptions):
|
||||
=(hostProcess): "false"
|
||||
57
.kyverno/policies/disallow-latest-tag.yaml
Normal file
57
.kyverno/policies/disallow-latest-tag.yaml
Normal file
@@ -0,0 +1,57 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
apiVersion: "kyverno.io/v1"
|
||||
kind: "ClusterPolicy"
|
||||
metadata:
|
||||
name: "disallow-latest-tag"
|
||||
annotations:
|
||||
policies.kyverno.io/title: "Disallow usage of latest tag"
|
||||
policies.kyverno.io/subject: "Pod"
|
||||
policies.kyverno.io/description: >-
|
||||
The ':latest' tag is mutable and can lead to unexpected errors if the image changes.
|
||||
A best practice is to use an immutable tag that maps to a specific version of an application Pod.
|
||||
This policy validates that the image specifies a tag and that it is not called `latest`.
|
||||
Defining no image tag or digest result in the container engine retrieving the latest tag.
|
||||
spec:
|
||||
background: true
|
||||
rules:
|
||||
- match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
name: "disallow-latest-tag"
|
||||
validate:
|
||||
message: "Using a mutable image tag e.g. 'latest' is not allowed."
|
||||
pattern:
|
||||
spec:
|
||||
=(ephemeralContainers):
|
||||
- image: "!*:latest"
|
||||
=(initContainers):
|
||||
- image: "!*:latest"
|
||||
containers:
|
||||
- image: "!*:latest"
|
||||
- match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
name: "require-image-tag-or-digest"
|
||||
validate:
|
||||
message: "A image tag or a digest is required, otherwise latest tag is chosen."
|
||||
anyPattern:
|
||||
- spec:
|
||||
=(ephemeralContainers):
|
||||
- image: "*:*"
|
||||
=(initContainers):
|
||||
- image: "*:*"
|
||||
containers:
|
||||
- image: "*:*"
|
||||
- spec:
|
||||
=(ephemeralContainers):
|
||||
- image: "*@*"
|
||||
=(initContainers):
|
||||
- image: "*@*"
|
||||
containers:
|
||||
- image: "*@*"
|
||||
validationFailureAction: "audit"
|
||||
...
|
||||
244
.kyverno/policies/require-containersecuritycontext.yaml
Normal file
244
.kyverno/policies/require-containersecuritycontext.yaml
Normal file
@@ -0,0 +1,244 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
apiVersion: "kyverno.io/v1"
|
||||
kind: "ClusterPolicy"
|
||||
metadata:
|
||||
name: "require-containersecuritycontext"
|
||||
annotations:
|
||||
policies.kyverno.io/title: "ContainerSecurityContext best practices are set."
|
||||
policies.kyverno.io/subject: "Pod"
|
||||
policies.kyverno.io/description: >-
|
||||
The containerSecurityContext is the most important security-related section because it has the highest precedence
|
||||
and restricts the container to its minimal privileges.
|
||||
spec:
|
||||
background: true
|
||||
rules:
|
||||
- name: "require-ro-rootfs"
|
||||
match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
validate:
|
||||
message: "Root filesystem must be read-only."
|
||||
pattern:
|
||||
spec:
|
||||
=(ephemeralContainers):
|
||||
- securityContext:
|
||||
readOnlyRootFilesystem: true
|
||||
=(initContainers):
|
||||
- securityContext:
|
||||
readOnlyRootFilesystem: true
|
||||
containers:
|
||||
- securityContext:
|
||||
readOnlyRootFilesystem: true
|
||||
|
||||
- name: "require-no-privilege-escalation"
|
||||
match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
validate:
|
||||
message: "Disallow privilege escalation."
|
||||
pattern:
|
||||
spec:
|
||||
=(ephemeralContainers):
|
||||
- securityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
=(initContainers):
|
||||
- securityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
containers:
|
||||
- securityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
|
||||
- name: "require-all-capabilities-dropped"
|
||||
match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
validate:
|
||||
message: "Required to drop ALL linux capabilities."
|
||||
pattern:
|
||||
spec:
|
||||
=(ephemeralContainers):
|
||||
- securityContext:
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
=(initContainers):
|
||||
- securityContext:
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
containers:
|
||||
- securityContext:
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
|
||||
- name: "require-no-privileged"
|
||||
match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
validate:
|
||||
message: "Disallow privileged container."
|
||||
pattern:
|
||||
spec:
|
||||
=(ephemeralContainers):
|
||||
- securityContext:
|
||||
privileged: false
|
||||
=(initContainers):
|
||||
- securityContext:
|
||||
privileged: false
|
||||
containers:
|
||||
- securityContext:
|
||||
privileged: false
|
||||
|
||||
- name: "require-run-as-user"
|
||||
match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
validate:
|
||||
message: "Container must run as non-root user."
|
||||
pattern:
|
||||
spec:
|
||||
=(ephemeralContainers):
|
||||
- securityContext:
|
||||
runAsUser: ">0"
|
||||
=(initContainers):
|
||||
- securityContext:
|
||||
runAsUser: ">0"
|
||||
containers:
|
||||
- securityContext:
|
||||
runAsUser: ">0"
|
||||
|
||||
- name: "require-run-as-group"
|
||||
match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
validate:
|
||||
message: "Container must run as non-root group."
|
||||
pattern:
|
||||
spec:
|
||||
=(ephemeralContainers):
|
||||
- securityContext:
|
||||
runAsGroup: ">0"
|
||||
=(initContainers):
|
||||
- securityContext:
|
||||
runAsGroup: ">0"
|
||||
containers:
|
||||
- securityContext:
|
||||
runAsGroup: ">0"
|
||||
|
||||
- name: "require-seccomp-profile"
|
||||
match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
validate:
|
||||
message: "Container must have seccompProfile"
|
||||
pattern:
|
||||
spec:
|
||||
=(ephemeralContainers):
|
||||
- securityContext:
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault | Localhost"
|
||||
=(initContainers):
|
||||
- securityContext:
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault | Localhost"
|
||||
containers:
|
||||
- securityContext:
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault | Localhost"
|
||||
|
||||
- name: "require-run-as-non-root"
|
||||
match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
validate:
|
||||
message: "Container must run in non-root mode."
|
||||
pattern:
|
||||
spec:
|
||||
=(ephemeralContainers):
|
||||
- securityContext:
|
||||
runAsNonRoot: true
|
||||
=(initContainers):
|
||||
- securityContext:
|
||||
runAsNonRoot: true
|
||||
containers:
|
||||
- securityContext:
|
||||
runAsNonRoot: true
|
||||
|
||||
- name: "require-empty-seLinuxOptions"
|
||||
match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
validate:
|
||||
message: "SELinux options have to be unset."
|
||||
pattern:
|
||||
spec:
|
||||
=(ephemeralContainers):
|
||||
- securityContext:
|
||||
seLinuxOptions:
|
||||
=(initContainers):
|
||||
- securityContext:
|
||||
seLinuxOptions:
|
||||
containers:
|
||||
- securityContext:
|
||||
seLinuxOptions:
|
||||
|
||||
- name: "require-default-procMount"
|
||||
match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
validate:
|
||||
message: >-
|
||||
Changing the proc mount from the default is not allowed. The fields
|
||||
spec.containers[*].securityContext.procMount, spec.initContainers[*].securityContext.procMount,
|
||||
and spec.ephemeralContainers[*].securityContext.procMount must be unset or
|
||||
set to `Default`.
|
||||
pattern:
|
||||
spec:
|
||||
=(ephemeralContainers):
|
||||
- =(securityContext):
|
||||
=(procMount): "Default"
|
||||
=(initContainers):
|
||||
- =(securityContext):
|
||||
=(procMount): "Default"
|
||||
containers:
|
||||
- =(securityContext):
|
||||
=(procMount): "Default"
|
||||
|
||||
- name: "restrict-sysctls"
|
||||
match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
validate:
|
||||
message: >-
|
||||
Setting additional sysctls above the allowed type is not allowed.
|
||||
The field spec.securityContext.sysctls must be unset or not use any other names
|
||||
than kernel.shm_rmid_forced, net.ipv4.ip_local_port_range,
|
||||
net.ipv4.ip_unprivileged_port_start, net.ipv4.tcp_syncookies and
|
||||
net.ipv4.ping_group_range.
|
||||
pattern:
|
||||
spec:
|
||||
=(securityContext):
|
||||
=(sysctls):
|
||||
- =(name): >-
|
||||
kernel.shm_rmid_forced |
|
||||
net.ipv4.ip_local_port_range |
|
||||
net.ipv4.ip_unprivileged_port_start |
|
||||
net.ipv4.tcp_syncookies |
|
||||
net.ipv4.ping_group_range
|
||||
|
||||
validationFailureAction: "audit"
|
||||
...
|
||||
38
.kyverno/policies/require-health-and-liveness-check.yaml
Normal file
38
.kyverno/policies/require-health-and-liveness-check.yaml
Normal file
@@ -0,0 +1,38 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
apiVersion: "kyverno.io/v1"
|
||||
kind: "ClusterPolicy"
|
||||
metadata:
|
||||
name: "require-health-and-liveness-check"
|
||||
annotations:
|
||||
policies.kyverno.io/title: "Disallow usage of latest tag"
|
||||
policies.kyverno.io/subject: "Pod"
|
||||
policies.kyverno.io/description: >-
|
||||
Liveness and readiness probes need to be configured to correctly manage a Pod's lifecycle during deployments,
|
||||
restarts, and upgrades.
|
||||
For each Pod, a periodic `livenessProbe` is performed by the kubelet to determine if the Pod's containers are
|
||||
running or need to be restarted.
|
||||
A `readinessProbe` is used by Services and Pods to determine if the Pod is ready to receive network traffic.
|
||||
This policy validates that all containers have livenessProbe and readinessProbe defined.
|
||||
spec:
|
||||
background: true
|
||||
rules:
|
||||
- match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
name: "require-health-and-liveness-check"
|
||||
validate:
|
||||
message: >-
|
||||
Liveness and readiness probes are required. spec.containers[*].livenessProbe.periodSeconds must be set to a
|
||||
value greater than 0.
|
||||
pattern:
|
||||
spec:
|
||||
containers:
|
||||
- livenessProbe:
|
||||
periodSeconds: ">0"
|
||||
readinessProbe:
|
||||
periodSeconds: ">0"
|
||||
validationFailureAction: "audit"
|
||||
...
|
||||
51
.kyverno/policies/require-imagepullpolicy.yaml
Normal file
51
.kyverno/policies/require-imagepullpolicy.yaml
Normal file
@@ -0,0 +1,51 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
apiVersion: "kyverno.io/v1"
|
||||
kind: "ClusterPolicy"
|
||||
metadata:
|
||||
name: "require-imagepullpolicy"
|
||||
annotations:
|
||||
policies.kyverno.io/title: "Disallow usage of latest tag"
|
||||
policies.kyverno.io/subject: "Pod"
|
||||
policies.kyverno.io/description: >-
|
||||
If the `latest` tag is allowed for images, it is a good idea to have the imagePullPolicy field set to `Always` to
|
||||
ensure later pulls get an updated image in case the latest tag gets updated.
|
||||
This policy validates the imagePullPolicy is set to `Always` when the `latest` tag is specified explicitly or
|
||||
where a tag is not defined at all.
|
||||
Additionally this policy checks if the variable `.Values.global.imagePullPolicy` is used in templates.
|
||||
spec:
|
||||
background: true
|
||||
rules:
|
||||
- match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
name: "require-imagePullPolicy"
|
||||
validate:
|
||||
message: >-
|
||||
The imagePullPolicy must be set to `Always` when the `latest` tag is used, otherwise the value from
|
||||
`.Values.global.imagePullPolicy` has to be used.
|
||||
anyPattern:
|
||||
- spec:
|
||||
=(ephemeralContainers):
|
||||
- (image): "*:latest | !*:*"
|
||||
imagePullPolicy: "Always"
|
||||
=(initContainers):
|
||||
- (image): "*:latest | !*:*"
|
||||
imagePullPolicy: "Always"
|
||||
containers:
|
||||
- (image): "*:latest | !*:*"
|
||||
imagePullPolicy: "Always"
|
||||
- spec:
|
||||
=(ephemeralContainers):
|
||||
- (image): "!*:latest"
|
||||
imagePullPolicy: "kyverno"
|
||||
=(initContainers):
|
||||
- (image): "!*:latest"
|
||||
imagePullPolicy: "kyverno"
|
||||
containers:
|
||||
- (image): "!*:latest"
|
||||
imagePullPolicy: "kyverno"
|
||||
validationFailureAction: "audit"
|
||||
...
|
||||
38
.kyverno/policies/require-requests-limits.yaml
Normal file
38
.kyverno/policies/require-requests-limits.yaml
Normal file
@@ -0,0 +1,38 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
apiVersion: "kyverno.io/v1"
|
||||
kind: "ClusterPolicy"
|
||||
metadata:
|
||||
name: "require-requests-limits"
|
||||
annotations:
|
||||
policies.kyverno.io/title: "Require resources cpu/memory request and limits."
|
||||
policies.kyverno.io/subject: "Pod"
|
||||
policies.kyverno.io/description: >-
|
||||
As application workloads share cluster resources, it is important to limit resources requested and consumed by
|
||||
each Pod.
|
||||
It is recommended to require resource requests and limits per Pod, especially for memory and CPU.
|
||||
If a Namespace level request or limit is specified, defaults will automatically be applied to each Pod based on
|
||||
the LimitRange configuration.
|
||||
This policy validates that all containers have specified requests for memory and CPU and a limit for memory.
|
||||
spec:
|
||||
background: true
|
||||
rules:
|
||||
- match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
name: "validate-resources"
|
||||
validate:
|
||||
message: "CPU and memory resource requests and limits are required."
|
||||
pattern:
|
||||
spec:
|
||||
containers:
|
||||
- resources:
|
||||
limits:
|
||||
memory: "?*"
|
||||
requests:
|
||||
cpu: "?*"
|
||||
memory: "?*"
|
||||
validationFailureAction: "audit"
|
||||
...
|
||||
35
.kyverno/policies/require-tag-and-digest.yaml
Normal file
35
.kyverno/policies/require-tag-and-digest.yaml
Normal file
@@ -0,0 +1,35 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
apiVersion: "kyverno.io/v1"
|
||||
kind: "ClusterPolicy"
|
||||
metadata:
|
||||
name: "require-tag-and-digest"
|
||||
annotations:
|
||||
policies.kyverno.io/title: "Require tag and digest for image."
|
||||
policies.kyverno.io/subject: "Pod"
|
||||
policies.kyverno.io/description: >-
|
||||
To ensure that containers are not compromised in container registry by pushing malicious code to the same tag, it
|
||||
is required to reference images by setting a sha256 hashed digest.
|
||||
Setting only the digest is complicated for humans to compare software versions, therefore in openDesk it is
|
||||
required to reference container images by tag and digest.
|
||||
spec:
|
||||
background: true
|
||||
rules:
|
||||
- match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
name: "require-tag-and-digest"
|
||||
validate:
|
||||
message: "An image tag and digest required."
|
||||
pattern:
|
||||
spec:
|
||||
=(ephemeralContainers):
|
||||
- image: "*:*@sha256:*"
|
||||
=(initContainers):
|
||||
- image: "*:*@sha256:*"
|
||||
containers:
|
||||
- image: "*:*@sha256:*"
|
||||
validationFailureAction: "audit"
|
||||
...
|
||||
33
.kyverno/policies/template-image-registries.yaml
Normal file
33
.kyverno/policies/template-image-registries.yaml
Normal file
@@ -0,0 +1,33 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
apiVersion: "kyverno.io/v1"
|
||||
kind: "ClusterPolicy"
|
||||
metadata:
|
||||
name: "template-image-registries"
|
||||
annotations:
|
||||
policies.kyverno.io/title: "Check image registry template"
|
||||
policies.kyverno.io/subject: "Pod"
|
||||
policies.kyverno.io/description: >-
|
||||
This policy verifies that a custom external registry can be template to allow downloads from a private registry or
|
||||
cache.
|
||||
spec:
|
||||
background: true
|
||||
rules:
|
||||
- match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
name: "template-image-registries"
|
||||
validate:
|
||||
message: "Unknown image registry."
|
||||
pattern:
|
||||
spec:
|
||||
=(ephemeralContainers):
|
||||
- image: "my_private_registry.domain.tld/*"
|
||||
=(initContainers):
|
||||
- image: "my_private_registry.domain.tld/*"
|
||||
containers:
|
||||
- image: "my_private_registry.domain.tld/*"
|
||||
validationFailureAction: "audit"
|
||||
...
|
||||
38
.kyverno/policies/template-ingress.yaml
Normal file
38
.kyverno/policies/template-ingress.yaml
Normal file
@@ -0,0 +1,38 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
apiVersion: "kyverno.io/v1"
|
||||
kind: "ClusterPolicy"
|
||||
metadata:
|
||||
name: "template-ingress"
|
||||
annotations:
|
||||
policies.kyverno.io/title: "Validate openDesk Ingress templating"
|
||||
policies.kyverno.io/subject: "Pod"
|
||||
policies.kyverno.io/description: >-
|
||||
This policy verifies that ingress variables are templated.
|
||||
spec:
|
||||
background: true
|
||||
rules:
|
||||
- match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Ingress"
|
||||
name: "template-ingressClassName"
|
||||
validate:
|
||||
message: "Verifies that ingressClassName can be customized by `.Values.ingress.ingressClassName` variable."
|
||||
pattern:
|
||||
spec:
|
||||
ingressClassName: "kyverno"
|
||||
- match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Ingress"
|
||||
name: "template-tls-secretName"
|
||||
validate:
|
||||
message: "Verifies that tls.secretName can be customized by `.Values.ingress.tls.secretName` variable."
|
||||
pattern:
|
||||
spec:
|
||||
tls:
|
||||
- secretName: "kyverno-tls"
|
||||
validationFailureAction: "audit"
|
||||
...
|
||||
29
.kyverno/policies/template-replicas.yaml
Normal file
29
.kyverno/policies/template-replicas.yaml
Normal file
@@ -0,0 +1,29 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
apiVersion: "kyverno.io/v1"
|
||||
kind: "ClusterPolicy"
|
||||
metadata:
|
||||
name: "template-replicas"
|
||||
annotations:
|
||||
policies.kyverno.io/title: "Validate openDesk Pod replicas templating"
|
||||
policies.kyverno.io/subject: "Pod"
|
||||
policies.kyverno.io/description: >-
|
||||
This policy verifies that `.Values.replicas.<app>` variables are templated.
|
||||
spec:
|
||||
background: true
|
||||
rules:
|
||||
- match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Deployment"
|
||||
- "StatefulSet"
|
||||
name: "template-replicas"
|
||||
validate:
|
||||
message: "Verifies that replica count can be customized by `.Values.replicas.<app>` variable."
|
||||
pattern:
|
||||
spec:
|
||||
replicas: 42
|
||||
|
||||
validationFailureAction: "audit"
|
||||
...
|
||||
31
.kyverno/policies/template-require-imagepullsecets.yaml
Normal file
31
.kyverno/policies/template-require-imagepullsecets.yaml
Normal file
@@ -0,0 +1,31 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
apiVersion: "kyverno.io/v1"
|
||||
kind: "ClusterPolicy"
|
||||
metadata:
|
||||
name: "template-imagepullsecrets"
|
||||
annotations:
|
||||
policies.kyverno.io/title: "ImagePullSecrets template variable have to be implemented."
|
||||
policies.kyverno.io/subject: "Pod"
|
||||
policies.kyverno.io/description: >-
|
||||
It is recommended to cache images to ensure continuous image availability during network partitions, rate limiting
|
||||
or registry outages.
|
||||
These caches as well as a company proxy may require authentication which will be provided as ImagePullSecrets.
|
||||
This is a openDesk test to ensure that environment variables are templated in Helmfile deployment.
|
||||
spec:
|
||||
background: true
|
||||
rules:
|
||||
- match:
|
||||
resources:
|
||||
kinds:
|
||||
- "Pod"
|
||||
name: "template-imagePullSecrets"
|
||||
validate:
|
||||
message: "ImagePullSecrets are required."
|
||||
pattern:
|
||||
spec:
|
||||
imagePullSecrets:
|
||||
- name: "kyverno-test"
|
||||
validationFailureAction: "audit"
|
||||
...
|
||||
67
.kyverno/policies/template-storage.yaml
Normal file
67
.kyverno/policies/template-storage.yaml
Normal file
@@ -0,0 +1,67 @@
|
||||
# SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
apiVersion: "kyverno.io/v1"
|
||||
kind: "ClusterPolicy"
|
||||
metadata:
|
||||
name: "template-storage"
|
||||
annotations:
|
||||
policies.kyverno.io/title: "Validate storageClass and size templates."
|
||||
policies.kyverno.io/subject: "Pod"
|
||||
policies.kyverno.io/description: >-
|
||||
This policy validates if `.Values.persistence.storageClassNames` variables are used in templates and if the size
|
||||
of volumes can be customized by `.Values.persistence.size` variable.
|
||||
spec:
|
||||
background: true
|
||||
rules:
|
||||
- match:
|
||||
resources:
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
name: "template-storageClassName-pod"
|
||||
validate:
|
||||
message: "VolumeClaims inside pods needs to have storageClass set when templated."
|
||||
pattern:
|
||||
spec:
|
||||
(volumeClaimTemplates):
|
||||
- spec:
|
||||
storageClassName: "kyverno-test"
|
||||
- match:
|
||||
resources:
|
||||
kinds:
|
||||
- "PersistentVolumeClaim"
|
||||
name: "template-storageClassName-pvc"
|
||||
validate:
|
||||
message: "PersistentVolumeClaim needs to have storageClassName set when templated."
|
||||
pattern:
|
||||
spec:
|
||||
storageClassName: "kyverno-test"
|
||||
|
||||
- match:
|
||||
resources:
|
||||
kinds:
|
||||
- "StatefulSet"
|
||||
name: "template-requests-storage-pod"
|
||||
validate:
|
||||
message: "VolumeClaims inside pods needs to have storageClass set when templated."
|
||||
pattern:
|
||||
spec:
|
||||
(volumeClaimTemplates):
|
||||
- spec:
|
||||
resources:
|
||||
requests:
|
||||
storage: "42Gi"
|
||||
- match:
|
||||
resources:
|
||||
kinds:
|
||||
- "PersistentVolumeClaim"
|
||||
name: "template-requests-storage-pvc"
|
||||
validate:
|
||||
message: "PersistentVolumeClaim needs to have storageClassName set when templated."
|
||||
pattern:
|
||||
spec:
|
||||
resources:
|
||||
requests:
|
||||
storage: "42Gi"
|
||||
validationFailureAction: "audit"
|
||||
...
|
||||
92
.renovate/config.yaml
Normal file
92
.renovate/config.yaml
Normal file
@@ -0,0 +1,92 @@
|
||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
# Platform type of repository
|
||||
platform: "gitlab"
|
||||
|
||||
# Enable onboarding merge request
|
||||
onboarding: false
|
||||
|
||||
# If set to true: keep repository data between runs instead of deleting the data
|
||||
persistRepoData: false
|
||||
|
||||
# Controls Renovate's behavior regarding repository config files such as renovate.json
|
||||
requireConfig: "ignored"
|
||||
|
||||
# List of Repositories
|
||||
# See: https://docs.renovatebot.com/configuration-options/
|
||||
repositories:
|
||||
- repository: "bmi/opendesk/deployment/opendesk"
|
||||
# Set the branch to read current dependency state from, this is especially useful during
|
||||
# renovate setup when looking into your feature branch or when your default branch is
|
||||
# not the one you want to check on.
|
||||
baseBranches: [ "develop" ]
|
||||
# Set a limit for the maximum number of parallel MRs (default 10)
|
||||
prConcurrentLimit: 50
|
||||
# Prefix to use for all branch names created by renovate bot (default: "renovate/")
|
||||
branchPrefix: "renovate/"
|
||||
# Lowercase merge request and commit titles ("never" = leave titles untouched )
|
||||
commitMessageLowerCase: "never"
|
||||
# Commit scope to use if Semantic Commits are enabled (fix(<scope>)...)
|
||||
semanticCommitScope: "renovate"
|
||||
# Commit type to use if Semantic Commits are enabled (default: "chore")
|
||||
semanticCommitType: "chore"
|
||||
# Enable dependency dashboard
|
||||
dependencyDashboard: true
|
||||
# Include package files only within these defined paths
|
||||
includePaths:
|
||||
- "helmfile/environments/default/images.yaml"
|
||||
- "helmfile/environments/default/charts.yaml"
|
||||
customManagers:
|
||||
- customType: "regex"
|
||||
fileMatch:
|
||||
- "helmfile/environments/default/images.yaml"
|
||||
datasourceTemplate: "docker"
|
||||
matchStrings:
|
||||
# yamllint disable rule:line-length rule:quoted-strings
|
||||
- ' providerResponsible: "(?<depType>.+?)"[\s\S]+? upstreamRegistry: "(?<registryUrl>.+?)"[\s\S]+? upstreamRepository: "(?<depName>.+?)"[\s\S]+? tag: "(?<currentValue>[^@]+)@(?<currentDigest>sha256:[a-f0-9]+)"'
|
||||
# yamllint enable rule:line-length rule:quoted-strings
|
||||
- customType: "regex"
|
||||
fileMatch:
|
||||
- "helmfile/environments/default/charts.yaml"
|
||||
datasourceTemplate: "docker"
|
||||
matchStrings:
|
||||
# yamllint disable rule:line-length rule:quoted-strings
|
||||
- ' providerResponsible: "(?<depType>.+?)"[\s\S]+? upstreamRegistry: "(?<registryUrl>.+?)"[\s\S]+? upstreamRepository: "(?<depName>.+?)"[\s\S]+? version: "(?<currentValue>.+?)"'
|
||||
# yamllint enable rule:line-length rule:quoted-strings
|
||||
# Rules for matching packages
|
||||
packageRules:
|
||||
- matchDatasources: [ "docker" ]
|
||||
matchDepTypes: [ "openDesk" ]
|
||||
groupName: "Platform"
|
||||
- matchDatasources: [ "docker" ]
|
||||
matchDepTypes: [ "Collabora" ]
|
||||
groupName: "Collabora"
|
||||
- matchDatasources: [ "docker" ]
|
||||
matchDepTypes: [ "Element" ]
|
||||
groupName: "Element"
|
||||
- matchDatasources: [ "docker" ]
|
||||
matchDepTypes: [ "Nordeck" ]
|
||||
groupName: "Nordeck"
|
||||
- matchDatasources: [ "docker" ]
|
||||
matchDepTypes: [ "Open-Xchange" ]
|
||||
groupName: "Open-Xchange"
|
||||
- matchDatasources: [ "docker" ]
|
||||
matchDepTypes: [ "OpenProject" ]
|
||||
groupName: "OpenProject"
|
||||
- matchDatasources: [ "docker" ]
|
||||
matchDepTypes: [ "OpenProject" ]
|
||||
groupName: "OpenProject"
|
||||
- matchDatasources: [ "docker" ]
|
||||
matchDepTypes: [ "Univention" ]
|
||||
groupName: "Univention"
|
||||
- matchDatasources: [ "docker" ]
|
||||
matchDepTypes: [ "XWiki" ]
|
||||
groupName: "XWiki"
|
||||
# Add merge request labels
|
||||
labels:
|
||||
- "renovate"
|
||||
# Enable custom regex manager only
|
||||
enabledManagers:
|
||||
- "custom.regex"
|
||||
...
|
||||
18
.reuse/dep5
18
.reuse/dep5
@@ -1,8 +1,16 @@
|
||||
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
|
||||
Upstream-Name: openDesk
|
||||
Upstream-Contact: <git+bmi-souveraener-arbeitsplatz-cla-1339-29pr0g9pj4or9yi6wfly6pbhg-issue@opencode.de>
|
||||
Source: https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/deployment/sovereign-workplace
|
||||
Upstream-Name: openDesk - der Souveräne Arbeitsplatz
|
||||
Upstream-Contact: <opendesk@zendis.de>
|
||||
Source: https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk
|
||||
|
||||
Files: helmfile/environments/default/theme/*
|
||||
Copyright: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
Files: helmfile/files/theme/*
|
||||
Copyright: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
License: Apache-2.0
|
||||
|
||||
Files: helmfile/files/gpg-pubkeys/*
|
||||
Copyright: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
License: CC0-1.0
|
||||
|
||||
Files: cspell.json
|
||||
Copyright: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
License: Apache-2.0
|
||||
|
||||
1130
CHANGELOG.md
1130
CHANGELOG.md
File diff suppressed because it is too large
Load Diff
@@ -1,28 +0,0 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
**Content / Quick navigation**
|
||||
|
||||
[[_TOC_]]
|
||||
|
||||
# Functional Components
|
||||
|
||||
Functional components are the core of the SWP as they provide it's rich functionaly. We use the community versions of the named products. For production environments please use enterprise versions for support and scalabiliy reasons.
|
||||
|
||||
## Groupware - Open-Xchange AppSuite
|
||||
|
||||
## WebOffice - Collabora Development Edition
|
||||
|
||||
## File & Share - Nextcloud
|
||||
|
||||
## Kollaboration - Element
|
||||
|
||||
## Videokonferenzen - Jitsi
|
||||
|
||||
## Knowledge Management - XWiki
|
||||
|
||||
## Project Management - OpenProject
|
||||
|
||||
## Portal & IAM - Univention Corporate Services
|
||||
@@ -1,62 +0,0 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
**Content / Quick navigation**
|
||||
|
||||
[[_TOC_]]
|
||||
|
||||
# Service Components
|
||||
|
||||
Service components are required to operate the SWP. The deployment automation contains a full set of service components in order for the deployment to be self contained. But please be aware that the components are not ment to be used in production scenarios. Check out the service components details to understand how to make use of external services in case you want to setup production environments.
|
||||
|
||||
## Database - MariaDB
|
||||
|
||||
This services is used by:
|
||||
- Nextcloud
|
||||
- Open-Xchange
|
||||
- XWiki
|
||||
|
||||
## Database - PostgreSQL
|
||||
|
||||
This services is used by:
|
||||
- Keycloak
|
||||
- OpenProject
|
||||
|
||||
## Redis
|
||||
|
||||
This service is used by:
|
||||
- Intercom-Service
|
||||
- Nextcloud
|
||||
|
||||
## Postfix
|
||||
|
||||
This service is used by:
|
||||
- Keycloak (e.g. new device login notification)
|
||||
- Nextcloud (e.g. share file notifictions)
|
||||
- Open-Xchange (emails)
|
||||
- OpenProject (general notifications)
|
||||
- UCS (e.g. password reset emails)
|
||||
- XWiki (e.g. change notifications)
|
||||
|
||||
## TURN Server
|
||||
|
||||
This services is used by:
|
||||
- Jitsi
|
||||
|
||||
## NFS
|
||||
|
||||
[remove this as it should be addressed by the RWX prerequsite!?]
|
||||
|
||||
This service is used by
|
||||
- Dovecot
|
||||
- Nextcloud
|
||||
|
||||
## ICAP
|
||||
|
||||
This service is used by
|
||||
- Nextcloud
|
||||
- Open-Xchange
|
||||
|
||||
## Objectstore - MinIO
|
||||
@@ -5,72 +5,12 @@ SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
# Read me first
|
||||
|
||||
Please read the [project's overall CONTRIBUTING.md](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/info/-/blob/main/CONTRIBUTING.md) first.
|
||||
Please read the [project's overall CONTRIBUTING.md](https://gitlab.opencode.de/bmi/opendesk/info/-/blob/main/CONTRIBUTING.md) first.
|
||||
|
||||
# How to contribute?
|
||||
|
||||
When providing contributes to this project, please adhere to the standards and conventions described in further down in this document. Doing so please feel free to create merge requests.
|
||||
|
||||
# Standards and conventions
|
||||
|
||||
## Branching
|
||||
|
||||
We use of [Github flow](https://docs.github.com/en/get-started/quickstart/github-flow).
|
||||
|
||||
## Verified commits
|
||||
|
||||
We only allow verify commits:
|
||||
- https://docs.gitlab.com/ee/user/project/repository/ssh_signed_commits/
|
||||
- https://docs.gitlab.com/ee/user/project/repository/gpg_signed_commits/
|
||||
- https://docs.gitlab.com/ee/user/project/repository/x509_signed_commits/
|
||||
|
||||
## Approval
|
||||
|
||||
MRs require one approval from the SouvAP devops team with security clearance.
|
||||
|
||||
## Conventional Commits
|
||||
|
||||
See https://www.conventionalcommits.org/en/v1.0.0/#summary for reference.
|
||||
|
||||
Commits that do not adhere to the standard might be rejected.
|
||||
|
||||
```text
|
||||
<type>(<scope>): [path/to/issue#1] <short summary>
|
||||
│ │ │ │
|
||||
│ │ | └─> Summary in present tense, sentence case, with no period at the end
|
||||
│ │ |
|
||||
│ │ └─> Issue reference (optional)
|
||||
│ │
|
||||
│ └─> Commit Scope: helmfile, docs, collabora, intercom-service, ...
|
||||
│
|
||||
└─> Commit Type: chore, ci, docs, feat, fix
|
||||
```
|
||||
Valid commit scopes:
|
||||
- `helmfile`
|
||||
- `ci`
|
||||
- `docs`
|
||||
- `collabora`
|
||||
- `ìntercom-service`
|
||||
- `jitsi`
|
||||
- `keycloak`
|
||||
- `keycloak-bootstrap`
|
||||
- `nextcloud`
|
||||
- `open-xchange`
|
||||
- `openproject`
|
||||
- `provisioning`
|
||||
- `services`
|
||||
- `univention-corporate-container`
|
||||
- `xwiki`
|
||||
|
||||
## Semantic Release
|
||||
|
||||
See https://github.com/semantic-release/semantic-release for reference.
|
||||
|
||||
## Linting
|
||||
|
||||
Following linters must pass:
|
||||
- [yaml-lint](https://github.com/adrienverge/yamllint)
|
||||
- [helm-lint](https://helm.sh/docs/helm/helm_lint/)
|
||||
Please also read the [project's workflow documentation](./docs/workflow.md) for more details on standards like commit
|
||||
messages and branching.
|
||||
|
||||
## Helm vs. Operators vs. Manifests
|
||||
|
||||
@@ -80,10 +20,18 @@ Due to DVS requirements:
|
||||
- we should avoid stand alone Manifests.
|
||||
- we do not use Operators and CRDs.
|
||||
|
||||
In order to align the Helm files from various sources into an unified deployment of the SWP we make use of to [Helmfile](https://github.com/helmfile/helmfile).
|
||||
In order to align the Helm files from various sources into the unified deployment of openDesk we make use of
|
||||
[Helmfile](https://github.com/helmfile/helmfile).
|
||||
|
||||
## Tooling
|
||||
|
||||
We should not introduce a new tool without sharing the purpose with the team and let the team decide if the tool should be used.
|
||||
We should not introduce a new tool without sharing the purpose with the team and let the team decide if the tool should
|
||||
be used.
|
||||
|
||||
We should avoid adding unnecessary complexity.
|
||||
|
||||
## In doubt? Ask!
|
||||
|
||||
We are always happy about contributions, but also like to discuss technical approaches to solve a problem to ensure
|
||||
a contribution fits the openDesk platform strategy or clarify that specific topics might be must ahead on our own
|
||||
roadmap. So when in doubt please [open an issue](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/issues/new) and start a discussion.
|
||||
|
||||
121
LICENSES/CC0-1.0.txt
Normal file
121
LICENSES/CC0-1.0.txt
Normal file
@@ -0,0 +1,121 @@
|
||||
Creative Commons Legal Code
|
||||
|
||||
CC0 1.0 Universal
|
||||
|
||||
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
|
||||
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
|
||||
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
|
||||
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
|
||||
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
|
||||
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
|
||||
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
|
||||
HEREUNDER.
|
||||
|
||||
Statement of Purpose
|
||||
|
||||
The laws of most jurisdictions throughout the world automatically confer
|
||||
exclusive Copyright and Related Rights (defined below) upon the creator
|
||||
and subsequent owner(s) (each and all, an "owner") of an original work of
|
||||
authorship and/or a database (each, a "Work").
|
||||
|
||||
Certain owners wish to permanently relinquish those rights to a Work for
|
||||
the purpose of contributing to a commons of creative, cultural and
|
||||
scientific works ("Commons") that the public can reliably and without fear
|
||||
of later claims of infringement build upon, modify, incorporate in other
|
||||
works, reuse and redistribute as freely as possible in any form whatsoever
|
||||
and for any purposes, including without limitation commercial purposes.
|
||||
These owners may contribute to the Commons to promote the ideal of a free
|
||||
culture and the further production of creative, cultural and scientific
|
||||
works, or to gain reputation or greater distribution for their Work in
|
||||
part through the use and efforts of others.
|
||||
|
||||
For these and/or other purposes and motivations, and without any
|
||||
expectation of additional consideration or compensation, the person
|
||||
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
|
||||
is an owner of Copyright and Related Rights in the Work, voluntarily
|
||||
elects to apply CC0 to the Work and publicly distribute the Work under its
|
||||
terms, with knowledge of his or her Copyright and Related Rights in the
|
||||
Work and the meaning and intended legal effect of CC0 on those rights.
|
||||
|
||||
1. Copyright and Related Rights. A Work made available under CC0 may be
|
||||
protected by copyright and related or neighboring rights ("Copyright and
|
||||
Related Rights"). Copyright and Related Rights include, but are not
|
||||
limited to, the following:
|
||||
|
||||
i. the right to reproduce, adapt, distribute, perform, display,
|
||||
communicate, and translate a Work;
|
||||
ii. moral rights retained by the original author(s) and/or performer(s);
|
||||
iii. publicity and privacy rights pertaining to a person's image or
|
||||
likeness depicted in a Work;
|
||||
iv. rights protecting against unfair competition in regards to a Work,
|
||||
subject to the limitations in paragraph 4(a), below;
|
||||
v. rights protecting the extraction, dissemination, use and reuse of data
|
||||
in a Work;
|
||||
vi. database rights (such as those arising under Directive 96/9/EC of the
|
||||
European Parliament and of the Council of 11 March 1996 on the legal
|
||||
protection of databases, and under any national implementation
|
||||
thereof, including any amended or successor version of such
|
||||
directive); and
|
||||
vii. other similar, equivalent or corresponding rights throughout the
|
||||
world based on applicable law or treaty, and any national
|
||||
implementations thereof.
|
||||
|
||||
2. Waiver. To the greatest extent permitted by, but not in contravention
|
||||
of, applicable law, Affirmer hereby overtly, fully, permanently,
|
||||
irrevocably and unconditionally waives, abandons, and surrenders all of
|
||||
Affirmer's Copyright and Related Rights and associated claims and causes
|
||||
of action, whether now known or unknown (including existing as well as
|
||||
future claims and causes of action), in the Work (i) in all territories
|
||||
worldwide, (ii) for the maximum duration provided by applicable law or
|
||||
treaty (including future time extensions), (iii) in any current or future
|
||||
medium and for any number of copies, and (iv) for any purpose whatsoever,
|
||||
including without limitation commercial, advertising or promotional
|
||||
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
|
||||
member of the public at large and to the detriment of Affirmer's heirs and
|
||||
successors, fully intending that such Waiver shall not be subject to
|
||||
revocation, rescission, cancellation, termination, or any other legal or
|
||||
equitable action to disrupt the quiet enjoyment of the Work by the public
|
||||
as contemplated by Affirmer's express Statement of Purpose.
|
||||
|
||||
3. Public License Fallback. Should any part of the Waiver for any reason
|
||||
be judged legally invalid or ineffective under applicable law, then the
|
||||
Waiver shall be preserved to the maximum extent permitted taking into
|
||||
account Affirmer's express Statement of Purpose. In addition, to the
|
||||
extent the Waiver is so judged Affirmer hereby grants to each affected
|
||||
person a royalty-free, non transferable, non sublicensable, non exclusive,
|
||||
irrevocable and unconditional license to exercise Affirmer's Copyright and
|
||||
Related Rights in the Work (i) in all territories worldwide, (ii) for the
|
||||
maximum duration provided by applicable law or treaty (including future
|
||||
time extensions), (iii) in any current or future medium and for any number
|
||||
of copies, and (iv) for any purpose whatsoever, including without
|
||||
limitation commercial, advertising or promotional purposes (the
|
||||
"License"). The License shall be deemed effective as of the date CC0 was
|
||||
applied by Affirmer to the Work. Should any part of the License for any
|
||||
reason be judged legally invalid or ineffective under applicable law, such
|
||||
partial invalidity or ineffectiveness shall not invalidate the remainder
|
||||
of the License, and in such case Affirmer hereby affirms that he or she
|
||||
will not (i) exercise any of his or her remaining Copyright and Related
|
||||
Rights in the Work or (ii) assert any associated claims and causes of
|
||||
action with respect to the Work, in either case contrary to Affirmer's
|
||||
express Statement of Purpose.
|
||||
|
||||
4. Limitations and Disclaimers.
|
||||
|
||||
a. No trademark or patent rights held by Affirmer are waived, abandoned,
|
||||
surrendered, licensed or otherwise affected by this document.
|
||||
b. Affirmer offers the Work as-is and makes no representations or
|
||||
warranties of any kind concerning the Work, express, implied,
|
||||
statutory or otherwise, including without limitation warranties of
|
||||
title, merchantability, fitness for a particular purpose, non
|
||||
infringement, or the absence of latent or other defects, accuracy, or
|
||||
the present or absence of errors, whether or not discoverable, all to
|
||||
the greatest extent permissible under applicable law.
|
||||
c. Affirmer disclaims responsibility for clearing rights of other persons
|
||||
that may apply to the Work or any use thereof, including without
|
||||
limitation any person's Copyright and Related Rights in the Work.
|
||||
Further, Affirmer disclaims responsibility for obtaining any necessary
|
||||
consents, permissions or other rights required for any use of the
|
||||
Work.
|
||||
d. Affirmer understands and acknowledges that Creative Commons is not a
|
||||
party to this document and has no duty or obligation with respect to
|
||||
this CC0 or use of the Work.
|
||||
522
README.md
522
README.md
@@ -1,443 +1,129 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
**Content / Quick navigation**
|
||||
|
||||
[[_TOC_]]
|
||||
<h1>openDesk Deployment Automation</h1>
|
||||
|
||||
# Disclaimer August 2023
|
||||
<!-- TOC -->
|
||||
* [Overview](#overview)
|
||||
* [Disclaimer](#disclaimer)
|
||||
* [Requirements](#requirements)
|
||||
* [Getting started](#getting-started)
|
||||
* [Advanced customization](#advanced-customization)
|
||||
* [Development](#development)
|
||||
* [Releases](#releases)
|
||||
* [Components](#components)
|
||||
* [Feedback](#feedback)
|
||||
* [License](#license)
|
||||
* [Copyright](#copyright)
|
||||
* [Footnotes](#footnotes)
|
||||
<!-- TOC -->
|
||||
|
||||
The current state of the Sovereign Workplace contains components that are going to be
|
||||
replaced. Like for example the UCS dev container monolith will be substituted by
|
||||
multiple Univention Management Stack containers.
|
||||
# Overview
|
||||
|
||||
In the next months we not only expect upstream updates of the functional
|
||||
components within their feature scope, but we are also going to address
|
||||
operational issues like monitoring and network policies.
|
||||
openDesk is a Kubernetes based, open-source and cloud-native digital workplace suite provided by the
|
||||
*Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH*.
|
||||
|
||||
Of course, further development also includes enhancing the documentation.
|
||||
openDesk currently features the following functional main components:
|
||||
|
||||
The first release of the Sovereign Workplace is scheduled for December 2023.
|
||||
Before that release there will be breaking changes in the deployment.
|
||||
| Function | Functional Component | Component<br/>Version | Upstream Documentation |
|
||||
| -------------------- | --------------------------- | ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Chat & collaboration | Element ft. Nordeck widgets | [1.11.67](https://github.com/element-hq/element-desktop/releases/tag/v1.11.67) | [For the most recent release](https://element.io/user-guide) |
|
||||
| Diagram editor | CryptPad ft. diagrams.net | [5.6.0](https://github.com/cryptpad/cryptpad/releases/tag/5.6.0) | [For the most recent release](https://docs.cryptpad.org/en/) |
|
||||
| File management | Nextcloud | [28.0.5](https://nextcloud.com/de/changelog/#28-0-5) | [Nextcloud 28](https://docs.nextcloud.com/) |
|
||||
| Groupware | OX App Suite | [8.26](https://documentation.open-xchange.com/appsuite/releases/8.26/) | Online documentation available from within the installed application; [Additional resources](https://www.open-xchange.com/resources/oxpedia) |
|
||||
| Knowledge management | XWiki | [16.4.1](https://www.xwiki.org/xwiki/bin/view/ReleaseNotes/Data/XWiki/16.4.1/) | [For the most recent release](https://www.xwiki.org/xwiki/bin/view/Documentation) |
|
||||
| Portal & IAM | Nubus | Product Preview[^1] | [Univention's documentation website](https://docs.software-univention.de/n/en/index.html) |
|
||||
| Project management | OpenProject | [14.4.0](https://www.openproject.org/docs/release-notes/14-4-0/) | [For the most recent release](https://www.openproject.org/docs/user-guide/) |
|
||||
| Videoconferencing | Jitsi | [2.0.9646](https://github.com/jitsi/jitsi-meet/releases/tag/stable%2Fjitsi-meet_9646) | [For the most recent release](https://jitsi.github.io/handbook/docs/category/user-guide/) |
|
||||
| Weboffice | Collabora | [24.04.6.1.1](https://www.collaboraoffice.com/code-24-04-release-notes/) | Online documentation available from within the installed application; [Additional resources](https://sdk.collaboraonline.com/) |
|
||||
|
||||
While not all components are perfectly shaped for the execution inside containers, one of the project's objectives is to
|
||||
align the applications with best practices regarding container design and operations.
|
||||
|
||||
# The Sovereign Workplace (SWP)
|
||||
This documentation aims to give you all that is needed to set up your own instance of the openDesk.
|
||||
|
||||
The Sovereign Workplace's runtime environment is [Kubernetes](https://kubernetes.io/), or "K8s" in
|
||||
short.
|
||||
Basic knowledge of Kubernetes and DevOps processes is required though.
|
||||
|
||||
While not all components are still perfectly shaped for the execution inside
|
||||
containers, one of the projects objectives is it to align the applications
|
||||
with the best practises regarding container design and operations.
|
||||
# Disclaimer
|
||||
|
||||
This documentation aims to give you all that is needed to set up your own
|
||||
instance of the Sovereign Workplace. Basic knowledge of Kubernetes and Devops is
|
||||
required though.
|
||||
openDesk will face breaking changes in the near future without upgrade paths before
|
||||
[technical release](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/releases)
|
||||
v1.0.0 is reached.
|
||||
|
||||
To have an overview of what can be found at Open CoDE and the basic components
|
||||
of the Sovereign Workplace, please check out the
|
||||
[OVERVIEW.md](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/info/-/blob/main/OVERVIEW.md) in the [Info repository](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/info).
|
||||
While most components support upgrades, major configuration or component changes may occur, therefore we recommend
|
||||
from scratch installations for now.
|
||||
|
||||
We love to get feedback from you! Related to the deployment / contents of this
|
||||
repository please use the [issues within this project](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/deployment/sovereign-workplace/-/issues).
|
||||
In the next months, we not only expect to integrate upstream updates of the functional components to include their
|
||||
most recent feature and security sets, but also to address operational topics like scalability for the openDesk
|
||||
platform.
|
||||
|
||||
Of course, further development also includes enhancing the documentation itself.
|
||||
|
||||
# Requirements
|
||||
|
||||
⟶ Visit our detailed [Requirements](./docs/requirements.md) overview.
|
||||
|
||||
# Getting started
|
||||
|
||||
⟶ Visit our detailed [Getting started](./docs/getting-started.md) guide.
|
||||
|
||||
# Advanced customization
|
||||
|
||||
- [Enhanced Configuration](./docs/enhanced-configuration.md)
|
||||
- [External services](./docs/external-services.md)
|
||||
- [Security](./docs/security.md)
|
||||
- [Scaling](./docs/scaling.md)
|
||||
- [Monitoring](./docs/monitoring.md)
|
||||
- [Theming](./docs/theming.md)
|
||||
|
||||
# Development
|
||||
|
||||
⟶ To understand the repository contents from a developer perspective please read the [Development](./docs/development.md) guide.
|
||||
|
||||
# Releases
|
||||
|
||||
All technical releases are created using [Semantic Versioning](https://semver.org/lang/de/).
|
||||
|
||||
Gitlab provides an
|
||||
[overview on the releases](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/releases)
|
||||
of this project.
|
||||
|
||||
Please find a list of the artifacts related to the release either in the source code archive attached to the release or
|
||||
in the files from the release's git-tag:
|
||||
- `./helmfile/environments/default/images.yaml`
|
||||
- `./helmfile/environments/default/charts.yaml`
|
||||
|
||||
⟶ Visit our detailed [Workflow](./docs/workflow.md) docs.
|
||||
|
||||
# Components
|
||||
|
||||
⟶ Visit our detailed [Component](./docs/components.md) docs.
|
||||
|
||||
# Feedback
|
||||
|
||||
We love to get feedback from you!
|
||||
|
||||
Related to the deployment / contents of this repository,
|
||||
please use the [issues within this project](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/issues).
|
||||
|
||||
If you want to address other topics, please check the section
|
||||
["Rückmeldungen und Beteiligung" of the Infos' project OVERVIEW.md](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/info/-/blob/main/OVERVIEW.md#rückmeldungen-und-beteiligung).
|
||||
["Rückmeldungen und Beteiligung" in the OVERVIEW.md](https://gitlab.opencode.de/bmi/opendesk/info/-/blob/main/OVERVIEW.md#rückmeldungen-und-beteiligung) of the [openDesk Info Repository](https://gitlab.opencode.de/bmi/opendesk/info).
|
||||
|
||||
# Deployment
|
||||
# License
|
||||
|
||||
**Note for project members:** You can use the project's `dev` K8s cluster to set
|
||||
up your own instance for development purposes. Please see the project
|
||||
`sovereign-workplace-env` on the internal Gitlab for more details.
|
||||
This project uses the following license: Apache-2.0
|
||||
|
||||
## Prerequisites
|
||||
|
||||
### Mandatory technical prerequisites
|
||||
|
||||
These are the requirements of the Sovereign Workplace deployment:
|
||||
|
||||
- Vanilla K8s cluster
|
||||
- Domain and DNS Service
|
||||
- Ingress controller (supported are nginx-ingress, ingress-nginx, HAProxy)
|
||||
- [Helm](https://helm.sh/), [HelmFile](https://helmfile.readthedocs.io/en/latest/) and
|
||||
[HelmDiff](https://github.com/databus23/helm-diff)
|
||||
- Volume provisioner supporting RWO (read-write-once)
|
||||
- Certificate handling with [cert-manager](https://cert-manager.io/)
|
||||
- [Istio](https://istio.io/) is currently required to deploy and operate OX AppSuite8, we are talking to Open-Xchange and will try to get rid of this dependency.
|
||||
|
||||
#### TLS Certificate
|
||||
|
||||
The setup will create a `cert-manager.io` Certificate resource.
|
||||
|
||||
You can set the ClusterIssuer via `certificate.issuerRef.name`
|
||||
|
||||
### Required input variables
|
||||
|
||||
You need to expose following environment variables in order to run the
|
||||
installation.
|
||||
|
||||
| name | default | description |
|
||||
|---------------------|-----------------------|---------------------------------------------------|
|
||||
| `DOMAIN` | `souvap.cloud` | External reachable domain |
|
||||
| `ISTIO_DOMAIN` | `istio.souvap.cloud` | External reachable domain for Istio Gateway |
|
||||
| `MASTER_PASSWORD` | `sovereign-workplace` | The password that seeds the autogenerated secrets |
|
||||
| `SMTP_PASSWORD` | | Password for SMTP relay gateway |
|
||||
| `TURN_CREDENTIALS` | | Credentials for coturn server |
|
||||
|
||||
Please ensure that you set the DNS records pointing to the loadbalancer/IP for
|
||||
`DOMAIN` and `ISTIO_DOMAIN`.
|
||||
|
||||
If you want inbound email you need to set the MX records that points to the
|
||||
public IP address of the Postfix-pods.
|
||||
|
||||
More details on DNS options including SPF/DKIM and autodiscovery options
|
||||
are to come...
|
||||
|
||||
### Optional or feature based prerequisites
|
||||
|
||||
All of these requirements are optional as long as you do not want to use the
|
||||
related feature.
|
||||
|
||||
| Feature | Component(s) | Requirement |
|
||||
|------------------------------|----------------|-----------------------------|
|
||||
| Component Scalability | Various[^1] | Read-Write-Many Provisioner |
|
||||
| Sending outbound emails | Various | SMTP relay/gateway |
|
||||
| S/MIME Support | OX AppSuite8 | PKI / CI |
|
||||
| Improved videoconferencing | Jitsi | STUN/TURN server |
|
||||
|
||||
## CI based deployment
|
||||
|
||||
The project includes a `.gitlab-ci.yml` that allows you to execute the
|
||||
deployment from a Gitlab instance of your choice.
|
||||
|
||||
Please ensure to provide the environment variables listed at
|
||||
[Required input variables](#required-input-variables).
|
||||
|
||||
When starting the pipeline through the Gitlab UI you will be queried for some
|
||||
of the variables plus the following ones:
|
||||
|
||||
- `BASE_DOMAIN`: The base domain the SWP will use. For example: `souvap.cloud`
|
||||
- `NAMESPACE`: Defines into which namespace of your K8s cluster the SWP will be installed
|
||||
- `MASTER_PASSWORD_WEB_VAR`: Overwrites value of `MASTER_PASSWORD`
|
||||
|
||||
Based on your input the following variables will be set:
|
||||
- `DOMAIN` = `NAMESPACE`.`BASE_DOMAIN`
|
||||
- `ISTIO_DOMAIN` = istio.`DOMAIN`
|
||||
- `MASTER_PASSWORD` = `MASTER_PASSWORD_WEB_VAR`. If `MASTER_PASSWORD_WEB_VAR`
|
||||
is not set, the default for `MASTER_PASSWORD` will be used, unless you set
|
||||
`MASTER_PASSWORD` as a masked CI/CD variable in Gitlab to supercede the default.
|
||||
|
||||
You might want to set credential variables in the Gitlab project at
|
||||
`Settings` > `CI/CD` > `Variables`.
|
||||
|
||||
## Local deployment
|
||||
|
||||
Please ensure to provide the environment variables listed at
|
||||
[Required input variables](#required-input-variables).
|
||||
Also, please read [Helmfile](#helmfile) a little below in case of a non default
|
||||
configuration.
|
||||
|
||||
Then go with
|
||||
|
||||
```shell
|
||||
helmfile apply -n <NAMESPACE>
|
||||
```
|
||||
|
||||
and wait a little. After the deployment is finished some bootstrapping is
|
||||
executed which might take some more minutes before you can log in your new
|
||||
instance.
|
||||
|
||||
## Offline deployment
|
||||
|
||||
Before executing a [local deployment](#local-deployment), you can set following
|
||||
environment variables to use your own container image and helm chart registry:
|
||||
|
||||
| name | description |
|
||||
|------------------------------|--------------------------------|
|
||||
| PRIVATE_CHART_REPOSITORY_URL | Your helm chart repository url |
|
||||
| PRIVATE_IMAGE_REGISTRY_URL | Your image registry url |
|
||||
|
||||
## Logging in
|
||||
|
||||
When successfully deployed the SWP, all K8s jobs from the deployment should be
|
||||
in the status `Succeeded` and all pods should be `Running`.
|
||||
|
||||
You should see the portal's login page at `https://portal.<DOMAIN>`.
|
||||
|
||||
Off the shelf you get two accounts with passwords you can look up in the
|
||||
`univention-corporate-container-*` pod environment. You can use a shell on that
|
||||
container or a `kubectl describe`-command to get the credentials.
|
||||
|
||||
| Username / Login | Password environment variable |
|
||||
|--------------------|--------------------------------|
|
||||
| default.user | DEFAULT_ACCOUNT_USER_PASSWORD |
|
||||
| default.admin | DEFAULT_ACCOUNT_ADMIN_PASSWORD |
|
||||
|
||||
If you do not see any tiles in the portal after the login you may want to wait a
|
||||
couple of minutes, as on the initial start some bootstrapping and cache building
|
||||
is done. This blocks the portal entries from showing up.
|
||||
|
||||
# Helmfile
|
||||
|
||||
## Custom Configuration
|
||||
|
||||
### Deployment selection
|
||||
|
||||
By default, all components are deployed. The components of type `Eval` are used
|
||||
for development and evaluation purposes only - they need to be replaced in
|
||||
production deployments. These components are grouped together in the
|
||||
subdirectory `/helmfile/apps/services`.
|
||||
|
||||
| Component | Name | Default | Description | Type |
|
||||
|-----------------------------|-------------------------------------|---------|--------------------------------|------------|
|
||||
| Certificates | `certificates.enabled` | `true` | TLS certificates | Eval |
|
||||
| ClamAV (Distributed) | `clamavDistributed.enabled` | `false` | Antivirus engine | Eval |
|
||||
| ClamAV (Simple) | `clamavSimple.enabled` | `true` | Antivirus engine | Eval |
|
||||
| Collabora | `collabora.enabled` | `true` | Weboffice | Functional |
|
||||
| Dovecot | `dovecot.enabled` | `true` | Mail backend | Functional |
|
||||
| Element | `element.enabled` | `true` | Secure communications platform | Functional |
|
||||
| Intercom Service | `intercom.enabled` | `true` | Cross service data exchange | Functional |
|
||||
| Jitsi | `jitsi.enabled` | `true` | Videoconferencing | Functional |
|
||||
| Keycloak | `keycloak.enabled` | `true` | Identity Provider | Functional |
|
||||
| MariaDB | `mariadb.enabled` | `true` | Database | Eval |
|
||||
| Nextcloud | `nextcloud.enabled` | `true` | File share | Functional |
|
||||
| OpenProject | `openproject.enabled` | `true` | Project management | Functional |
|
||||
| OX Appsuite | `oxAppsuite.enabled` | `true` | Groupware | Functional |
|
||||
| Provisioning | `oxConnector.enabled` | `true` | Backend provisioning | Functional |
|
||||
| Postfix | `postfix.enabled` | `true` | MTA | Eval |
|
||||
| PostgreSQL | `postgresql.enabled` | `true` | Database | Eval |
|
||||
| Redis | `redis.enabled` | `true` | Cache Database | Eval |
|
||||
| Univention Corporate Server | `univentionCorporateServer.enabled` | `true` | Identity Management & Portal | Functional |
|
||||
| XWiki | `xwiki.enabled` | `true` | Knowledgebase | Functional |
|
||||
|
||||
|
||||
#### Cluster capabilities
|
||||
| Capability | Default | Options | Notes |
|
||||
|-------------------------------------|-----------------|-----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `cluster.service.type` | `LoadBalancer` | `ClusterIP`, `NodePort`, `LoadBalancer` | External access to TCP/UDP services. [Additional Information](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types) |
|
||||
| `cluster.persistence.readWriteMany` | `false` | `true`, `false` | Enable if ReadWriteMany (RWX) storage is available (f.e. CephFS, NFS, ...). |
|
||||
| `cluster.networking.domain` | `cluster.local` | | Kubernetes cluster domain. |
|
||||
| `cluster.networking.cidr` | `10.0.0.0/8` | | Kubernetes internal network |
|
||||
|
||||
|
||||
#### Databases
|
||||
|
||||
In case you don't got for a develop or evaluation environment you want to point
|
||||
the application to your own database instances.
|
||||
|
||||
| Component | Name | Type | Parameter | Key | Default |
|
||||
|-------------|--------------------|------------|-----------|----------------------------------------|----------------------------|
|
||||
| Element | Synapse | PostgreSQL | | | |
|
||||
| | | | Name | `databases.synapse.name` | `matrix` |
|
||||
| | | | Host | `databases.synapse.host` | `postgresql` |
|
||||
| | | | Port | `databases.synapse.port` | `5432` |
|
||||
| | | | Username | `databases.synapse.username` | `matrix_user` |
|
||||
| | | | Password | `databases.synapse.password` | |
|
||||
| Keycloak | Keycloak | PostgreSQL | | | |
|
||||
| | | | Name | `databases.keycloak.name` | `keycloak` |
|
||||
| | | | Host | `databases.keycloak.host` | `postgresql` |
|
||||
| | | | Port | `databases.keycloak.port` | `5432` |
|
||||
| | | | Username | `databases.keycloak.username` | `keycloak_user` |
|
||||
| | | | Password | `databases.keycloak.password` | |
|
||||
| | Keycloak Extension | PostgreSQL | | | |
|
||||
| | | | Name | `databases.keycloakExtension.name` | `keycloak_extensions` |
|
||||
| | | | Host | `databases.keycloakExtension.host` | `postgresql` |
|
||||
| | | | Port | `databases.keycloakExtension.port` | `5432` |
|
||||
| | | | Username | `databases.keycloakExtension.username` | `keycloak_extensions_user` |
|
||||
| | | | Password | `databases.keycloakExtension.password` | |
|
||||
| Nextcloud | Nextcloud | MariaDB | | | |
|
||||
| | | | Name | `databases.nextcloud.name` | `nextcloud` |
|
||||
| | | | Host | `databases.nextcloud.host` | `mariadb` |
|
||||
| | | | Username | `databases.nextcloud.username` | `nextcloud_user` |
|
||||
| | | | Password | `databases.nextcloud.password` | |
|
||||
| OpenProject | Keycloak | PostgreSQL | | | |
|
||||
| | | | Name | `databases.openproject.name` | `openproject` |
|
||||
| | | | Host | `databases.openproject.host` | `postgresql` |
|
||||
| | | | Port | `databases.openproject.port` | `5432` |
|
||||
| | | | Username | `databases.openproject.username` | `openproject_user` |
|
||||
| | | | Password | `databases.openproject.password` | |
|
||||
| OX Appsuite | OX Appsuite | MariaDB | | | |
|
||||
| | | | Name | `databases.oxAppsuite.name` | `CONFIGDB` |
|
||||
| | | | Host | `databases.oxAppsuite.host` | `mariadb` |
|
||||
| | | | Username | `databases.oxAppsuite.username` | `root` |
|
||||
| | | | Password | `databases.oxAppsuite.password` | |
|
||||
| XWiki | XWiki | MariaDB | | | |
|
||||
| | | | Name | `databases.xwiki.name` | `xwiki` |
|
||||
| | | | Host | `databases.xwiki.host` | `mariadb` |
|
||||
| | | | Username | `databases.xwiki.username` | `xwiki_user` |
|
||||
| | | | Password | `databases.xwiki.password` | |
|
||||
|
||||
### Scaling
|
||||
|
||||
The Replicas of components can be increased, while we still have to look in the
|
||||
actual scalability of the components (see column `Scales at least to 2`).
|
||||
|
||||
| Component | Name | Default | Service | Scaling | Scales at least to 2 |
|
||||
|-------------|------------------------|---------|--------------------|--------------------|----------------------|
|
||||
| ClamAV | `replicas.clamav` | `1` | :white_check_mark: | :white_check_mark: | not tested |
|
||||
| | `replicas.clamd` | `1` | :white_check_mark: | :white_check_mark: | not tested |
|
||||
| | `replicas.freshclam` | `1` | :white_check_mark: | :x: | not tested |
|
||||
| | `replicas.icap` | `1` | :white_check_mark: | :white_check_mark: | not tested |
|
||||
| | `replicas.milter` | `1` | :white_check_mark: | :white_check_mark: | not tested |
|
||||
| Collabora | `replicas.collabora` | `1` | :white_check_mark: | :white_check_mark: | not tested |
|
||||
| Dovecot | `replicas.dovecot` | `1` | :white_check_mark: | :x: | not tested |
|
||||
| Element | `replicas.element` | `2` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
||||
| | `replicas.synapse` | `1` | :white_check_mark: | :x: | not tested |
|
||||
| | `replicas.synapseWeb` | `2` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
||||
| | `replicas.wellKnown` | `2` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
||||
| Jitsi | `replicas.jibri` | `1` | :white_check_mark: | :white_check_mark: | not tested |
|
||||
| | `replicas.jicofo` | `1` | :white_check_mark: | :white_check_mark: | not tested |
|
||||
| | `replicas.jitsi ` | `1` | :white_check_mark: | :white_check_mark: | not tested |
|
||||
| | `replicas.jvb ` | `1` | :white_check_mark: | :x: | :x: |
|
||||
| Keycloak | `replicas.keycloak` | `1` | :white_check_mark: | :white_check_mark: | not tested |
|
||||
| Nextcloud | `replicas.nextcloud` | `1` | :white_check_mark: | :white_check_mark: | not tested |
|
||||
| OpenProject | `replicas.openproject` | `1` | :white_check_mark: | :white_check_mark: | not tested |
|
||||
| Postfix | `replicas.postfix` | `1` | :white_check_mark: | :x: | not tested |
|
||||
| XWiki | `replicas.xwiki` | `1` | :white_check_mark: | :white_check_mark: | not tested |
|
||||
|
||||
|
||||
# Component integration
|
||||
|
||||
## Functional use cases
|
||||
|
||||
### Overview
|
||||
|
||||
Some use cases require inter component integration.
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
OXAppSuiteFrontend-->|SilentLogin, Filepicker, CentralNavigation|IntercomService
|
||||
IntercomService-->|SilentLogin, TokenExchange|Keycloak
|
||||
IntercomService-->|Filepicker|Nextcloud
|
||||
IntercomService-->|CentralNavigation|Portal
|
||||
OXAppSuiteBackend-->|Filepicker|Nextcloud
|
||||
Nextcloud-->|CentralNavigation|Portal
|
||||
OpenProject-->|CentralNavigation|Portal
|
||||
XWiki-->|CentralNavigation|Portal
|
||||
Nextcloud-->|CentralContacts|OXAppSuiteBackend
|
||||
OXAppSuiteFrontend-->|Filepicker|OXAppSuiteBackend
|
||||
```
|
||||
|
||||
#### Intercom Service (ICS)
|
||||
|
||||
The UCS Intercom Service's role is to enable cross application integration based
|
||||
on browser interaction. Handling authentication when the frontend of an
|
||||
application is using the API from another application is often a challenge.
|
||||
For more details on the ICS please refer to its own [README.md](./helmfile/apps/intercom-service/README.md).
|
||||
|
||||
In order to establish a session with the Intercom Service, the application that
|
||||
wants to use the ICS must initiate a silent login.
|
||||
|
||||
Currently only OX AppSuite is using the frontend based integration, and
|
||||
therefore it is right now the only consumer of the ICS API.
|
||||
|
||||
### Filepicker
|
||||
|
||||
The Nextcloud filepicker which is integrated into the OX AppSuite allows you to
|
||||
add attachments or links to files from and saving attachments to Nextcloud.
|
||||
|
||||
The filepicker is using frontend and backend based integration. Frontend based
|
||||
integration means that OX AppSuite in the browser is communicating with ICS.
|
||||
While using backend based integration, OX AppSuite middleware is communicating
|
||||
with Nextcloud, which is especially used when adding a file to an email or
|
||||
storing a file into Nextcloud.
|
||||
|
||||
### Central Navigation
|
||||
|
||||
Central navigation is based on an API endpoint in the portal that provides the
|
||||
contents of the portal for a user in order to allow components to render the
|
||||
menu showing all available SWP applications for the user.
|
||||
|
||||
### (Read & write) Central contacts
|
||||
|
||||
Open-Xchange App Suite is used to manage contacts within the Sovereign
|
||||
Workplace. There is an API in the AppSuite that is being used by
|
||||
Nextcloud to lookup contacts as well as to create contacts. This is maybe done
|
||||
when a file is shared with a not yet available personal contact.
|
||||
|
||||
# Identity data flows
|
||||
|
||||
An overview of
|
||||
- components that consume the LDAP service. Mostly by using a dedicated LDAP search account.
|
||||
- components using Keycloak as identity provider. If not otherwise denoted based on the OAuth2 / OIDC flows.
|
||||
|
||||
Some components trust others to handle authentication for them.
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
K[Keycloak]-->L[LDAP]
|
||||
N[Nextcloud]-->L
|
||||
A[OX AppSuite]-->L
|
||||
D[OX Dovecot]-->L
|
||||
P[Portal/Admin]-->L
|
||||
O[OpenProject]-->L
|
||||
X[XWiki]-->|in 2023|L
|
||||
A-->K
|
||||
N-->K
|
||||
D-->K
|
||||
O-->K
|
||||
X-->K
|
||||
P-->|SAML|K
|
||||
E[Element]-->K
|
||||
J[Jitsi]-->K
|
||||
I[IntercomService]-->K
|
||||
C[Collabora]-->N
|
||||
F[Postfix]-->D
|
||||
```
|
||||
|
||||
# Provisioning
|
||||
|
||||
Currently active provisioning is only done for OX AppSuite. The OX-Connector
|
||||
synchronizes creates, modifies and deletes activities for the following objects
|
||||
to the OX AppSuite using the AppSuite's SOAP API:
|
||||
|
||||
- Contexts
|
||||
- Users
|
||||
- Groups
|
||||
- Functional Mailboxes
|
||||
- Resources
|
||||
|
||||
# Component specific documentation
|
||||
|
||||
We want to provide more information per component in separate, component
|
||||
specific `README.md` files. In order to establish a common view on the
|
||||
components we are going to cover various aspects:
|
||||
|
||||
- **Component overview**: Shall provide a quick introduction including the components prerequisites and subcomponents (f.e. pods).
|
||||
- **Resources**: Will contain a link to the components upstream documentation, the helm chart and image locations.
|
||||
- **Operational Capabilities**
|
||||
- **Install**: The components installs within the SWP.
|
||||
- **Restart**: Deleting and restarting pods works seamlessly.
|
||||
- **Update**: Redeploying the component with a different configuration works as expected. The component makes use of the updates configuration afterwards.
|
||||
- **Upgrade**: Component allows to upgrade existing deployments with more current versions of itself.
|
||||
- **Secrets**: The component uses K8s secrets.
|
||||
- **Logging**: Only logging to STDOUT, no logs inside the container.
|
||||
- **Monitoring**: Application provides based on kube-prometheus-stack CRD: ServiceMonitor and PrometheusRule. Optional: Grafana Dashboard.
|
||||
- **Scale**: If supported (as we use community products) the component should be manually scalable. Optional: Autoscaling.
|
||||
- **Network policies**: Deny by default, allow application related traffic.
|
||||
- **Uninstall**: Documented and working complete uninstallation of the component.
|
||||
- **Debugging**: Some helpful information when it comes to debugging a component, e.g. setting log level.
|
||||
|
||||
## Links to component README.mds
|
||||
|
||||
- [Intercom-Service](./helmfile/apps/intercom-service/README.md)
|
||||
|
||||
## Tests
|
||||
|
||||
There is a frontend end-to-end test suite that can get triggered if the
|
||||
deployment is performed via a Gitlab pipeline.
|
||||
|
||||
Currently, the test suite is in progress to be published, so right now it is
|
||||
only usable by project members. But that will change soon, and it could be used
|
||||
to create custom tests and perform them after deployment.
|
||||
|
||||
The deployment pipeline provides a variable named `TESTS_PROJECT_URL` that
|
||||
points to the test pipeline residing in another Gitlab repository. At the end of
|
||||
the deployment the test pipeline is triggered. Tests are just performed for
|
||||
components that have been deployed prior.
|
||||
# Copyright
|
||||
|
||||
Copyright (C) 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
|
||||
# Footnotes
|
||||
|
||||
[^1] Required for scaling components Nextcloud, Dovecot and ClamAV Distributed.
|
||||
[^1]: Nubus is the Cloud Portal and IAM from Univention.
|
||||
It is currently integrated as a product preview within openDesk therefore, not all resources like documentation
|
||||
and structured release notes are available, while the
|
||||
[source code can already be found on Open CoDE](https://gitlab.opencode.de/bmi/opendesk/component-code/crossfunctional/univention).
|
||||
Please find updates regarding the Nubus at https://nubus.io.
|
||||
|
||||
80
cspell.json
Normal file
80
cspell.json
Normal file
@@ -0,0 +1,80 @@
|
||||
{
|
||||
"version": "0.2",
|
||||
"ignorePaths": [],
|
||||
"dictionaryDefinitions": [],
|
||||
"dictionaries": [],
|
||||
"words": [
|
||||
"openDesk",
|
||||
"AppSuite",
|
||||
"Collabora",
|
||||
"Digitale",
|
||||
"Jitsi",
|
||||
"Nextcloud",
|
||||
"Öffentlichen",
|
||||
"OpenProject",
|
||||
"Souveränität",
|
||||
"Verwaltung",
|
||||
"Zentrum",
|
||||
"Keycloak",
|
||||
"NATS",
|
||||
"slapadd",
|
||||
"slapcat",
|
||||
"RDBMS",
|
||||
"Velero",
|
||||
"Univention",
|
||||
"OIDC",
|
||||
"kcadmin",
|
||||
"DMARC",
|
||||
"homeserver",
|
||||
"Bundesministerium",
|
||||
"Innern",
|
||||
"Heimat",
|
||||
"Projektgruppe",
|
||||
"Aufbau",
|
||||
"Filepicker",
|
||||
"Weboffice",
|
||||
"Xchange",
|
||||
"opencode",
|
||||
"seccomp",
|
||||
"psql",
|
||||
"databasename",
|
||||
"helmfile",
|
||||
"gotmpl",
|
||||
"containerd",
|
||||
"letsencrypt",
|
||||
"CNCF",
|
||||
"kubespray",
|
||||
"ICAP",
|
||||
"Ceph",
|
||||
"Coturn",
|
||||
"Minio",
|
||||
"Kyverno",
|
||||
"Otterize",
|
||||
"IBAC",
|
||||
"pubkeys",
|
||||
"Grundschutz",
|
||||
"Kubescape",
|
||||
"Gitflow",
|
||||
"hadolint",
|
||||
"explorative",
|
||||
"Nordeck",
|
||||
"Nubus",
|
||||
"Souveräne",
|
||||
"Arbeitsplatz",
|
||||
"commandline",
|
||||
"helmfiles",
|
||||
"SMTPS",
|
||||
"IMAPS",
|
||||
"xwiki",
|
||||
"cryptpad",
|
||||
"clamav",
|
||||
"templating",
|
||||
"localpart",
|
||||
"Addressbooks",
|
||||
"filestore",
|
||||
"trashbin",
|
||||
"bootstrap"
|
||||
],
|
||||
"ignoreWords": [],
|
||||
"import": []
|
||||
}
|
||||
36
dev/README.md
Normal file
36
dev/README.md
Normal file
@@ -0,0 +1,36 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
<h1>Tools for local development</h1>
|
||||
|
||||
* [charts-local.py](#charts-localpy)
|
||||
* [Commandline parameter](#commandline-parameter)
|
||||
* [`--branch`](#--branch)
|
||||
* [`--revert`](#--revert)
|
||||
|
||||
# charts-local.py
|
||||
|
||||
This script helps you on cloning the platform development Helm charts and referencing them directly in the openDesk
|
||||
Helmfile deployment for comfortable local test and development. The charts will be cloned into a directory
|
||||
parallel created next to the `opendesk` repo containing this documentation and the `charts-local.py` script.
|
||||
The name of the chart directory is derived from the branch name you are working with in this `opendesk` repo.
|
||||
|
||||
The script will create `.bak` copies of the helmfiles that have been touched.
|
||||
|
||||
Run the script with `-h` to get information about the script's parameter on commandline.
|
||||
|
||||
## Commandline parameter
|
||||
|
||||
### `--branch`
|
||||
|
||||
Optional parameter: Defines a branch for the `opendesk` repo to work with. The script will create the branch if it
|
||||
does not exist yet. Otherwise it will switch to defined branch.
|
||||
|
||||
If parameter is omitted the current branch of the `opendesk` repo will be used.
|
||||
|
||||
### `--revert`
|
||||
|
||||
Reverts the changes in the helmfiles pointing to the local Helm charts by copying the backup files created by the
|
||||
scripts itself back to their original location.
|
||||
170
dev/charts-local.py
Executable file
170
dev/charts-local.py
Executable file
@@ -0,0 +1,170 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
import os.path
|
||||
import logging
|
||||
import yaml
|
||||
import sys
|
||||
import shutil
|
||||
import re
|
||||
import configargparse
|
||||
|
||||
from pathlib import Path
|
||||
from git import Repo
|
||||
|
||||
p = configargparse.ArgParser()
|
||||
p.add('--branch', env_var='CHART_DEV_BRANCH', help='The branch you want to work with. Will be created by the script if it does not exist yet.')
|
||||
p.add('--git_hostname', env_var='GIT_HOSTNAME', default='git@gitlab.opencode.de', help='Set the hostname for the chart git checkouts.')
|
||||
p.add('--revert', default=False, action='store_true', help='Set this parameter if you want to revert the referencing of the local helm chart checkout paths in the helmfiles.')
|
||||
p.add('--loglevel', env_var='LOGLEVEL', default='DEBUG', help='Set the loglevel: DEBUG, INFO, WARNING, ERROR, CRITICAL-')
|
||||
options = p.parse_args()
|
||||
|
||||
script_path = os.path.dirname(os.path.realpath(__file__))
|
||||
# some static definitions
|
||||
log_path = script_path+'/../logs'
|
||||
charts_yaml = script_path+'/../helmfile/environments/default/charts.yaml'
|
||||
base_repo_path = script_path+'/..'
|
||||
base_helmfile = base_repo_path+'/helmfile_generic.yaml'
|
||||
helmfile_backup_extension = '.bak'
|
||||
|
||||
Path(log_path).mkdir(parents=True, exist_ok=True)
|
||||
|
||||
logFormatter = logging.Formatter("%(asctime)s %(levelname)-5.5s %(message)s")
|
||||
rootLogger = logging.getLogger()
|
||||
rootLogger.setLevel(options.loglevel)
|
||||
|
||||
fileHandler = logging.FileHandler("{0}/{1}.log".format(log_path, os.path.basename(__file__)))
|
||||
fileHandler.setFormatter(logFormatter)
|
||||
rootLogger.addHandler(fileHandler)
|
||||
|
||||
consoleHandler = logging.StreamHandler()
|
||||
consoleHandler.setFormatter(logFormatter)
|
||||
rootLogger.addHandler(consoleHandler)
|
||||
|
||||
logging.debug(f"Working with relative paths from script location: {script_path}")
|
||||
logging.debug(f"Log directory: {log_path}")
|
||||
logging.debug(f"charts.yaml : {charts_yaml}")
|
||||
|
||||
|
||||
def create_or_switch_branch_base_repo():
|
||||
base_repo = Repo(path=base_repo_path)
|
||||
current_branch = base_repo.active_branch.name
|
||||
if not options.branch:
|
||||
branch = current_branch
|
||||
logging.debug(f"No branch specified on commandline, working with current branch: {current_branch}")
|
||||
else:
|
||||
branch = options.branch
|
||||
if branch in base_repo.branches:
|
||||
if branch != current_branch:
|
||||
logging.debug(f"Selected {branch} already exists, switching.")
|
||||
# ToDo: Graceful handle: "Please commit your changes or stash them before you switch branches."
|
||||
base_repo.git.switch(branch)
|
||||
else:
|
||||
logging.debug(f"Already on selected brach {branch}")
|
||||
else:
|
||||
logging.debug(f"Creating branch {branch} and switching")
|
||||
base_repo.git.branch(branch)
|
||||
base_repo.git.switch(branch)
|
||||
return branch
|
||||
|
||||
|
||||
def clone_charts_locally(branch, charts):
|
||||
charts_clone_path = script_path+'/../../'+branch.replace('/', '_')
|
||||
charts_dict = {}
|
||||
doublette_dict = {}
|
||||
if os.path.isdir(charts_clone_path):
|
||||
logging.warning(f"Path {charts_clone_path} already exists, will not clone any charts.")
|
||||
else:
|
||||
logging.debug(f"creating directory {charts_clone_path} to clone charts into")
|
||||
Path(charts_clone_path).mkdir(parents=True, exist_ok=True)
|
||||
|
||||
for chart in charts['charts']:
|
||||
if 'opendesk/components/platform-development/charts' in charts['charts'][chart]['repository']:
|
||||
tag = charts['charts'][chart]['version']
|
||||
logging.debug(f"Working on {chart} / tag {tag}")
|
||||
repository = charts['charts'][chart]['repository']
|
||||
git_url = options.git_hostname+':'+repository
|
||||
chart_repo_path = charts_clone_path+'/'+charts['charts'][chart]['name']
|
||||
if git_url in doublette_dict:
|
||||
logging.debug(f"{chart} located at {git_url} is already checked out to {doublette_dict[git_url]}")
|
||||
charts_dict[chart] = doublette_dict[git_url]
|
||||
else:
|
||||
if os.path.isdir(chart_repo_path):
|
||||
logging.debug(f"Already exists {chart_repo_path} leaving it unmodified")
|
||||
else:
|
||||
logging.debug(f"Cloning into {chart_repo_path}")
|
||||
Repo.clone_from(git_url, chart_repo_path)
|
||||
chart_repo = Repo(path=chart_repo_path)
|
||||
chart_repo.git.checkout('v'+charts['charts'][chart]['version'])
|
||||
doublette_dict[git_url] = chart_repo_path
|
||||
charts_dict[chart] = chart_repo_path
|
||||
return charts_dict
|
||||
|
||||
|
||||
def grep_yaml(file):
|
||||
with open(file, 'r') as file:
|
||||
content = ''
|
||||
for line in file.readlines():
|
||||
if not ': {{' in line and not '- {{' in line:
|
||||
content += line
|
||||
return yaml.safe_load(content)
|
||||
|
||||
|
||||
def get_child_helmfiles():
|
||||
child_helmfiles = []
|
||||
root_helmfile = grep_yaml(base_helmfile)
|
||||
for entry in root_helmfile['helmfiles']:
|
||||
child_helmfiles.append(base_repo_path+'/'+entry['path'])
|
||||
return child_helmfiles
|
||||
|
||||
|
||||
def process_the_helmfiles(charts_dict, charts):
|
||||
chart_def_prefix = ' chart: "'
|
||||
child_helmfiles = get_child_helmfiles()
|
||||
for child_helmfile in child_helmfiles:
|
||||
child_helmfile_updated = False
|
||||
output = []
|
||||
with open(child_helmfile, 'r') as file:
|
||||
for line in file:
|
||||
if chart_def_prefix in line:
|
||||
for chart_ident in charts_dict:
|
||||
if '.Values.charts.'+chart_ident+'.name' in line:
|
||||
logging.debug(f"found match with {chart_ident} in {line.strip()}")
|
||||
line = chart_def_prefix+charts_dict[chart_ident]+'/charts/'+charts['charts'][chart_ident]['name']+'" # replaced by local-dev script'+"\n"
|
||||
child_helmfile_updated = True
|
||||
break
|
||||
output.append(line)
|
||||
if child_helmfile_updated:
|
||||
child_helmfile_backup = child_helmfile+helmfile_backup_extension
|
||||
if os.path.isfile(child_helmfile_backup):
|
||||
logging.debug("backup {child_helmfile_backup} already exists, will not create a new one.")
|
||||
else:
|
||||
logging.debug(f"creating backup {child_helmfile_backup}.")
|
||||
shutil.copy2(child_helmfile, child_helmfile_backup)
|
||||
logging.debug(f"Updating {child_helmfile}")
|
||||
with open(child_helmfile, 'w') as file:
|
||||
file.writelines(output)
|
||||
|
||||
|
||||
def revert_the_helmfiles():
|
||||
child_helmfiles = get_child_helmfiles()
|
||||
for child_helmfile in child_helmfiles:
|
||||
child_helmfile_backup = child_helmfile+helmfile_backup_extension
|
||||
if os.path.isfile(child_helmfile_backup):
|
||||
logging.debug(f"Reverting {child_helmfile} from backup {child_helmfile_backup}")
|
||||
os.rename(child_helmfile_backup, child_helmfile)
|
||||
else:
|
||||
logging.debug(f"Did not found the backup file {child_helmfile_backup}")
|
||||
|
||||
##
|
||||
## Main program
|
||||
##
|
||||
if options.revert:
|
||||
revert_the_helmfiles()
|
||||
else:
|
||||
branch = create_or_switch_branch_base_repo()
|
||||
with open(charts_yaml, 'r') as file:
|
||||
charts = yaml.safe_load(file)
|
||||
charts_dict = clone_charts_locally(branch, charts)
|
||||
process_the_helmfiles(charts_dict, charts)
|
||||
6
dev/requirements.txt
Normal file
6
dev/requirements.txt
Normal file
@@ -0,0 +1,6 @@
|
||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
configargparse
|
||||
pyyaml
|
||||
GitPython
|
||||
42
docs/ci.md
Normal file
42
docs/ci.md
Normal file
@@ -0,0 +1,42 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
<h1>CI/CD</h1>
|
||||
|
||||
This page covers openDesk deployment automation via Gitlab CI.
|
||||
|
||||
<!-- TOC -->
|
||||
* [Deployment](#deployment)
|
||||
* [Tests](#tests)
|
||||
<!-- TOC -->
|
||||
|
||||
# Deployment
|
||||
|
||||
The project includes a `.gitlab-ci.yml` that allows you to execute the deployment from a GitLab instance of your choice.
|
||||
|
||||
When starting the pipeline through the GitLab UI, you will be queried for some variables plus the following ones:
|
||||
|
||||
- `DOMAIN`: Primary domain for your deployment making the openDesk services available e.g. as `https://portal.DOMAIN`.
|
||||
- `MAIL_DOMAIN`: (optional) Domain for the users mail addresses, defaults to `DOMAIN`.
|
||||
- `MATRIX_DOMAIN`: (optional) Domain for the users Matrix IDs, defaults to `DOMAIN`.
|
||||
- `NAMESPACE`: Namespace of your K8s cluster openDesk will be installed to.
|
||||
- `MASTER_PASSWORD_WEB_VAR`: Overwrites value of `MASTER_PASSWORD`.
|
||||
|
||||
Based on your input, the following variables will be set:
|
||||
- `MASTER_PASSWORD:`: `MASTER_PASSWORD_WEB_VAR`. If `MASTER_PASSWORD_WEB_VAR`
|
||||
is not set, the default for `MASTER_PASSWORD` will be used, unless you set
|
||||
`MASTER_PASSWORD` as a masked CI/CD variable in GitLab to supersede the default.
|
||||
|
||||
You might want to set credential variables in the GitLab project at `Settings` > `CI/CD` > `Variables`.
|
||||
|
||||
# Tests
|
||||
|
||||
The GitLab CI pipeline contains a job named `run-tests` that can trigger a test suite pipeline on another GitLab project.
|
||||
The `DEPLOY_`-variables are used to determine which components should be tested.
|
||||
In order for the trigger to work, the variable `TESTS_PROJECT_URL` has to be set on this GitLab project's CI variables
|
||||
that can be found at `Settings` -> `CI/CD` -> `Variables`. The variable should have this format:
|
||||
`<domain of gitlab>/api/v4/projects/<id>`.
|
||||
|
||||
If the branch of the test pipeline is not `main` this can be set with the `.gitlab-ci.yml` variable
|
||||
`TESTS_BRANCH` while creating a new pipeline.
|
||||
190
docs/components.md
Normal file
190
docs/components.md
Normal file
@@ -0,0 +1,190 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
<h1>Components</h1>
|
||||
|
||||
This section covers the internal system requirements as well as external service requirements for productive use.
|
||||
|
||||
<!-- TOC -->
|
||||
* [Overview](#overview)
|
||||
* [Component integration](#component-integration)
|
||||
* [Intercom Service / Silent Login](#intercom-service--silent-login)
|
||||
* [Filepicker](#filepicker)
|
||||
* [Central Navigation](#central-navigation)
|
||||
* [Central Contacts](#central-contacts)
|
||||
* [File Store (OpenProject -\> Nextcloud)](#file-store-openproject---nextcloud)
|
||||
* [Identity data flows](#identity-data-flows)
|
||||
* [Provisioning](#provisioning)
|
||||
<!-- TOC -->
|
||||
|
||||
# Overview
|
||||
|
||||
openDesk consists out of a variety of open-source projects. Here is a list with the description and type.
|
||||
|
||||
Components of type `Eval` are used for development and evaluation purposes only,
|
||||
they need to be replaced in production deployments.
|
||||
|
||||
| Component | Description | Type |
|
||||
|-----------------------------|--------------------------------|------------|
|
||||
| Certificates | TLS certificates | Eval |
|
||||
| ClamAV (Distributed) | Antivirus engine | Eval |
|
||||
| ClamAV (Simple) | Antivirus engine | Eval |
|
||||
| Collabora | Weboffice | Functional |
|
||||
| CryptPad | Weboffice | Functional |
|
||||
| Element | Secure communications platform | Functional |
|
||||
| Intercom Service | Cross service data exchange | Functional |
|
||||
| Jitsi | Videoconferencing | Functional |
|
||||
| MariaDB | Database | Eval |
|
||||
| Memcached | Cache Database | Eval |
|
||||
| MinIO | Object Storage | Eval |
|
||||
| Nextcloud | File share | Functional |
|
||||
| OpenProject | Project management | Functional |
|
||||
| OX Appsuite | Groupware | Functional |
|
||||
| OX Dovecot | Mail backend (IMAP) | Functional |
|
||||
| Provisioning (OX Connector) | Groupware provisioning | Functional |
|
||||
| Postfix | MTA | Eval |
|
||||
| PostgreSQL | Database | Eval |
|
||||
| Redis | Cache Database | Eval |
|
||||
| Univention Management Stack | Identity Management & Portal | Functional |
|
||||
| XWiki | Knowledge Management | Functional |
|
||||
|
||||
# Component integration
|
||||
|
||||
Some use cases require inter component integration.
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
OX-AppSuite_Frontend-->|Silent Login, Filepicker, Central Navigation|Intercom_Service
|
||||
Element-->|Silent Login, Central Navigation|Intercom_Service
|
||||
Intercom_Service-->|Silent Login, Token Exchange|IdP
|
||||
Intercom_Service-->|Filepicker|Nextcloud
|
||||
Intercom_Service-->|Central Navigation|Portal
|
||||
OX-AppSuite_Backend-->|Filepicker|Nextcloud
|
||||
Nextcloud-->|Central Navigation|Portal
|
||||
OpenProject-->|Central Navigation|Portal
|
||||
OpenProject-->|File Store|Nextcloud
|
||||
XWiki-->|Central Navigation|Portal
|
||||
Nextcloud-->|Central Contacts|OX-AppSuite_Backend
|
||||
OX-AppSuite_Frontend-->|Filepicker|OX-AppSuite_Backend
|
||||
```
|
||||
|
||||
Most details can be found in the upstream documentation that is linked in the respective sections.
|
||||
|
||||
## Intercom Service / Silent Login
|
||||
|
||||
The Intercom Service's role is to enable cross-application integration based on the user's browser interaction as handling
|
||||
authentication when the frontend of an application has to call the API from another application is often a
|
||||
challenge.
|
||||
|
||||
To establish a session with the Intercom Service an application can use the silent login feature within an iframe.
|
||||
|
||||
Currently only OX AppSuite and Element are using the frontend based integration.
|
||||
|
||||
**Links**
|
||||
- [Intercom Service upstream documentation](https://docs.software-univention.de/intercom-service/latest/index.html).
|
||||
|
||||
## Filepicker
|
||||
|
||||
The Nextcloud filepicker is integrated into the OX AppSuite supporting the following use cases against the respective openDesk instance's Nextcloud:
|
||||
- Attaching files from Nextcloud to emails.
|
||||
- Adding links of Nextcloud files to emails.
|
||||
- Saving attachments from emails into Nextcloud.
|
||||
- Attaching files from Nextcloud to calendar entries.
|
||||
|
||||
The filepicker is using frontend and backend based integration:
|
||||
- For frontend based integration the OX AppSuite frontend uses the Intercom Service.
|
||||
- Backend based integration is coming from OX AppSuite middleware. The middleware is communicating directly with Nextcloud,
|
||||
which is used when adding a file to an email or storing a file into Nextcloud, to avoid passing these files through the user's browser.
|
||||
|
||||
**Links**
|
||||
- [OX AppSuite Nextcloud Integration upstream documentation](https://gitlab.open-xchange.com/extensions/nextcloud-integration/-/tree/main/documentation).
|
||||
|
||||
## Central Navigation
|
||||
|
||||
Central navigation is based on an API endpoint in the Nubus portal that returns a JSON containing the contents of the portal for
|
||||
a given user. The response from the API endpoint is used in the openDesk applications to render the central navigation.
|
||||
|
||||
The API can be called by
|
||||
- frontend services through the Intercom Service's `/navigation.json` endpoint or
|
||||
- backend services directly at the portal's `/univention/portal/navigation.json` endpoint.
|
||||
|
||||
The central navigation expects the API caller to present a shared secret for authentication and the username for whom the portal
|
||||
contents should be returned for.
|
||||
|
||||
A `curl` based request returning the navigation contents looks like this:
|
||||
|
||||
```
|
||||
curl 'https://portal.<DOMAIN>/univention/portal/navigation.json?base=https%3A//portal.<DOMAIN>&language=de-DE' -u "<USERNAME>:<SHARED_SECRET>"
|
||||
```
|
||||
|
||||
## Central Contacts
|
||||
|
||||
OX App Suite is managing contacts in openDesk. Therefore Nextcloud's PHP backend is using the OX AppSuite's middleware Contacts API to
|
||||
- create a new contact in the user's contacts folder when a file is shared with a yet unknown email address.
|
||||
- retrieve contacts from the user's contacts folder to support search-as-you-type when starting to share a file.
|
||||
|
||||
**Links:**
|
||||
- Currently used [OX Contacts API (deprecated)](https://documentation.open-xchange.com/components/middleware/http/8/index.html#!Contacts).
|
||||
- New [OX Addressbooks API](https://documentation.open-xchange.com/components/middleware/http/8/index.html#!Addressbooks) the Central Contacts integration will switch to.
|
||||
|
||||
## File Store (OpenProject -> Nextcloud)
|
||||
|
||||
While OpenProject allows you to attach files to work packages directly, it is often preferred that the files are
|
||||
stored within Nextcloud or to link an existing file from your openDesk Nextcloud to a work package.
|
||||
|
||||
Therefore openDesk pre-configures the trust between the openDesk instance's OpenProject and Nextcloud during the `openproject-boostrap` deployment step. As prerequisite for that openDesk's Nextcloud contains the `integration_openproject` app.
|
||||
|
||||
The file store still needs to be enabled on a per-project level in OpenProject's project admin section.
|
||||
|
||||
**Links:**
|
||||
- [OpenProject's documentation on Nextcloud integration](https://www.openproject.org/docs/system-admin-guide/integrations/nextcloud/)
|
||||
- [OpenProject Integration Nextcloud app](https://apps.nextcloud.com/apps/integration_openproject)
|
||||
|
||||
# Identity data flows
|
||||
|
||||
An overview of
|
||||
- components that consume the LDAP service.
|
||||
- The components accessing the LDAP using a component specific LDAP search account.
|
||||
- components using Univention Keycloak as identity provider (IdP).
|
||||
- If not otherwise denoted the components make use of OAuth2 / OIDC flows.
|
||||
- All components have a client configured in Keycloak, except for Jitsi which is using authentication with the
|
||||
[Authorization Code Flow](https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth) that does not
|
||||
require an OIDC client to be configured in Keycloak.
|
||||
|
||||
Some components trust others to handle authentication for them.
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
K[IdP]-->L[LDAP]
|
||||
N[Nextcloud]-->L
|
||||
O[OpenProject] --> L
|
||||
A[OX AppSuite]-->L
|
||||
D[OX Dovecot]-->L
|
||||
P[Portal/Admin]-->L
|
||||
X[XWiki]-->L
|
||||
A-->K
|
||||
N-->K
|
||||
D-->K
|
||||
O-->K
|
||||
X-->K
|
||||
P-->|SAML|K
|
||||
E[Element]-->K
|
||||
J[Jitsi]-->K
|
||||
I[IntercomService]-->K
|
||||
C[Collabora]-->N
|
||||
R[CryptPad]-->N
|
||||
F[Postfix]-->D
|
||||
```
|
||||
|
||||
# Provisioning
|
||||
|
||||
Currently, active provisioning is only done for OX AppSuite. The OX-Connector is synchronizing, creating, modifying and
|
||||
deleting activities for the following objects to the OX AppSuite using the AppSuite's SOAP API:
|
||||
|
||||
- Contexts
|
||||
- Users
|
||||
- Groups
|
||||
- Functional Mailboxes
|
||||
- Resources
|
||||
174
docs/debugging.md
Normal file
174
docs/debugging.md
Normal file
@@ -0,0 +1,174 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
<h1>Debugging</h1>
|
||||
|
||||
* [Disclaimer](#disclaimer)
|
||||
* [Enable debugging](#enable-debugging)
|
||||
* [Adding containers to a pod for debugging purposes](#adding-containers-to-a-pod-for-debugging-purposes)
|
||||
* [Adding a container to a pod/deployment - Dev/Test only](#adding-a-container-to-a-poddeployment---devtest-only)
|
||||
* [Temporary/ephemeral containers](#temporaryephemeral-containers)
|
||||
* [Components](#components)
|
||||
* [MariaDB](#mariadb)
|
||||
* [Nextcloud](#nextcloud)
|
||||
* [OpenProject](#openproject)
|
||||
* [PostgreSQL](#postgresql)
|
||||
|
||||
# Disclaimer
|
||||
|
||||
This document collects information how to deal with debugging an openDesk deployment.
|
||||
|
||||
It will be extended over time as we have to deal with debugging cases.
|
||||
|
||||
We for sure do not want to reinvent the wheel, so we might link to external sources that contain helpful
|
||||
information where available.
|
||||
|
||||
**Note:** You should never enable debug in production environments! By looking up `debug.enable` in the deployment you
|
||||
will find the various places changes are applied when enabling debugging. So outside of development and test
|
||||
environments you may want to make use of them in a very thoughtful and selective manner if needed.
|
||||
|
||||
# Enable debugging
|
||||
|
||||
Set `debug.enable` to `true` in [`debug.yaml`](../helmfile/environments/default/debug.yaml) to set the
|
||||
component's log level to debug and it get some features like:
|
||||
- The `/admin` console is routed for Keycloak.
|
||||
- An ingress for `http://minio-console.<your_domain>` is configured.
|
||||
and set the log level for components to "Debug".
|
||||
|
||||
**Note:** All containers should write their log output to STDOUT, if you find (valuable) logs inside a container, please let us know!
|
||||
|
||||
# Adding containers to a pod for debugging purposes
|
||||
|
||||
During test or development you come across the need to execute tools, browse or even change things in the filesystem of another container.
|
||||
|
||||
This can be a challenge the more security hardened container images are, because there are no debugging tools available and sometimes not even a shell.
|
||||
|
||||
Adding a container to a Pod can ease the pain.
|
||||
|
||||
Below you will find some wrap-up notes when it comes to debugging openDesk by adding debug containers. Of course there are a lot of more detailed resources out in the wild.
|
||||
|
||||
## Adding a container to a pod/deployment - Dev/Test only
|
||||
|
||||
You can add a container by editing and updating an existing deployment, which is quite comfortable with tools like [Lens](https://k8slens.dev/).
|
||||
|
||||
- Select the container you want to make use of as debugging container, in the example below it is `registry.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-debugging-image:latest`.
|
||||
- Ensure the `shareProcessNamespace` option is enabled for the Pod.
|
||||
- Reference the selected container within the `containers` array of the deployment.
|
||||
- In case you want to access another containers filesystem, ensure the user/group settings of both containers match.
|
||||
- Save & update the deployment.
|
||||
|
||||
The following example can e.g. be used to debug the `openDesk-Nextcloud-PHP` container, in case you want to modify files, don't forget to set `readOnlyRootFilesystem` to `true` on the PHP container.
|
||||
|
||||
```
|
||||
shareProcessNamespace: true
|
||||
containers:
|
||||
- name: debugging
|
||||
image: registry.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-debugging-image:latest
|
||||
command: ["/bin/bash", "-c", "while true; do echo 'This is a temporary container for debugging'; sleep 5 ; done"]
|
||||
securityContext:
|
||||
capabilities:
|
||||
drop:
|
||||
- ALL
|
||||
privileged: false
|
||||
runAsUser: 65532
|
||||
runAsGroup: 65532
|
||||
runAsNonRoot: true
|
||||
readOnlyRootFilesystem: false
|
||||
allowPrivilegeEscalation: false
|
||||
seccompProfile:
|
||||
type: RuntimeDefault
|
||||
```
|
||||
|
||||
- After the deployment was reloaded open the shell of the debugging container.
|
||||
- When you've been successful you will see the processes of both/all containers in the pod when doing a `ps aux`.
|
||||
- To access another containers filesystem just select the PID of a process from the other container an do a `cd /proc/<selected_process_id>/root`
|
||||
|
||||
## Temporary/ephemeral containers
|
||||
|
||||
Interesting read we picked most of the details below from: https://iximiuz.com/en/posts/kubernetes-ephemeral-containers/
|
||||
|
||||
Sometimes you do not want to add a container permanently to your existing deployment. In that case you could use [ephemeral containers](https://kubernetes.io/docs/concepts/workloads/pods/ephemeral-containers/).
|
||||
|
||||
For the commands further down this section we set some environment variables first:
|
||||
- `NAMESPACE`: The namespace the Pod you want to inspects is running in.
|
||||
- `DEPLOYMENT_NAME`: The name of the deployment responsible for spawning the Pod you want to inspect within the pre-mentioned namespace.
|
||||
- `POD_NAME`: The name of the Pod you want to inspect within the pre-mentioned namespace.
|
||||
- `EPH_CONTAINER_NAME`: Chose the name for the container, "debugging" seem obvious.
|
||||
- `DEBUG_IMAGE`: The image you want to make use of for debugging purposes.
|
||||
|
||||
e.g.
|
||||
|
||||
```
|
||||
export EPH_CONTAINER_NAME=debugging
|
||||
export NAMESPACE=my_test_deployment
|
||||
export DEPLOYMENT_NAME=opendesk-nextcloud-php
|
||||
export POD_NAME=opendesk-nextcloud-php-6686d47cfb-7642f
|
||||
export DEBUG_IMAGE=registry.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-debugging-image:1.0.0
|
||||
```
|
||||
|
||||
You still need to ensure that your deployment supports process namespace sharing:
|
||||
|
||||
```
|
||||
kubectl -n ${NAMESPACE} patch deployment ${DEPLOYMENT_NAME} --patch '
|
||||
spec:
|
||||
template:
|
||||
spec:
|
||||
shareProcessNamespace: true'
|
||||
```
|
||||
|
||||
Now you can add the ephemeral container with:
|
||||
```
|
||||
kubectl -n ${NAMESPACE} debug -it --attach=false -c ${EPH_CONTAINER_NAME} --image={DEBUG_IMAGE} ${POD_NAME}
|
||||
```
|
||||
and open its interactive terminal with
|
||||
```
|
||||
kubectl -n ${NAMESPACE} attach -it -c ${EPH_CONTAINER_NAME} ${POD_NAME}
|
||||
```
|
||||
|
||||
# Components
|
||||
|
||||
## MariaDB
|
||||
|
||||
When using the openDesk bundled MariaDB you can explore database(s) using the MariaDB interactive terminal from the pod's command line: `mariadb -u root -p`. As password provide the value for `MARIADB_ROOT_PASSWORD` set in the pod's environment.
|
||||
|
||||
While you will find all details for the CLI tool in [the online documentation](https://mariadb.com/kb/en/mariadb-command-line-client/), some quick commands are:
|
||||
|
||||
- `help`: Get help on the psql command set
|
||||
- `show databases`: Lists all databases
|
||||
- `use <databasename>`: Connect to `<databasename>`
|
||||
- `show tables`: Lists tables within the currently connected database
|
||||
- `quit`: Quit the client
|
||||
|
||||
## Nextcloud
|
||||
|
||||
`occ` is the CLI for Nextcloud, all the details can be found in the [upstream documentation](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/occ_command.html).
|
||||
|
||||
You can run occ commands in the `opendesk-nextcloud-php` pod like this: `php /var/www/html/occ config:list`
|
||||
|
||||
## OpenProject
|
||||
|
||||
OpenProject is a Ruby on Rails application. Therefore you can make use of the Rails console from the pod's command line `bundle exec rails console`
|
||||
|
||||
and run debug code like this:
|
||||
|
||||
```
|
||||
uri = URI('https://nextcloud.url/index.php/apps/integration_openproject/check-config')
|
||||
Net::HTTP.start(uri.host, uri.port,
|
||||
:use_ssl => uri.scheme == 'https') do |http|
|
||||
request = Net::HTTP::Get.new uri
|
||||
response = http.request request # Net::HTTPResponse object
|
||||
end
|
||||
```
|
||||
|
||||
## PostgreSQL
|
||||
|
||||
When using the openDesk bundled PostgreSQL you can explore database(s) using the PostgreSQL interactive terminal from the pod's command line: `psql -U postgres`.
|
||||
|
||||
While you will find all details in the [psql subsection](https://www.postgresql.org/docs/current/app-psql.html)) of the PostgreSQL documentation, some quick commands are:
|
||||
|
||||
- `\?`: Get help on the psql command set
|
||||
- `\l`: Lists all databases
|
||||
- `\c <databasename>`: Connect to `<databasename>`
|
||||
- `\dt`: List (describe) tables within the currently connected database
|
||||
- `\q`: Quit the client
|
||||
163
docs/development.md
Normal file
163
docs/development.md
Normal file
@@ -0,0 +1,163 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
<h1>Developing openDesk deployment automation</h1>
|
||||
|
||||
Active development on the deployment is currently only available for project members.
|
||||
But contributions will be possible soon once the CLA process is sorted out.
|
||||
|
||||
* [Overview](#overview)
|
||||
* [Default branch, `develop` and other branches](#default-branch-develop-and-other-branches)
|
||||
* [External artifacts - `charts.yaml` and `images.yaml`](#external-artifacts---chartsyaml-and-imagesyaml)
|
||||
* [Linting](#linting)
|
||||
* [Disable linting selectively](#disable-linting-selectively)
|
||||
* [Renovate](#renovate)
|
||||
* [Mirroring](#mirroring)
|
||||
* [Get new artifacts mirrored](#get-new-artifacts-mirrored)
|
||||
* [Creating new charts / images](#creating-new-charts--images)
|
||||
|
||||
# Overview
|
||||
|
||||
The following sketch provides an high level overview to get a basic understanding of the deployment relevant
|
||||
structure of this repository. An understanding of that structure is vital if you want to contribute to
|
||||
the development of the deployment automation of openDesk.
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
J[helmfile.yaml\nor a helmfile outside of this repository]-->A
|
||||
J-->K[./helmfile/environemnts/*your_environment*/values.yaml.gotmpl\nor any an environment values file]
|
||||
A[./helmfile_generic.yaml]-->B[./helmfile/apps/*all_configured_apps*/helmfile.yaml\nReferences the relevant app Helm\ncharts using details from 'charts.yaml']
|
||||
B-->C[./values-*all_configured_components*.yaml.gotmpl\nValues to template the charts\nwith references to the `images.yaml`]
|
||||
A-->D[./helmfile/environments/default/*\nwith just some examples below]
|
||||
D-->F[charts.yaml]
|
||||
D-->G[images.yaml]
|
||||
D-->H[global.*]
|
||||
D-->I[secrets.yaml\nreplicas.yaml\nresources.yaml\n...]
|
||||
A-->|overwrite defaults with your\ndeployment/environment specific values|E[./helmfile/environments/default/values.yaml.gotmpl]
|
||||
```
|
||||
|
||||
The `helmfile.yaml` file in the root folder serves as the foundation
|
||||
for the entire deployment. It references the `helmfile_generic.yaml`
|
||||
file, which includes app-specific `helmfile.yaml` files, as well as
|
||||
global values files located in `./environments/default`.
|
||||
|
||||
`helmfile.yaml` also refers to three predefined environments: `dev`,
|
||||
`test`, and `prod`.
|
||||
|
||||
The `helmfile_generic.yaml` file is designed to be referenced from
|
||||
external repositories, where custom environments may be defined. An
|
||||
example is demonstrated in the `helmfile.yaml` file.
|
||||
|
||||
Before you look into any app specific configuration it is recommended to review the contents of `./environments/default` to get an understanding of what
|
||||
details are maintained in there, as they are usually referenced by the app configurations.
|
||||
|
||||
# Default branch, `develop` and other branches
|
||||
|
||||
The `main` branch is configured to be the default branch, as visitors of the project on Open CoDE should see that
|
||||
branch by default.
|
||||
|
||||
Please use the `develop` branch to diverge your own branch(es) from. See the [workflow guide](./workflow.md)
|
||||
for more details on naming conventions.
|
||||
|
||||
There is a CI bot that automatically creates a merge request once you initially pushed your branch to Open CoDE.
|
||||
The merge request will of course target the `develop` branch, be in status `draft` and have you as assignee.
|
||||
|
||||
In case you do not plan to actually merge from the branch you have pushed, please close or delete the auto-created MR.
|
||||
|
||||
# External artifacts - `charts.yaml` and `images.yaml`
|
||||
|
||||
The `charts.yaml` and `images.yaml` are the central place to reference external artifacts that are used for the deployment.
|
||||
|
||||
Beside the deployment automation itself some tools work with the contents of the files:
|
||||
|
||||
- **Linting**: Ensures consistency of the file contents for the other tools.
|
||||
- **Renovate**: Automatically create MRs that update the components to their latest version.
|
||||
- **Mirror**: Mirror artifacts to Open CoDE.
|
||||
|
||||
Please find details on these tools below.
|
||||
|
||||
## Linting
|
||||
|
||||
In the project's CI there is a step dedicated to lint the two yaml files, as we want them to be in
|
||||
- alphabetical order regarding the components and
|
||||
- in a logical order regarding the non-commented lines (registry > repository > tag).
|
||||
|
||||
In the linting step the [openDesk CI CLI](https://gitlab.opencode.de/bmi/opendesk/tooling/opendesk-ci-cli) is used to apply the
|
||||
just mentioned sorting and the result is compared with the unsorted version. If there is a delta the linting fails and you probably
|
||||
want to fix it by running the CLI tool locally.
|
||||
|
||||
**Note**: Please ensure that in component blocks you use comments only at the beginning of the block or at its end. Ideally you just stick
|
||||
with the many available examples in the yaml files.
|
||||
|
||||
Example:
|
||||
```
|
||||
synapse:
|
||||
# providerCategory: "Supplier"
|
||||
# providerResponsible: "Element"
|
||||
# upstreamRegistry: "https://registry-1.docker.io"
|
||||
# upstreamRepository: "matrixdotorg/synapse"
|
||||
# upstreamMirrorTagFilterRegEx: '^v(\d+)\.(\d+)\.(\d+)$'
|
||||
# upstreamMirrorStartFrom: ["1", "91", "2"]
|
||||
registry: "registry.opencode.de"
|
||||
repository: "bmi/opendesk/components/supplier/element/images-mirror/synapse"
|
||||
tag: "v1.91.2@sha256:1d19508db417bb2b911c8e086bd3dc3b719ee75c6f6194d58af59b4c32b11322"
|
||||
```
|
||||
|
||||
### Disable linting selectively
|
||||
|
||||
If you follow the "push early, push often" paradigm to save your work to the central Git instance or you just fix a typo in the text
|
||||
of an existing documentation you might want to avoid the CI with its linting to be executed, as it might not offer additional value.
|
||||
|
||||
GitLab offers two options to skip the CI on a commit/push:
|
||||
- Add `[ci skip]` to your commit message ([details](https://docs.gitlab.com/ee/ci/pipelines/#skip-a-pipeline)).
|
||||
**Note:** The string has to be removed before merging your feature branch into `develop`.
|
||||
- Use the related git push option `git push -o ci.skip` ([details](https://docs.gitlab.com/ee/user/project/push_options.html#push-options-for-gitlab-cicd)).
|
||||
|
||||
## Renovate
|
||||
|
||||
Uses a regular expression to match the values of the following attributes:
|
||||
|
||||
- `# upstreamRegistry` *required*: Attribute's value must be prefixed with `https://` for Renovate.
|
||||
- `# upstreamRepository` *required*
|
||||
- `tag` *required*
|
||||
|
||||
Checks for newer versions of the given artefact and creates a MR containing the newest version's tag (and digest).
|
||||
|
||||
## Mirroring
|
||||
|
||||
- See also: https://gitlab.opencode.de/bmi/opendesk/tooling/oci-pull-mirror
|
||||
|
||||
**Note:** The mirror is scheduled to run every hour at 42 minutes past the hour.
|
||||
|
||||
openDesk strives to make all relevant artifacts available on Open CoDE so there is the mirroring process
|
||||
configured to pull artifacts that do not originate from Open CoDE into projects called `*-Mirror` within the
|
||||
[openDesk Components section](https://gitlab.opencode.de/bmi/opendesk/components).
|
||||
|
||||
The mirror script takes the information on what artifacts to mirror from the annotation inside the two yaml files:
|
||||
- `# upstreamRegistry` *required*: To identify the source registry
|
||||
- `# upstreamRepository` *required*: To identify the source repository
|
||||
- `# upstreamMirrorTagFilterRegEx` *required*: If this annotation is set it activates the mirror for the component. Only tags are being mirrored that match the given regular expression. **Note:** You have to use single quotes for this attribute's value in case you use backslash leading regex notation like `\d`.
|
||||
- `# upstreamMirrorStartFrom` *optional*: Array of numeric values in case you want to mirror only artifacts beginning with a specific version. You must use capturing groups
|
||||
in `# upstreamMirrorTagFilterRegEx` to identify the single numeric elements of the version within the tag and use per capturing group (left to right) one numeric array
|
||||
element here to define the version the mirror should start with.
|
||||
|
||||
### Get new artifacts mirrored
|
||||
|
||||
If you want new images or charts to be mirrored that are not yet included in one of the yaml files there are two options:
|
||||
|
||||
You include them in your branch with all required annotations and either
|
||||
1. ask somebody from the platform development team to trigger the mirror's CI based on your branch or
|
||||
2. you get your branch merged to `develop` already.
|
||||
|
||||
# Creating new charts / images
|
||||
|
||||
When you create new Helm charts please check out the
|
||||
[openDesk Best Practices](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-best-practises)
|
||||
for Helm charts.
|
||||
|
||||
You may also want to make use of our [standard CI](https://gitlab.opencode.de/bmi/opendesk/tooling/gitlab-config) to
|
||||
easily get Charts and Images that are signed, linted, scanned and released.
|
||||
Check out the `.gitlab-ci.yaml` files in the project's [Charts](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts) or [Images](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images) to get an idea how little you need to do yourself.
|
||||
14
docs/enhanced-configuration.md
Normal file
14
docs/enhanced-configuration.md
Normal file
@@ -0,0 +1,14 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
<h1>Enhanced configuration use cases for openDesk</h1>
|
||||
|
||||
# Overview
|
||||
|
||||
The following enhanced configuration use cases are described in separate documents.
|
||||
|
||||
- [Separate mail & Matrix domain](enhanced-configuration/separate-mail-matrix-domain.md)
|
||||
- [Federation with external identity provider](enhanced-configuration/idp-federation.md)
|
||||
- [Matrix federation](enhanced-configuration/matrix-federation.md)
|
||||
157
docs/enhanced-configuration/idp-federation.md
Normal file
157
docs/enhanced-configuration/idp-federation.md
Normal file
@@ -0,0 +1,157 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
<h1>Federation with external identity provider (IdP)</h1>
|
||||
|
||||
* [Context](#context)
|
||||
* [Prerequisites](#prerequisites)
|
||||
* [User accounts](#user-accounts)
|
||||
* [External IdP with OIDC](#external-idp-with-oidc)
|
||||
* [Example configuration](#example-configuration)
|
||||
* [Versions](#versions)
|
||||
* [Example values](#example-values)
|
||||
* [Keycloak admin console access](#keycloak-admin-console-access)
|
||||
* [Your organizations IdP](#your-organizations-idp)
|
||||
* [Separate realm](#separate-realm)
|
||||
* [OIDC Client](#oidc-client)
|
||||
* [openDesk IdP](#opendesk-idp)
|
||||
|
||||
# Context
|
||||
|
||||
Most organizations already have an Identity and Access Management (IAM) of their own that includes an identity provider (IdP) for single-sign-on to internal or external web applications.
|
||||
|
||||
This document shows how to configure your organizations IdP as well as the openDesk IdP to allow account federation to support single-sign-on to openDesk based on your organization's login.
|
||||
|
||||
# Prerequisites
|
||||
|
||||
## User accounts
|
||||
|
||||
Beside the configuration it is required that the user accounts with the same name exist within openDesk. This prerequisite is outside the scope of this document.
|
||||
|
||||
We will provide additional documents regarding user provisioning in the future, so here's just an overview regarding potential scenarios:
|
||||
|
||||
- Manual user management
|
||||
- That is a lightweight way for testing your IdP federation setup or in case you just have a small amount of users to manage.
|
||||
- Just create and maintain you user(s) in openDesk and ensure the username in your IAM and openDesk is identical.
|
||||
- User import
|
||||
- If you need to create more than just a couple of test accounts you can use the [openDesk User Importer](https://gitlab.opencode.de/bmi/opendesk/tooling/user-import) that utilizes the UDM REST API for user account creation.
|
||||
- Downsides: Managing groups and deleting accounts needs to be done manually.
|
||||
- Automated Pre-provisioning:
|
||||
- Pre-provisioning users and groups including de-provisioning (deleting) accounts is the best practice as it ensures that openDesk is in sync with your organization's IAM.
|
||||
- There are at least two ways of implementing the pre-provisioning:
|
||||
- UDM REST API:
|
||||
- Build a provisioning solution by yourself using the [UDM REST API](https://docs.software-univention.de/developer-reference/5.0/en/udm/rest-api.html).
|
||||
- The API gives you full control over the contents of the IAM in order to create, update or delete users and groups.
|
||||
- Nubus Directory Importer:
|
||||
- It is based on a Python one-way directory synchronization for users and groups.
|
||||
- Please find more details in the [upstream product's documentation](https://docs.software-univention.de/nubus-kubernetes-operation/latest/en/howto-connect-external-iam.html).
|
||||
- Ad-hoc provisioning (AHP)
|
||||
- This feature is currently not available in the openDesk Keycloak, but there are plans by the Supplier Univention to make it available.
|
||||
- Ad-hoc provisioning creates an user account on the fly during a users first login.
|
||||
- While AHP this is a nice approach for a quick start with openDesk it has various downsides:
|
||||
- Users are just created after their first login, so you cannot find your colleagues in the openDesk apps unless they already logged in.
|
||||
- A user account would never be deactivated or deleted in openDesk.
|
||||
- Group memberships are not transferred.
|
||||
|
||||
## External IdP with OIDC
|
||||
|
||||
This document focusses on the OIDC federation between an external IdP and the openDesk IdP. It makes use of the OpenID Connect (OIDC) protocol, so your external IdP must support OIDC.
|
||||
|
||||
# Example configuration
|
||||
|
||||
## Versions
|
||||
|
||||
The example was tested with openDesk v0.7.0 using its integrated Keycloak v24.0.3, as external IdP we also used an openDesk deployment of the same version but created a separate realm for proper separation of the configuration.
|
||||
|
||||
## Example values
|
||||
|
||||
The following values are used in this example documentation. Please ensure when you come across such a value even if it is part of a URL hostname or path that you adapt it where needed to your setup:
|
||||
|
||||
- `idp.organization.tld`: hostname for your organization's IdP
|
||||
- `id.opendesk.tld`: hostname for the openDesk IdP, so openDesk is obviously deployed at `opendesk.tld`
|
||||
- `fed-test-idp-realm`: realm name for your organizations IdP
|
||||
- `opendesk-federation-client`: OIDC client for the openDesk federation that is defined in your organizations IdP
|
||||
- `auto-federate-idp`: Identifier of your organizations IdP's configuration within the openDesk Keycloak.
|
||||
- `auto-federate-flow`: Identifier of the required additional login flow to be created and referenced in the openDesk Keycloak.
|
||||
|
||||
## Keycloak admin console access
|
||||
|
||||
To access the admin console of Keycloak in an openDesk deployment you need to add a route for `/admin` to the Keycloak's ingress. This is done automatically if you deploy openDesk with `debug.enabled: true` but beware that this will also cause a lot of log output across all openDesk pods.
|
||||
|
||||
The admin console will be available at:
|
||||
- Organization's IdP: https://idp.organization.tld/admin/master/console/
|
||||
- openDesk IdP: https://id.opendesk.tld/admin/master/console/
|
||||
|
||||
For the following configuration steps login with user `kcadmin` and grab the password from the `ums-keycloak` pod's `KEYCLOAK_ADMIN_PASSWORD` variable.
|
||||
|
||||
## Your organizations IdP
|
||||
|
||||
As we use the Keycloak of another openDesk instance to simulate your organization's IdP in this example, especially URL paths within the Keycloak might differ if you use different products.
|
||||
|
||||
Please let us know about your experiences or differences you came across.
|
||||
|
||||
### Separate realm
|
||||
|
||||
To not interfere with an existing configuration for our test scenario we create a separate realm:
|
||||
|
||||
- `Create realm` (from realm selection drop down menu in the left upper corner)
|
||||
- *Realm name*: `fed-test-idp-realm`
|
||||
- `Create`
|
||||
|
||||
### OIDC Client
|
||||
|
||||
If you just created the `fed-test-idp-realm` your are already in the admin screen for the realm, if not use the realm selection drop down menu in the left upper corner to switch to the realm.
|
||||
|
||||
- *Clients* > *Create Client*
|
||||
- Client create wizard page 1:
|
||||
- *Client type*: `OpenID Connect`
|
||||
- *Client-ID*: `opendesk-federation-client`
|
||||
- *Name*: `openDesk @ your organization` (is the descriptive text of the client that might show up in you IdP's UI and therefore should explain what the client is used for)
|
||||
- Client create wizard page 2:
|
||||
- *Client authentication*: `On`
|
||||
- *Authorization*: `Off` (default)
|
||||
- *Authentication flow*: leave defaults
|
||||
- `Standard flow`
|
||||
- `Direct access grants`
|
||||
- Client create wizard page 3:
|
||||
- *Valid Redirect URLs*: `https://id.opendesk.tld/realms/opendesk/broker/auto-federate-idp/endpoint`
|
||||
- When completed with *Save* you get to the detailed client configured that also needs some updates:
|
||||
- Tab *Settings* > Section *Logout settings*
|
||||
- *Front channel logout*: `Off`
|
||||
- *Back channel logout URL*: `https://id.opendesk.tld/realms/opendesk/protocol/openid-connect/logout/backchannel-logout`
|
||||
- Tab *Credentials*
|
||||
- Copy the *Client Secret* as we need it for the configuration of the openDesk IdP to be used in the openDesk IdP, as well as the *Client-ID*.
|
||||
|
||||
## openDesk IdP
|
||||
|
||||
The following configuration is taking place in the Keycloak realm `opendesk`.
|
||||
|
||||
- *Authentication* > *Create flow*
|
||||
- *Name*: `auto-federate-flow`
|
||||
- *Flow type*: `Basic flow`
|
||||
- *Create*
|
||||
- *Add execution*: Add `Detect existing broker user` and set it to `Required`
|
||||
- *Add step*: `Automatically set existing user` and set it to `Required`
|
||||
|
||||
- *Identity providers* > *User-defined* > *OpenID Connect 1.0*
|
||||
- *Alias*: `auto-federate-idp` (used in our example)
|
||||
- *Display Name*: Descriptive Name in case you do not forcefully redirect the user to the IdP that name is shown in the login screen for manual selection.
|
||||
- *Use discovery endpoint*: `On` (default)
|
||||
- *Discovery endpoint*: `https://idp.organization.tld/realms/fed-test-idp-realm/.well-known/openid-configuration` - this URL may look different if you do not use Keycloak or a different Keycloak version as IdP in your organization
|
||||
- In case the IdP metadata could not be auto-discovered you will get an error.
|
||||
- If everything is fine you can review the discovered metadata for your IdP by clicking on *Show metadata*.
|
||||
- *Client authentication*: `Client secret sent as post` (default)
|
||||
- *Client ID*: Use the client ID you took form your organization's IdP config (`opendesk-federation-client` in this example)
|
||||
- *Client Secret*: Use the secret you took form your organization's IdP config
|
||||
- When completed with *Add* you get to the detailed IdP configured that also needs some updates (you may need to open the *Advanced* section to access some settings)
|
||||
- *Back-channel logout*: `On`
|
||||
- *Disable user info*: `On`
|
||||
- *First login flow override*: `auto-federate-flow`
|
||||
|
||||
- In case you want to forcefully redirect all users to your organizations IdP (disabling login with local openDesk accounts):
|
||||
- *Authentication* > `2fa-browser`
|
||||
- Click on the cogwheel next to the *Identity Provider Re-director*
|
||||
- *Alias*: `auto-federate-idp`
|
||||
- *Default Identity Provider*: `auto-federate-idp`
|
||||
63
docs/enhanced-configuration/matrix-federation.md
Normal file
63
docs/enhanced-configuration/matrix-federation.md
Normal file
@@ -0,0 +1,63 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
<h1>Matrix federation</h1>
|
||||
|
||||
<!-- TOC -->
|
||||
* [Use case](#use-case)
|
||||
* [Example configuration](#example-configuration)
|
||||
* [Disable federation](#disable-federation)
|
||||
* [Separate Matrix domain](#separate-matrix-domain)
|
||||
<!-- TOC -->
|
||||
|
||||
# Use case
|
||||
|
||||
The Element chat application and its server component Synapse are based on the Matrix protocol,
|
||||
that supports federation with other Matrix servers to communicate with the users with accounts on these servers.
|
||||
|
||||
By default, you can chat with users that have an account within your openDesk installation and federate with other
|
||||
matrix-based servers.
|
||||
Federation support can be disabled.
|
||||
|
||||
# Example configuration
|
||||
|
||||
The following values are used in this example documentation.
|
||||
Please ensure when you come across such a value,
|
||||
even if it is part of a URL hostname or path, that you adapt it where needed to your setup:
|
||||
|
||||
- `opendesk.domain.tld`: the mandatory `DOMAIN` setting for your deployment resulting in
|
||||
`https://chat.opendesk.domain.tld` to access the Element chat.
|
||||
- `my_organization.tld`: an optional alternative domain used for mail and/or Matrix.
|
||||
If not used it is also set to `opendesk.domain.tld`.
|
||||
|
||||
## Disable federation
|
||||
|
||||
The following setting can disable federation:
|
||||
|
||||
```yaml
|
||||
functional:
|
||||
externalServices:
|
||||
matrix:
|
||||
federation:
|
||||
enabled: false
|
||||
```
|
||||
|
||||
## Separate Matrix domain
|
||||
|
||||
If you want to federate with other Matrix instances and use a separate Matrix domain, you need to provide a JSON file on
|
||||
the Matrix domain to use delegation.
|
||||
This is not included inside openDesk.
|
||||
|
||||
Domain path: `https://my_organization.tld/.well-known/matrix/server`
|
||||
|
||||
Content:
|
||||
```JSON
|
||||
{
|
||||
"m.server": "matrix-federation.opendesk.domain.tld:443"
|
||||
}
|
||||
```
|
||||
|
||||
More detailed information can be found in Matrix/Synapse documentation:
|
||||
[Matrix Delegation](https://matrix-org.github.io/synapse/v1.98/delegate.html)
|
||||
99
docs/enhanced-configuration/separate-mail-matrix-domain.md
Normal file
99
docs/enhanced-configuration/separate-mail-matrix-domain.md
Normal file
@@ -0,0 +1,99 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
<h1>Separate domains for mail and or matrix</h1>
|
||||
|
||||
* [Use case](#use-case)
|
||||
* [Example configuration](#example-configuration)
|
||||
* [Mail domain](#mail-domain)
|
||||
* [Matrix domain](#matrix-domain)
|
||||
* [DNS](#dns)
|
||||
* [Webserver](#webserver)
|
||||
* [Content Security Policy](#content-security-policy)
|
||||
* [.well-known](#well-known)
|
||||
|
||||
# Use case
|
||||
|
||||
As communication over mail and chat can go beyond the borders of your openDesk installation you may want to use different domains for the mail and/or matrix.
|
||||
|
||||
# Example configuration
|
||||
|
||||
The following values are used in this example documentation. Please ensure when you come across such a value even if it is part of a URL hostname or path that you adapt it where needed to your setup:
|
||||
|
||||
- `opendesk.domain.tld`: the mandatory `DOMAIN` setting for your deployment resulting in `https://mail.opendesk.domain.tld` to access emails and `https://chat.opendesk.domain.tld` to access the Element chat that is based on the Matrix protocol.
|
||||
- `my_organization.tld`: the alternative domain used for mail and/or Matrix.
|
||||
|
||||
## Mail domain
|
||||
|
||||
By default all email addresses in openDesk are created based on the `DOMAIN` you specified for your deployment. In our example resulting in the users having `<username>@opendesk.domain.tld` as mail addresses. In case you prefer the users to send and receive emails with another domain you can set that one using the optional `MAIL_DOMAIN` in the deployment:
|
||||
|
||||
```yaml
|
||||
global:
|
||||
mailDomain: "my_organization.tld"
|
||||
```
|
||||
|
||||
or via environment variable
|
||||
|
||||
```shell
|
||||
export MAIL_DOMAIN=my_organization.tld
|
||||
```
|
||||
|
||||
This of course requires the MX record for the domain to point to the mail host for your openDesk deployment. Optionally add the SPF and DMARC records.
|
||||
|
||||
| Record name | Type | Value |
|
||||
| -------------------------- | ---- | ------------------------------------------------ |
|
||||
| my_organization.tld | MX | `10 mail.opendesk.domain.tld` |
|
||||
| my_organization.tld | TXT | `v=spf1 +a +mx +a:mail.opendesk.domain.tld ~all` |
|
||||
| _dmarc.my_organization.tld | TXT | `v=DMARC1; p=quarantine` |
|
||||
|
||||
## Matrix domain
|
||||
|
||||
Similar to the specific domain for email addresses you may want to specify a domain that differs from your deployment's default `DOMAIN` to define your users Matrix IDs. Use the `MATRIX_DOMAIN` to do so:
|
||||
|
||||
```yaml
|
||||
global:
|
||||
matrixDomain: "my_organization.tld"
|
||||
```
|
||||
|
||||
or via environment variable
|
||||
|
||||
```shell
|
||||
export MATRIX_DOMAIN=my_organization.tld
|
||||
```
|
||||
|
||||
### DNS
|
||||
|
||||
The following changes apply to the standard DNS:
|
||||
|
||||
| Record name | Type | Value | Comment |
|
||||
| -------------------------------- | ---- | -------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| _matrix._tcp.my_organization.tld | SRV | `1 10 PORT matrix.opendesk.domain.tld` | `PORT` is your NodePort/LoadBalancer port of `opendesk-synapse-federation` service |
|
||||
|
||||
*Note:* `matrix.opendesk.domain.tld` in the "Value" column can also be the IP address where synapse TLS port is listening to.
|
||||
|
||||
### Webserver
|
||||
|
||||
#### Content Security Policy
|
||||
|
||||
The webserver of `my_organization.tld` should add `*.opendesk.domain.tld` to its CSP header.
|
||||
|
||||
#### .well-known
|
||||
|
||||
If you want to use other Matrix clients,
|
||||
e.g., Element Messenger for [iOS](https://apps.apple.com/de/app/element-messenger/id1083446067)
|
||||
or [Android](https://play.google.com/store/apps/details?id=im.vector.app),
|
||||
you need to create a JSON file with the following contents that is served from
|
||||
`https://my_organization.tld/.well-known/matrix/client`:
|
||||
|
||||
```json
|
||||
{
|
||||
"m.homeserver": {
|
||||
"base_url": "https://matrix.opendesk.domain.tld"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
This ensures clients know where to find the Matrix protocol endpoint when users specify `my_organization.tld`
|
||||
as their homeserver.
|
||||
110
docs/external-services.md
Normal file
110
docs/external-services.md
Normal file
@@ -0,0 +1,110 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
<h1>External services</h1>
|
||||
|
||||
This document will cover the additional configuration to use external services like databases, caches or buckets.
|
||||
|
||||
<!-- TOC -->
|
||||
* [Database](#database)
|
||||
* [Object storage](#object-storage)
|
||||
* [Cache](#cache)
|
||||
<!-- TOC -->
|
||||
|
||||
# Database
|
||||
|
||||
When deploying this suite to production, you need to configure the applications to use your production grade database
|
||||
service.
|
||||
|
||||
| Component | Name | Type | Parameter | Key | Default |
|
||||
|-------------|--------------------|------------|-----------|------------------------------------------|----------------------------|
|
||||
| Element | Synapse | PostgreSQL | | | |
|
||||
| | | | Name | `databases.synapse.name` | `matrix` |
|
||||
| | | | Host | `databases.synapse.host` | `postgresql` |
|
||||
| | | | Port | `databases.synapse.port` | `5432` |
|
||||
| | | | Username | `databases.synapse.username` | `matrix_user` |
|
||||
| | | | Password | `databases.synapse.password` | |
|
||||
| Keycloak | Keycloak | PostgreSQL | | | |
|
||||
| | | | Name | `databases.keycloak.name` | `keycloak` |
|
||||
| | | | Host | `databases.keycloak.host` | `postgresql` |
|
||||
| | | | Port | `databases.keycloak.port` | `5432` |
|
||||
| | | | Username | `databases.keycloak.username` | `keycloak_user` |
|
||||
| | | | Password | `databases.keycloak.password` | |
|
||||
| | Keycloak Extension | PostgreSQL | | | |
|
||||
| | | | Name | `databases.keycloakExtension.name` | `keycloak_extensions` |
|
||||
| | | | Host | `databases.keycloakExtension.host` | `postgresql` |
|
||||
| | | | Port | `databases.keycloakExtension.port` | `5432` |
|
||||
| | | | Username | `databases.keycloakExtension.username` | `keycloak_extensions_user` |
|
||||
| | | | Password | `databases.keycloakExtension.password` | |
|
||||
| UMS | Notifications API | PostgreSQL | | | |
|
||||
| | | | Name | `databases.umsNotificationsApi.name` | `notificationsapi` |
|
||||
| | | | Host | `databases.umsNotificationsApi.host` | `postgresql` |
|
||||
| | | | Port | `databases.umsNotificationsApi.port` | `5432` |
|
||||
| | | | Username | `databases.umsNotificationsApi.username` | `notificationsapi_user` |
|
||||
| | | | Password | `databases.umsNotificationsApi.password` | |
|
||||
| | Self Service | PostgreSQL | | | |
|
||||
| | | | Name | `databases.umsSelfservice.name` | `selfservice` |
|
||||
| | | | Host | `databases.umsSelfservice.host` | `postgresql` |
|
||||
| | | | Port | `databases.umsSelfservice.port` | `5432` |
|
||||
| | | | Username | `databases.umsSelfservice.username` | `selfservice_user` |
|
||||
| | | | Password | `databases.umsSelfservice.password` | |
|
||||
| Nextcloud | Nextcloud | MariaDB | | | |
|
||||
| | | | Name | `databases.nextcloud.name` | `nextcloud` |
|
||||
| | | | Host | `databases.nextcloud.host` | `mariadb` |
|
||||
| | | | Username | `databases.nextcloud.username` | `nextcloud_user` |
|
||||
| | | | Password | `databases.nextcloud.password` | |
|
||||
| OpenProject | OpenProject | PostgreSQL | | | |
|
||||
| | | | Name | `databases.openproject.name` | `openproject` |
|
||||
| | | | Host | `databases.openproject.host` | `postgresql` |
|
||||
| | | | Port | `databases.openproject.port` | `5432` |
|
||||
| | | | Username | `databases.openproject.username` | `openproject_user` |
|
||||
| | | | Password | `databases.openproject.password` | |
|
||||
| OX Appsuite | OX Appsuite | MariaDB | | | |
|
||||
| | | | Name | `databases.oxAppsuite.name` | `CONFIGDB` |
|
||||
| | | | Host | `databases.oxAppsuite.host` | `mariadb` |
|
||||
| | | | Username | `databases.oxAppsuite.username` | `root` |
|
||||
| | | | Password | `databases.oxAppsuite.password` | |
|
||||
| XWiki | XWiki | MariaDB | | | |
|
||||
| | | | Name | `databases.xwiki.name` | `xwiki` |
|
||||
| | | | Host | `databases.xwiki.host` | `mariadb` |
|
||||
| | | | Username | `databases.xwiki.username` | `xwiki_user` |
|
||||
| | | | Password | `databases.xwiki.password` | |
|
||||
|
||||
# Object storage
|
||||
|
||||
When deploying this suite to production, you need to configure the applications to use your production grade object
|
||||
storage service.
|
||||
|
||||
| Component | Name | Parameter | Key | Default |
|
||||
|-------------|-------------|-----------------|------------------------------------------|--------------------|
|
||||
| OpenProject | OpenProject | | | |
|
||||
| | | Backend | `objectstores.openproject.backend` | `minio` |
|
||||
| | | Bucket | `objectstores.openproject.bucket` | `openproject` |
|
||||
| | | Endpoint | `objectstores.openproject.endpoint` | |
|
||||
| | | Provider | `objectstores.openproject.provider` | `AWS` |
|
||||
| | | Region | `objectstores.openproject.region` | |
|
||||
| | | Secret | `objectstores.openproject.secret` | |
|
||||
| | | Username | `objectstores.openproject.username` | `openproject_user` |
|
||||
| | | Use IAM profile | `objectstores.openproject.useIAMProfile` | |
|
||||
|
||||
# Cache
|
||||
|
||||
When deploying this suite to production, you need to configure the applications to use your production grade cache
|
||||
service.
|
||||
|
||||
| Component | Name | Type | Parameter | Key | Default |
|
||||
|------------------|------------------|-----------|-----------|------------------------------|------------------|
|
||||
| Intercom Service | Intercom Service | Redis | | | |
|
||||
| | | | Host | `cache.intercomService.host` | `redis-headless` |
|
||||
| | | | Port | `cache.intercomService.port` | `6379` |
|
||||
| Nextcloud | Nextcloud | Redis | | | |
|
||||
| | | | Host | `cache.nextcloud.host` | `redis-headless` |
|
||||
| | | | Port | `cache.nextcloud.port` | `6379` |
|
||||
| OpenProject | OpenProject | Memcached | | | |
|
||||
| | | | Host | `cache.openproject.host` | `memcached` |
|
||||
| | | | Port | `cache.openproject.port` | `11211` |
|
||||
| UMS | Self Service | Memcached | | | |
|
||||
| | | | Host | `cache.umsSelfservice.host` | `memcached` |
|
||||
| | | | Port | `cache.umsSelfservice.port` | `11211` |
|
||||
449
docs/getting-started.md
Normal file
449
docs/getting-started.md
Normal file
@@ -0,0 +1,449 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
<h1>Getting started</h1>
|
||||
|
||||
This documentation should enable you to create your own evaluation instance of openDesk on your Kubernetes cluster.
|
||||
|
||||
<!-- TOC -->
|
||||
* [Requirements](#requirements)
|
||||
* [Customize environment](#customize-environment)
|
||||
* [DNS](#dns)
|
||||
* [Domain](#domain)
|
||||
* [Apps](#apps)
|
||||
* [Private registries](#private-registries)
|
||||
* [Cluster capabilities](#cluster-capabilities)
|
||||
* [Service](#service)
|
||||
* [Networking](#networking)
|
||||
* [Ingress](#ingress)
|
||||
* [Container runtime](#container-runtime)
|
||||
* [Volumes](#volumes)
|
||||
* [Connectivity](#connectivity)
|
||||
* [Ports](#ports)
|
||||
* [Web based user interface](#web-based-user-interface)
|
||||
* [Mail clients](#mail-clients)
|
||||
* [Mail/SMTP configuration](#mailsmtp-configuration)
|
||||
* [TURN configuration](#turn-configuration)
|
||||
* [Certificate issuer](#certificate-issuer)
|
||||
* [Password seed](#password-seed)
|
||||
* [Install](#install)
|
||||
* [Install single app](#install-single-app)
|
||||
* [Install single release/chart](#install-single-releasechart)
|
||||
* [Access deployment](#access-deployment)
|
||||
* [Using from external repository](#using-from-external-repository)
|
||||
* [Uninstall](#uninstall)
|
||||
<!-- TOC -->
|
||||
|
||||
Thanks for looking into the openDesk Getting started guide. This documents covers essentials configuration steps to
|
||||
deploy openDesk onto your kubernetes infrastructure.
|
||||
|
||||
# Requirements
|
||||
|
||||
Detailed system requirements are covered on [requirements](requirements.md) page.
|
||||
|
||||
# Customize environment
|
||||
|
||||
Before deploying openDesk, you have to configure the deployment to suit your environment.
|
||||
To keep your deployment up to date, we recommend customizing in `dev`, `test` or `prod` and not in `default` environment
|
||||
files.
|
||||
|
||||
> All configuration options and their default values can be found in files at `helmfile/environments/default/`
|
||||
|
||||
For the following guide, we will use `dev` as environment, where variables can be set in
|
||||
`helmfile/environments/dev/values.yaml.gotmpl`.
|
||||
|
||||
## DNS
|
||||
|
||||
The deployment is designed to deploy each application/service under a dedicated subdomain.
|
||||
For your convenience, we recommend to create a `*.domain.tld` A-Record to your cluster ingress controller,
|
||||
otherwise you need to create an A-Record for each subdomain.
|
||||
|
||||
| Record name | Type | Value | Additional information |
|
||||
| ----------------------- | ---- | -------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| *.domain.tld | A | IPv4 address of your Ingress Controller | |
|
||||
| *.domain.tld | AAAA | IPv6 address of your Ingress Controller | |
|
||||
| mail.domain.tld | A | IPv4 address of your postfix NodePort/LoadBalancer | Optional mail should directly be delivered to openDesk's Postfix |
|
||||
| mail.domain.tld | AAAA | IPv6 address of your postfix NodePort/LoadBalancer | Optional mail should directly be delivered to openDesk's Postfix |
|
||||
| domain.tld | MX | `10 mail.domain.tld` | |
|
||||
| domain.tld | TXT | `v=spf1 +a +mx +a:mail.domain.tld ~all` | Optional, use proper MTA record if present |
|
||||
| _dmarc.domain.tld | TXT | `v=DMARC1; p=quarantine` | Optional |
|
||||
| _matrix._tcp.domain.tld | SRV | `1 10 PORT matrix.domain.tld` | `PORT` is your NodePort/LoadBalancer port of `opendesk-synapse-federation` service |
|
||||
|
||||
## Domain
|
||||
|
||||
A list of all subdomains can be found in `helmfile/environments/default/global.yaml`.
|
||||
|
||||
All subdomains can be customized. For example, _Nextcloud_ can be changed to `files.domain.tld` in `dev` environment:
|
||||
|
||||
```yaml
|
||||
global:
|
||||
hosts:
|
||||
nextcloud: "files"
|
||||
```
|
||||
|
||||
The domain have to be set either via `dev` environment
|
||||
|
||||
```yaml
|
||||
global:
|
||||
domain: "domain.tld"
|
||||
```
|
||||
|
||||
or via environment variable
|
||||
|
||||
```shell
|
||||
export DOMAIN=domain.tld
|
||||
```
|
||||
|
||||
### Apps
|
||||
|
||||
All available apps and their default value can be found in `helmfile/environments/default/workplace.yaml`.
|
||||
|
||||
| Component | Name | Default | Description |
|
||||
| -------------------- | --------------------------- | ------- | ------------------------------ |
|
||||
| Certificates | `certificates.enabled` | `true` | TLS certificates |
|
||||
| ClamAV (Distributed) | `clamavDistributed.enabled` | `false` | Antivirus engine |
|
||||
| ClamAV (Simple) | `clamavSimple.enabled` | `true` | Antivirus engine |
|
||||
| Collabora | `collabora.enabled` | `true` | Weboffice |
|
||||
| CryptPad | `cryptpad.enabled` | `true` | Weboffice |
|
||||
| Dovecot | `dovecot.enabled` | `true` | Mail backend |
|
||||
| Element | `element.enabled` | `true` | Secure communications platform |
|
||||
| Intercom Service | `intercom.enabled` | `true` | Cross service data exchange |
|
||||
| Jitsi | `jitsi.enabled` | `true` | Videoconferencing |
|
||||
| MariaDB | `mariadb.enabled` | `true` | Database |
|
||||
| Memcached | `memcached.enabled` | `true` | Cache Database |
|
||||
| MinIO | `minio.enabled` | `true` | Object Storage |
|
||||
| Nextcloud | `nextcloud.enabled` | `true` | File share |
|
||||
| Nubus | `nubus.enabled` | `true` | Identity Management & Portal |
|
||||
| OpenProject | `openproject.enabled` | `true` | Project management |
|
||||
| OX Appsuite | `oxAppsuite.enabled` | `true` | Groupware |
|
||||
| Provisioning | `oxConnector.enabled` | `true` | Backend provisioning |
|
||||
| Postfix | `postfix.enabled` | `true` | MTA |
|
||||
| PostgreSQL | `postgresql.enabled` | `true` | Database |
|
||||
| Redis | `redis.enabled` | `true` | Cache Database |
|
||||
| XWiki | `xwiki.enabled` | `true` | Knowledge management |
|
||||
|
||||
Exemplary, Jitsi can be disabled like:
|
||||
|
||||
```yaml
|
||||
jitsi:
|
||||
enabled: false
|
||||
```
|
||||
|
||||
## Private registries
|
||||
|
||||
By default Helm charts and container images are fetched from OCI registries. These registries can be found for most cases
|
||||
in the [openDesk/component section on Open CoDE](https://gitlab.opencode.de/bmi/opendesk/components).
|
||||
|
||||
For untouched upstream artifacts that do not belong to a functional component's core we use upstream registries
|
||||
like Docker Hub.
|
||||
|
||||
Doing a test deployment will most likely be fine with this setup. In case you want to deploy multiple times a day
|
||||
and fetch from the same IP address you might run into rate limits at Docker Hub. In that case and in cases you
|
||||
prefer the use of a private image registry anyway you can configure such for
|
||||
[your target environment](./../helmfile/environments/dev/values.yaml.gotmpl.sample) by setting
|
||||
- `global.imageRegistry` for a private image registry and
|
||||
- `global.helmRegistry` for a private Helm chart registry.
|
||||
|
||||
```yaml
|
||||
global:
|
||||
imageRegistry: "my_private_registry.domain.tld"
|
||||
```
|
||||
|
||||
alternatively you can use an environment variable:
|
||||
|
||||
```shell
|
||||
export PRIVATE_IMAGE_REGISTRY_URL=my_private_registry.domain.tld
|
||||
```
|
||||
|
||||
If authentication is required, you can reference imagePullSecrets as following:
|
||||
|
||||
```yaml
|
||||
global:
|
||||
imagePullSecrets:
|
||||
- "external-registry"
|
||||
```
|
||||
|
||||
## Cluster capabilities
|
||||
|
||||
### Service
|
||||
|
||||
Some apps, like Jitsi or Dovecot, require HTTP and external TCP connections.
|
||||
These apps create a Kubernetes service object.
|
||||
You can configure, whether `NodePort` (for on-premise), `LoadBalancer` (for cloud) or `ClusterIP` (to disable) should be
|
||||
used:
|
||||
|
||||
```yaml
|
||||
cluster:
|
||||
service:
|
||||
type: "NodePort"
|
||||
```
|
||||
|
||||
### Networking
|
||||
|
||||
If your cluster has not the default `cluster.local` domain configured, you need to provide the domain via:
|
||||
|
||||
```yaml
|
||||
cluster:
|
||||
networking:
|
||||
domain: "acme.internal"
|
||||
```
|
||||
|
||||
If your cluster has not the default `10.0.0.0/8` CIDR configured, you need to provide the CIDR via:
|
||||
|
||||
```yaml
|
||||
cluster:
|
||||
networking:
|
||||
cidr:
|
||||
- "127.0.0.0/8"
|
||||
```
|
||||
|
||||
If your load balancer / reverse proxy IPs are not already covered by the above `cidr` you need to
|
||||
explicitly configure the related IPs or IP ranges:
|
||||
|
||||
```yaml
|
||||
cluster:
|
||||
networking:
|
||||
incomingCIDR:
|
||||
- "172.16.0.0/12"
|
||||
```
|
||||
|
||||
### Ingress
|
||||
|
||||
By default, the `ingressClassName` is empty to choose your default ingress controller. You may want to customize it by
|
||||
setting the following attribute to the name of the currently only supported ingress controller `ingress-nginx` (see
|
||||
[requirements.md](./requirements.md)) for reference) within your deployment if that is not the clusters default ingress.
|
||||
|
||||
```yaml
|
||||
ingress:
|
||||
ingressClassName: "name-of-my-nginx-ingress"
|
||||
```
|
||||
|
||||
### Container runtime
|
||||
|
||||
Some apps require specific configuration for the container runtime. You can set your container runtime like `cri-o`,
|
||||
`containerd` or `docker` by:
|
||||
|
||||
```yaml
|
||||
cluster:
|
||||
container:
|
||||
engine: "containerd"
|
||||
```
|
||||
|
||||
### Volumes
|
||||
|
||||
When your cluster has a `ReadWriteMany` volume provisioner, you can benefit from distributed or scaling of apps. By
|
||||
default, only `ReadWriteOnce` is enabled. To enable `ReadWriteMany` you can set:
|
||||
|
||||
```yaml
|
||||
cluster:
|
||||
persistence:
|
||||
readWriteMany: true
|
||||
```
|
||||
|
||||
The **StorageClass** can be set by:
|
||||
|
||||
```yaml
|
||||
persistence:
|
||||
storageClassNames:
|
||||
RWX: "my-read-write-many-class"
|
||||
RWO: "my-read-write-once-class"
|
||||
```
|
||||
|
||||
## Connectivity
|
||||
|
||||
### Ports
|
||||
|
||||
**Note:** If you use `NodePort` for service exposure, you need to check your deployment for the actual ports.
|
||||
|
||||
#### Web based user interface
|
||||
|
||||
To use the openDesk functionality with its web based user interface you need to publicly expose the following ports:
|
||||
|
||||
| Component | Description | Port | Type |
|
||||
| ------------------ | ----------------------- | ----: | ---: |
|
||||
| Jitsi Video Bridge | ICE Port for video data | 10000 | UDP |
|
||||
|
||||
#### Mail clients
|
||||
|
||||
To connect with mail clients like [Thunderbird](https://www.thunderbird.net/), the following ports need public exposure:
|
||||
|
||||
| Component | Description | Port | Type |
|
||||
| ------------------ | ----------------------- | ----: | ---: |
|
||||
| Dovecot | IMAPS | 993 | TCP |
|
||||
| | POP3S | 995 | TCP |
|
||||
| Postfix | SMTP | 25 | TCP |
|
||||
| | SMTPS | 587 | TCP |
|
||||
|
||||
### Mail/SMTP configuration
|
||||
|
||||
To use the full potential of the openDesk, you need to set up an SMTP relay which allows sending emails from
|
||||
the whole subdomain.
|
||||
|
||||
```yaml
|
||||
smtp:
|
||||
host: "mail.open.desk"
|
||||
username: "openDesk"
|
||||
password: "secret"
|
||||
```
|
||||
|
||||
### TURN configuration
|
||||
|
||||
Some components (Jitsi, Element) use for direct communication a TURN server. You can configure your own TURN server with
|
||||
these options:
|
||||
|
||||
```yaml
|
||||
turn:
|
||||
transport: "udp" # or tcp
|
||||
credentials: "secret"
|
||||
server:
|
||||
host: "turn.open.desk"
|
||||
port: "3478"
|
||||
tls:
|
||||
host: "turns.open.desk"
|
||||
port: "5349"
|
||||
```
|
||||
|
||||
### Certificate issuer
|
||||
|
||||
As mentioned in [requirements](requirements.md#certificate-management) you can provide your own valid certificate. A TLS
|
||||
secret with name `opendesk-certificates-tls` needs to be present in application namespace. For deployment, you can
|
||||
disable `Certificate` resource creation by:
|
||||
|
||||
```yaml
|
||||
certificates:
|
||||
enabled: false
|
||||
```
|
||||
|
||||
If you want to leverage the `cert-manager.io` to handle certificates, like `Let's encrypt`, you need to provide the
|
||||
configured cluster issuer:
|
||||
|
||||
```yaml
|
||||
certificate:
|
||||
issuerRef:
|
||||
name: "letsencrypt-prod"
|
||||
```
|
||||
|
||||
Additionally, it is possible to request wildcard certificates by:
|
||||
|
||||
```yaml
|
||||
certificate:
|
||||
wildcard: true
|
||||
```
|
||||
|
||||
## Password seed
|
||||
|
||||
All secrets are generated from a single master password via Master Password (algorithm).
|
||||
To prevent others from using your openDesk instance, we highly recommend setting an individual master password via:
|
||||
|
||||
```shell
|
||||
export MASTER_PASSWORD="openDesk"
|
||||
```
|
||||
|
||||
## Install
|
||||
|
||||
After setting your environment specific values in `dev` environment, you can start deployment by:
|
||||
|
||||
```shell
|
||||
helmfile apply -e dev -n <NAMESPACE> [-l <label>] [--suppress-diff]
|
||||
```
|
||||
|
||||
**Arguments:**
|
||||
|
||||
- `-e <env>`: Environment name out of `default`, `dev`, `test`, `prod`
|
||||
- `-n <namespace>`: Kubernetes namespace
|
||||
- `-l <label>`: Label selector
|
||||
- `--suppress-diff`: Disable diff printing
|
||||
|
||||
## Install single app
|
||||
|
||||
You can also install or upgrade only a single app like Collabora, either by label selector:
|
||||
|
||||
```shell
|
||||
helmfile apply -e dev -n <NAMESPACE> -l component=collabora
|
||||
```
|
||||
|
||||
or by switching into the apps' directory (faster):
|
||||
|
||||
```shell
|
||||
cd helmfile/apps/collabora
|
||||
helmfile apply -e dev -n <NAMESPACE>
|
||||
```
|
||||
|
||||
## Install single release/chart
|
||||
|
||||
Instead of iteration through all services, you can also deploy a single release like mariadb by:
|
||||
|
||||
```shell
|
||||
helmfile apply -e dev -n <NAMESPACE> -l name=mariadb
|
||||
```
|
||||
|
||||
# Access deployment
|
||||
|
||||
When all apps are successfully deployed and pod status' went to `Running` or `Succeeded`, you can navigate to
|
||||
|
||||
```text
|
||||
https://portal.domain.tld
|
||||
```
|
||||
|
||||
If you change the subdomain of `nubus`, you need to replace `portal` by your specified subdomain.
|
||||
|
||||
**Credentials:**
|
||||
|
||||
```shell
|
||||
# Replace with your namespace
|
||||
NAMESPACE=your-namespace
|
||||
|
||||
# Get ConfigMap with credentials
|
||||
kubectl -n ${NAMESPACE} get cm ums-stack-data-swp-data -o jsonpath='{.data.dev-test-users\.yaml}'
|
||||
```
|
||||
|
||||
Renders you a two part ConfigMap where the `username` and `password` attributes in the `properties`
|
||||
section provide you with the desired information to login with the two default user roles:
|
||||
|
||||
| Username | Password | Description |
|
||||
|-----------------|--------------------------------------------|------------------|
|
||||
| `default.user` | `40615..............................e9e2f` | Application user |
|
||||
| `default.admin` | `17027..............................04db6` | Administrator |
|
||||
|
||||
## Using from external repository
|
||||
|
||||
It is possible to refer to `./helmfile_generic.yaml` from an external
|
||||
directory or repository. The `helmfile.yaml` that refers to
|
||||
`./helmfile_generic.yaml` may define custom environments. These custom
|
||||
environments may overwrite certain configuration values. These
|
||||
configuration values are:
|
||||
|
||||
* `global.domain`
|
||||
* `global.helmRegistry`
|
||||
* `global.master_password`
|
||||
|
||||
# Uninstall
|
||||
|
||||
You can uninstall the deployment by:
|
||||
|
||||
```shell
|
||||
helmfile destroy -n <NAMESPACE>
|
||||
```
|
||||
|
||||
> **Note**
|
||||
> Not all Jobs, PersistentVolumeClaims or Certificates are deleted; you have to delete them manually
|
||||
|
||||
**'Sledgehammer destroy'** - for fast development turn-around times (at your own risk):
|
||||
|
||||
```shell
|
||||
NAMESPACE=your-namespace
|
||||
|
||||
# Uninstall all Helm charts
|
||||
for OPENDESK_RELEASE in $(helm ls -n ${NAMESPACE} -aq); do
|
||||
helm uninstall -n ${NAMESPACE} ${OPENDESK_RELEASE};
|
||||
done
|
||||
|
||||
# Delete leftover resources
|
||||
kubectl delete pvc --all --namespace ${NAMESPACE};
|
||||
kubectl delete jobs --all --namespace ${NAMESPACE};
|
||||
```
|
||||
|
||||
> **Warning**
|
||||
> Without specifying or empty `--namespace` flag, cluster-wide components get deleted!
|
||||
97
docs/migrations.md
Normal file
97
docs/migrations.md
Normal file
@@ -0,0 +1,97 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
<h1>Upgrade migrations</h1>
|
||||
|
||||
* [Disclaimer](#disclaimer)
|
||||
* [Releases upgrades](#releases-upgrades)
|
||||
* [From v0.9.0](#from-v090)
|
||||
* [Automated migrations](#automated-migrations)
|
||||
* [Updated IAM component Nubus](#updated-iam-component-nubus)
|
||||
* [Manual cleanup](#manual-cleanup)
|
||||
* [From v0.8.1](#from-v081)
|
||||
* [Updated `cluster.networking.cidr`](#updated-clusternetworkingcidr)
|
||||
* [Updated customizable template attributes](#updated-customizable-template-attributes)
|
||||
* [`migrations` S3 bucket](#migrations-s3-bucket)
|
||||
* [Related components and artefacts](#related-components-and-artefacts)
|
||||
* [Development](#development)
|
||||
|
||||
# Disclaimer
|
||||
|
||||
We do not offer support for upgrades before we reach openDesk 1.0.
|
||||
|
||||
Though we try to ease the pain when it comes to 0.x upgrades. That is what this document is for.
|
||||
|
||||
Limitations:
|
||||
- We assume that the PV reclaim policy is set to `delete`, so expect that PVs get deleted as soon as the related PVC was deleted and will cover an explicit delete for PVs.
|
||||
|
||||
# Releases upgrades
|
||||
|
||||
## From v0.9.0
|
||||
|
||||
### Automated migrations
|
||||
|
||||
#### Updated IAM component Nubus
|
||||
|
||||
openDesk is integrating the latest [Nubus](https://www.univention.de/produkte/nubus/) development from Univention. The now redundant and scalable LDAP requires migration activities. These have been automated to avoid manual interaction. The `run_2` of the openDesk
|
||||
upgrade migrations executes the following steps:
|
||||
|
||||
- Stage PRE:
|
||||
- Delete service `ums-keycloak`, as it will be recreated headless.
|
||||
- Scale down `statefulset/ums-ldap-server` and `statefulset/ums-ldap-notifier` in preparation or the next step:
|
||||
- Create two new PVCs `shared-data-ums-ldap-server-primary-0` and `shared-data-ums-ldap-server-primary-1` for the new LDAP primary pods as copy from the existing `shared-data-ums-ldap-server-0`. The LDAP secondaries will sync from the primary nodes.
|
||||
- Stage POST:
|
||||
- Restart Keycloak.
|
||||
|
||||
##### Manual cleanup
|
||||
|
||||
Currently we do not execute possible cleanup steps as part of the migrations POST stage. So you might want to remove the no longer used PVCs after successful upgrade:
|
||||
```
|
||||
NAMESPACE=<your_namespace>
|
||||
kubectl -n ${NAMESPACE} delete pvc shared-data-ums-ldap-server-0
|
||||
kubectl -n ${NAMESPACE} delete pvc shared-run-ums-ldap-server-0
|
||||
```
|
||||
|
||||
## From v0.8.1
|
||||
|
||||
### Updated `cluster.networking.cidr`
|
||||
|
||||
- Action: `cluster.networking.cidr` is now an array (was a string until 0.8.1), please update your setup accordingly if you explicitly set this value.
|
||||
- Reference:[cluster.yaml](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/main/helmfile/environments/default/cluster.yaml)
|
||||
|
||||
### Updated customizable template attributes
|
||||
|
||||
- Action: Please ensure you update you custom deployment values according with the updated default value structure.
|
||||
- References:
|
||||
- `functional.` prefix for `authentication.*`, `externalServices.*`, `admin.*` and `filestore.*`, see [functional.yaml](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/main/helmfile/environments/default/functional.yaml).
|
||||
- `debug.` prefix for `cleanup.*`, see [debug.yaml](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/main/helmfile/environments/default/debug.yaml).
|
||||
- `monitoring.` prefix for `prometheus.*` and `graphana.*`, see [monitoring.yaml](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/main/helmfile/environments/default/monitoring.yaml).
|
||||
- `smtp.` prefix for `localpartNoReply`, see [smtp.yaml](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/main/helmfile/environments/default/smtp.yaml).
|
||||
|
||||
### `migrations` S3 bucket
|
||||
|
||||
- Action: For self managed/external S3/object storages, please ensure you add a bucket `migrations` to your S3.
|
||||
- Reference: `objectstores.migrations` in [objectstores.yaml](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/main/helmfile/environments/default/objectstores.yaml)
|
||||
|
||||
# Related components and artefacts
|
||||
|
||||
openDesk comes with two upgrade steps as part of the deployment, they can be found in the folder [/helmfile/apps](../helmfile/apps/) as all other components:
|
||||
|
||||
- `migrations-pre`: Is the very first app that gets deployed.
|
||||
- `migrations-post`: Is the last app that gets deployed.
|
||||
|
||||
Both migrations have to be deployed exclusively at their first/last position and not in parallel with other components.
|
||||
|
||||
The status of the upgrade migrations is tracked in the ConfigMap `migrations-status`, more details can be found in the [README.md of the related container image](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-migrations/README.md).
|
||||
|
||||
## Development
|
||||
|
||||
When a new upgrade migration is required, ensure to address the following list:
|
||||
|
||||
- Update the generated release version file [`global.generated.yaml`](../helmfile/environments/default/global.generated.yaml) at least on the patch level to test the upgrade in your feature branch as well as trigger it in the `develop` branch after the feature branch was merged. The set value gets overwritten during the release process with the release's actual version number.
|
||||
- You have to implement the migration logic as a runner script in the [`opendesk-migrations`](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/opendesk-migrations) image. Please find more instructions in the linked repository.
|
||||
- You most likely have to update the [`opendesk-migrations` Helm chart](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-migrations) within the `rules` section of the [`role.yaml`](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-migrations/-/blob/main/charts/opendesk-migrations/templates/role.yaml) to provide the permissions required for the execution of your migration's logic.
|
||||
- You have to set the runner's ID you want to execute in the [migrations.yaml.gotmpl](../helmfile/shared/migrations.yaml.gotmpl). See also the `migrations.*` section of [the Helm chart's README.md](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-migrations/-/blob/main/charts/opendesk-migrations/README.md).
|
||||
- Update the [`charts.yaml`](../helmfile/environments/default/charts.yaml) and [`images.yaml`](../helmfile/environments/default/images.yaml) to reflect the newer releases of the `opendesk-migrations` Helm chart and container image.
|
||||
72
docs/monitoring.md
Normal file
72
docs/monitoring.md
Normal file
@@ -0,0 +1,72 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
<h1>Monitoring</h1>
|
||||
|
||||
This document will cover how you can enable observability with Prometheus based monitoring and Grafana dashboards, as
|
||||
well as the overall status of monitoring integration.
|
||||
|
||||
<!-- TOC -->
|
||||
* [Technology](#technology)
|
||||
* [Defaults](#defaults)
|
||||
* [Metrics](#metrics)
|
||||
* [Alerts](#alerts)
|
||||
* [Dashboards for Grafana](#dashboards-for-grafana)
|
||||
* [Components](#components)
|
||||
<!-- TOC -->
|
||||
|
||||
# Technology
|
||||
|
||||
We provide integration into the Prometheus based monitoring.
|
||||
Together with
|
||||
[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) you
|
||||
easily leverage the full potential of open-source cloud-native observability stack.
|
||||
|
||||
Before enabling the following options, you need to install the respective CRDs from the kube-prometheus-stack
|
||||
repository or prometheus operator.
|
||||
|
||||
# Defaults
|
||||
|
||||
All configurable options and their defaults can be found in
|
||||
[`monitoring.yaml`](../helmfile/environments/default/monitoring.yaml).
|
||||
|
||||
# Metrics
|
||||
|
||||
To deploy podMonitor and serviceMonitor custom resources, enable it by:
|
||||
|
||||
```yaml
|
||||
prometheus:
|
||||
serviceMonitors:
|
||||
enabled: true
|
||||
podMonitors:
|
||||
enabled: true
|
||||
```
|
||||
|
||||
# Alerts
|
||||
|
||||
Some helm-charts provide a default set of prometheusRules for alerting, enable it by:
|
||||
|
||||
```yaml
|
||||
prometheus:
|
||||
prometheusRules:
|
||||
enabled: true
|
||||
```
|
||||
|
||||
# Dashboards for Grafana
|
||||
|
||||
To deploy optional ConfigMaps with Grafana dashboards, enable it by:
|
||||
|
||||
```yaml
|
||||
grafana:
|
||||
dashboards:
|
||||
enabled: true
|
||||
```
|
||||
|
||||
# Components
|
||||
|
||||
| Component | Metrics (pod- or serviceMonitor) | Alerts (prometheusRule) | Dashboard (Grafana) |
|
||||
|:----------|-----------------------------------|-------------------------|---------------------|
|
||||
| Collabora | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
||||
| Nextcloud | :white_check_mark: | :x: | :x: |
|
||||
104
docs/requirements.md
Normal file
104
docs/requirements.md
Normal file
@@ -0,0 +1,104 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
<h1>Requirements</h1>
|
||||
|
||||
This section covers the internal system requirements as well as external service requirements for productive use.
|
||||
|
||||
<!-- TOC -->
|
||||
* [tl;dr](#tldr)
|
||||
* [Hardware](#hardware)
|
||||
* [Kubernetes](#kubernetes)
|
||||
* [Ingress controller](#ingress-controller)
|
||||
* [Volume provisioner](#volume-provisioner)
|
||||
* [Certificate management](#certificate-management)
|
||||
* [External services](#external-services)
|
||||
* [Deployment](#deployment)
|
||||
<!-- TOC -->
|
||||
|
||||
# tl;dr
|
||||
openDesk is a Kubernetes only solution and requires an existing Kubernetes (K8s) cluster.
|
||||
|
||||
- K8s cluster >= 1.24, [CNCF Certified Kubernetes distribution](https://www.cncf.io/certification/software-conformance/)
|
||||
- Domain and DNS Service
|
||||
- Ingress controller (Ingress NGINX)
|
||||
- [Helm](https://helm.sh/) >= v3.9.0
|
||||
- [Helmfile](https://helmfile.readthedocs.io/en/latest/) >= **v0.157.0**
|
||||
- [HelmDiff](https://github.com/databus23/helm-diff) >= 3.6.0
|
||||
- Volume provisioner supporting RWO (read-write-once)
|
||||
- Certificate handling with [cert-manager](https://cert-manager.io/)
|
||||
|
||||
# Hardware
|
||||
|
||||
The following minimal requirements are thought for initial evaluation deployment:
|
||||
|
||||
| Spec | Value |
|
||||
| ---- | ----------------------------------------------------- |
|
||||
| CPU | 12 Cores of x64 or x86 CPU (ARM is not supported yet) |
|
||||
| RAM | 32 GB, more recommended |
|
||||
| Disk | HDD or SSD, >10 GB |
|
||||
|
||||
Check [`scaling.md`](./scaling.md) for more details on resource requirements and scalability.
|
||||
|
||||
# Kubernetes
|
||||
|
||||
Any self-hosted or managed K8s cluster >= 1.24 listed in
|
||||
[CNCF Certified Kubernetes distributions](https://www.cncf.io/certification/software-conformance/) should be supported.
|
||||
|
||||
The deployment is tested against [kubespray](https://github.com/kubernetes-sigs/kubespray) based clusters.
|
||||
|
||||
> **Note:** The deployment is not tested against OpenShift.
|
||||
|
||||
# Ingress controller
|
||||
|
||||
The deployment is intended to use only over HTTPS via a configured FQDN, therefor it is required to have a proper
|
||||
configured ingress controller deployed.
|
||||
|
||||
**Supported controllers:**
|
||||
- [Ingress NGINX Controller](https://github.com/kubernetes/ingress-nginx)
|
||||
|
||||
Note: The platform development team is evaluating the use of [Gateway API](https://gateway-api.sigs.k8s.io/).
|
||||
If you have feedback on that topic, please share it with us.
|
||||
|
||||
# Volume provisioner
|
||||
|
||||
Initial evaluation deployment requires a `ReadWriteOnce` volume provisioner. For local deployment a local- or hostPath-
|
||||
provisioner is sufficient.
|
||||
|
||||
> **Note:** Some components requiring a `ReadWriteMany` volume provisioner for distributed mode or scaling.
|
||||
|
||||
# Certificate management
|
||||
|
||||
This deployment leverages [cert-manager](https://cert-manager.io/) to generate valid certificates. This is **optional**,
|
||||
but a secret containing a valid TLS certificate is required.
|
||||
|
||||
Only `Certificate` resources will be deployed, the `cert-manager` including its CRD must be installed prior to this or
|
||||
openDesk certificate management disabled.
|
||||
|
||||
# External services
|
||||
|
||||
For development and evaluation of openDesk we bundle some service to start with. Be aware that for production
|
||||
deployments you need to make use of your own production grade services, see the
|
||||
[external-services.md](./external-services.md) for configuration details.
|
||||
|
||||
| Group | Type | Version | Tested against |
|
||||
| -------- | ------------------- | ------- | --------------------- |
|
||||
| Cache | Memcached | `1.6.x` | Memcached |
|
||||
| | Redis | `7.x.x` | Redis |
|
||||
| Database | MariaDB | `10.x` | MariaDB |
|
||||
| | PostgreSQL | `15.x` | PostgreSQL |
|
||||
| Mail | Mail Transfer Agent | | Postfix |
|
||||
| | PKI/CI (S/MIME) | | |
|
||||
| Security | AntiVirus/ICAP | | ClamAV |
|
||||
| Storage | K8s ReadWriteOnce | | Ceph / Cloud specific |
|
||||
| | K8s ReadWriteMany | | Ceph / NFS |
|
||||
| | Object Storage | | MinIO |
|
||||
| Voice | TURN | | Coturn |
|
||||
|
||||
# Deployment
|
||||
|
||||
The deployment of each individual component is [Helm](https://helm.sh/) based. The 35+ Helm charts are configured and
|
||||
templated via [Helmfile](https://helmfile.readthedocs.io/en/latest/) to provide a streamlined deployment experience.
|
||||
|
||||
Helmfile requires [HelmDiff](https://github.com/databus23/helm-diff) to compare desired against deployed state.
|
||||
23
docs/scaling.md
Normal file
23
docs/scaling.md
Normal file
@@ -0,0 +1,23 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
<h1>Scaling</h1>
|
||||
|
||||
This document should cover the abilities to scale apps.
|
||||
|
||||
# Horizontal scalability
|
||||
|
||||
We are working on generating this document automatically based on the file
|
||||
[`replicas.yaml`](../helmfile/environments/default/replicas.yaml) that contains necessary annotations.
|
||||
In the meantime this file can be used to check the components scaling support / capabilities.
|
||||
|
||||
# Upstream information
|
||||
|
||||
While scaling services horizontally is the ideal solution, information about vertical scaling is helpful
|
||||
when it comes to defining the applications resources, see [`resources.yaml`](../helmfile/environments/default/resources.yaml) for references.
|
||||
|
||||
Please find below links to the application's upstream resources about scaling:
|
||||
|
||||
- [OpenProject system requirements](https://www.openproject.org/docs/installation-and-operations/system-requirements/)
|
||||
214
docs/security-context.md
Normal file
214
docs/security-context.md
Normal file
@@ -0,0 +1,214 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2024 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
<h1>Kubernetes Security Context</h1>
|
||||
|
||||
* [Container Security Context](#container-security-context)
|
||||
* [allowPrivilegeEscalation](#allowprivilegeescalation)
|
||||
* [capabilities](#capabilities)
|
||||
* [privileged](#privileged)
|
||||
* [runAsUser](#runasuser)
|
||||
* [runAsGroup](#runasgroup)
|
||||
* [seccompProfile](#seccompprofile)
|
||||
* [readOnlyRootFilesystem](#readonlyrootfilesystem)
|
||||
* [runAsNonRoot](#runasnonroot)
|
||||
* [Status quo](#status-quo)
|
||||
|
||||
# Container Security Context
|
||||
|
||||
|
||||
The containerSecurityContext is the most important security-related section because it has the highest precedence and restricts the container to its minimal privileges.
|
||||
|
||||
## allowPrivilegeEscalation
|
||||
|
||||
|
||||
Privilege escalation (such as via set-user-ID or set-group-ID file mode) should not be allowed (Linux only) at any time.
|
||||
|
||||
```yaml
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
```
|
||||
|
||||
## capabilities
|
||||
|
||||
|
||||
Containers must drop ALL capabilities, and are only permitted to add back the `NET_BIND_SERVICE` capability (Linux only).
|
||||
|
||||
|
||||
**Optimal:**
|
||||
|
||||
```yaml
|
||||
containerSecurityContext:
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
```
|
||||
|
||||
|
||||
**Allowed:**
|
||||
|
||||
```yaml
|
||||
containerSecurityContext:
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
add:
|
||||
- "NET_BIND_SERVICE"
|
||||
```
|
||||
|
||||
## privileged
|
||||
|
||||
|
||||
Privileged Pods disable most security mechanisms and must be disallowed.
|
||||
|
||||
```yaml
|
||||
containerSecurityContext:
|
||||
privileged: false
|
||||
```
|
||||
|
||||
## runAsUser
|
||||
|
||||
|
||||
Containers should set a user id >= 1000 and never use 0 (root) as user.
|
||||
|
||||
```yaml
|
||||
containerSecurityContext:
|
||||
runAsUser: 1000
|
||||
```
|
||||
|
||||
## runAsGroup
|
||||
|
||||
|
||||
Containers should set a group id >= 1000 and never use 0 (root) as user.
|
||||
|
||||
```yaml
|
||||
containerSecurityContext:
|
||||
runAsGroup: 1000
|
||||
```
|
||||
|
||||
## seccompProfile
|
||||
|
||||
|
||||
Seccomp profile must be explicitly set to one of the allowed values. An unconfined profile and the complete absence of the profile are prohibited.
|
||||
|
||||
```yaml
|
||||
containerSecurityContext:
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
```
|
||||
|
||||
|
||||
or
|
||||
|
||||
```yaml
|
||||
containerSecurityContext:
|
||||
seccompProfile:
|
||||
type: "Localhost"
|
||||
```
|
||||
|
||||
## readOnlyRootFilesystem
|
||||
|
||||
|
||||
Containers should have an immutable file systems, so that attackers could not modify application code or download malicious code.
|
||||
|
||||
```yaml
|
||||
containerSecurityContext:
|
||||
readOnlyRootFilesystem: true
|
||||
```
|
||||
|
||||
## runAsNonRoot
|
||||
|
||||
|
||||
Containers must be required to run as non-root users.
|
||||
|
||||
```yaml
|
||||
containerSecurityContext:
|
||||
runAsNonRoot: true
|
||||
```
|
||||
|
||||
# Status quo
|
||||
|
||||
|
||||
openDesk aims to achieve that all security relevant settings are explicitly templated and comply with security recommendations.
|
||||
|
||||
|
||||
The rendered manifests are also validated against Kyverno [policies](/.kyverno/policies) in CI to ensure that the provided values inside openDesk are also properly templated by the given Helm charts.
|
||||
|
||||
|
||||
This list gives you an overview of templated security settings and if they comply with security standards:
|
||||
|
||||
|
||||
- **yes**: Value is set to `true`
|
||||
- **no**: Value is set to `false`
|
||||
- **n/a**: No explicitly templated in openDesk and default is used.
|
||||
|
||||
| process | status | allowPrivilegeEscalation | privileged | readOnlyRootFilesystem | runAsNonRoot | runAsUser | runAsGroup | seccompProfile | capabilities |
|
||||
| ------- | ------ | ------------------------ | ---------- | ---------------------- | ------------ | --------- | ---------- | -------------- | ------------ |
|
||||
| **collabora**/collabora-online | :x: | yes | no | no | yes | 100 | 101 | yes | no ["CHOWN","DAC_OVERRIDE","FOWNER","FSETID","KILL","SETGID","SETUID","SETPCAP","NET_BIND_SERVICE","NET_RAW","SYS_CHROOT","MKNOD"] |
|
||||
| **cryptpad**/cryptpad | :x: | no | no | no | yes | 4001 | 4001 | yes | yes |
|
||||
| **element**/matrix-neoboard-widget | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
|
||||
| **element**/matrix-neochoice-widget | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
|
||||
| **element**/matrix-neodatefix-bot | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
|
||||
| **element**/matrix-neodatefix-bot-bootstrap | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
|
||||
| **element**/matrix-neodatefix-widget | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
|
||||
| **element**/opendesk-element | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
|
||||
| **element**/opendesk-matrix-user-verification-service | :x: | no | no | no | no | 0 | 0 | yes | yes |
|
||||
| **element**/opendesk-matrix-user-verification-service-bootstrap | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
|
||||
| **element**/opendesk-synapse | :white_check_mark: | no | no | yes | yes | 10991 | 10991 | yes | yes |
|
||||
| **element**/opendesk-synapse-web | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
|
||||
| **element**/opendesk-well-known | :white_check_mark: | no | no | yes | yes | 101 | 101 | yes | yes |
|
||||
| **intercom-service**/intercom-service | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||
| **jitsi**/jitsi | :white_check_mark: | no | no | yes | yes | 1993 | 1993 | yes | yes |
|
||||
| **jitsi**/jitsi/jitsi/jibri | :x: | n/a | n/a | n/a | n/a | n/a | n/a | n/a | no ["SYS_ADMIN"] |
|
||||
| **jitsi**/jitsi/jitsi/jicofo | :x: | no | no | no | no | 0 | 0 | yes | no |
|
||||
| **jitsi**/jitsi/jitsi/jvb | :x: | no | no | no | no | 0 | 0 | yes | no |
|
||||
| **jitsi**/jitsi/jitsi/prosody | :x: | no | no | no | no | 0 | 0 | yes | no |
|
||||
| **jitsi**/jitsi/jitsi/web | :x: | no | no | no | no | 0 | 0 | yes | no |
|
||||
| **jitsi**/jitsi/patchJVB | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
|
||||
| **nextcloud**/opendesk-nextcloud-management | :x: | no | no | no | yes | 65532 | 65532 | yes | yes |
|
||||
| **nextcloud**/opendesk-nextcloud/apache2 | :white_check_mark: | no | no | yes | yes | 65532 | 65532 | yes | yes |
|
||||
| **nextcloud**/opendesk-nextcloud/exporter | :white_check_mark: | no | no | yes | yes | 65532 | 65532 | yes | yes |
|
||||
| **nextcloud**/opendesk-nextcloud/php | :white_check_mark: | no | no | yes | yes | 65532 | 65532 | yes | yes |
|
||||
| **open-xchange**/dovecot | :x: | no | n/a | yes | n/a | n/a | n/a | yes | no ["CHOWN","DAC_OVERRIDE","KILL","NET_BIND_SERVICE","SETGID","SETUID","SYS_CHROOT"] |
|
||||
| **open-xchange**/open-xchange/appsuite/core-documentconverter | :x: | no | no | no | yes | 987 | 1000 | yes | yes |
|
||||
| **open-xchange**/open-xchange/appsuite/core-guidedtours | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||
| **open-xchange**/open-xchange/appsuite/core-imageconverter | :x: | no | no | no | yes | 987 | 1000 | yes | yes |
|
||||
| **open-xchange**/open-xchange/appsuite/core-mw/gotenberg | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
|
||||
| **open-xchange**/open-xchange/appsuite/core-ui | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||
| **open-xchange**/open-xchange/appsuite/core-ui-middleware | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||
| **open-xchange**/open-xchange/appsuite/core-user-guide | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||
| **open-xchange**/open-xchange/appsuite/guard-ui | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||
| **open-xchange**/open-xchange/nextcloud-integration-ui | :x: | no | no | no | yes | 1000 | 1000 | yes | yes |
|
||||
| **open-xchange**/open-xchange/public-sector-ui | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||
| **openproject**/openproject | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||
| **openproject-bootstrap**/opendesk-openproject-bootstrap | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||
| **provisioning**/ox-connector | :x: | no | no | no | no | 0 | 0 | yes | no ["CHOWN","DAC_OVERRIDE","FOWNER","FSETID","KILL","SETGID","SETUID","SETPCAP","NET_BIND_SERVICE","NET_RAW","SYS_CHROOT"] |
|
||||
| **services**/clamav | :x: | no | no | yes | no | 0 | 0 | yes | no |
|
||||
| **services**/clamav-simple | :white_check_mark: | no | no | yes | yes | 100 | 101 | yes | yes |
|
||||
| **services**/clamav/clamd | :white_check_mark: | no | no | yes | yes | 100 | 101 | yes | yes |
|
||||
| **services**/clamav/freshclam | :white_check_mark: | no | no | yes | yes | 100 | 101 | yes | yes |
|
||||
| **services**/clamav/icap | :white_check_mark: | no | no | yes | yes | 100 | 101 | yes | yes |
|
||||
| **services**/clamav/milter | :white_check_mark: | no | no | yes | yes | 100 | 101 | yes | yes |
|
||||
| **services**/mariadb | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
|
||||
| **services**/memcached | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
|
||||
| **services**/minio | :x: | no | no | no | yes | 1000 | 0 | yes | yes |
|
||||
| **services**/postfix | :x: | yes | yes | no | no | 0 | 0 | yes | no |
|
||||
| **services**/postgresql | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
|
||||
| **services**/redis/master | :white_check_mark: | no | no | yes | yes | 1001 | 1001 | yes | yes |
|
||||
| **univention-management-stack**/opendesk-keycloak-bootstrap | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||
| **univention-management-stack**/ums/keycloak | :x: | no | no | no | yes | 1000 | 1000 | yes | yes |
|
||||
| **univention-management-stack**/ums/keycloak-bootstrap | :x: | no | no | no | yes | 1000 | 1000 | yes | yes |
|
||||
| **univention-management-stack**/ums/keycloak-extensions/handler | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||
| **univention-management-stack**/ums/keycloak-extensions/proxy | :white_check_mark: | no | no | yes | yes | 1000 | 1000 | yes | yes |
|
||||
| **univention-management-stack**/ums/ldap-notifier | :x: | n/a | n/a | n/a | n/a | n/a | n/a | yes | no |
|
||||
| **univention-management-stack**/ums/portal-listener | :x: | no | no | no | no | 0 | 0 | yes | no ["CHOWN","DAC_OVERRIDE","FOWNER","FSETID","KILL","SETGID","SETUID","SETPCAP","NET_BIND_SERVICE","NET_RAW","SYS_CHROOT"] |
|
||||
| **univention-management-stack**/ums/selfservice-listener | :x: | no | no | no | no | 0 | 0 | yes | no ["CHOWN","DAC_OVERRIDE","FOWNER","FSETID","KILL","SETGID","SETUID","SETPCAP","NET_BIND_SERVICE","NET_RAW","SYS_CHROOT"] |
|
||||
| **univention-management-stack**/ums/stack-data-swp | :x: | no | no | no | no | 0 | 0 | yes | yes |
|
||||
| **univention-management-stack**/ums/stack-gateway | :x: | no | no | no | yes | 1001 | 0 | yes | yes |
|
||||
| **univention-management-stack**/ums/umc-gateway | :x: | no | no | no | no | 0 | 0 | yes | no ["CHOWN","DAC_OVERRIDE","FOWNER","FSETID","KILL","SETGID","SETUID","SETPCAP","NET_BIND_SERVICE","NET_RAW","SYS_CHROOT"] |
|
||||
| **univention-management-stack**/ums/umc-server | :x: | no | no | no | no | 0 | 0 | yes | no ["CHOWN","DAC_OVERRIDE","FOWNER","FSETID","KILL","SETGID","SETUID","SETPCAP","NET_BIND_SERVICE","NET_RAW","SYS_CHROOT"] |
|
||||
| **xwiki**/xwiki | :x: | no | no | no | yes | 100 | 101 | yes | yes |
|
||||
|
||||
|
||||
This file is auto-generated by [openDesk CI CLI](https://gitlab.opencode.de/bmi/opendesk/tooling/opendesk-ci-cli)
|
||||
51
docs/security.md
Normal file
51
docs/security.md
Normal file
@@ -0,0 +1,51 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
<h1>Security</h1>
|
||||
|
||||
This document should cover the current status of security measurements.
|
||||
|
||||
<!-- TOC -->
|
||||
* [Helm Chart Trust Chain](#helm-chart-trust-chain)
|
||||
* [Kubernetes Security Enforcements](#kubernetes-security-enforcements)
|
||||
* [NetworkPolicies](#networkpolicies)
|
||||
<!-- TOC -->
|
||||
|
||||
# Helm Chart Trust Chain
|
||||
|
||||
Helm charts are signed and validated against GPG keys which can be found in `helmfile/files/gpg-pubkeys`.
|
||||
|
||||
For more details on Chart validation please visit: https://helm.sh/docs/topics/provenance/
|
||||
|
||||
All charts except the ones mentioned below are verifiable:
|
||||
|
||||
| Repository | Verifiable |
|
||||
|-------------------|:----------:|
|
||||
| open-xchange-repo | no |
|
||||
|
||||
# Kubernetes Security Enforcements
|
||||
|
||||
This list gives you an overview of default security settings and if they comply with security standards:
|
||||
|
||||
⟶ Visit our generated detailed [Security Context](./security-context.md) overview.
|
||||
|
||||
# NetworkPolicies
|
||||
|
||||
Kubernetes NetworkPolicies are an important measure to secure your kubernetes apps and clusters.
|
||||
When applied, they restrict the traffic to your services.
|
||||
This protects other deployments in your cluster or other services in your deployment to get compromised when one
|
||||
component is compromised.
|
||||
|
||||
We ship a default set of Otterize ClientIntents via
|
||||
[Otterize intents operator](https://github.com/otterize/intents-operator) which translates intent-based access control
|
||||
(IBAC) into kubernetes native NetworkPolicies.
|
||||
|
||||
This requires the Otterize intents operator to be installed.
|
||||
|
||||
```yaml
|
||||
security:
|
||||
otterizeIntents:
|
||||
enabled: true
|
||||
```
|
||||
57
docs/theming.md
Normal file
57
docs/theming.md
Normal file
@@ -0,0 +1,57 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
<h1>Theming</h1>
|
||||
|
||||
This document will cover the theming and customization of your openDesk deployment.
|
||||
|
||||
<!-- TOC -->
|
||||
* [Strings and texts](#strings-and-texts)
|
||||
* [Colors](#colors)
|
||||
* [Images and Logos](#images-and-logos)
|
||||
* [Known limits](#known-limits)
|
||||
<!-- TOC -->
|
||||
|
||||
# Strings and texts
|
||||
|
||||
The deployment name can be changed by:
|
||||
|
||||
```yaml
|
||||
theme:
|
||||
texts:
|
||||
productName: "openDesk Cloud"
|
||||
```
|
||||
|
||||
# Colors
|
||||
|
||||
The primary color and their derives with lesser opacity be customized by:
|
||||
|
||||
```yaml
|
||||
theme:
|
||||
colors:
|
||||
primary: "#5e27dd"
|
||||
primary65: "#9673e9"
|
||||
primary35: "#c7b3f3"
|
||||
primary15: "#e7dffa"
|
||||
```
|
||||
|
||||
## Images and Logos
|
||||
|
||||
You can customize the logo and favicon by providing SVG or icon as inline value:
|
||||
|
||||
```yaml
|
||||
theme:
|
||||
imagery:
|
||||
logoHeaderSvg: '<?xml version="1.0" encoding="UTF-8"?>...</svg>'
|
||||
logoHeaderSvgWhite: '<?xml version="1.0" encoding="UTF-8"?>...</svg>'
|
||||
logoPortalBackgroundSvg: '<?xml version="1.0" encoding="UTF-8"?>...</svg>'
|
||||
faviconIco: "..."
|
||||
```
|
||||
|
||||
# Known limits
|
||||
|
||||
Not all applications support theming. Known exceptions are:
|
||||
- OpenProject
|
||||
- Jitsi
|
||||
384
docs/workflow.md
Normal file
384
docs/workflow.md
Normal file
@@ -0,0 +1,384 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
<h1>Technical development and release workflow</h1>
|
||||
|
||||
* [Scope](#scope)
|
||||
* [Roles and responsibilities](#roles-and-responsibilities)
|
||||
* [Deployment automation](#deployment-automation)
|
||||
* [openDesk technical component classes](#opendesk-technical-component-classes)
|
||||
* [Functional vs. service components](#functional-vs-service-components)
|
||||
* [Origins](#origins)
|
||||
* [Reference CI for creating Images and Helm charts (gitlab-config)](#reference-ci-for-creating-images-and-helm-charts-gitlab-config)
|
||||
* [Licensing](#licensing)
|
||||
* [Development workflow](#development-workflow)
|
||||
* [Disclaimer](#disclaimer)
|
||||
* [Workflow](#workflow)
|
||||
* [Branching concept](#branching-concept)
|
||||
* [Standard Quality Gate (SQG)](#standard-quality-gate-sqg)
|
||||
* [Branch workflows](#branch-workflows)
|
||||
* [`main`](#main)
|
||||
* [`develop`](#develop)
|
||||
* [`docs`](#docs)
|
||||
* [`fix`](#fix)
|
||||
* [`feat`](#feat)
|
||||
* [Branch names](#branch-names)
|
||||
* [Commit messages / Conventional Commits](#commit-messages--conventional-commits)
|
||||
* [Verified commits](#verified-commits)
|
||||
* [Footnotes](#footnotes)
|
||||
|
||||
# Scope
|
||||
|
||||
This document covers the development of a technical release, thereby addressing
|
||||
- the development and branching concept for the openDesk deployment automation,
|
||||
- the related quality gates and
|
||||
- how technical releases are being created.
|
||||
|
||||
It does not cover additional artifacts that might be related to a functional release.
|
||||
|
||||
# Roles and responsibilities
|
||||
|
||||
The following section should provide a high-level view of the involved parties in the openDesk context and their responsibilities:
|
||||
|
||||
- **Open source product suppliers**
|
||||
- Focus areas
|
||||
- Development of upstream products
|
||||
- Development of integrative functionality relevant to openDesk and others
|
||||
- Providing source code and the artifacts required to install openDesk to Open CoDE
|
||||
- Hand over to _openDesk platform development_
|
||||
- Helm charts
|
||||
- Container images
|
||||
- Documentation
|
||||
- **openDesk platform development**
|
||||
- Focus areas
|
||||
- Integration of the supplier's artifacts addressing basic operational needs
|
||||
- Implementation of services required (e.g. persistence layer) to develop and test openDesk
|
||||
- Implementation of the required quality gates (QG)
|
||||
- Ensuring the quality gates are passed
|
||||
- Hand over to _Operator_
|
||||
- Deployment automation
|
||||
- **Operator**
|
||||
- Focus areas
|
||||
- Providing production-grade required services (e.g. persistence layer) to operate openDesk
|
||||
- Rollout, operate, and support openDesk
|
||||
- Further develop the deployment automation to meet extended operational requirements, ideally providing these developments upstream to openDesk platform development to adopt them into the standard
|
||||
- The operator can either use a self-operated Kubernetes cluster to deploy openDesk or make use of managed Kubernetes offerings of a **Cloud Provider**.
|
||||
|
||||
# Deployment automation
|
||||
|
||||
The openDesk deployment automation is the core outcome of the platform development process.
|
||||
|
||||
The openDesk platform development team created and maintains the deployment automation to allow interested parties to deploy openDesk into their cloud infrastructure with a low entry barrier. The core technology for the automation are [Helm charts](https://helm.sh/) which are orchestrated using [Helmfile](https://github.com/helmfile/helmfile). Of course this deployment is also used in the everyday work by the suppliers and the platform team.
|
||||
|
||||
Please find the deployment automation including the relevant documentation here: https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace
|
||||
|
||||
The automation supports Gitlab CI/CD execution as well as local execution triggering the Helmfile deployment for the whole platform or single applications.
|
||||
|
||||
## openDesk technical component classes
|
||||
|
||||
The below rendering in class diagram notation shows the three component classes openDesk consists of. In each of these:
|
||||
- the first section below the name of the class shows the required **characteristics** of each component of the given class, and
|
||||
- the second section shows the **methods** like linting that have to be applied to artifacts of that class.
|
||||
|
||||
**Note:** The methods prefixed with '-' are not yet available in `gitlab-config` you will learn about them later.
|
||||
|
||||
```mermaid
|
||||
classDiagram
|
||||
Images <|-- Helm_charts
|
||||
Images <|-- Helmfile_based_deployment_automation
|
||||
Helm_charts <|-- Helmfile_based_deployment_automation
|
||||
class Images{
|
||||
SBOM
|
||||
SBOM signature
|
||||
Image signature
|
||||
reuseLint()
|
||||
CVE analysis()
|
||||
hadolint()
|
||||
Malware scan()
|
||||
}
|
||||
class Helm_charts{
|
||||
HelmDocs
|
||||
Helm chart signature
|
||||
reuseLint()
|
||||
KubeLinter()
|
||||
YamlLint()
|
||||
-Kubescape()
|
||||
}
|
||||
class Helmfile_based_deployment_automation{
|
||||
reuseLint()
|
||||
YamlLint()
|
||||
-markdownlint()
|
||||
}
|
||||
```
|
||||
|
||||
## Functional vs. service components
|
||||
|
||||
The focus of openDesk is to provide an integrated functional productivity platform based on the functional components (products) of the involved suppliers. These functional components usually rely on certain service components, e.g. database services for persistence. When running openDesk in production the operator is responsible for providing these services production grade. For evaluation and development purposes the openDesk deployment automation includes these services.
|
||||
|
||||
Find the list of functional and service components in the [deployment automation's components.md](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/blob/main/docs/components.md).
|
||||
|
||||
## Origins
|
||||
|
||||
The openDesk platform consolidates the technical components from various origins:
|
||||
|
||||
1) Supplier - for functional components: Provide their upstream product including sometimes openDesk-specific builds or extensions and also the deployment of the product (Helm charts).
|
||||
2) 3rd party upstream - for service components: The platform development tries to use as many as possible community upstream components for the services they have to provide within openDesk.
|
||||
3) Platform development - filling the gap: Some suppliers might not provide Helm charts or images for their product that fit the needs of openDesk and some 3rd party upstream components are not built to fit into openDesk. In these cases, the platform development team creates their own Helm charts and images.
|
||||
|
||||
## Reference CI for creating Images and Helm charts (gitlab-config)
|
||||
|
||||
As mentioned in the chapter "Origins" above, the openDesk platform development also creates images and Helm charts when needed.
|
||||
|
||||
For that purpose openDesk provides a [GitLab CI-based reference implementation](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/tooling/gitlab-config) called `gitlab-config` to achieve the required characteristics and apply the necessary methods including releasing the artifacts based on [Semantic Release](https://github.com/semantic-release/semantic-release#readme) into the GitLab container registry.
|
||||
|
||||
## Licensing
|
||||
|
||||
As a standard, the openDesk platform development team uses [reuse.software](https://reuse.software/) wherever possible to annotate license and copyright.
|
||||
|
||||
openDesk uses Apache 2.0 as the license for their work. A typical reuse copyright and license header looks like this:
|
||||
```
|
||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
```
|
||||
As the way to mark the license header as a comment differs between the various filetypes, please find matching examples for the types all across the [deployment automation repository](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/deployment/sovereign-workplace).
|
||||
|
||||
**Remark**: If there is already an existing `SPDX-FileCopyrightText` please just add the one from the above example.
|
||||
|
||||
## Development workflow
|
||||
|
||||
### Disclaimer
|
||||
|
||||
openDesk consists only of community products, so there is no SLA to receive service updates or backport of critical security fixes. This has two consequences:
|
||||
- In production scenarios, you should replace the community versions of the functional components with supported, SLA-backed paid versions.
|
||||
- openDesk aims to always update to the latest available releases of the community components and we therefore have rolling technical releases.
|
||||
|
||||
### Workflow
|
||||
|
||||
This chapter describes the development workflow of the deployment automation. The suppliers have their development processes and workflows. While we aim to update always to the most recent community version(s) available, openDesk also sponsors development done by the suppliers. As the openDesk team has to take a closer look at these sponsored features, they are referred to as *supplier deliverables* within the platform development workflow.
|
||||
|
||||
#### Branching concept
|
||||
|
||||
The picture below uses Gitflow notation to give an overview of the different types of development flows.
|
||||
|
||||
The basic facts for the flow are:
|
||||
- When the `develop` branch is merged into `main` a technical release is created (except when the merge commit(s) are of type `chore` or `docs`)
|
||||
- Changes that will be applied to openDesk have to branch off from `develop`, we call these branches *feature* branches.
|
||||
- Developers can create sub-branches from their feature branch(es) as needed.
|
||||
- When a *feature* branch gets pushed a Merge Request in `Draft` state is automatically created.
|
||||
- We know three types of *feature* branches:
|
||||
- `docs`: Doing just documentation changes
|
||||
- `fix`: Maintenance of the openDesk software components and minor configurational changes
|
||||
- `feat`: All changes that do not fall into the two categories above, especially
|
||||
- supplier deliverables and
|
||||
- configurational changes that have a significant impact on openDesk users or require migrations[^1]
|
||||
- The *QG* entries in the workflow refer to quality gates that are explained in more detail later
|
||||
- All merges into `develop` or `main` require two approvals from the platform development team[^2]. The approvers have to ensure that the defined quality gates have been passed successfully.
|
||||
|
||||
```mermaid
|
||||
gitGraph
|
||||
commit id: "QA 'nightly main'"
|
||||
commit id: " "
|
||||
branch "develop"
|
||||
checkout "develop"
|
||||
commit id: "QA 'nightly develop'"
|
||||
commit id: " "
|
||||
branch "docs"
|
||||
checkout "docs"
|
||||
commit id: "Documentation commits" type: HIGHLIGHT
|
||||
checkout "develop"
|
||||
merge "docs"
|
||||
checkout "main"
|
||||
merge "develop" tag: "No release"
|
||||
checkout "develop"
|
||||
commit id: " "
|
||||
branch "fix"
|
||||
checkout "fix"
|
||||
commit id: "Maintenance commits" type: HIGHLIGHT
|
||||
commit id: "QG 'fix'" type: REVERSE
|
||||
checkout "develop"
|
||||
merge "fix"
|
||||
commit id: "QA 'release merge'" type: REVERSE
|
||||
checkout "main"
|
||||
merge "develop" tag: "Patch or minor release"
|
||||
checkout "develop"
|
||||
commit id: " "
|
||||
branch "feat"
|
||||
checkout "feat"
|
||||
commit id: "Feature commits" type: HIGHLIGHT
|
||||
commit id: "QG 'feat'" type: REVERSE
|
||||
commit id: "Manual Feature QA" type: REVERSE
|
||||
commit id: "Develop Tests"
|
||||
commit id: "Documentation"
|
||||
checkout "develop"
|
||||
merge "feat"
|
||||
commit id: "QA 'release merge' " type: REVERSE
|
||||
checkout "main"
|
||||
merge "develop" tag: "Minor or major release"
|
||||
checkout "develop"
|
||||
checkout "main"
|
||||
commit id: " "
|
||||
commit id: "Manual Functional Release Activities" type: HIGHLIGHT
|
||||
commit id: " "
|
||||
```
|
||||
|
||||
#### Standard Quality Gate (SQG)
|
||||
|
||||
The Standard Quality Gate addresses quality assurance steps that should be executed within each of the mentioned quality gates in the workflow.
|
||||
|
||||
1. Linting
|
||||
- Blocking
|
||||
- Licensing: [reuse](https://github.com/fsfe/reuse-tool)
|
||||
- openDesk specific: Especially `images.yaml` and `charts.yaml`, find more details in [development.md](./development.md).
|
||||
- Non Blocking
|
||||
- Security: [Kyverno policy check](../.kyverno) addressing some IT-Grundschutz requirements
|
||||
- Formal: Yaml
|
||||
1. Deploy the full openDesk stack from scratch:
|
||||
- All deployment steps must be successful (green)
|
||||
- All tests from the end-to-end test set must be successful
|
||||
1. Update deployment[^3] of the full openDesk stack and apply the quality measures from the step #1:
|
||||
- Deploy the current merge target baseline (`develop` or `main`)
|
||||
- Update deploy from your QA branch into the instance from the previous step
|
||||
1. No showstopper found regarding
|
||||
- SBOM compliance[^4]
|
||||
- Malware check
|
||||
- CVE check[^5]
|
||||
- Kubescape scan[^5]
|
||||
|
||||
Steps #1 to #3 from above are executed as GitLab CI and therefore documented within GitLab.
|
||||
|
||||
Step #4 is focussed on security and was not fully implemented yet. Its main objective is to check for regressions. That step is just the second step of a security check and monitoring chain as shown below. While some checks can be executed against the static artifacts (e.g. container images) other might require an up-and-running instance. These are especially located in the third step below which is not yet implemented.
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
A[<u><b>Container image</b></u>
|
||||
checks during build time
|
||||
e.g. based on openDesk
|
||||
reference implementation 'gitlab-config'.
|
||||
>> Can the artefact be integrated? <<
|
||||
] -->|integrate artifacts| B[<u><b>Deployment automation</b></u> SQG
|
||||
based on GitLab CI during
|
||||
technical release process.
|
||||
>> Can the platform be released? <<
|
||||
]
|
||||
B-->|release| C[<u><b>openDesk release</b></u> monitoring
|
||||
on a regular e.g. daily or live basis.
|
||||
>> Do we need to fix something? <<
|
||||
]
|
||||
```
|
||||
|
||||
#### Branch workflows
|
||||
|
||||
This section will explain the workflow for each branch (type) based on the Gitflow picture from above.
|
||||
|
||||
##### `main`
|
||||
|
||||
- `QA 'nightly main'`: Execute the SQG based on the most recent release. The upgrade test environment should be a long-standing environment that only gets built from scratch with the previous technical release when something breaks the environment.
|
||||
- Merge points: We are using the [Semantic Release convention](https://github.com/semantic-release/semantic-release) which itself is based on the [Semantic Versioning (SemVer) notation](https://semver.org) to automatically create technical releases on the merge points.
|
||||
- "No release": When a merge from `develop` includes only changes from `docs` branches the merge into `main` will only consist of `docs` or `chore` commits. No new release will be generated by that merge.
|
||||
- "Patch or minor release": When changes from `fix` branches get merged these might contain `fix` or `feat` commits causing a new technical release to be built with an updated version on Patch or Minor level.
|
||||
- "Minor or major release": When changes from `feat` branches get merged these might contain `feat` commits even with breaking changes, causing a technical release to be built with an updated version on Minor or Major level.
|
||||
- "Manual Functional Release Activities": Technical releases are loosely coupled to functional releases. The additional activities for a functional release select an existing technical release as a basis to generate the artifacts required for a functional release, for example:
|
||||
- Conduct additional manual explorative and regression tests.
|
||||
- Perform checks like IT Grundschutz, Accessibility, or Data Protection.
|
||||
|
||||
##### `develop`
|
||||
|
||||
- `QA 'nightly develop'`: Follows the same approach as `QA 'nightly main'` - execute the SQG based in this case on the head revision of the `develop` branch.
|
||||
- `QA 'release merge'`: The Merge Request for this merge has to be created manually by members of the platform development team. It should document:
|
||||
- That the SQG was successfully executed upon the to-be merged state - it could be done explicitly or based on a `QA 'nightly develop'`
|
||||
- In case of `fix` changes that usually how no test automation: Changes have been verified by a member of the platform development team.
|
||||
- That the changes have been reviewed by at least two members of the platform development team giving their approval on the Merge Request.
|
||||
- Merge points (from `docs`, `fix`, and `feat` branches): No additional activity on these merge points as the QA is ensured before the merge in the just-named branch types.
|
||||
|
||||
##### `docs`
|
||||
|
||||
Branches of type `docs` only contain the commits themselves and have to adhere to the workflow basic fact that:
|
||||
> All merges into `develop` or `main` require two approvals from the platform development team.
|
||||
|
||||
##### `fix`
|
||||
|
||||
Besides the actual changes being committed in an `fix` branch there is only the:
|
||||
- `QG 'fix'`: In addition to validating the actual change the owner of the branch has to ensure the successful execution of the SQG.
|
||||
|
||||
##### `feat`
|
||||
|
||||
This branch type requires the most activities on top of the actual development:
|
||||
- `QG 'feat'`: The owner of the branch has to validate the implemented functionality and has to ensure the SQG is passed successfully.
|
||||
- `Manual Feature QA`:
|
||||
- This is the actual interface between the platform development workflow and the supplier work package workflow.
|
||||
- The openDesk QA team validates the change, ideally based on the acceptance criteria defined in the supplier's work package definition.
|
||||
- If improvements are needed QA passes on the feedback to the developer/supplier.
|
||||
- If the QA was successful test cases for the test automation of the feature are defined.
|
||||
- QA should also evaluate if there is a need for end-user documentation of the feature.
|
||||
- `Develop Test`: The test cases are implemented by the openDesk platform development and added to the openDesk end-to-end test suite.
|
||||
- `Documentation`: When required the documentation team has to update the end-user documentation.
|
||||
|
||||
#### Branch names
|
||||
|
||||
Branches created from the `develop` branch have to adhere to the following notation: `<type>/<responsible_developer>/<details>`:
|
||||
|
||||
- `<type>`: From the list of branch types explained above:
|
||||
- `docs`
|
||||
- `fix`
|
||||
- `feat`
|
||||
- `<responsible_developer>`: Something that makes you identifiable as owner of the branch, e.g. the first letter of your first name followed by your family name.
|
||||
- `<details>`: A very short note about what is going to happen in the branch and ideally what component is affected from the following list of components:
|
||||
- `helmfile`
|
||||
- `ci`
|
||||
- `docs`
|
||||
- `collabora`
|
||||
- `cryptpad`
|
||||
- `element`
|
||||
- `jitsi`
|
||||
- `nextcloud`
|
||||
- `nubus`
|
||||
- `open-xchange`
|
||||
- `openproject`
|
||||
- `services`
|
||||
- `xwiki`
|
||||
|
||||
Example: `feat/tmueller/bump_nextcloud_to_29.0.0`.
|
||||
|
||||
**Note**: The above naming convention is not enforced yet, but please ensure you make use of it.
|
||||
|
||||
#### Commit messages / Conventional Commits
|
||||
|
||||
Commit messages must adhere to the [Conventional Commit standard](https://www.conventionalcommits.org/en/v1.0.0/#summary). Commits that do not adhere to the standard get rejected by either [Gitlab push rules](https://docs.gitlab.com/ee/user/project/repository/push_rules.html) or the CI.
|
||||
|
||||
```text
|
||||
<type>(<scope>): [path/to/issue#1] <short summary>.
|
||||
│ │ │ │
|
||||
│ │ | └─> Summary in present tense, sentence case, with no period at the end
|
||||
│ │ |
|
||||
│ │ └─> Issue reference (optional)
|
||||
│ │
|
||||
│ └─> Commit Scope: helmfile, docs, collabora, intercom-service, ...
|
||||
│
|
||||
└─> Commit Type: chore, ci, docs, feat, fix
|
||||
```
|
||||
|
||||
Example: `fix(open-xchange): Bump to 8.26 to heal issue with functional mailbox provisioning.`
|
||||
|
||||
**Beware**: The commit messages are an essential part of the [technical releases](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/releases) as the release's notes are generated from the messages.
|
||||
|
||||
#### Verified commits
|
||||
|
||||
We only allow verified commits, please read on about the options you have to make your commits verified:
|
||||
- https://docs.gitlab.com/ee/user/project/repository/ssh_signed_commits/
|
||||
- https://docs.gitlab.com/ee/user/project/repository/gpg_signed_commits/
|
||||
- https://docs.gitlab.com/ee/user/project/repository/x509_signed_commits/
|
||||
|
||||
# Footnotes
|
||||
|
||||
[^1]: Migrations are in general not supported before openDesk hits [technical release](https://gitlab.opencode.de/bmi/opendesk/deployment/sovereign-workplace/-/releases) v1.0.0
|
||||
|
||||
[^2]: These approval rules are not available in the Gitlab Free Tier which is one of the main reasons why the deployment automation is not developed on Open CoDE.
|
||||
|
||||
[^3]: As long as migrations/upgrade paths are not provided - see also footnote #1 - this step is optional.
|
||||
|
||||
[^4]: The SBOM process is currently executed asynchronously to the development process and tests the most current technical release from main. The process is not fully automated yet.
|
||||
|
||||
[^5]: The quality gate is not yet implemented especially when it comes to identifying regressions.
|
||||
@@ -1,43 +1,29 @@
|
||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
#
|
||||
# Advanced Configuration: Nested States
|
||||
#
|
||||
helmfiles:
|
||||
# Path to the helmfile state file being processed BEFORE releases in this state file
|
||||
- path: "helmfile/apps/services/helmfile.yaml"
|
||||
- path: "helmfile/apps/keycloak/helmfile.yaml"
|
||||
- path: "helmfile/apps/univention-corporate-container/helmfile.yaml"
|
||||
- path: "helmfile/apps/keycloak-bootstrap/helmfile.yaml"
|
||||
- path: "helmfile/apps/intercom-service/helmfile.yaml"
|
||||
- path: "helmfile/apps/open-xchange/helmfile.yaml"
|
||||
- path: "helmfile/apps/nextcloud/helmfile.yaml"
|
||||
- path: "helmfile/apps/collabora/helmfile.yaml"
|
||||
- path: "helmfile/apps/jitsi/helmfile.yaml"
|
||||
- path: "helmfile/apps/element/helmfile.yaml"
|
||||
- path: "helmfile/apps/openproject/helmfile.yaml"
|
||||
- path: "helmfile/apps/xwiki/helmfile.yaml"
|
||||
- path: "helmfile/apps/provisioning/helmfile.yaml"
|
||||
|
||||
missingFileHandler: "Error"
|
||||
|
||||
# Environment is defined here and in helmfile/bases/environments.yaml
|
||||
# This is a temporary solution to solve issue with different (relative) paths required when
|
||||
# - Installing all releases from root via helmfile apply
|
||||
# - Installing a single release from root via helmfile apply -f helmfile/apps/<app>/helmfile.yaml
|
||||
# - Installing a single release from app directory via helmfile apply
|
||||
# Issue: https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/deployment/sovereign-workplace/-/issues/2
|
||||
environments:
|
||||
default:
|
||||
values:
|
||||
- "helmfile/environments/default/*.gotmpl"
|
||||
dev:
|
||||
values:
|
||||
- "helmfile/environments/default/*.gotmpl"
|
||||
- "helmfile/environments/dev/values.yaml"
|
||||
- "helmfile/environments/dev/*.yaml.gotmpl"
|
||||
test:
|
||||
values:
|
||||
- "helmfile/environments/test/*.yaml.gotmpl"
|
||||
prod:
|
||||
values:
|
||||
- "helmfile/environments/default/*.gotmpl"
|
||||
- "helmfile/environments/prod/values.yaml"
|
||||
- "helmfile/environments/prod/*.yaml.gotmpl"
|
||||
---
|
||||
# yamllint disable
|
||||
helmfiles:
|
||||
- path: "./helmfile_generic.yaml"
|
||||
values:
|
||||
- {{ toYaml .Values | nindent 8 }}
|
||||
# {{/*
|
||||
#
|
||||
# Use this format from a remote repository
|
||||
#
|
||||
# - path: "git::https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk.git@helmfile_generic.yaml?ref=v0.7.1"
|
||||
# values:
|
||||
# - {{ toYaml .Values | nindent 8 }}
|
||||
# */}}
|
||||
...
|
||||
|
||||
27
helmfile/apps/collabora/helmfile-child.yaml
Normal file
27
helmfile/apps/collabora/helmfile-child.yaml
Normal file
@@ -0,0 +1,27 @@
|
||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
repositories:
|
||||
# Collabora Online
|
||||
# Source: https://github.com/CollaboraOnline/online
|
||||
- name: "collabora-online-repo"
|
||||
keyring: "../../files/gpg-pubkeys/collaboraoffice-com.gpg"
|
||||
verify: {{ .Values.charts.collabora.verify }}
|
||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||
oci: true
|
||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.collabora.registry }}/\
|
||||
{{ .Values.charts.collabora.repository }}"
|
||||
|
||||
releases:
|
||||
- name: "collabora-online"
|
||||
chart: "collabora-online-repo/{{ .Values.charts.collabora.name }}"
|
||||
version: "{{ .Values.charts.collabora.version }}"
|
||||
values:
|
||||
- "values.yaml.gotmpl"
|
||||
installed: {{ .Values.collabora.enabled }}
|
||||
|
||||
commonLabels:
|
||||
deploy-stage: "component-1"
|
||||
component: "collabora"
|
||||
...
|
||||
@@ -1,25 +1,12 @@
|
||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
repositories:
|
||||
- name: "collabora-online-repo"
|
||||
url: >-
|
||||
{{ env "PRIVATE_CHART_REPOSITORY_URL" |
|
||||
default "https://collaboraonline.github.io/online" }}
|
||||
|
||||
releases:
|
||||
- name: "collabora-online"
|
||||
chart: "collabora-online-repo/collabora-online"
|
||||
version: "1.0.2"
|
||||
values:
|
||||
- "values.yaml"
|
||||
- "values.gotmpl"
|
||||
condition: "collabora.enabled"
|
||||
|
||||
commonLabels:
|
||||
deploy-stage: "component-1"
|
||||
component: "collabora"
|
||||
|
||||
bases:
|
||||
- "../../bases/environments.yaml"
|
||||
---
|
||||
helmfiles:
|
||||
- path: "./helmfile-child.yaml"
|
||||
values:
|
||||
- {{ toYaml .Values | nindent 8 }}
|
||||
...
|
||||
|
||||
@@ -1,45 +0,0 @@
|
||||
{{/*
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
*/}}
|
||||
---
|
||||
image:
|
||||
repository: "{{ .Values.global.imageRegistry }}/{{ .Values.images.collabora.repository }}"
|
||||
tag: "{{ .Values.images.collabora.tag }}"
|
||||
|
||||
imagePullSecrets:
|
||||
{{- range .Values.global.imagePullSecrets }}
|
||||
- name: {{ . }}
|
||||
{{- end }}
|
||||
|
||||
ingress:
|
||||
enabled: {{ .Values.ingress.enabled }}
|
||||
className: "{{ .Values.ingress.ingressClassName }}"
|
||||
hosts:
|
||||
- host: "{{ .Values.global.hosts.collabora }}.{{ .Values.global.domain }}"
|
||||
paths:
|
||||
- path: "/"
|
||||
pathType: "Prefix"
|
||||
tls:
|
||||
- secretName: "{{ .Values.ingress.tls.secretName }}"
|
||||
hosts:
|
||||
- "{{ .Values.global.hosts.collabora }}.{{ .Values.global.domain }}"
|
||||
|
||||
collabora:
|
||||
# Admin Console Credentials: https://CODE-domain/browser/dist/admin/admin.html
|
||||
username: "collabora-internal-admin"
|
||||
password: {{ .Values.secrets.collabora.adminPassword }}
|
||||
aliasgroups:
|
||||
- host: "https://{{ .Values.global.hosts.nextcloud }}.{{ .Values.global.domain }}:443"
|
||||
|
||||
{{- if not (eq .Values.cluster.container.engine "containerd") }}
|
||||
# In case of issues with "Failed to exec command '/usr/bin/loolforkit' (EPERM: Operation not permitted)...", activate:
|
||||
# Ref.: https://github.com/CollaboraOnline/online/issues/2800
|
||||
securityContext:
|
||||
capabilities:
|
||||
add:
|
||||
- "MKNOD"
|
||||
{{- end }}
|
||||
|
||||
replicaCount: {{ .Values.replicas.collabora }}
|
||||
...
|
||||
@@ -1,32 +0,0 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
# https://github.com/CollaboraOnline/online/blob/master/kubernetes/helm/README.md or
|
||||
# https://github.com/CollaboraOnline/online/blob/master/kubernetes/helm/collabora-online/values.yaml
|
||||
|
||||
fullnameOverride: "collabora"
|
||||
|
||||
image:
|
||||
pullPolicy: "IfNotPresent"
|
||||
|
||||
collabora:
|
||||
extra_params: "--o:ssl.enable=false --o:ssl.termination=true"
|
||||
|
||||
ingress:
|
||||
annotations:
|
||||
# nginx
|
||||
nginx.ingress.kubernetes.io/upstream-hash-by: "$arg_WOPISrc"
|
||||
# HAProxy
|
||||
haproxy.org/timeout-tunnel: "3600s"
|
||||
haproxy.org/backend-config-snippet: |
|
||||
mode http
|
||||
balance leastconn
|
||||
stick-table type string len 2048 size 1k store conn_cur
|
||||
http-request set-var(txn.wopisrcconns) url_param(WOPISrc),table_conn_cur()
|
||||
http-request track-sc1 url_param(WOPISrc)
|
||||
stick match url_param(WOPISrc) if { var(txn.wopisrcconns) -m int gt 0 }
|
||||
stick store-request url_param(WOPISrc)
|
||||
|
||||
autoscaling:
|
||||
enabled: false
|
||||
...
|
||||
133
helmfile/apps/collabora/values.yaml.gotmpl
Normal file
133
helmfile/apps/collabora/values.yaml.gotmpl
Normal file
@@ -0,0 +1,133 @@
|
||||
{{/*
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
*/}}
|
||||
---
|
||||
autoscaling:
|
||||
enabled: false
|
||||
|
||||
collabora:
|
||||
extra_params: "--o:ssl.enable=false --o:ssl.termination=true --o:fetch_update_check=0"
|
||||
username: "collabora-internal-admin"
|
||||
password: {{ .Values.secrets.collabora.adminPassword | quote }}
|
||||
aliasgroups:
|
||||
- host: "https://{{ .Values.global.hosts.nextcloud }}.{{ .Values.global.domain }}"
|
||||
|
||||
fullnameOverride: "collabora"
|
||||
|
||||
grafana:
|
||||
dashboards:
|
||||
enabled: {{ .Values.monitoring.grafana.dashboards.enabled }}
|
||||
labels:
|
||||
{{ .Values.monitoring.grafana.dashboards.labels | toYaml | nindent 6 }}
|
||||
annotations:
|
||||
{{ .Values.monitoring.grafana.dashboards.annotations | toYaml | nindent 6 }}
|
||||
|
||||
image:
|
||||
repository: "{{ .Values.global.imageRegistry | default .Values.images.collabora.registry }}/{{ .Values.images.collabora.repository }}"
|
||||
tag: {{ .Values.images.collabora.tag | quote }}
|
||||
pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||
|
||||
imagePullSecrets:
|
||||
{{- range .Values.global.imagePullSecrets }}
|
||||
- name: {{ . | quote }}
|
||||
{{- end }}
|
||||
|
||||
ingress:
|
||||
annotations:
|
||||
# Ingress NGINX
|
||||
nginx.ingress.kubernetes.io/upstream-hash-by: "$arg_WOPISrc"
|
||||
nginx.ingress.kubernetes.io/proxy-body-size: "{{ .Values.ingress.parameters.bodySize.collabora }}"
|
||||
nginx.ingress.kubernetes.io/proxy-read-timeout: "{{ .Values.ingress.parameters.bodyTimeout.collabora }}"
|
||||
nginx.ingress.kubernetes.io/proxy-send-timeout: "{{ .Values.ingress.parameters.bodyTimeout.collabora }}"
|
||||
nginx.ingress.kubernetes.io/server-snippet: |
|
||||
# block admin and metrics endpoint from outside by default
|
||||
location /cool/getMetrics { deny all; return 403; }
|
||||
location /cool/adminws/ { deny all; return 403; }
|
||||
location /browser/dist/admin/admin.html { deny all; return 403; }
|
||||
# NGINX
|
||||
nginx.org/websocket-services: "collabora"
|
||||
nginx.org/lb-method: "hash $arg_WOPISrc consistent"
|
||||
nginx.org/proxy-read-timeout: "{{ .Values.ingress.parameters.bodyTimeout.collabora }}s"
|
||||
nginx.org/proxy-send-timeout: "{{ .Values.ingress.parameters.bodyTimeout.collabora }}s"
|
||||
nginx.org/client-max-body-size: "{{ .Values.ingress.parameters.bodySize.collabora }}"
|
||||
nginx.org/server-snippets: |
|
||||
# block admin and metrics endpoint from outside by default
|
||||
location /cool/getMetrics { deny all; return 403; }
|
||||
location /cool/adminws/ { deny all; return 403; }
|
||||
location /browser/dist/admin/admin.html { deny all; return 403; }
|
||||
# HAProxy
|
||||
haproxy.org/timeout-tunnel: "{{ .Values.ingress.parameters.bodyTimeout.collabora }}s"
|
||||
haproxy.org/backend-config-snippet: |
|
||||
balance url_param WOPISrc check_post
|
||||
hash-type consistent
|
||||
# HAProxy - Community: https://haproxy-ingress.github.io/
|
||||
haproxy-ingress.github.io/timeout-tunnel: "{{ .Values.ingress.parameters.bodyTimeout.collabora }}s"
|
||||
haproxy-ingress.github.io/balance-algorithm: "url_param WOPISrc check_post"
|
||||
haproxy-ingress.github.io/config-backend: |
|
||||
hash-type consistent
|
||||
# block admin urls from outside
|
||||
acl admin_url path_beg /cool/getMetrics
|
||||
acl admin_url path_beg /cool/adminws/
|
||||
acl admin_url path_beg /browser/dist/admin/admin.html
|
||||
http-request deny if admin_url
|
||||
enabled: {{ .Values.ingress.enabled }}
|
||||
className: {{ .Values.ingress.ingressClassName | quote }}
|
||||
hosts:
|
||||
- host: "{{ .Values.global.hosts.collabora }}.{{ .Values.global.domain }}"
|
||||
paths:
|
||||
- path: "/"
|
||||
pathType: "Prefix"
|
||||
tls:
|
||||
- secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||
hosts:
|
||||
- "{{ .Values.global.hosts.collabora }}.{{ .Values.global.domain }}"
|
||||
|
||||
podSecurityContext:
|
||||
fsGroup: 100
|
||||
|
||||
prometheus:
|
||||
servicemonitor:
|
||||
enabled: {{ .Values.monitoring.prometheus.serviceMonitors.enabled }}
|
||||
labels:
|
||||
{{ .Values.monitoring.prometheus.serviceMonitors.labels | toYaml | nindent 6 }}
|
||||
rules:
|
||||
enabled: {{ .Values.monitoring.prometheus.prometheusRules.enabled }}
|
||||
additionalLabels:
|
||||
{{ .Values.monitoring.prometheus.prometheusRules.labels | toYaml | nindent 6 }}
|
||||
|
||||
replicaCount: {{ .Values.replicas.collabora }}
|
||||
|
||||
resources:
|
||||
{{ .Values.resources.collabora | toYaml | nindent 2 }}
|
||||
|
||||
securityContext:
|
||||
allowPrivilegeEscalation: true
|
||||
privileged: false
|
||||
readOnlyRootFilesystem: false
|
||||
runAsNonRoot: true
|
||||
runAsUser: 100
|
||||
runAsGroup: 101
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
add:
|
||||
- "CHOWN"
|
||||
- "DAC_OVERRIDE"
|
||||
- "FOWNER"
|
||||
- "FSETID"
|
||||
- "KILL"
|
||||
- "SETGID"
|
||||
- "SETUID"
|
||||
- "SETPCAP"
|
||||
- "NET_BIND_SERVICE"
|
||||
- "NET_RAW"
|
||||
- "SYS_CHROOT"
|
||||
- "MKNOD"
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.collabora | toYaml | nindent 4 }}
|
||||
serviceAccount:
|
||||
create: true
|
||||
...
|
||||
27
helmfile/apps/cryptpad/helmfile-child.yaml
Normal file
27
helmfile/apps/cryptpad/helmfile-child.yaml
Normal file
@@ -0,0 +1,27 @@
|
||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
repositories:
|
||||
# CryptPad
|
||||
# Source: https://github.com/cryptpad/helm
|
||||
- name: "cryptpad-repo"
|
||||
keyring: "../../files/gpg-pubkeys/xwiki-com.gpg"
|
||||
verify: {{ .Values.charts.cryptpad.verify }}
|
||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||
oci: true
|
||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.cryptpad.registry }}/\
|
||||
{{ .Values.charts.cryptpad.repository }}"
|
||||
|
||||
releases:
|
||||
- name: "cryptpad"
|
||||
chart: "cryptpad-repo/{{ .Values.charts.cryptpad.name }}"
|
||||
version: "{{ .Values.charts.cryptpad.version }}"
|
||||
values:
|
||||
- "values.yaml.gotmpl"
|
||||
installed: {{ .Values.cryptpad.enabled }}
|
||||
|
||||
commonLabels:
|
||||
deploy-stage: "component-1"
|
||||
component: "cryptpad"
|
||||
...
|
||||
12
helmfile/apps/cryptpad/helmfile.yaml
Normal file
12
helmfile/apps/cryptpad/helmfile.yaml
Normal file
@@ -0,0 +1,12 @@
|
||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
bases:
|
||||
- "../../bases/environments.yaml"
|
||||
---
|
||||
helmfiles:
|
||||
- path: "./helmfile-child.yaml"
|
||||
values:
|
||||
- {{ toYaml .Values | nindent 8 }}
|
||||
...
|
||||
81
helmfile/apps/cryptpad/values.yaml.gotmpl
Normal file
81
helmfile/apps/cryptpad/values.yaml.gotmpl
Normal file
@@ -0,0 +1,81 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
# https://github.com/cryptpad/helm/blob/main/charts/cryptpad/README.md or
|
||||
# https://github.com/cryptpad/helm/blob/main/charts/cryptpad/values.yaml
|
||||
|
||||
# Disable registration and access to unregistered users:
|
||||
# (https://docs.cryptpad.org/en/admin_guide/customization.html#application-config)
|
||||
|
||||
application_config:
|
||||
availablePadTypes:
|
||||
- "diagram"
|
||||
|
||||
# Deactivating public access breaks nextcloud plugin!
|
||||
# registeredOnlyTypes:
|
||||
# - "diagram"
|
||||
|
||||
autoscaling:
|
||||
enabled: false
|
||||
|
||||
enableEmbedding: true
|
||||
|
||||
fullnameOverride: "cryptpad"
|
||||
|
||||
image:
|
||||
repository: "{{ .Values.global.imageRegistry | default .Values.images.cryptpad.registry }}/{{ .Values.images.cryptpad.repository }}"
|
||||
tag: {{ .Values.images.cryptpad.tag | quote }}
|
||||
pullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||
|
||||
imagePullSecrets:
|
||||
{{- range .Values.global.imagePullSecrets }}
|
||||
- name: {{ . | quote }}
|
||||
{{- end }}
|
||||
|
||||
ingress:
|
||||
enabled: {{ .Values.ingress.enabled }}
|
||||
annotations:
|
||||
nginx.org/websocket-services: "cryptpad"
|
||||
className: {{ .Values.ingress.ingressClassName | quote }}
|
||||
hosts:
|
||||
- host: "{{ .Values.global.hosts.cryptpad }}.{{ .Values.global.domain }}"
|
||||
paths:
|
||||
- path: "/"
|
||||
pathType: "ImplementationSpecific"
|
||||
tls:
|
||||
- secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||
hosts:
|
||||
- "{{ .Values.global.hosts.cryptpad }}.{{ .Values.global.domain }}"
|
||||
|
||||
persistence:
|
||||
enabled: false
|
||||
|
||||
podSecurityContext:
|
||||
fsGroup: 4001
|
||||
|
||||
replicaCount: {{ .Values.replicas.cryptpad }}
|
||||
|
||||
resources:
|
||||
{{ .Values.resources.cryptpad | toYaml | nindent 2 }}
|
||||
|
||||
securityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
privileged: false
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
readOnlyRootFilesystem: false
|
||||
runAsNonRoot: true
|
||||
runAsUser: 4001
|
||||
runAsGroup: 4001
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.cryptpad | toYaml | nindent 4 }}
|
||||
|
||||
serviceAccount:
|
||||
create: true
|
||||
|
||||
workloadStateful: false
|
||||
|
||||
...
|
||||
184
helmfile/apps/element/helmfile-child.yaml
Normal file
184
helmfile/apps/element/helmfile-child.yaml
Normal file
@@ -0,0 +1,184 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
repositories:
|
||||
# openDesk Element
|
||||
# Source: https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-element
|
||||
- name: "element-repo"
|
||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||
verify: {{ .Values.charts.element.verify }}
|
||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||
oci: true
|
||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.element.registry }}/\
|
||||
{{ .Values.charts.element.repository }}"
|
||||
- name: "element-well-known-repo"
|
||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||
verify: {{ .Values.charts.elementWellKnown.verify }}
|
||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||
oci: true
|
||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.elementWellKnown.registry }}/\
|
||||
{{ .Values.charts.elementWellKnown.repository }}"
|
||||
- name: "synapse-web-repo"
|
||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||
verify: {{ .Values.charts.synapseWeb.verify }}
|
||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||
oci: true
|
||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.synapseWeb.registry }}/\
|
||||
{{ .Values.charts.synapseWeb.repository }}"
|
||||
- name: "synapse-repo"
|
||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||
verify: {{ .Values.charts.synapse.verify }}
|
||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||
oci: true
|
||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.synapse.registry }}/\
|
||||
{{ .Values.charts.synapse.repository }}"
|
||||
- name: "synapse-create-account-repo"
|
||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||
verify: {{ .Values.charts.synapseCreateAccount.verify }}
|
||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||
oci: true
|
||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.synapseCreateAccount.registry }}/\
|
||||
{{ .Values.charts.synapseCreateAccount.repository }}"
|
||||
|
||||
# openDesk Matrix Widgets
|
||||
# Source: https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-matrix-widgets
|
||||
- name: "matrix-user-verification-service-repo"
|
||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||
verify: {{ .Values.charts.matrixUserVerificationService.verify }}
|
||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||
oci: true
|
||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.matrixUserVerificationService.registry }}/\
|
||||
{{ .Values.charts.matrixUserVerificationService.repository }}"
|
||||
- name: "matrix-neoboard-widget-repo"
|
||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||
verify: {{ .Values.charts.matrixNeoboardWidget.verify }}
|
||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||
oci: true
|
||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.matrixNeoboardWidget.registry }}/\
|
||||
{{ .Values.charts.matrixNeoboardWidget.repository }}"
|
||||
- name: "matrix-neochoice-widget-repo"
|
||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||
verify: {{ .Values.charts.matrixNeoboardWidget.verify }}
|
||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||
oci: true
|
||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.matrixNeoboardWidget.registry }}/\
|
||||
{{ .Values.charts.matrixNeoboardWidget.repository }}"
|
||||
- name: "matrix-neodatefix-widget-repo"
|
||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||
verify: {{ .Values.charts.matrixNeodatefixWidget.verify }}
|
||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||
oci: true
|
||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.matrixNeodatefixWidget.registry }}/\
|
||||
{{ .Values.charts.matrixNeodatefixWidget.repository }}"
|
||||
- name: "matrix-neodatefix-bot-repo"
|
||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||
verify: {{ .Values.charts.matrixNeodatefixBot.verify }}
|
||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||
oci: true
|
||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.matrixNeodatefixBot.registry }}/\
|
||||
{{ .Values.charts.matrixNeodatefixBot.repository }}"
|
||||
|
||||
|
||||
releases:
|
||||
- name: "opendesk-element"
|
||||
chart: "element-repo/{{ .Values.charts.element.name }}"
|
||||
version: "{{ .Values.charts.element.version }}"
|
||||
values:
|
||||
- "values-element.yaml.gotmpl"
|
||||
installed: {{ .Values.element.enabled }}
|
||||
timeout: 900
|
||||
|
||||
- name: "opendesk-well-known"
|
||||
chart: "element-well-known-repo/{{ .Values.charts.elementWellKnown.name }}"
|
||||
version: "{{ .Values.charts.elementWellKnown.version }}"
|
||||
values:
|
||||
- "values-well-known.yaml.gotmpl"
|
||||
installed: {{ .Values.element.enabled }}
|
||||
timeout: 900
|
||||
|
||||
- name: "opendesk-synapse-web"
|
||||
chart: "synapse-web-repo/{{ .Values.charts.synapseWeb.name }}"
|
||||
version: "{{ .Values.charts.synapseWeb.version }}"
|
||||
values:
|
||||
- "values-synapse-web.yaml.gotmpl"
|
||||
installed: {{ .Values.element.enabled }}
|
||||
timeout: 900
|
||||
|
||||
- name: "opendesk-synapse"
|
||||
chart: "synapse-repo/{{ .Values.charts.synapse.name }}"
|
||||
version: "{{ .Values.charts.synapse.version }}"
|
||||
values:
|
||||
- "values-synapse.yaml.gotmpl"
|
||||
installed: {{ .Values.element.enabled }}
|
||||
timeout: 900
|
||||
|
||||
- name: "opendesk-matrix-user-verification-service-bootstrap"
|
||||
chart: "synapse-create-account-repo/{{ .Values.charts.synapseCreateAccount.name }}"
|
||||
version: "{{ .Values.charts.synapseCreateAccount.version }}"
|
||||
values:
|
||||
- "values-matrix-user-verification-service-bootstrap.yaml.gotmpl"
|
||||
installed: {{ .Values.element.enabled }}
|
||||
timeout: 900
|
||||
|
||||
- name: "opendesk-matrix-user-verification-service"
|
||||
chart: "matrix-user-verification-service-repo/{{ .Values.charts.matrixUserVerificationService.name }}"
|
||||
version: "{{ .Values.charts.matrixUserVerificationService.version }}"
|
||||
values:
|
||||
- "values-matrix-user-verification-service.yaml.gotmpl"
|
||||
installed: {{ .Values.element.enabled }}
|
||||
timeout: 900
|
||||
|
||||
- name: "matrix-neoboard-widget"
|
||||
chart: "matrix-neoboard-widget-repo/{{ .Values.charts.matrixNeoboardWidget.name }}"
|
||||
version: "{{ .Values.charts.matrixNeoboardWidget.version }}"
|
||||
values:
|
||||
- "values-matrix-neoboard-widget.yaml.gotmpl"
|
||||
installed: {{ .Values.element.enabled }}
|
||||
timeout: 900
|
||||
|
||||
- name: "matrix-neochoice-widget"
|
||||
chart: "matrix-neochoice-widget-repo/{{ .Values.charts.matrixNeochoiseWidget.name }}"
|
||||
version: "{{ .Values.charts.matrixNeochoiseWidget.version }}"
|
||||
values:
|
||||
- "values-matrix-neochoice-widget.yaml.gotmpl"
|
||||
installed: {{ .Values.element.enabled }}
|
||||
timeout: 900
|
||||
|
||||
- name: "matrix-neodatefix-widget"
|
||||
chart: "matrix-neodatefix-widget-repo/{{ .Values.charts.matrixNeodatefixWidget.name }}"
|
||||
version: "{{ .Values.charts.matrixNeodatefixWidget.version }}"
|
||||
values:
|
||||
- "values-matrix-neodatefix-widget.yaml.gotmpl"
|
||||
installed: {{ .Values.element.enabled }}
|
||||
timeout: 900
|
||||
|
||||
- name: "matrix-neodatefix-bot-bootstrap"
|
||||
chart: "synapse-create-account-repo/{{ .Values.charts.synapseCreateAccount.name }}"
|
||||
version: "{{ .Values.charts.synapseCreateAccount.version }}"
|
||||
values:
|
||||
- "values-matrix-neodatefix-bot-bootstrap.yaml.gotmpl"
|
||||
installed: {{ .Values.element.enabled }}
|
||||
timeout: 900
|
||||
|
||||
- name: "matrix-neodatefix-bot"
|
||||
chart: "matrix-neodatefix-bot-repo/{{ .Values.charts.matrixNeodatefixBot.name }}"
|
||||
version: "{{ .Values.charts.matrixNeodatefixBot.version }}"
|
||||
values:
|
||||
- "values-matrix-neodatefix-bot.yaml.gotmpl"
|
||||
installed: {{ .Values.element.enabled }}
|
||||
timeout: 900
|
||||
|
||||
commonLabels:
|
||||
deploy-stage: "component-1"
|
||||
component: "element"
|
||||
...
|
||||
@@ -1,46 +1,12 @@
|
||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
repositories:
|
||||
- name: "sovereign-workplace-element-repo"
|
||||
url: >-
|
||||
{{ env "PRIVATE_CHART_REPOSITORY_URL" |
|
||||
default "https://gitlab.souvap-univention.de/api/v4/projects/148/packages/helm/stable" }}
|
||||
|
||||
releases:
|
||||
- name: "sovereign-workplace-element"
|
||||
chart: "sovereign-workplace-element-repo/sovereign-workplace-element"
|
||||
version: "1.3.0"
|
||||
values:
|
||||
- "values-element.gotmpl"
|
||||
condition: "element.enabled"
|
||||
|
||||
- name: "sovereign-workplace-well-known"
|
||||
chart: "sovereign-workplace-element-repo/sovereign-workplace-well-known"
|
||||
version: "1.3.0"
|
||||
values:
|
||||
- "values-well-known.yaml"
|
||||
- "values-well-known.gotmpl"
|
||||
condition: "element.enabled"
|
||||
|
||||
- name: "sovereign-workplace-synapse-web"
|
||||
chart: "sovereign-workplace-element-repo/sovereign-workplace-synapse-web"
|
||||
version: "1.3.0"
|
||||
values:
|
||||
- "values-synapse-web.gotmpl"
|
||||
condition: "element.enabled"
|
||||
|
||||
- name: "sovereign-workplace-synapse"
|
||||
chart: "sovereign-workplace-element-repo/sovereign-workplace-synapse"
|
||||
version: "1.3.0"
|
||||
values:
|
||||
- "values-synapse.gotmpl"
|
||||
condition: "element.enabled"
|
||||
|
||||
commonLabels:
|
||||
deploy-stage: "component-1"
|
||||
component: "element"
|
||||
|
||||
bases:
|
||||
- "../../bases/environments.yaml"
|
||||
---
|
||||
helmfiles:
|
||||
- path: "./helmfile-child.yaml"
|
||||
values:
|
||||
- {{ toYaml .Values | nindent 8 }}
|
||||
...
|
||||
|
||||
@@ -1,38 +0,0 @@
|
||||
{{/*
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
*/}}
|
||||
---
|
||||
global:
|
||||
domain: "{{ .Values.global.domain }}"
|
||||
registry: "{{ .Values.global.imageRegistry }}"
|
||||
hosts:
|
||||
{{ .Values.global.hosts | toYaml | nindent 4 }}
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
configuration:
|
||||
additionalConfiguration:
|
||||
logout_redirect_url: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/souvap/protocol/openid-connect/logout?client_id=matrix&post_logout_redirect_uri=https%3A%2F%2F{{ .Values.global.hosts.univentionCorporateServer }}.{{ .Values.global.domain }}"
|
||||
|
||||
image:
|
||||
registry: "{{ .Values.global.imageRegistry }}"
|
||||
repository: "{{ .Values.images.element.repository }}"
|
||||
tag: "{{ .Values.images.element.tag }}"
|
||||
|
||||
ingress:
|
||||
host: "{{ .Values.global.hosts.element }}.{{ .Values.global.domain }}"
|
||||
enabled: "{{ .Values.ingress.enabled }}"
|
||||
ingressClassName: "{{ .Values.ingress.ingressClassName }}"
|
||||
tls:
|
||||
enabled: "{{ .Values.ingress.tls.enabled }}"
|
||||
secretName: "{{ .Values.ingress.tls.secretName }}"
|
||||
|
||||
theme:
|
||||
{{ .Values.theme | toYaml | nindent 2 }}
|
||||
|
||||
replicaCount: {{ .Values.replicas.element }}
|
||||
|
||||
resources:
|
||||
{{ .Values.resources.element | toYaml | nindent 2 }}
|
||||
...
|
||||
148
helmfile/apps/element/values-element.yaml.gotmpl
Normal file
148
helmfile/apps/element/values-element.yaml.gotmpl
Normal file
@@ -0,0 +1,148 @@
|
||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
configuration:
|
||||
endToEndEncryption: true
|
||||
additionalConfiguration:
|
||||
logout_redirect_url: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}/protocol/openid-connect/logout?client_id=matrix&post_logout_redirect_uri=https%3A%2F%2F{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}"
|
||||
|
||||
"net.nordeck.element_web.module.opendesk":
|
||||
config:
|
||||
banner:
|
||||
ics_navigation_json_url: "https://{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}/navigation.json"
|
||||
ics_silent_url: "https://{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}/silent"
|
||||
portal_logo_svg_url: "https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/univention/portal/icons/logos/domain.svg"
|
||||
portal_url: "https://{{ .Values.global.hosts.nubus }}.{{ .Values.global.domain }}/"
|
||||
custom_css_variables:
|
||||
--cpd-color-bg-action-primary-rest: {{ .Values.theme.colors.primary | quote }}
|
||||
--cpd-color-text-action-accent: {{ .Values.theme.colors.primary | quote }}
|
||||
|
||||
"net.nordeck.element_web.module.widget_lifecycle":
|
||||
widget_permissions:
|
||||
"https://{{ .Values.global.hosts.element }}.{{ .Values.global.domain }}/jitsi.html":
|
||||
identity_approved: true
|
||||
"https://{{ .Values.global.hosts.matrixNeoBoardWidget }}.{{ .Values.global.domain }}/*":
|
||||
preload_approved: true
|
||||
capabilities_approved:
|
||||
- org.matrix.msc2762.send.event:net.nordeck.whiteboard.document.create
|
||||
- org.matrix.msc2762.receive.event:net.nordeck.whiteboard.document.create
|
||||
- org.matrix.msc2762.send.event:net.nordeck.whiteboard.document.chunk
|
||||
- org.matrix.msc2762.receive.event:net.nordeck.whiteboard.document.chunk
|
||||
- org.matrix.msc2762.send.event:net.nordeck.whiteboard.document.snapshot
|
||||
- org.matrix.msc2762.receive.event:net.nordeck.whiteboard.document.snapshot
|
||||
- org.matrix.msc2762.send.state_event:m.room.power_levels#
|
||||
- org.matrix.msc2762.receive.state_event:m.room.power_levels#
|
||||
- org.matrix.msc2762.receive.state_event:m.room.member
|
||||
- org.matrix.msc2762.receive.state_event:m.room.name
|
||||
- org.matrix.msc2762.send.state_event:net.nordeck.whiteboard
|
||||
- org.matrix.msc2762.receive.state_event:net.nordeck.whiteboard
|
||||
- org.matrix.msc2762.send.state_event:net.nordeck.whiteboard.sessions#*
|
||||
- org.matrix.msc2762.receive.state_event:net.nordeck.whiteboard.sessions
|
||||
- org.matrix.msc3819.send.to_device:net.nordeck.whiteboard.connection_signaling
|
||||
- org.matrix.msc3819.receive.to_device:net.nordeck.whiteboard.connection_signaling
|
||||
- town.robin.msc3846.turn_servers
|
||||
"https://{{ .Values.global.hosts.matrixNeoChoiceWidget }}.{{ .Values.global.domain }}/*":
|
||||
preload_approved: true
|
||||
capabilities_approved:
|
||||
- org.matrix.msc2762.send.event:net.nordeck.poll.vote
|
||||
- org.matrix.msc2762.receive.event:net.nordeck.poll.vote
|
||||
- org.matrix.msc2762.send.state_event:net.nordeck.poll
|
||||
- org.matrix.msc2762.receive.state_event:net.nordeck.poll
|
||||
- org.matrix.msc2762.send.state_event:net.nordeck.poll.settings
|
||||
- org.matrix.msc2762.receive.state_event:net.nordeck.poll.settings
|
||||
- org.matrix.msc2762.receive.state_event:m.room.power_levels
|
||||
- org.matrix.msc2762.receive.state_event:m.room.name
|
||||
- org.matrix.msc2762.receive.state_event:m.room.member
|
||||
- org.matrix.msc2762.send.state_event:net.nordeck.poll.group
|
||||
- org.matrix.msc2762.receive.state_event:net.nordeck.poll.group
|
||||
- org.matrix.msc2762.send.event:net.nordeck.poll.start
|
||||
- org.matrix.msc2762.receive.event:net.nordeck.poll.start
|
||||
"https://{{ .Values.global.hosts.matrixNeoDateFixWidget }}.{{ .Values.global.domain }}/*":
|
||||
preload_approved: true
|
||||
identity_approved: true
|
||||
capabilities_approved:
|
||||
- org.matrix.msc2931.navigate
|
||||
- org.matrix.msc2762.timeline:*
|
||||
- org.matrix.msc2762.receive.state_event:m.room.power_levels
|
||||
- org.matrix.msc2762.receive.event:m.reaction
|
||||
- org.matrix.msc2762.receive.state_event:m.room.create
|
||||
- org.matrix.msc2762.receive.state_event:m.room.tombstone
|
||||
- org.matrix.msc2762.receive.state_event:m.room.member
|
||||
- org.matrix.msc2762.send.state_event:m.room.member
|
||||
- org.matrix.msc2762.receive.state_event:m.room.name
|
||||
- org.matrix.msc2762.receive.state_event:m.room.topic
|
||||
- org.matrix.msc2762.receive.state_event:m.space.parent
|
||||
- org.matrix.msc2762.receive.state_event:m.space.child
|
||||
- org.matrix.msc2762.receive.state_event:net.nordeck.meetings.metadata
|
||||
- org.matrix.msc2762.receive.state_event:im.vector.modular.widgets
|
||||
- org.matrix.msc2762.send.event:net.nordeck.meetings.meeting.create
|
||||
- org.matrix.msc2762.receive.event:net.nordeck.meetings.meeting.create
|
||||
- org.matrix.msc2762.send.event:net.nordeck.meetings.breakoutsessions.create
|
||||
- org.matrix.msc2762.receive.event:net.nordeck.meetings.breakoutsessions.create
|
||||
- org.matrix.msc2762.send.event:net.nordeck.meetings.meeting.close
|
||||
- org.matrix.msc2762.receive.event:net.nordeck.meetings.meeting.close
|
||||
- org.matrix.msc2762.send.event:net.nordeck.meetings.meeting.widgets.handle
|
||||
- org.matrix.msc2762.receive.event:net.nordeck.meetings.meeting.widgets.handle
|
||||
- org.matrix.msc2762.send.event:net.nordeck.meetings.meeting.participants.handle
|
||||
- org.matrix.msc2762.receive.event:net.nordeck.meetings.meeting.participants.handle
|
||||
- org.matrix.msc2762.send.event:net.nordeck.meetings.meeting.update
|
||||
- org.matrix.msc2762.receive.event:net.nordeck.meetings.meeting.update
|
||||
- org.matrix.msc2762.send.event:net.nordeck.meetings.meeting.change.message_permissions
|
||||
- org.matrix.msc2762.receive.event:net.nordeck.meetings.meeting.change.message_permissions
|
||||
- org.matrix.msc2762.send.event:net.nordeck.meetings.sub_meetings.send_message
|
||||
- org.matrix.msc2762.receive.event:net.nordeck.meetings.sub_meetings.send_message
|
||||
- org.matrix.msc3973.user_directory_search
|
||||
|
||||
welcomeUserId: "@meetings-bot:{{ .Values.global.domain }}"
|
||||
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
enabled: true
|
||||
privileged: false
|
||||
readOnlyRootFilesystem: true
|
||||
runAsGroup: 101
|
||||
runAsNonRoot: true
|
||||
runAsUser: 101
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.element | toYaml | nindent 4 }}
|
||||
|
||||
global:
|
||||
domain: {{ .Values.global.domain | quote }}
|
||||
hosts:
|
||||
{{ .Values.global.hosts | toYaml | nindent 4 }}
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
image:
|
||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||
registry: {{ .Values.global.imageRegistry | default .Values.images.element.registry | quote }}
|
||||
repository: {{ .Values.images.element.repository | quote }}
|
||||
tag: {{ .Values.images.element.tag | quote }}
|
||||
|
||||
ingress:
|
||||
host: "{{ .Values.global.hosts.element }}.{{ .Values.global.domain }}"
|
||||
enabled: {{ .Values.ingress.enabled }}
|
||||
ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
|
||||
tls:
|
||||
enabled: {{ .Values.ingress.tls.enabled }}
|
||||
secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||
|
||||
podSecurityContext:
|
||||
enabled: true
|
||||
fsGroup: 101
|
||||
|
||||
replicaCount: {{ .Values.replicas.element }}
|
||||
|
||||
resources:
|
||||
{{ .Values.resources.element | toYaml | nindent 2 }}
|
||||
|
||||
theme:
|
||||
{{ .Values.theme | toYaml | nindent 2 }}
|
||||
|
||||
...
|
||||
@@ -0,0 +1,52 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
enabled: true
|
||||
privileged: false
|
||||
readOnlyRootFilesystem: true
|
||||
runAsGroup: 101
|
||||
runAsNonRoot: true
|
||||
runAsUser: 101
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.matrixNeoBoardWidget | toYaml | nindent 4 }}
|
||||
|
||||
global:
|
||||
domain: {{ .Values.global.domain | quote }}
|
||||
hosts:
|
||||
{{ .Values.global.hosts | toYaml | nindent 4 }}
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
image:
|
||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||
registry: {{ .Values.global.imageRegistry | default .Values.images.matrixNeoBoardWidget.registry | quote }}
|
||||
repository: {{ .Values.images.matrixNeoBoardWidget.repository | quote }}
|
||||
tag: {{ .Values.images.matrixNeoBoardWidget.tag | quote }}
|
||||
|
||||
ingress:
|
||||
enabled: {{ .Values.ingress.enabled }}
|
||||
ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
|
||||
tls:
|
||||
enabled: {{ .Values.ingress.tls.enabled }}
|
||||
secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||
|
||||
podSecurityContext:
|
||||
enabled: true
|
||||
fsGroup: 101
|
||||
|
||||
replicaCount: {{ .Values.replicas.matrixNeoBoardWidget }}
|
||||
|
||||
resources:
|
||||
{{ .Values.resources.matrixNeoBoardWidget | toYaml | nindent 2 }}
|
||||
|
||||
theme:
|
||||
{{ .Values.theme | toYaml | nindent 2 }}
|
||||
|
||||
...
|
||||
@@ -0,0 +1,52 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
enabled: true
|
||||
privileged: false
|
||||
readOnlyRootFilesystem: true
|
||||
runAsGroup: 101
|
||||
runAsNonRoot: true
|
||||
runAsUser: 101
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.matrixNeoChoiceWidget | toYaml | nindent 4 }}
|
||||
|
||||
global:
|
||||
domain: {{ .Values.global.domain | quote }}
|
||||
hosts:
|
||||
{{ .Values.global.hosts | toYaml | nindent 4 }}
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
image:
|
||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||
registry: {{ .Values.global.imageRegistry | default .Values.images.matrixNeoChoiceWidget.registry | quote }}
|
||||
repository: {{ .Values.images.matrixNeoChoiceWidget.repository | quote }}
|
||||
tag: {{ .Values.images.matrixNeoChoiceWidget.tag | quote }}
|
||||
|
||||
ingress:
|
||||
enabled: {{ .Values.ingress.enabled }}
|
||||
ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
|
||||
tls:
|
||||
enabled: {{ .Values.ingress.tls.enabled }}
|
||||
secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||
|
||||
podSecurityContext:
|
||||
enabled: true
|
||||
fsGroup: 101
|
||||
|
||||
replicaCount: {{ .Values.replicas.matrixNeoChoiceWidget }}
|
||||
|
||||
theme:
|
||||
{{ .Values.theme | toYaml | nindent 2 }}
|
||||
|
||||
resources:
|
||||
{{ .Values.resources.matrixNeoChoiceWidget | toYaml | nindent 2 }}
|
||||
|
||||
...
|
||||
@@ -0,0 +1,41 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
cleanup:
|
||||
deletePodsOnSuccess: {{ .Values.debug.cleanup.deletePodsOnSuccess }}
|
||||
deletePodsOnSuccessTimeout: {{ .Values.debug.cleanup.deletePodsOnSuccessTimeout }}
|
||||
|
||||
configuration:
|
||||
username: "meetings-bot"
|
||||
pod: "opendesk-synapse-0"
|
||||
secretName: "matrix-neodatefix-bot-account"
|
||||
password: {{ .Values.secrets.matrixNeoDateFixBot.password | quote }}
|
||||
|
||||
global:
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
image:
|
||||
registry: {{ .Values.global.imageRegistry | default .Values.images.synapseCreateUser.registry | quote }}
|
||||
url: {{ .Values.images.synapseCreateUser.repository | quote }}
|
||||
tag: {{ .Values.images.synapseCreateUser.tag | quote }}
|
||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||
|
||||
fullnameOverride: "matrix-neodatefix-bot-bootstrap"
|
||||
|
||||
securityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
privileged: false
|
||||
readOnlyRootFilesystem: true
|
||||
runAsGroup: 101
|
||||
runAsNonRoot: true
|
||||
runAsUser: 101
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.synapseCreateUser | toYaml | nindent 4 }}
|
||||
|
||||
...
|
||||
@@ -0,0 +1,80 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
global:
|
||||
domain: {{ .Values.global.domain | quote }}
|
||||
hosts:
|
||||
{{ .Values.global.hosts | toYaml | nindent 4 }}
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
configuration:
|
||||
bot:
|
||||
username: "meetings-bot"
|
||||
displayname: "Terminplaner Bot"
|
||||
openxchangeBaseUrl: "https://{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}"
|
||||
strings:
|
||||
breakoutSessionWidgetName: "Breakoutsessions"
|
||||
calendarRoomName: "Terminplaner"
|
||||
calendarWidgetName: "Terminplaner"
|
||||
cockpitWidgetName: "Meeting Steuerung"
|
||||
jitsiWidgetName: "Videokonferenz"
|
||||
matrixNeoBoardWidgetName: "Whiteboard"
|
||||
matrixNeoChoiceWidgetName: "Abstimmungen"
|
||||
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
enabled: true
|
||||
privileged: false
|
||||
readOnlyRootFilesystem: true
|
||||
runAsGroup: 101
|
||||
runAsNonRoot: true
|
||||
runAsUser: 101
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.matrixNeoDateFixBot | toYaml | nindent 4 }}
|
||||
|
||||
extraEnvVars:
|
||||
- name: "ACCESS_TOKEN"
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: "matrix-neodatefix-bot-account"
|
||||
key: "access_token"
|
||||
|
||||
image:
|
||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||
registry: {{ .Values.global.imageRegistry | default .Values.images.matrixNeoDateFixBot.registry | quote }}
|
||||
repository: {{ .Values.images.matrixNeoDateFixBot.repository | quote }}
|
||||
tag: {{ .Values.images.matrixNeoDateFixBot.tag | quote }}
|
||||
|
||||
ingress:
|
||||
enabled: {{ .Values.ingress.enabled }}
|
||||
ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
|
||||
tls:
|
||||
enabled: {{ .Values.ingress.tls.enabled }}
|
||||
secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||
|
||||
livenessProbe:
|
||||
enabled: true
|
||||
|
||||
persistence:
|
||||
size: {{ .Values.persistence.size.matrixNeoDateFixBot | quote }}
|
||||
storageClass: {{ .Values.persistence.storageClassNames.RWO | quote }}
|
||||
|
||||
podSecurityContext:
|
||||
enabled: true
|
||||
fsGroup: 101
|
||||
|
||||
readinessProbe:
|
||||
enabled: true
|
||||
|
||||
replicaCount: {{ .Values.replicas.matrixNeoDateFixBot }}
|
||||
|
||||
resources:
|
||||
{{ .Values.resources.matrixNeoDateFixBot | toYaml | nindent 2 }}
|
||||
|
||||
...
|
||||
@@ -0,0 +1,57 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
configuration:
|
||||
bot:
|
||||
username: "meetings-bot"
|
||||
homeserver: {{ .Values.global.matrixDomain | default .Values.global.domain }}
|
||||
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
enabled: true
|
||||
privileged: false
|
||||
readOnlyRootFilesystem: true
|
||||
runAsGroup: 101
|
||||
runAsNonRoot: true
|
||||
runAsUser: 101
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.matrixNeoDateFixWidget | toYaml | nindent 4 }}
|
||||
|
||||
global:
|
||||
domain: {{ .Values.global.domain | quote }}
|
||||
hosts:
|
||||
{{ .Values.global.hosts | toYaml | nindent 4 }}
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
image:
|
||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||
registry: {{ .Values.global.imageRegistry | default .Values.images.matrixNeoDateFixWidget.registry | quote }}
|
||||
repository: {{ .Values.images.matrixNeoDateFixWidget.repository | quote }}
|
||||
tag: {{ .Values.images.matrixNeoDateFixWidget.tag | quote }}
|
||||
|
||||
ingress:
|
||||
enabled: {{ .Values.ingress.enabled }}
|
||||
ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
|
||||
tls:
|
||||
enabled: {{ .Values.ingress.tls.enabled }}
|
||||
secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||
|
||||
podSecurityContext:
|
||||
enabled: true
|
||||
fsGroup: 101
|
||||
|
||||
replicaCount: {{ .Values.replicas.matrixNeoDateFixWidget }}
|
||||
|
||||
resources:
|
||||
{{ .Values.resources.matrixNeoDateFixWidget | toYaml | nindent 2 }}
|
||||
|
||||
theme:
|
||||
{{ .Values.theme | toYaml | nindent 2 }}
|
||||
|
||||
...
|
||||
@@ -0,0 +1,40 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
cleanup:
|
||||
deletePodsOnSuccess: {{ .Values.debug.cleanup.deletePodsOnSuccess }}
|
||||
deletePodsOnSuccessTimeout: {{ .Values.debug.cleanup.deletePodsOnSuccessTimeout }}
|
||||
|
||||
configuration:
|
||||
username: "uvs"
|
||||
pod: "opendesk-synapse-0"
|
||||
secretName: "opendesk-matrix-user-verification-service-account"
|
||||
password: {{ .Values.secrets.matrixUserVerificationService.password | quote }}
|
||||
|
||||
global:
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
image:
|
||||
registry: {{ .Values.global.imageRegistry | default .Values.images.synapseCreateUser.registry | quote }}
|
||||
url: {{ .Values.images.synapseCreateUser.repository | quote }}
|
||||
tag: {{ .Values.images.synapseCreateUser.tag | quote }}
|
||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||
|
||||
fullnameOverride: "opendesk-matrix-user-verification-service-bootstrap"
|
||||
|
||||
securityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
privileged: false
|
||||
readOnlyRootFilesystem: true
|
||||
runAsGroup: 101
|
||||
runAsNonRoot: true
|
||||
runAsUser: 101
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.synapseCreateUser | toYaml | nindent 4 }}
|
||||
...
|
||||
@@ -0,0 +1,51 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
enabled: true
|
||||
privileged: false
|
||||
readOnlyRootFilesystem: false
|
||||
runAsGroup: 0
|
||||
runAsNonRoot: false
|
||||
runAsUser: 0
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.matrixUserVerificationService | toYaml | nindent 4 }}
|
||||
|
||||
extraEnvVars:
|
||||
- name: "UVS_ACCESS_TOKEN"
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: "opendesk-matrix-user-verification-service-account"
|
||||
key: "access_token"
|
||||
- name: "UVS_DISABLE_IP_BLACKLIST"
|
||||
value: "true"
|
||||
|
||||
global:
|
||||
domain: {{ .Values.global.domain | quote }}
|
||||
hosts:
|
||||
{{ .Values.global.hosts | toYaml | nindent 4 }}
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
image:
|
||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||
registry: {{ .Values.global.imageRegistry | default .Values.images.matrixUserVerificationService.registry | quote }}
|
||||
repository: {{ .Values.images.matrixUserVerificationService.repository | quote }}
|
||||
tag: {{ .Values.images.matrixUserVerificationService.tag | quote }}
|
||||
|
||||
podSecurityContext:
|
||||
enabled: true
|
||||
fsGroup: 101
|
||||
|
||||
replicaCount: {{ .Values.replicas.matrixUserVerificationService }}
|
||||
|
||||
resources:
|
||||
{{ .Values.resources.matrixUserVerificationService | toYaml | nindent 2 }}
|
||||
|
||||
...
|
||||
@@ -1,31 +0,0 @@
|
||||
{{/*
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
*/}}
|
||||
---
|
||||
global:
|
||||
domain: "{{ .Values.global.domain }}"
|
||||
registry: "{{ .Values.global.imageRegistry }}"
|
||||
hosts:
|
||||
{{ .Values.global.hosts | toYaml | nindent 4 }}
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
image:
|
||||
registry: "{{ .Values.global.imageRegistry }}"
|
||||
repository: "{{ .Values.images.synapseWeb.repository }}"
|
||||
tag: "{{ .Values.images.synapseWeb.tag }}"
|
||||
|
||||
ingress:
|
||||
host: "{{ .Values.global.hosts.synapse }}.{{ .Values.global.domain }}"
|
||||
enabled: "{{ .Values.ingress.enabled }}"
|
||||
ingressClassName: "{{ .Values.ingress.ingressClassName }}"
|
||||
tls:
|
||||
enabled: "{{ .Values.ingress.tls.enabled }}"
|
||||
secretName: "{{ .Values.ingress.tls.secretName }}"
|
||||
|
||||
replicaCount: {{ .Values.replicas.synapseWeb }}
|
||||
|
||||
resources:
|
||||
{{ .Values.resources.synapseWeb | toYaml | nindent 2 }}
|
||||
...
|
||||
60
helmfile/apps/element/values-synapse-web.yaml.gotmpl
Normal file
60
helmfile/apps/element/values-synapse-web.yaml.gotmpl
Normal file
@@ -0,0 +1,60 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
clusterDomain: {{ .Values.cluster.networking.domain }}
|
||||
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
enabled: true
|
||||
privileged: false
|
||||
readOnlyRootFilesystem: true
|
||||
runAsGroup: 101
|
||||
runAsNonRoot: true
|
||||
runAsUser: 101
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.synapseWeb | toYaml | nindent 4 }}
|
||||
|
||||
global:
|
||||
domain: {{ .Values.global.domain | quote }}
|
||||
clusterDomain: {{ .Values.cluster.networking.domain | quote }}
|
||||
hosts:
|
||||
{{ .Values.global.hosts | toYaml | nindent 4 }}
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
image:
|
||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||
registry: {{ .Values.global.imageRegistry | default .Values.images.synapseWeb.registry | quote }}
|
||||
repository: {{ .Values.images.synapseWeb.repository | quote }}
|
||||
tag: {{ .Values.images.synapseWeb.tag | quote }}
|
||||
|
||||
ingress:
|
||||
annotations:
|
||||
nginx.ingress.kubernetes.io/proxy-body-size: "{{ .Values.ingress.parameters.bodySize.element }}"
|
||||
nginx.ingress.kubernetes.io/proxy-read-timeout: "{{ .Values.ingress.parameters.bodyTimeout.element }}"
|
||||
nginx.ingress.kubernetes.io/proxy-send-timeout: "{{ .Values.ingress.parameters.bodyTimeout.element }}"
|
||||
nginx.org/client-max-body-size: "{{ .Values.ingress.parameters.bodySize.element }}"
|
||||
nginx.org/proxy-read-timeout: "{{ .Values.ingress.parameters.bodyTimeout.element }}s"
|
||||
nginx.org/proxy-send-timeout: "{{ .Values.ingress.parameters.bodyTimeout.element }}s"
|
||||
host: "{{ .Values.global.hosts.synapse }}.{{ .Values.global.domain }}"
|
||||
enabled: {{ .Values.ingress.enabled }}
|
||||
ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
|
||||
tls:
|
||||
enabled: {{ .Values.ingress.tls.enabled }}
|
||||
secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||
|
||||
podSecurityContext:
|
||||
enabled: true
|
||||
fsGroup: 101
|
||||
|
||||
replicaCount: {{ .Values.replicas.synapseWeb }}
|
||||
|
||||
resources:
|
||||
{{ .Values.resources.synapseWeb | toYaml | nindent 2 }}
|
||||
|
||||
...
|
||||
@@ -1,52 +0,0 @@
|
||||
{{/*
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
*/}}
|
||||
---
|
||||
global:
|
||||
domain: "{{ .Values.global.domain }}"
|
||||
registry: "{{ .Values.global.imageRegistry }}"
|
||||
hosts:
|
||||
{{ .Values.global.hosts | toYaml | nindent 4 }}
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
image:
|
||||
registry: "{{ .Values.global.imageRegistry }}"
|
||||
repository: "{{ .Values.images.synapse.repository }}"
|
||||
tag: "{{ .Values.images.synapse.tag }}"
|
||||
|
||||
configuration:
|
||||
database:
|
||||
host: "{{ .Values.databases.synapse.host }}"
|
||||
name: "{{ .Values.databases.synapse.name }}"
|
||||
user: "{{ .Values.databases.synapse.username }}"
|
||||
password: "{{ .Values.databases.synapse.password | default .Values.secrets.postgresql.matrixUser }}"
|
||||
|
||||
homeserver:
|
||||
oidc:
|
||||
clientSecret: {{ .Values.secrets.keycloak.clientSecret.matrix }}
|
||||
issuer: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/souvap"
|
||||
|
||||
turn:
|
||||
sharedSecret: {{ .Values.turn.credentials }}
|
||||
servers:
|
||||
{{- if .Values.turn.tls.host }}
|
||||
- server: {{ .Values.turn.tls.host }}
|
||||
port: {{ .Values.turn.tls.port }}
|
||||
transport: {{ .Values.turn.transport }}
|
||||
{{- else if .Values.turn.server.host }}
|
||||
- server: {{ .Values.turn.server.host }}
|
||||
port: {{ .Values.turn.server.port }}
|
||||
transport: {{ .Values.turn.transport }}
|
||||
{{- end }}
|
||||
|
||||
persistence:
|
||||
size: "{{ .Values.persistence.size.synapse }}"
|
||||
storageClass: "{{ .Values.persistence.storageClassNames.RWO }}"
|
||||
|
||||
replicaCount: {{ .Values.replicas.synapse }}
|
||||
|
||||
resources:
|
||||
{{ .Values.resources.synapse | toYaml | nindent 2 }}
|
||||
...
|
||||
150
helmfile/apps/element/values-synapse.yaml.gotmpl
Normal file
150
helmfile/apps/element/values-synapse.yaml.gotmpl
Normal file
@@ -0,0 +1,150 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
configuration:
|
||||
additionalConfiguration:
|
||||
user_directory:
|
||||
enabled: true
|
||||
search_all_users: true
|
||||
room_prejoin_state:
|
||||
additional_event_types:
|
||||
- "m.space.parent"
|
||||
- "net.nordeck.meetings.metadata"
|
||||
- "m.room.power_levels"
|
||||
# When a user logs into Element a parallel request is done through Intercom Service to allow Synapse API
|
||||
# interaction, to avoid (temporary) blocking of the user for followup logins we want to raise the limits.
|
||||
# https://matrix-org.github.io/synapse/v1.59/usage/configuration/config_documentation.html#ratelimiting
|
||||
rc_login:
|
||||
account:
|
||||
per_second: 2
|
||||
burst_count: 8
|
||||
address:
|
||||
per_second: 2
|
||||
burst_count: 12
|
||||
|
||||
database:
|
||||
host: {{ .Values.databases.synapse.host | quote }}
|
||||
name: {{ .Values.databases.synapse.name | quote }}
|
||||
user: {{ .Values.databases.synapse.username | quote }}
|
||||
password: {{ .Values.databases.synapse.password | default .Values.secrets.postgresql.matrixUser | quote }}
|
||||
|
||||
homeserver:
|
||||
serverName: {{ .Values.global.matrixDomain | default .Values.global.domain }}
|
||||
appServiceConfigs:
|
||||
- as_token: {{ .Values.secrets.intercom.synapseAsToken | quote }}
|
||||
hs_token: {{ .Values.secrets.intercom.synapseAsToken | quote }}
|
||||
id: intercom-service
|
||||
namespaces:
|
||||
users:
|
||||
- exclusive: false
|
||||
regex: "@.*"
|
||||
url: null
|
||||
sender_localpart: intercom-service
|
||||
- as_token: {{ .Values.secrets.oxAppsuite.synapseAsToken | quote }}
|
||||
hs_token: {{ .Values.secrets.oxAppsuite.synapseAsToken | quote }}
|
||||
id: ox-appsuite
|
||||
namespaces:
|
||||
users:
|
||||
- exclusive: false
|
||||
regex: "@.*"
|
||||
url: null
|
||||
sender_localpart: ox-appsuite
|
||||
|
||||
presence:
|
||||
enabled: {{ .Values.functional.dataProtection.matrixPresence.enabled }}
|
||||
|
||||
smtp:
|
||||
senderAddress: "{{ .Values.smtp.localpartNoReply }}@{{ if .Values.functional.email.systemGenerated.useComponentInSenderdomain }}{{ .Values.global.hosts.element }}.{{ end }}{{ .Values.global.domain }}"
|
||||
host: {{ .Values.smtp.host | quote }}
|
||||
port: {{ .Values.smtp.port }}
|
||||
username: {{ .Values.smtp.username | quote }}
|
||||
password: {{ .Values.smtp.password | quote }}
|
||||
|
||||
oidc:
|
||||
clientId: "opendesk-matrix"
|
||||
clientSecret: {{ .Values.secrets.keycloak.clientSecret.matrix | quote }}
|
||||
issuer: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}"
|
||||
scopes:
|
||||
- "openid"
|
||||
- "opendesk-matrix-scope"
|
||||
|
||||
turn:
|
||||
sharedSecret: {{ .Values.turn.credentials | quote }}
|
||||
servers:
|
||||
{{- if .Values.turn.tls.host }}
|
||||
- server: {{ .Values.turn.tls.host | quote }}
|
||||
port: {{ .Values.turn.tls.port }}
|
||||
transport: {{ .Values.turn.transport | quote }}
|
||||
{{- else if .Values.turn.server.host }}
|
||||
- server: {{ .Values.turn.server.host | quote }}
|
||||
port: {{ .Values.turn.server.port }}
|
||||
transport: {{ .Values.turn.transport | quote }}
|
||||
{{- end }}
|
||||
|
||||
guestModule:
|
||||
enabled: true
|
||||
image:
|
||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||
registry: {{ .Values.global.imageRegistry | default .Values.images.synapseGuestModule.registry | quote }}
|
||||
repository: {{ .Values.images.synapseGuestModule.repository | quote }}
|
||||
tag: {{ .Values.images.synapseGuestModule.tag | quote }}
|
||||
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
enabled: true
|
||||
privileged: false
|
||||
readOnlyRootFilesystem: true
|
||||
runAsNonRoot: true
|
||||
runAsUser: 10991
|
||||
runAsGroup: 10991
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.synapse | toYaml | nindent 4 }}
|
||||
|
||||
federation:
|
||||
enabled: {{ .Values.functional.externalServices.matrix.federation.enabled }}
|
||||
ingress:
|
||||
host: "{{ .Values.global.hosts.synapseFederation }}.{{ .Values.global.domain }}"
|
||||
enabled: {{ .Values.ingress.enabled }}
|
||||
ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
|
||||
tls:
|
||||
enabled: {{ .Values.ingress.tls.enabled }}
|
||||
secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||
|
||||
global:
|
||||
domain: {{ .Values.global.domain | quote }}
|
||||
hosts:
|
||||
{{ .Values.global.hosts | toYaml | nindent 4 }}
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
image:
|
||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||
registry: {{ .Values.global.imageRegistry | default .Values.images.synapse.registry | quote }}
|
||||
repository: {{ .Values.images.synapse.repository | quote }}
|
||||
tag: {{ .Values.images.synapse.tag | quote }}
|
||||
|
||||
persistence:
|
||||
size: {{ .Values.persistence.size.synapse | quote }}
|
||||
storageClass: {{ .Values.persistence.storageClassNames.RWO | quote }}
|
||||
|
||||
podSecurityContext:
|
||||
enabled: true
|
||||
fsGroup: 10991
|
||||
|
||||
readinessProbe:
|
||||
initialDelaySeconds: 15
|
||||
periodSeconds: 5
|
||||
|
||||
replicaCount: {{ .Values.replicas.synapse }}
|
||||
|
||||
resources:
|
||||
{{ .Values.resources.synapse | toYaml | nindent 2 }}
|
||||
|
||||
tls:
|
||||
secretName: {{ if .Values.global.matrixDomain }}"opendesk-certificates-synapse-tls"{{ else }}"opendesk-certificates-tls"{{ end }}
|
||||
...
|
||||
@@ -1,31 +0,0 @@
|
||||
{{/*
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
*/}}
|
||||
---
|
||||
global:
|
||||
domain: "{{ .Values.global.domain }}"
|
||||
registry: "{{ .Values.global.imageRegistry }}"
|
||||
hosts:
|
||||
{{ .Values.global.hosts | toYaml | nindent 4 }}
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
image:
|
||||
registry: "{{ .Values.global.imageRegistry }}"
|
||||
repository: "{{ .Values.images.wellKnown.repository }}"
|
||||
tag: "{{ .Values.images.wellKnown.tag }}"
|
||||
|
||||
ingress:
|
||||
host: "{{ .Values.global.domain }}"
|
||||
enabled: "{{ .Values.ingress.enabled }}"
|
||||
ingressClassName: "{{ .Values.ingress.ingressClassName }}"
|
||||
tls:
|
||||
enabled: "{{ .Values.ingress.tls.enabled }}"
|
||||
secretName: "{{ .Values.ingress.tls.secretName }}"
|
||||
|
||||
replicaCount: {{ .Values.replicas.wellKnown }}
|
||||
|
||||
resources:
|
||||
{{ .Values.resources.wellKnown | toYaml | nindent 2 }}
|
||||
...
|
||||
@@ -1,7 +0,0 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
configuration:
|
||||
e2ee:
|
||||
forceDisable: true
|
||||
...
|
||||
54
helmfile/apps/element/values-well-known.yaml.gotmpl
Normal file
54
helmfile/apps/element/values-well-known.yaml.gotmpl
Normal file
@@ -0,0 +1,54 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
configuration:
|
||||
e2ee:
|
||||
forceDisable: false
|
||||
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
enabled: true
|
||||
privileged: false
|
||||
readOnlyRootFilesystem: true
|
||||
runAsGroup: 101
|
||||
runAsNonRoot: true
|
||||
runAsUser: 101
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.wellKnown | toYaml | nindent 4 }}
|
||||
|
||||
global:
|
||||
domain: {{ .Values.global.domain | quote }}
|
||||
hosts:
|
||||
{{ .Values.global.hosts | toYaml | nindent 4 }}
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
image:
|
||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||
registry: {{ .Values.global.imageRegistry | default .Values.images.wellKnown.registry | quote }}
|
||||
repository: {{ .Values.images.wellKnown.repository | quote }}
|
||||
tag: {{ .Values.images.wellKnown.tag | quote }}
|
||||
|
||||
ingress:
|
||||
host: {{ .Values.global.domain | quote }}
|
||||
enabled: {{ .Values.ingress.enabled }}
|
||||
ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
|
||||
tls:
|
||||
enabled: {{ .Values.ingress.tls.enabled }}
|
||||
secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||
|
||||
podSecurityContext:
|
||||
enabled: true
|
||||
fsGroup: 101
|
||||
|
||||
replicaCount: {{ .Values.replicas.wellKnown }}
|
||||
|
||||
resources:
|
||||
{{ .Values.resources.wellKnown | toYaml | nindent 2 }}
|
||||
|
||||
...
|
||||
@@ -1,43 +0,0 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
**Content / Quick navigation**
|
||||
|
||||
[[_TOC_]]
|
||||
|
||||
# Component overview
|
||||
|
||||
The Intercom Service (ICS) is used to address integrational use cases where the frontend of one application has to call APIs from another application.
|
||||
|
||||
# Resources
|
||||
|
||||
- External documentation: https://docs.software-univention.de/intercom-service/latest/index.html
|
||||
- Helm chart: https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/components/charts/sovereign-workplace-intercom-service
|
||||
- Image: not yet published on Open CoDE, image will be provided through external artifactory.
|
||||
|
||||
# Operational Capabilities
|
||||
|
||||
## Install
|
||||
|
||||
## Restart
|
||||
|
||||
## Update
|
||||
|
||||
## Upgrade
|
||||
|
||||
## Secrets
|
||||
|
||||
## Logging
|
||||
|
||||
## Monitoring
|
||||
|
||||
## Scale
|
||||
|
||||
## Network policies
|
||||
|
||||
## Uninstall
|
||||
|
||||
# Debugging
|
||||
|
||||
ICS does not have a debug level option yet. But please refer to the most current documentation of the component. You just want to look into the standard log output of the component.
|
||||
27
helmfile/apps/intercom-service/helmfile-child.yaml
Normal file
27
helmfile/apps/intercom-service/helmfile-child.yaml
Normal file
@@ -0,0 +1,27 @@
|
||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
repositories:
|
||||
# Intercom Service
|
||||
# Source: https://gitlab.souvap-univention.de/souvap/tooling/charts/intercom-service
|
||||
- name: "intercom-service-repo"
|
||||
keyring: "../../files/gpg-pubkeys/souvap-univention-de.gpg"
|
||||
verify: {{ .Values.charts.intercomService.verify }}
|
||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||
oci: true
|
||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.intercomService.registry }}/\
|
||||
{{ .Values.charts.intercomService.repository }}"
|
||||
|
||||
releases:
|
||||
- name: "intercom-service"
|
||||
chart: "intercom-service-repo/{{ .Values.charts.intercomService.name }}"
|
||||
version: "{{ .Values.charts.intercomService.version }}"
|
||||
values:
|
||||
- "values.yaml.gotmpl"
|
||||
installed: {{ .Values.intercom.enabled }}
|
||||
|
||||
commonLabels:
|
||||
deploy-stage: "component-1"
|
||||
component: "intercom-service"
|
||||
...
|
||||
@@ -1,25 +1,12 @@
|
||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
repositories:
|
||||
- name: "intercom-service-repo"
|
||||
url: >-
|
||||
{{ env "PRIVATE_CHART_REPOSITORY_URL" |
|
||||
default "https://gitlab.souvap-univention.de/api/v4/projects/66/packages/helm/stable" }}
|
||||
|
||||
releases:
|
||||
- name: "intercom-service"
|
||||
chart: "intercom-service-repo/intercom-service"
|
||||
version: "1.1.3"
|
||||
values:
|
||||
- "values.yaml"
|
||||
- "values.gotmpl"
|
||||
condition: "intercom.enabled"
|
||||
|
||||
commonLabels:
|
||||
deploy-stage: "component-1"
|
||||
component: "intercom-service"
|
||||
|
||||
bases:
|
||||
- "../../bases/environments.yaml"
|
||||
---
|
||||
helmfiles:
|
||||
- path: "./helmfile-child.yaml"
|
||||
values:
|
||||
- {{ toYaml .Values | nindent 8 }}
|
||||
...
|
||||
|
||||
@@ -1,43 +0,0 @@
|
||||
{{/*
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
*/}}
|
||||
---
|
||||
global:
|
||||
domain: "{{ .Values.global.domain }}"
|
||||
hosts:
|
||||
{{ .Values.global.hosts | toYaml | nindent 4 }}
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
ics:
|
||||
secret: {{ .Values.secrets.intercom.secret }}
|
||||
issuerBaseUrl: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/souvap"
|
||||
originRegex: "{{ .Values.istio.domain }}"
|
||||
default:
|
||||
domain: "{{ .Values.global.domain }}"
|
||||
oidc:
|
||||
secret: {{ .Values.secrets.keycloak.clientSecret.intercom }}
|
||||
matrix:
|
||||
asSecret: {{ .Values.secrets.jitsi.synapseAsToken }}
|
||||
serverName: "matrix.{{ .Values.global.domain }}"
|
||||
portal:
|
||||
apiKey: {{ .Values.secrets.centralnavigation.apiKey }}
|
||||
redis:
|
||||
password: {{ .Values.secrets.redis.password }}
|
||||
openxchange:
|
||||
url: "https://{{ .Values.global.hosts.openxchange }}.{{ .Values.istio.domain }}"
|
||||
|
||||
image:
|
||||
registry: "{{ .Values.global.imageRegistry }}"
|
||||
repository: "{{ .Values.images.intercom.repository }}"
|
||||
tag: "{{ .Values.images.intercom.tag }}"
|
||||
|
||||
ingress:
|
||||
host: "{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}"
|
||||
enabled: "{{ .Values.ingress.enabled }}"
|
||||
ingressClassName: "{{ .Values.ingress.ingressClassName }}"
|
||||
tls:
|
||||
enabled: "{{ .Values.ingress.tls.enabled }}"
|
||||
secretName: "{{ .Values.ingress.tls.secretName }}"
|
||||
...
|
||||
@@ -1,8 +0,0 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
istio:
|
||||
enabled: false
|
||||
virtualService:
|
||||
enabled: false
|
||||
...
|
||||
80
helmfile/apps/intercom-service/values.yaml.gotmpl
Normal file
80
helmfile/apps/intercom-service/values.yaml.gotmpl
Normal file
@@ -0,0 +1,80 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
enabled: true
|
||||
privileged: false
|
||||
runAsUser: 1000
|
||||
runAsGroup: 1000
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
readOnlyRootFilesystem: true
|
||||
runAsNonRoot: true
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.intercom | toYaml | nindent 4 }}
|
||||
|
||||
global:
|
||||
domain: {{ .Values.global.domain | quote }}
|
||||
hosts:
|
||||
{{ .Values.global.hosts | toYaml | nindent 4 }}
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
ics:
|
||||
secret: {{ .Values.secrets.intercom.secret | quote }}
|
||||
issuerBaseUrl: "https://{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}/realms/{{ .Values.platform.realm }}"
|
||||
originRegex: "{{ .Values.global.domain }}"
|
||||
keycloak:
|
||||
realm: {{ .Values.platform.realm | quote }}
|
||||
default:
|
||||
domain: {{ .Values.global.domain | quote }}
|
||||
oidc:
|
||||
id: "opendesk-intercom"
|
||||
secret: {{ .Values.secrets.keycloak.clientSecret.intercom | quote }}
|
||||
matrix:
|
||||
asSecret: {{ .Values.secrets.intercom.synapseAsToken | quote }}
|
||||
subdomain: {{ .Values.global.hosts.synapse | quote }}
|
||||
serverName: "{{ .Values.global.hosts.synapse }}.{{ .Values.global.domain }}"
|
||||
nordeck:
|
||||
subdomain: {{ .Values.global.hosts.matrixNeoDateFixBot | quote }}
|
||||
portal:
|
||||
apiKey: {{ .Values.secrets.centralnavigation.apiKey | quote }}
|
||||
redis:
|
||||
host: {{ .Values.cache.intercomService.host | quote }}
|
||||
port: {{ .Values.cache.intercomService.port }}
|
||||
password: {{ .Values.cache.intercomService.password | default .Values.secrets.redis.password | quote }}
|
||||
openxchange:
|
||||
oci: true
|
||||
url: "https://{{ .Values.global.hosts.openxchange }}.{{ .Values.global.domain }}"
|
||||
audience: "opendesk-oxappsuite"
|
||||
nextcloud:
|
||||
audience: "opendesk-nextcloud"
|
||||
image:
|
||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||
registry: {{ .Values.global.imageRegistry | default .Values.images.intercom.registry | quote }}
|
||||
repository: {{ .Values.images.intercom.repository | quote }}
|
||||
tag: {{ .Values.images.intercom.tag | quote }}
|
||||
|
||||
ingress:
|
||||
host: "{{ .Values.global.hosts.intercomService }}.{{ .Values.global.domain }}"
|
||||
enabled: {{ .Values.ingress.enabled }}
|
||||
ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
|
||||
tls:
|
||||
enabled: {{ .Values.ingress.tls.enabled }}
|
||||
secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||
|
||||
podSecurityContext:
|
||||
enabled: true
|
||||
fsGroup: 1000
|
||||
fsGroupChangePolicy: "Always"
|
||||
|
||||
replicaCount: {{ .Values.replicas.intercomService }}
|
||||
|
||||
resources:
|
||||
{{ .Values.resources.intercomService | toYaml | nindent 2 }}
|
||||
|
||||
...
|
||||
28
helmfile/apps/jitsi/helmfile-child.yaml
Normal file
28
helmfile/apps/jitsi/helmfile-child.yaml
Normal file
@@ -0,0 +1,28 @@
|
||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
repositories:
|
||||
# openDesk Jitsi
|
||||
# Source: https://gitlab.opencode.de/bmi/opendesk/components/platform-development/charts/opendesk-jitsi
|
||||
- name: "jitsi-repo"
|
||||
keyring: "../../files/gpg-pubkeys/opencode.gpg"
|
||||
verify: {{ .Values.charts.jitsi.verify }}
|
||||
username: {{ env "OD_PRIVATE_REGISTRY_USERNAME" | quote }}
|
||||
password: {{ env "OD_PRIVATE_REGISTRY_PASSWORD" | quote }}
|
||||
oci: true
|
||||
url: "{{ .Values.global.helmRegistry | default .Values.charts.jitsi.registry }}/\
|
||||
{{ .Values.charts.jitsi.repository }}"
|
||||
|
||||
releases:
|
||||
- name: "jitsi"
|
||||
chart: "jitsi-repo/{{ .Values.charts.jitsi.name }}"
|
||||
version: "{{ .Values.charts.jitsi.version }}"
|
||||
values:
|
||||
- "values-jitsi.yaml.gotmpl"
|
||||
installed: {{ .Values.jitsi.enabled }}
|
||||
timeout: 900
|
||||
|
||||
commonLabels:
|
||||
deploy-stage: "component-1"
|
||||
component: "jitsi"
|
||||
...
|
||||
@@ -1,24 +1,12 @@
|
||||
# SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
repositories:
|
||||
- name: "jitsi-repo"
|
||||
oci: true
|
||||
url: >-
|
||||
{{ env "PRIVATE_IMAGE_REGISTRY_URL" | default
|
||||
"external-registry.souvap-univention.de/sovereign-workplace/souvap/tooling/charts/sovereign-workplace-jitsi" }}
|
||||
releases:
|
||||
- name: "jitsi"
|
||||
chart: "jitsi-repo/sovereign-workplace-jitsi"
|
||||
version: "1.3.0"
|
||||
values:
|
||||
- "values-jitsi.gotmpl"
|
||||
condition: "jitsi.enabled"
|
||||
|
||||
commonLabels:
|
||||
deploy-stage: "component-1"
|
||||
component: "jitsi"
|
||||
|
||||
bases:
|
||||
- "../../bases/environments.yaml"
|
||||
---
|
||||
helmfiles:
|
||||
- path: "./helmfile-child.yaml"
|
||||
values:
|
||||
- {{ toYaml .Values | nindent 8 }}
|
||||
...
|
||||
|
||||
@@ -1,128 +0,0 @@
|
||||
{{/*
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
*/}}
|
||||
---
|
||||
global:
|
||||
domain: "{{ .Values.global.domain }}"
|
||||
registry: "{{ .Values.global.imageRegistry }}"
|
||||
hosts:
|
||||
{{ .Values.global.hosts | toYaml | nindent 4 }}
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
image:
|
||||
registry: "{{ .Values.global.imageRegistry }}"
|
||||
repository: "{{ .Values.images.jitsiKeycloakAdapter.repository }}"
|
||||
tag: "{{ .Values.images.jitsiKeycloakAdapter.tag }}"
|
||||
|
||||
settings:
|
||||
jwtAppSecret: "{{ .Values.secrets.jitsi.jwtAppSecret }}"
|
||||
|
||||
theme:
|
||||
{{ .Values.theme | toYaml | nindent 2 }}
|
||||
|
||||
jitsi:
|
||||
publicURL: "https://{{ .Values.global.hosts.jitsi }}.{{ .Values.global.domain }}"
|
||||
web:
|
||||
replicaCount: {{ .Values.replicas.jitsi }}
|
||||
image:
|
||||
repository: "{{ .Values.global.imageRegistry }}/{{ .Values.images.jitsi.repository }}"
|
||||
tag: "{{ .Values.images.jitsi.tag }}"
|
||||
ingress:
|
||||
enabled: "{{ .Values.ingress.enabled }}"
|
||||
ingressClassName: "{{ .Values.ingress.ingressClassName }}"
|
||||
hosts:
|
||||
- host: "{{ .Values.global.hosts.jitsi }}.{{ .Values.global.domain }}"
|
||||
paths:
|
||||
- "/"
|
||||
tls:
|
||||
- secretName: "{{ .Values.ingress.tls.secretName }}"
|
||||
hosts:
|
||||
- "{{ .Values.global.hosts.jitsi }}.{{ .Values.global.domain }}"
|
||||
extraEnvs:
|
||||
TURN_ENABLE: "1"
|
||||
resources:
|
||||
{{ .Values.resources.jitsi | toYaml | nindent 6 }}
|
||||
prosody:
|
||||
image:
|
||||
repository: "{{ .Values.global.imageRegistry }}/{{ .Values.images.prosody.repository }}"
|
||||
tag: "{{ .Values.images.prosody.tag }}"
|
||||
imagePullSecrets:
|
||||
{{- range .Values.global.imagePullSecrets }}
|
||||
- name: {{ . }}
|
||||
{{- end }}
|
||||
extraEnvs:
|
||||
- name: "AUTH_TYPE"
|
||||
value: "hybrid_matrix_token"
|
||||
- name: "JWT_APP_ID"
|
||||
value: "myappid"
|
||||
- name: "JWT_APP_SECRET"
|
||||
value: "{{ .Values.secrets.jitsi.jwtAppSecret }}"
|
||||
- name: TURNS_HOST
|
||||
value: "{{ .Values.turn.tls.host }}"
|
||||
- name: TURNS_PORT
|
||||
value: "{{ .Values.turn.tls.port }}"
|
||||
- name: TURN_HOST
|
||||
value: "{{ .Values.turn.server.host }}"
|
||||
- name: TURN_PORT
|
||||
value: "{{ .Values.turn.server.port }}"
|
||||
- name: TURN_TRANSPORT
|
||||
value: "{{ .Values.turn.transport }}"
|
||||
- name: TURN_CREDENTIALS
|
||||
value: "{{ .Values.turn.credentials }}"
|
||||
resources:
|
||||
{{ .Values.resources.prosody | toYaml | nindent 6 }}
|
||||
persistence:
|
||||
size: "{{ .Values.persistence.size.prosody }}"
|
||||
storageClassName: "{{ .Values.persistence.storageClassNames.RWO }}"
|
||||
jicofo:
|
||||
replicaCount: {{ .Values.replicas.jicofo }}
|
||||
image:
|
||||
repository: "{{ .Values.global.imageRegistry }}/{{ .Values.images.jicofo.repository }}"
|
||||
tag: "{{ .Values.images.jicofo.tag }}"
|
||||
xmpp:
|
||||
password: "{{ .Values.secrets.jitsi.jicofoAuthPassword }}"
|
||||
componentSecret: "{{ .Values.secrets.jitsi.jicofoComponentPassword }}"
|
||||
resources:
|
||||
{{ .Values.resources.jicofo | toYaml | nindent 6 }}
|
||||
jvb:
|
||||
replicaCount: {{ .Values.replicas.jvb }}
|
||||
image:
|
||||
repository: "{{ .Values.global.imageRegistry }}/{{ .Values.images.jvb.repository }}"
|
||||
tag: "{{ .Values.images.jvb.tag }}"
|
||||
xmpp:
|
||||
password: "{{ .Values.secrets.jitsi.jvbAuthPassword }}"
|
||||
resources:
|
||||
{{ .Values.resources.jvb | toYaml | nindent 6 }}
|
||||
service:
|
||||
type: "{{ .Values.cluster.service.type }}"
|
||||
jibri:
|
||||
replicaCount: {{ .Values.replicas.jibri }}
|
||||
image:
|
||||
repository: "{{ .Values.global.imageRegistry }}/{{ .Values.images.jibri.repository }}"
|
||||
tag: "{{ .Values.images.jibri.tag }}"
|
||||
recorder:
|
||||
password: "{{ .Values.secrets.jitsi.jibriRecorderPassword }}"
|
||||
xmpp:
|
||||
password: "{{ .Values.secrets.jitsi.jibriXmppPassword }}"
|
||||
resources:
|
||||
{{ .Values.resources.jibri | toYaml | nindent 6 }}
|
||||
imagePullSecrets:
|
||||
{{- range .Values.global.imagePullSecrets }}
|
||||
- name: {{ . }}
|
||||
{{- end }}
|
||||
|
||||
patchJVB:
|
||||
configuration:
|
||||
staticLoadbalancerIP: "{{ .Values.cluster.networking.ingressGatewayIP }}"
|
||||
loadbalancerStatusField: "{{ .Values.cluster.networking.loadBalancerStatusField }}"
|
||||
image:
|
||||
registry: "{{ .Values.global.imageRegistry }}"
|
||||
repository: "{{ .Values.images.jitsiPatchJVB.repository }}"
|
||||
tag: "{{ .Values.images.jitsiPatchJVB.tag }}"
|
||||
replicaCount: {{ .Values.replicas.jitsiKeycloakAdapter }}
|
||||
|
||||
resources:
|
||||
{{ .Values.resources.jitsiKeycloakAdapter | toYaml | nindent 2 }}
|
||||
...
|
||||
221
helmfile/apps/jitsi/values-jitsi.yaml.gotmpl
Normal file
221
helmfile/apps/jitsi/values-jitsi.yaml.gotmpl
Normal file
@@ -0,0 +1,221 @@
|
||||
{{/*
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
*/}}
|
||||
---
|
||||
global:
|
||||
domain: {{ .Values.global.domain | quote }}
|
||||
hosts:
|
||||
{{ .Values.global.hosts | toYaml | nindent 4 }}
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
enabled: true
|
||||
readOnlyRootFilesystem: true
|
||||
privileged: false
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
runAsUser: 1993
|
||||
runAsGroup: 1993
|
||||
runAsNonRoot: true
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.jitsiKeycloakAdapter | toYaml | nindent 4 }}
|
||||
|
||||
cleanup:
|
||||
deletePodsOnSuccess: {{ .Values.debug.cleanup.deletePodsOnSuccess }}
|
||||
|
||||
image:
|
||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||
registry: {{ .Values.global.imageRegistry | default .Values.images.jitsiKeycloakAdapter.registry | quote }}
|
||||
repository: {{ .Values.images.jitsiKeycloakAdapter.repository | quote }}
|
||||
tag: {{ .Values.images.jitsiKeycloakAdapter.tag | quote }}
|
||||
|
||||
settings:
|
||||
jwtAppSecret: {{ .Values.secrets.jitsi.jwtAppSecret | quote }}
|
||||
keycloakRealm: {{ .Values.platform.realm | quote }}
|
||||
keycloakClientId: "opendesk-jitsi"
|
||||
|
||||
theme:
|
||||
{{ .Values.theme | toYaml | nindent 2 }}
|
||||
|
||||
jitsi:
|
||||
publicURL: "https://{{ .Values.global.hosts.jitsi }}.{{ .Values.global.domain }}"
|
||||
web:
|
||||
replicaCount: {{ .Values.replicas.jitsi }}
|
||||
image:
|
||||
repository: "{{ .Values.global.imageRegistry | default .Values.images.jitsi.registry }}/{{ .Values.images.jitsi.repository }}"
|
||||
tag: {{ .Values.images.jitsi.tag | quote }}
|
||||
ingress:
|
||||
enabled: {{ .Values.ingress.enabled }}
|
||||
ingressClassName: {{ .Values.ingress.ingressClassName | quote }}
|
||||
hosts:
|
||||
- host: "{{ .Values.global.hosts.jitsi }}.{{ .Values.global.domain }}"
|
||||
paths:
|
||||
- "/"
|
||||
tls:
|
||||
- secretName: {{ .Values.ingress.tls.secretName | quote }}
|
||||
hosts:
|
||||
- "{{ .Values.global.hosts.jitsi }}.{{ .Values.global.domain }}"
|
||||
extraEnvs:
|
||||
TURN_ENABLE: "1"
|
||||
resources:
|
||||
{{ .Values.resources.jitsi | toYaml | nindent 6 }}
|
||||
securityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
capabilities: {}
|
||||
privileged: false
|
||||
readOnlyRootFilesystem: false
|
||||
runAsGroup: 0
|
||||
runAsNonRoot: false
|
||||
runAsUser: 0
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.jitsi | toYaml | nindent 8 }}
|
||||
prosody:
|
||||
image:
|
||||
repository: "{{ .Values.global.imageRegistry | default .Values.images.prosody.registry }}/{{ .Values.images.prosody.repository }}"
|
||||
tag: {{ .Values.images.prosody.tag | quote }}
|
||||
imagePullSecrets:
|
||||
{{- range .Values.global.imagePullSecrets }}
|
||||
- name: {{ . | quote }}
|
||||
{{- end }}
|
||||
extraEnvs:
|
||||
- name: "AUTH_TYPE"
|
||||
value: "hybrid_matrix_token"
|
||||
- name: "JWT_APP_ID"
|
||||
value: "{{ .Values.global.hosts.jitsi }}.{{ .Values.global.domain }}"
|
||||
- name: "JWT_APP_SECRET"
|
||||
value: {{ .Values.secrets.jitsi.jwtAppSecret | quote }}
|
||||
- name: "MATRIX_UVS_SYNC_POWER_LEVELS"
|
||||
value: "true"
|
||||
- name: "MATRIX_UVS_URL"
|
||||
value: "http://opendesk-matrix-user-verification-service.{{ .Release.Namespace }}.svc.{{ .Values.cluster.networking.domain }}"
|
||||
- name: TURNS_HOST
|
||||
value: {{ .Values.turn.tls.host | quote }}
|
||||
- name: TURNS_PORT
|
||||
value: {{ .Values.turn.tls.port | quote }}
|
||||
- name: TURN_HOST
|
||||
value: {{ .Values.turn.server.host | quote }}
|
||||
- name: TURN_PORT
|
||||
value: {{ .Values.turn.server.port | quote }}
|
||||
- name: TURN_TRANSPORT
|
||||
value: {{ .Values.turn.transport | quote }}
|
||||
- name: TURN_CREDENTIALS
|
||||
value: {{ .Values.turn.credentials | quote }}
|
||||
resources:
|
||||
{{ .Values.resources.prosody | toYaml | nindent 6 }}
|
||||
persistence:
|
||||
size: {{ .Values.persistence.size.prosody | quote }}
|
||||
storageClassName: {{ .Values.persistence.storageClassNames.RWO | quote }}
|
||||
securityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
capabilities: {}
|
||||
privileged: false
|
||||
readOnlyRootFilesystem: false
|
||||
runAsGroup: 0
|
||||
runAsNonRoot: false
|
||||
runAsUser: 0
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.prosody | toYaml | nindent 8 }}
|
||||
jicofo:
|
||||
replicaCount: {{ .Values.replicas.jicofo }}
|
||||
image:
|
||||
repository: "{{ .Values.global.imageRegistry | default .Values.images.jicofo.registry }}/{{ .Values.images.jicofo.repository }}"
|
||||
tag: {{ .Values.images.jicofo.tag | quote }}
|
||||
xmpp:
|
||||
password: {{ .Values.secrets.jitsi.jicofoAuthPassword | quote }}
|
||||
componentSecret: {{ .Values.secrets.jitsi.jicofoComponentPassword | quote }}
|
||||
resources:
|
||||
{{ .Values.resources.jicofo | toYaml | nindent 6 }}
|
||||
securityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
capabilities: {}
|
||||
privileged: false
|
||||
readOnlyRootFilesystem: false
|
||||
runAsGroup: 0
|
||||
runAsNonRoot: false
|
||||
runAsUser: 0
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.jicofo | toYaml | nindent 8 }}
|
||||
jvb:
|
||||
replicaCount: {{ .Values.replicas.jvb }}
|
||||
image:
|
||||
repository: "{{ .Values.global.imageRegistry | default .Values.images.jvb.registry }}/{{ .Values.images.jvb.repository }}"
|
||||
tag: {{ .Values.images.jvb.tag | quote }}
|
||||
xmpp:
|
||||
password: {{ .Values.secrets.jitsi.jvbAuthPassword | quote }}
|
||||
resources:
|
||||
{{ .Values.resources.jvb | toYaml | nindent 6 }}
|
||||
service:
|
||||
type: {{ .Values.cluster.service.type | quote }}
|
||||
securityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
capabilities: {}
|
||||
privileged: false
|
||||
readOnlyRootFilesystem: false
|
||||
runAsGroup: 0
|
||||
runAsNonRoot: false
|
||||
runAsUser: 0
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.jvb | toYaml | nindent 8 }}
|
||||
jibri:
|
||||
replicaCount: {{ .Values.replicas.jibri }}
|
||||
image:
|
||||
repository: "{{ .Values.global.imageRegistry | default .Values.images.jibri.registry }}/{{ .Values.images.jibri.repository }}"
|
||||
tag: {{ .Values.images.jibri.tag | quote }}
|
||||
recorder:
|
||||
password: {{ .Values.secrets.jitsi.jibriRecorderPassword | quote }}
|
||||
xmpp:
|
||||
password: {{ .Values.secrets.jitsi.jibriXmppPassword | quote }}
|
||||
resources:
|
||||
{{ .Values.resources.jibri | toYaml | nindent 6 }}
|
||||
securityContext:
|
||||
# Chart does not allow to template more
|
||||
capabilities:
|
||||
add: ["SYS_ADMIN"]
|
||||
imagePullSecrets:
|
||||
{{- range .Values.global.imagePullSecrets }}
|
||||
- name: {{ . | quote }}
|
||||
{{- end }}
|
||||
|
||||
patchJVB:
|
||||
configuration:
|
||||
staticLoadbalancerIP: {{ .Values.cluster.networking.ingressGatewayIP | quote }}
|
||||
loadbalancerStatusField: {{ .Values.cluster.networking.loadBalancerStatusField | quote }}
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
capabilities:
|
||||
drop:
|
||||
- "ALL"
|
||||
enabled: true
|
||||
privileged: false
|
||||
readOnlyRootFilesystem: true
|
||||
runAsUser: 1001
|
||||
runAsGroup: 1001
|
||||
runAsNonRoot: true
|
||||
seccompProfile:
|
||||
type: "RuntimeDefault"
|
||||
seLinuxOptions:
|
||||
{{ .Values.seLinuxOptions.jitsiPatchJVB | toYaml | nindent 6 }}
|
||||
image:
|
||||
imagePullPolicy: {{ .Values.global.imagePullPolicy | quote }}
|
||||
registry: {{ .Values.global.imageRegistry | default .Values.images.jitsiPatchJVB.registry | quote }}
|
||||
repository: {{ .Values.images.jitsiPatchJVB.repository | quote }}
|
||||
tag: {{ .Values.images.jitsiPatchJVB.tag | quote }}
|
||||
replicaCount: {{ .Values.replicas.jitsiKeycloakAdapter }}
|
||||
|
||||
resources:
|
||||
{{ .Values.resources.jitsiKeycloakAdapter | toYaml | nindent 2 }}
|
||||
...
|
||||
@@ -1,27 +0,0 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
repositories:
|
||||
- name: "sovereign-workplace-keycloak-bootstrap-repo"
|
||||
url: >-
|
||||
{{ env "PRIVATE_CHART_REPOSITORY_URL" |
|
||||
default "https://gitlab.souvap-univention.de/api/v4/projects/138/packages/helm/stable" }}
|
||||
|
||||
releases:
|
||||
- name: "sovereign-workplace-keycloak-bootstrap"
|
||||
chart: "sovereign-workplace-keycloak-bootstrap-repo/sovereign-workplace-keycloak-bootstrap"
|
||||
version: "1.1.11"
|
||||
values:
|
||||
- "values-bootstrap.gotmpl"
|
||||
- "values-bootstrap.yaml"
|
||||
condition: "keycloak.enabled"
|
||||
# as we have seen some slow clusters we want to ensure we not just fail due to a timeout.
|
||||
timeout: 1800
|
||||
|
||||
commonLabels:
|
||||
deploy-stage: "component-1"
|
||||
component: "keycloak-bootstrap"
|
||||
|
||||
bases:
|
||||
- "../../bases/environments.yaml"
|
||||
...
|
||||
@@ -1,25 +0,0 @@
|
||||
{{/*
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
*/}}
|
||||
---
|
||||
global:
|
||||
domain: "{{ .Values.global.domain }}"
|
||||
hosts:
|
||||
{{ .Values.global.hosts | toYaml | nindent 4 }}
|
||||
registry: "{{ .Values.global.imageRegistry }}"
|
||||
imagePullSecrets:
|
||||
{{ .Values.global.imagePullSecrets | toYaml | nindent 4 }}
|
||||
|
||||
config:
|
||||
administrator:
|
||||
password: "{{ .Values.secrets.keycloak.adminPassword }}"
|
||||
|
||||
image:
|
||||
registry: "{{ .Values.global.imageRegistry }}"
|
||||
repository: "{{ .Values.images.keycloakBootstrap.repository }}"
|
||||
tag: "{{ .Values.images.keycloakBootstrap.tag }}"
|
||||
|
||||
resources:
|
||||
{{ .Values.resources.keycloakBootstrap | toYaml | nindent 2 }}
|
||||
...
|
||||
@@ -1,10 +0,0 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
config:
|
||||
administrator:
|
||||
username: "kcadmin"
|
||||
|
||||
cleanup:
|
||||
deletePodsOnSuccess: true
|
||||
...
|
||||
@@ -1,51 +0,0 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
repositories:
|
||||
- name: "bitnami-repo"
|
||||
oci: true
|
||||
url: >-
|
||||
{{ env "PRIVATE_CHART_REPOSITORY_URL" |
|
||||
default "registry-1.docker.io/bitnamicharts" }}
|
||||
- name: "keycloak-theme-repo"
|
||||
url: >-
|
||||
{{ env "PRIVATE_CHART_REPOSITORY_URL" |
|
||||
default "https://gitlab.souvap-univention.de/api/v4/projects/96/packages/helm/stable" }}
|
||||
- name: "keycloak-extensions-repo"
|
||||
url: >-
|
||||
{{ env "PRIVATE_CHART_REPOSITORY_URL" |
|
||||
default "https://gitlab.souvap-univention.de/api/v4/projects/77/packages/helm/stable" }}
|
||||
|
||||
releases:
|
||||
- name: "keycloak-theme"
|
||||
chart: "keycloak-theme-repo/sovereign-workplace-theme"
|
||||
version: "1.1.0"
|
||||
values:
|
||||
- "values-theme.gotmpl"
|
||||
condition: "keycloak.enabled"
|
||||
- name: "keycloak"
|
||||
chart: "bitnami-repo/keycloak"
|
||||
version: "12.2.0"
|
||||
values:
|
||||
- "values-keycloak.gotmpl"
|
||||
- "values-keycloak.yaml"
|
||||
- "values-keycloak-idp.yaml"
|
||||
wait: true
|
||||
condition: "keycloak.enabled"
|
||||
- name: "keycloak-extensions"
|
||||
chart: "keycloak-extensions-repo/keycloak-extensions"
|
||||
version: "0.1.0"
|
||||
needs:
|
||||
- "keycloak"
|
||||
values:
|
||||
- "values-extensions.yaml"
|
||||
- "values-extensions.gotmpl"
|
||||
condition: "keycloak.enabled"
|
||||
|
||||
commonLabels:
|
||||
deploy-stage: "component-1"
|
||||
component: "keycloak"
|
||||
|
||||
bases:
|
||||
- "../../bases/environments.yaml"
|
||||
...
|
||||
@@ -1,57 +0,0 @@
|
||||
{{/*
|
||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
*/}}
|
||||
---
|
||||
global:
|
||||
keycloak:
|
||||
adminPassword: {{ .Values.secrets.keycloak.adminPassword }}
|
||||
postgresql:
|
||||
connection:
|
||||
host: "{{ .Values.databases.keycloakExtension.host }}"
|
||||
port: "{{ .Values.databases.keycloakExtension.port }}"
|
||||
auth:
|
||||
database: "{{ .Values.databases.keycloakExtension.name }}"
|
||||
username: "{{ .Values.databases.keycloakExtension.username }}"
|
||||
password: {{ .Values.databases.keycloakExtension.password | default .Values.secrets.postgresql.keycloakExtensionUser }}
|
||||
handler:
|
||||
image:
|
||||
registry: "{{ .Values.global.imageRegistry }}"
|
||||
repository: "{{ .Values.images.keycloakExtensionHandler.repository }}"
|
||||
{{- if .Values.images.keycloakExtensionHandler.digest }}
|
||||
sha256: "{{ .Values.images.keycloakExtensionHandler.digest}}"
|
||||
{{- else if .Values.images.keycloakExtensionHandler.tag }}
|
||||
tag: "{{ .Values.images.keycloakExtensionHandler.tag }}"
|
||||
{{- end }}
|
||||
imagePullPolicy: "Always"
|
||||
appConfig:
|
||||
smtpPassword: "{{ .Values.smtp.password }}"
|
||||
smtpHost: "{{ .Values.smtp.host }}"
|
||||
smtpUsername: "{{ .Values.smtp.username }}"
|
||||
mailFrom: "noreply@{{ .Values.global.domain }}"
|
||||
resources:
|
||||
{{ .Values.resources.keycloakExtension | toYaml | nindent 4 }}
|
||||
proxy:
|
||||
image:
|
||||
registry: "{{ .Values.global.imageRegistry }}"
|
||||
repository: "{{ .Values.images.keycloakExtensionProxy.repository }}"
|
||||
{{- if .Values.images.keycloakExtensionProxy.digest }}
|
||||
sha256: "{{ .Values.images.keycloakExtensionProxy.digest}}"
|
||||
{{- else if .Values.images.keycloakExtensionProxy.tag }}
|
||||
tag: "{{ .Values.images.keycloakExtensionProxy.tag }}"
|
||||
{{- end }}
|
||||
imagePullPolicy: "Always"
|
||||
ingress:
|
||||
enabled: "{{ .Values.ingress.enabled }}"
|
||||
ingressClassName: "{{ .Values.ingress.ingressClassName }}"
|
||||
annotations:
|
||||
nginx.org/proxy-buffer-size: "8k"
|
||||
nginx.ingress.kubernetes.io/proxy-buffer-size: "8k"
|
||||
host: "{{ .Values.global.hosts.keycloak }}.{{ .Values.global.domain }}"
|
||||
tls:
|
||||
enabled: "{{ .Values.ingress.tls.enabled }}"
|
||||
secretName: "{{ .Values.ingress.tls.secretName }}"
|
||||
resources:
|
||||
{{ .Values.resources.keycloakProxy | toYaml | nindent 4 }}
|
||||
|
||||
...
|
||||
@@ -1,21 +0,0 @@
|
||||
# SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
---
|
||||
global:
|
||||
keycloak:
|
||||
host: "keycloak"
|
||||
adminUsername: "kcadmin"
|
||||
adminRealm: "master"
|
||||
realm: "souvap"
|
||||
|
||||
handler:
|
||||
appConfig:
|
||||
captchaProtectionEnable: "False"
|
||||
|
||||
postgresql:
|
||||
enabled: false
|
||||
|
||||
proxy:
|
||||
image:
|
||||
tag: "latest"
|
||||
...
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user