Skip to content

Commit 87bd896

Browse files
authored
chore: Update CheCluster CR doc (#2991)
* chore: Update CheCluster CR doc Signed-off-by: Anatolii Bazko <[email protected]>
1 parent f681af4 commit 87bd896

File tree

2 files changed

+24
-2
lines changed

2 files changed

+24
-2
lines changed

modules/administration-guide/pages/checluster-custom-resource-fields-reference.adoc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,23 @@ This section describes all fields available to customize the `CheCluster` Custom
1111

1212
* xref:a-minimal-checluster-custom-resource-example[]
1313
* xref:checluster-custom-resource-devEnvironments-settings[]
14+
** xref:checluster-custom-resource-devEnvironments-allowedSources-settings[]
15+
** xref:checluster-custom-resource-devEnvironments-containerBuildConfiguration-settings[]
16+
** xref:checluster-custom-resource-devEnvironments-containerRunConfiguration-settings[]
1417
** xref:checluster-custom-resource-devEnvironments-defaultNamespace-settings[]
1518
** xref:checluster-custom-resource-devEnvironments-defaultPlugins-settings[]
19+
** xref:checluster-custom-resource-devEnvironments-editorsDownloadUrls-settings[]
1620
** xref:checluster-custom-resource-devEnvironments-gatewayContainer-settings[]
21+
** xref:checluster-custom-resource-devEnvironments-networking-settings[]
22+
*** xref:checluster-custom-resource-devEnvironments-networking-externalTLSConfig-settings[]
23+
** xref:checluster-custom-resource-devEnvironments-persistUserHome-settings[]
24+
** xref:checluster-custom-resource-devEnvironments-projectCloneContainer-settings[]
25+
** xref:checluster-custom-resource-devEnvironments-security-settings[]
1726
** xref:checluster-custom-resource-devEnvironments-storage-settings[]
1827
*** xref:checluster-custom-resource-devEnvironments-storage-perUserStrategyPvcConfig-settings[]
1928
*** xref:checluster-custom-resource-devEnvironments-storage-perWorkspaceStrategyPvcConfig-settings[]
2029
** xref:checluster-custom-resource-devEnvironments-trustedCerts-settings[]
21-
** xref:checluster-custom-resource-devEnvironments-containerBuildConfiguration-settings[]
30+
** xref:checluster-custom-resource-devEnvironments-user-settings[]
2231
* xref:checluster-custom-resource-components-settings[]
2332
** xref:checluster-custom-resource-components-cheServer-settings[]
2433
*** xref:checluster-custom-resource-components-cheServer-proxy-settings[]
@@ -46,6 +55,7 @@ This section describes all fields available to customize the `CheCluster` Custom
4655
****** xref:checluster-custom-resource-components-common-deployment-containers-resources-limits-settings[]
4756
** xref:checluster-custom-resource-components-dashboard-settings[]
4857
*** xref:checluster-custom-resource-components-dashboard-headerMessage-settings[]
58+
*** xref:checluster-custom-resource-components-dashboard-branding-settings[]
4959
*** xref:checluster-custom-resource-components-common-deployment-settings[]
5060
**** xref:checluster-custom-resource-components-common-deployment-securityContext-settings[]
5161
**** xref:checluster-custom-resource-components-common-deployment-containers-settings[]
@@ -62,6 +72,7 @@ This section describes all fields available to customize the `CheCluster` Custom
6272
* xref:checluster-custom-resource-networking-settings[]
6373
** xref:checluster-custom-resource-networking-auth-settings[]
6474
*** xref:checluster-custom-resource-networking-auth-gateway-settings[]
75+
*** xref:checluster-custom-resource-networking-auth-advancedAuthorization-settings[]
6576
**** xref:checluster-custom-resource-components-common-deployment-settings[]
6677
***** xref:checluster-custom-resource-components-common-deployment-securityContext-settings[]
6778
***** xref:checluster-custom-resource-components-common-deployment-containers-settings[]

tools/checluster_docs_gen.sh

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,14 +66,23 @@ fetch_conf_files_content() {
6666

6767
parse_content() {
6868
parse_section "devEnvironments" "Development environment configuration options."
69+
parse_section "devEnvironments.properties.allowedSources" "\`allowedSources\` options."
70+
parse_section "devEnvironments.properties.containerBuildConfiguration" "\`containerBuildConfiguration\` options."
71+
parse_section "devEnvironments.properties.containerRunConfiguration" "\`containerRunConfiguration\` options."
6972
parse_section "devEnvironments.properties.defaultNamespace" "\`defaultNamespace\` options."
7073
parse_section "devEnvironments.properties.defaultPlugins" "\`defaultPlugins\` options."
74+
parse_section "devEnvironments.properties.editorsDownloadUrls" "\`editorsDownloadUrls\` options."
7175
parse_section "devEnvironments.properties.gatewayContainer" "\`gatewayContainer\` options."
76+
parse_section "devEnvironments.properties.networking" "\`networking\` options."
77+
parse_section "devEnvironments.properties.networking.properties.externalTLSConfig" "\`externalTLSConfig\` options."
78+
parse_section "devEnvironments.properties.persistUserHome" "\`persistUserHome\` options."
79+
parse_section "devEnvironments.properties.projectCloneContainer" "\`projectCloneContainer\` options."
80+
parse_section "devEnvironments.properties.security" "\`security\` options."
7281
parse_section "devEnvironments.properties.storage" "\`storage\` options."
7382
parse_section "devEnvironments.properties.storage.properties.perUserStrategyPvcConfig" "\`per-user\` PVC strategy options."
7483
parse_section "devEnvironments.properties.storage.properties.perWorkspaceStrategyPvcConfig" "\`per-workspace\` PVC strategy options."
7584
parse_section "devEnvironments.properties.trustedCerts" "\`trustedCerts\` options."
76-
parse_section "devEnvironments.properties.containerBuildConfiguration" "\`containerBuildConfiguration\` options."
85+
parse_section "devEnvironments.properties.user" "\`user\` options."
7786

7887
parse_section "components" "{prod-short} components configuration."
7988

@@ -88,6 +97,7 @@ parse_content() {
8897

8998
parse_section "components.properties.dashboard" "Configuration settings related to the Dashboard component used by the {prod-short} installation."
9099
parse_section "components.properties.dashboard.properties.headerMessage" "\`headerMessage\` options."
100+
parse_section "components.properties.dashboard.properties.branding" "\`branding\` options."
91101

92102
parse_section "components.properties.imagePuller" "Kubernetes Image Puller component configuration."
93103

@@ -102,6 +112,7 @@ parse_content() {
102112
parse_section "networking" "Networking, {prod-short} authentication and TLS configuration."
103113
parse_section "networking.properties.auth" "\`auth\` options."
104114
parse_section "networking.properties.auth.properties.gateway" "\`gateway\` options."
115+
parse_section "networking.properties.auth.properties.advancedAuthorization" "\`advancedAuthorization\` options."
105116

106117
parse_section "containerRegistry" "Configuration of an alternative registry that stores {prod-short} images."
107118

0 commit comments

Comments
 (0)