Updated liqo doc

added documentation for Cluster configuration
liqotech · Aug 28, 2020 · 6690103 · 6690103
1 parent f2fd10f
commit 6690103
Show file tree

Hide file tree

Showing 14 changed files with 65 additions and 282 deletions.
diff --git a/api/cluster-config/v1/clusterconfig_types.go b/api/cluster-config/v1/clusterconfig_types.go
@@ -32,8 +32,8 @@ type ClusterConfigSpec struct {
 }
 
 type AdvertisementConfig struct {
-	OutgoingConfig BroadcasterConfig `json:"outgoingConfig,omitempty"`
-	IngoingConfig  AdvOperatorConfig `json:"ingoingConfig,omitempty"`
+	OutgoingConfig BroadcasterConfig `json:"outgoingConfig"`
+	IngoingConfig  AdvOperatorConfig `json:"ingoingConfig"`
 	// +kubebuilder:validation:Minimum=0
 	KeepaliveThreshold int32 `json:"keepaliveThreshold,omitempty"`
 	// +kubebuilder:validation:Minimum=0
@@ -43,8 +43,8 @@ type AdvertisementConfig struct {
 type BroadcasterConfig struct {
 	// +kubebuilder:validation:Maximum=100
 	// +kubebuilder:validation:Minimum=0
-	ResourceSharingPercentage int32 `json:"resourceSharingPercentage,omitempty"`
-	EnableBroadcaster         bool  `json:"enableBroadcaster,omitempty"`
+	ResourceSharingPercentage int32 `json:"resourceSharingPercentage"`
+	EnableBroadcaster         bool  `json:"enableBroadcaster"`
 }
 
 // AcceptPolicy defines the policy to accept/refuse an Advertisement
@@ -61,7 +61,7 @@ const (
 
 type AdvOperatorConfig struct {
 	// +kubebuilder:validation:Minimum=0
-	MaxAcceptableAdvertisement int32 `json:"maxAcceptableAdvertisement,omitempty"`
+	MaxAcceptableAdvertisement int32 `json:"maxAcceptableAdvertisement"`
 	// +kubebuilder:validation:Enum="AutoAcceptWithinMaximum";"Manual"
 	AcceptPolicy AcceptPolicy `json:"acceptPolicy"`
 }

diff --git a/config/cluster-config/crd/bases/policy.liqo.io_clusterconfigs.yaml b/config/cluster-config/crd/bases/policy.liqo.io_clusterconfigs.yaml
diff --git a/config/cluster-config/crd/kustomization.yaml b/config/cluster-config/crd/kustomization.yaml
diff --git a/config/cluster-config/crd/kustomizeconfig.yaml b/config/cluster-config/crd/kustomizeconfig.yaml
diff --git a/config/cluster-config/crd/patches/cainjection_in_clusterconfigs.yaml b/config/cluster-config/crd/patches/cainjection_in_clusterconfigs.yaml
diff --git a/config/cluster-config/crd/patches/webhook_in_clusterconfigs.yaml b/config/cluster-config/crd/patches/webhook_in_clusterconfigs.yaml
diff --git a/deployments/liqo_chart/crds/policy.liqo.io_clusterconfigs.yaml b/deployments/liqo_chart/crds/policy.liqo.io_clusterconfigs.yaml
@@ -53,6 +53,7 @@ spec:
                       type: integer
                   required:
                   - acceptPolicy
+                  - maxAcceptableAdvertisement
                   type: object
                 keepaliveRetryTime:
                   format: int32
@@ -71,10 +72,18 @@ spec:
                       maximum: 100
                       minimum: 0
                       type: integer
+                  required:
+                  - enableBroadcaster
+                  - resourceSharingPercentage
                   type: object
+              required:
+              - ingoingConfig
+              - outgoingConfig
               type: object
             discoveryConfig:
               properties:
+                allowUntrustedCA:
+                  type: boolean
                 autojoin:
                   type: boolean
                 autojoinUntrusted:
@@ -93,8 +102,6 @@ spec:
                   maximum: 65355
                   minimum: 1
                   type: integer
-                allowUntrustedCA:
-                  type: boolean
                 service:
                   type: string
                 updateTime:
@@ -104,18 +111,18 @@ spec:
                   minimum: 1
                   type: integer
               required:
-                - allowUntrustedCA
-                - autojoin
-                - autojoinUntrusted
-                - dnsServer
-                - domain
-                - enableAdvertisement
-                - enableDiscovery
-                - name
-                - port
-                - service
-                - updateTime
-                - waitTime
+              - allowUntrustedCA
+              - autojoin
+              - autojoinUntrusted
+              - dnsServer
+              - domain
+              - enableAdvertisement
+              - enableDiscovery
+              - name
+              - port
+              - service
+              - updateTime
+              - waitTime
               type: object
             dispatcherConfig:
               properties:
@@ -131,9 +138,9 @@ spec:
                       version:
                         type: string
                     required:
-                      - group
-                      - resource
-                      - version
+                    - group
+                    - resource
+                    - version
                     type: object
                   type: array
               type: object

diff --git a/docs/pages/User/Configure/_index.md b/docs/pages/User/Configure/_index.md
@@ -7,6 +7,7 @@ While the [installation procedure](../gettingstarted) works in most cases, you m
 
 This section presents some additional configuration options for your Liqo cluster:
 
+* [Cluster configuration](./cluster-config): how to set the desired configuration for your cluster (e.g. how many resources to share, the policies to accept another cluster etc...)
 * [Discovery and peering](./discovery): how to discover available Liqo cluster and peer with them
 * [Network](./network): how to finaly tune the network infastructure in Liqo
 * [Scheduling](./scheduling): how to force the Kubernetes scheduler to start pods the way we like