Skip to content

Commit 2e1beb4

Browse files
jobcespedesjobcespedes
committed
docs: update api docs and manifests docs
1 parent 35f0a2f commit 2e1beb4

4 files changed

+214
-5
lines changed

‎config/crd/bases/lms.krestomat.io_lmsmoodles.yaml

+93-2
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,18 @@ spec:
101101
- multimaster
102102
- custom
103103
type: string
104+
keydbNetpolEgressIpblock:
105+
description: KeydbNetpolEgressIpblock defines egress ip block
106+
for keydb default network policy
107+
type: string
108+
keydbNetpolIngressIpblock:
109+
description: GaneshaNetpolIngressIpblock defines ingress ip block
110+
for keydb default network policy
111+
type: string
112+
keydbNetpolOmit:
113+
description: 'KeydbNetpolOmit whether to omit default keydb network
114+
policy. Default: true'
115+
type: boolean
104116
keydbNodeSelector:
105117
description: KeydbNodeSelector defines any node labels selectors
106118
for Keydb pods.
@@ -214,6 +226,13 @@ spec:
214226
spec
215227
type: string
216228
type: object
229+
lmsMoodleNetpolOmit:
230+
description: |-
231+
LMSMoodleNetpolOmit whether to omit default network policy for the namespace. Default: false
232+
It will deny all ingress and egress traffic to the namespace
233+
Intended to be used with custom network policies already in place or
234+
by not omitting default network policies of each dependant resource
235+
type: boolean
217236
lmsMoodleTemplateName:
218237
description: LMSMoodleTemplateName defines what LMS Moodle template
219238
to use
@@ -349,6 +368,18 @@ spec:
349368
as redis cache.
350369
maxLength: 63
351370
type: string
371+
moodleNetpolEgressIpblock:
372+
description: MoodleNetpolEgressIpblock defines egress ip block
373+
for moodle default network policy
374+
type: string
375+
moodleNetpolIngressIpblock:
376+
description: MoodleNetpolIngressIpblock defines ingress ip block
377+
for moodle default network policy
378+
type: string
379+
moodleNetpolOmit:
380+
description: 'MoodleNetpolOmit whether to omit default moodle
381+
network policy. Default: true'
382+
type: boolean
352383
moodleNewAdminpassHash:
353384
description: MoodleNewAdminPassHash is the bcrypt compatible admin
354385
password to set in new instance. Required
@@ -651,6 +682,18 @@ spec:
651682
nginxIngressAnnotations:
652683
description: NginxIngressAnnotations defines nginx annotations
653684
type: string
685+
nginxNetpolEgressIpblock:
686+
description: NginxNetpolEgressIpblock defines egress ip block
687+
for nginx default network policy
688+
type: string
689+
nginxNetpolIngressIpblock:
690+
description: NginxNetpolIngressIpblock defines ingress ip block
691+
for nginx default network policy
692+
type: string
693+
nginxNetpolOmit:
694+
description: 'NginxNetpolOmit whether to omit default network
695+
policy for nginx. Default: true'
696+
type: boolean
654697
nginxNodeSelector:
655698
description: NginxNodeSelector defines any node labels selectors
656699
for Nginx pods.
@@ -749,6 +792,18 @@ spec:
749792
phpFpmIngressAnnotations:
750793
description: PhpFpmIngressAnnotations defines php-fpm annotations
751794
type: string
795+
phpFpmNetpolEgressIpblock:
796+
description: PhpFpmNetpolEgressIpblock defines egress ip block
797+
for php-fpm default network policy
798+
type: string
799+
phpFpmNetpolIngressIpblock:
800+
description: PhpFpmNetpolIngressIpblock defines ingress ip block
801+
for php-fpm default network policy
802+
type: string
803+
phpFpmNetpolOmit:
804+
description: 'PhpFpmNetpolOmit whether to omit default network
805+
policy for php-fpm. Default: true'
806+
type: boolean
752807
phpFpmNodeSelector:
753808
description: PhpFpmNodeSelector defines any node labels selectors
754809
for PhpFpm pods.
@@ -958,6 +1013,18 @@ spec:
9581013
description: GaneshaImage defines image for ganesha server container
9591014
maxLength: 255
9601015
type: string
1016+
ganeshaNetpolEgressIpblock:
1017+
description: GaneshaNetpolEgressIpblock defines egress ip block
1018+
for ganesha default network policy
1019+
type: string
1020+
ganeshaNetpolIngressIpblock:
1021+
description: GaneshaNetpolIngressIpblock defines ingress ip block
1022+
for ganesha default network policy
1023+
type: string
1024+
ganeshaNetpolOmit:
1025+
description: 'GaneshaNetpolOmit whether to omit default network
1026+
policy for ganesha. Default: true'
1027+
type: boolean
9611028
ganeshaNodeSelector:
9621029
description: GaneshaNodeSelector defines any node labels selectors
9631030
for Ganesha pods.
@@ -1078,6 +1145,18 @@ spec:
10781145
pgbouncerExtraConfig:
10791146
description: PgbouncerExtraConfig contains extra pgbouncer config
10801147
type: string
1148+
pgbouncerNetpolEgressIpblock:
1149+
description: PgbouncerNetpolEgressIpblock defines egress ip block
1150+
for pgbouncer default network policy
1151+
type: string
1152+
pgbouncerNetpolIngressIpblock:
1153+
description: PgbouncerNetpolIngressIpblock defines ipblock for
1154+
pgbouncer default network policy
1155+
type: string
1156+
pgbouncerNetpolOmit:
1157+
description: 'PgbouncerNetpolOmit whether to omit default network
1158+
policy for pgbouncer. Default: true'
1159+
type: boolean
10811160
pgbouncerNodeSelector:
10821161
description: PgbouncerNodeSelector defines any node labels selectors
10831162
for Pgbouncer pods.
@@ -1087,8 +1166,8 @@ spec:
10871166
for PgbouncerReadonly pods.
10881167
type: string
10891168
pgbouncerReadonlyExtraConfig:
1090-
description: PgbouncerReadonlyExtraConfig contains extra pgbouncerReadonly
1091-
config
1169+
description: PgbouncerReadonlyExtraConfig contains extra pgbouncer
1170+
readonly config
10921171
type: string
10931172
pgbouncerReadonlyNodeSelector:
10941173
description: PgbouncerReadonlyNodeSelector defines any node labels
@@ -1255,6 +1334,18 @@ spec:
12551334
- standalone
12561335
- readreplicas
12571336
type: string
1337+
postgresNetpolEgressIpblock:
1338+
description: PostgresNetpolEgressIpblock defines egress ip block
1339+
for postgres default network policy
1340+
type: string
1341+
postgresNetpolIngressIpblock:
1342+
description: PostgresNetpolIngressIpblock defines ingress ip block
1343+
for postgres default network policy
1344+
type: string
1345+
postgresNetpolOmit:
1346+
description: 'PostgresNetpolOmit whether to omit default network
1347+
policy for postgres. Default: true'
1348+
type: boolean
12581349
postgresNodeSelector:
12591350
description: PostgresNodeSelector defines any node labels selectors
12601351
for Postgres pods.

‎config/crd/bases/lms.krestomat.io_lmsmoodletemplates.yaml

+86-2
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,18 @@ spec:
7474
- multimaster
7575
- custom
7676
type: string
77+
keydbNetpolEgressIpblock:
78+
description: KeydbNetpolEgressIpblock defines egress ip block
79+
for keydb default network policy
80+
type: string
81+
keydbNetpolIngressIpblock:
82+
description: GaneshaNetpolIngressIpblock defines ingress ip block
83+
for keydb default network policy
84+
type: string
85+
keydbNetpolOmit:
86+
description: 'KeydbNetpolOmit whether to omit default keydb network
87+
policy. Default: true'
88+
type: boolean
7789
keydbNodeSelector:
7890
description: KeydbNodeSelector defines any node labels selectors
7991
for Keydb pods.
@@ -316,6 +328,18 @@ spec:
316328
as redis cache.
317329
maxLength: 63
318330
type: string
331+
moodleNetpolEgressIpblock:
332+
description: MoodleNetpolEgressIpblock defines egress ip block
333+
for moodle default network policy
334+
type: string
335+
moodleNetpolIngressIpblock:
336+
description: MoodleNetpolIngressIpblock defines ingress ip block
337+
for moodle default network policy
338+
type: string
339+
moodleNetpolOmit:
340+
description: 'MoodleNetpolOmit whether to omit default moodle
341+
network policy. Default: true'
342+
type: boolean
319343
moodleNewAdminpassHash:
320344
description: MoodleNewAdminPassHash is the bcrypt compatible admin
321345
password to set in new instance. Required
@@ -618,6 +642,18 @@ spec:
618642
nginxIngressAnnotations:
619643
description: NginxIngressAnnotations defines nginx annotations
620644
type: string
645+
nginxNetpolEgressIpblock:
646+
description: NginxNetpolEgressIpblock defines egress ip block
647+
for nginx default network policy
648+
type: string
649+
nginxNetpolIngressIpblock:
650+
description: NginxNetpolIngressIpblock defines ingress ip block
651+
for nginx default network policy
652+
type: string
653+
nginxNetpolOmit:
654+
description: 'NginxNetpolOmit whether to omit default network
655+
policy for nginx. Default: true'
656+
type: boolean
621657
nginxNodeSelector:
622658
description: NginxNodeSelector defines any node labels selectors
623659
for Nginx pods.
@@ -716,6 +752,18 @@ spec:
716752
phpFpmIngressAnnotations:
717753
description: PhpFpmIngressAnnotations defines php-fpm annotations
718754
type: string
755+
phpFpmNetpolEgressIpblock:
756+
description: PhpFpmNetpolEgressIpblock defines egress ip block
757+
for php-fpm default network policy
758+
type: string
759+
phpFpmNetpolIngressIpblock:
760+
description: PhpFpmNetpolIngressIpblock defines ingress ip block
761+
for php-fpm default network policy
762+
type: string
763+
phpFpmNetpolOmit:
764+
description: 'PhpFpmNetpolOmit whether to omit default network
765+
policy for php-fpm. Default: true'
766+
type: boolean
719767
phpFpmNodeSelector:
720768
description: PhpFpmNodeSelector defines any node labels selectors
721769
for PhpFpm pods.
@@ -925,6 +973,18 @@ spec:
925973
description: GaneshaImage defines image for ganesha server container
926974
maxLength: 255
927975
type: string
976+
ganeshaNetpolEgressIpblock:
977+
description: GaneshaNetpolEgressIpblock defines egress ip block
978+
for ganesha default network policy
979+
type: string
980+
ganeshaNetpolIngressIpblock:
981+
description: GaneshaNetpolIngressIpblock defines ingress ip block
982+
for ganesha default network policy
983+
type: string
984+
ganeshaNetpolOmit:
985+
description: 'GaneshaNetpolOmit whether to omit default network
986+
policy for ganesha. Default: true'
987+
type: boolean
928988
ganeshaNodeSelector:
929989
description: GaneshaNodeSelector defines any node labels selectors
930990
for Ganesha pods.
@@ -1045,6 +1105,18 @@ spec:
10451105
pgbouncerExtraConfig:
10461106
description: PgbouncerExtraConfig contains extra pgbouncer config
10471107
type: string
1108+
pgbouncerNetpolEgressIpblock:
1109+
description: PgbouncerNetpolEgressIpblock defines egress ip block
1110+
for pgbouncer default network policy
1111+
type: string
1112+
pgbouncerNetpolIngressIpblock:
1113+
description: PgbouncerNetpolIngressIpblock defines ipblock for
1114+
pgbouncer default network policy
1115+
type: string
1116+
pgbouncerNetpolOmit:
1117+
description: 'PgbouncerNetpolOmit whether to omit default network
1118+
policy for pgbouncer. Default: true'
1119+
type: boolean
10481120
pgbouncerNodeSelector:
10491121
description: PgbouncerNodeSelector defines any node labels selectors
10501122
for Pgbouncer pods.
@@ -1054,8 +1126,8 @@ spec:
10541126
for PgbouncerReadonly pods.
10551127
type: string
10561128
pgbouncerReadonlyExtraConfig:
1057-
description: PgbouncerReadonlyExtraConfig contains extra pgbouncerReadonly
1058-
config
1129+
description: PgbouncerReadonlyExtraConfig contains extra pgbouncer
1130+
readonly config
10591131
type: string
10601132
pgbouncerReadonlyNodeSelector:
10611133
description: PgbouncerReadonlyNodeSelector defines any node labels
@@ -1222,6 +1294,18 @@ spec:
12221294
- standalone
12231295
- readreplicas
12241296
type: string
1297+
postgresNetpolEgressIpblock:
1298+
description: PostgresNetpolEgressIpblock defines egress ip block
1299+
for postgres default network policy
1300+
type: string
1301+
postgresNetpolIngressIpblock:
1302+
description: PostgresNetpolIngressIpblock defines ingress ip block
1303+
for postgres default network policy
1304+
type: string
1305+
postgresNetpolOmit:
1306+
description: 'PostgresNetpolOmit whether to omit default network
1307+
policy for postgres. Default: true'
1308+
type: boolean
12251309
postgresNodeSelector:
12261310
description: PostgresNodeSelector defines any node labels selectors
12271311
for Postgres pods.

‎config/samples/lms_v1alpha1_lmsmoodle.yaml

+12
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,16 @@ metadata:
1010
app.kubernetes.io/created-by: lms-moodle-operator
1111
spec:
1212
lmsMoodleTemplateName: lmsmoodletemplate-sample
13+
14+
## whether to omit default network policy for the namespace. Default: false
15+
## It will deny all ingress and egress traffic to the namespace
16+
## Intended to be used with custom network policies already in place or
17+
## by not omitting default network policies of each dependant resource
18+
# lmsMoodleNetpolOmit: true
19+
20+
## defines the desired state to put a LMSMoodle
21+
# desiredState: Suspended
22+
1323
## Override lmsMoodleTemplate moodle spec, if any
1424
moodleSpec:
1525
moodleNewInstanceAgreeLicense: true
@@ -18,6 +28,8 @@ spec:
1828
moodleNewInstanceSummary: A demo LMS Moodle
1929
moodleNewInstanceAdminmail: admin@otherexample.com
2030
moodleNewAdminpassHash: $2b$10$zbRuwPil1wNWQUkvlkchwe3/rOljJvoheydndKH1X0bdIIigy0xim
31+
# moodleNetpolOmit: false
2132
## Override lmsMoodleTemplate nfs spec, if any
2233
# nfsSpec:
2334
# ganeshaPvcDataAutoexpansion: false
35+
# ganeshaNetpolOmit: false

0 commit comments

Comments
 (0)