Skip to content

Commit cf1adf5

Browse files
andreacv98andreacv98
authored
Prototype of user-friendly installation script and its documentation (#26)
1 parent f28d851 commit cf1adf5

File tree

14 files changed

+1683
-0
lines changed

14 files changed

+1683
-0
lines changed

‎docs/installation/installation.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Installation
2+
3+
A quick script for installing the FLUIDOS Node is available. Currently, the script supports installation on KIND Clusters, with plans to extend support to generic Kubernetes clusters in the near future.
4+
5+
---
6+
7+
**⚠️ ATTENTION:** The script is currently in an experimental phase, so it may not work as expected. If any issues arise, it may be tricky to understand and terminate the script, as many sub-tasks are executed in the background. We are aware of these issues and are actively working to resolve them.
8+
9+
If you want to use a **working and tested script** to test the FLUIDOS Node, please refer to the [**Testbed**](../testbed/README.md) section.
10+
11+
---
12+
13+
To execute the script, use the following command:
14+
15+
```bash
16+
cd tools/scripts
17+
. ./setup.sh
18+
```
19+
20+
No options are available through the CLI, but you can choose the installation mode by choosing the right option during the script execution.
21+
The option supported are:
22+
23+
- `1` to install the FLUIDOS Node as the demo testbed through KIND
24+
- `2` to install the FLUIDOS Node in n consumer clusters and m provider clusters through KIND
25+
- `3` to install the FLUIDOS Node in n clusters through their KUBECONFIG files
26+
**DISCLAIMER:** in this case all your Kubernetes clusters inserted in the script must have at least one node tagged with `node-role.fluidos.eu/worker: "true"` and at least in the provider clusters, you can choose the nodes that exposes their Kubernetes resources with the label `node-role.fluidos.eu/resources: "true"`.
27+
28+
For each option, you can choose to install from either the official remote FLUIDOS repository or the local repository, by building it at the moment.

‎quickstart/kind/configs/consumer.yaml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
kind: Cluster
2+
apiVersion: kind.x-k8s.io/v1alpha4
3+
nodes:
4+
- role: control-plane
5+
image: kindest/node:v1.28.0
6+
- role: worker
7+
labels:
8+
node-role.fluidos.eu/resources: "true"
9+
node-role.fluidos.eu/worker: "true"
10+
image: kindest/node:v1.28.0
11+
- role: worker
12+
image: kindest/node:v1.28.0
13+
labels:
14+
node-role.fluidos.eu/resources: "true"

‎quickstart/kind/configs/provider.yaml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
kind: Cluster
2+
apiVersion: kind.x-k8s.io/v1alpha4
3+
nodes:
4+
- role: control-plane
5+
image: kindest/node:v1.28.0
6+
- role: worker
7+
labels:
8+
node-role.fluidos.eu/resources: "true"
9+
node-role.fluidos.eu/worker: "true"
10+
image: kindest/node:v1.28.0
11+
- role: worker
12+
image: kindest/node:v1.28.0
13+
labels:
14+
node-role.fluidos.eu/resources: "true"

‎quickstart/kind/configs/standard.yaml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
kind: Cluster
2+
apiVersion: kind.x-k8s.io/v1alpha4
3+
nodes:
4+
- role: control-plane
5+
image: kindest/node:v1.28.0
6+
- role: worker
7+
labels:
8+
node-role.fluidos.eu/resources: "true"
9+
node-role.fluidos.eu/worker: "true"
10+
image: kindest/node:v1.28.0
11+
- role: worker
12+
image: kindest/node:v1.28.0
13+
labels:
14+
node-role.fluidos.eu/resources: "true"

‎quickstart/utils/consumer-values-nolrm.yaml‎

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
# Default values for fluidos-node.
2+
# This is a YAML-formatted file.
3+
# Declare variables to be passed into your templates.
4+
5+
# -- Images' tag to select a development version of fluidos-node instead of a release
6+
tag: ""
7+
# -- The pullPolicy for fluidos-node pods.
8+
pullPolicy: "IfNotPresent"
9+
10+
common:
11+
# -- NodeSelector for all fluidos-node pods
12+
nodeSelector: {
13+
node-role.fluidos.eu/worker: "true"
14+
}
15+
# -- Tolerations for all fluidos-node pods
16+
tolerations: []
17+
# -- Affinity for all fluidos-node pods
18+
affinity: {}
19+
# -- Extra arguments for all fluidos-node pods
20+
extraArgs: []
21+
22+
localResourceManager:
23+
# -- The number of REAR Controller, which can be increased for active/passive high availability.
24+
replicas: 0
25+
pod:
26+
# -- Annotations for the local-resource-manager pod.
27+
annotations: {}
28+
# -- Labels for the local-resource-manager pod.
29+
labels: {}
30+
# -- Extra arguments for the local-resource-manager pod.
31+
extraArgs: []
32+
# -- Resource requests and limits (https://kubernetes.io/docs/user-guide/compute-resources/) for the local-resource-manager pod.
33+
resources:
34+
limits: {}
35+
requests: {}
36+
imageName: "ghcr.io/fluidos-project/local-resource-manager"
37+
config:
38+
# -- Label used to identify the nodes from which resources are collected.
39+
nodeResourceLabel: "node-role.fluidos.eu/resources"
40+
# -- This flag defines the resource type of the generated flavours.
41+
resourceType: "k8s-fluidos"
42+
flavour:
43+
# -- The minimum number of CPUs that can be requested to purchase a flavour.
44+
cpuMin: "0"
45+
# -- The minimum amount of memory that can be requested to purchase a flavour.
46+
memoryMin: "0"
47+
# -- The CPU step that must be respected when requesting a flavour through a Flavour Selector.
48+
cpuStep: "1000m"
49+
# -- The memory step that must be respected when requesting a flavour through a Flavour Selector.
50+
memoryStep: "100Mi"
51+
52+
rearManager:
53+
# -- The number of REAR Manager, which can be increased for active/passive high availability.
54+
replicas: 1
55+
pod:
56+
# -- Annotations for the rear-manager pod.
57+
annotations: {}
58+
# -- Labels for the rear-manager pod.
59+
labels: {}
60+
# -- Extra arguments for the rear-manager pod.
61+
extraArgs: []
62+
# -- Resource requests and limits (https://kubernetes.io/docs/user-guide/compute-resources/) for the rear-manager pod.
63+
resources:
64+
limits: {}
65+
requests: {}
66+
imageName: "ghcr.io/fluidos-project/rear-manager"
67+
68+
rearController:
69+
# -- The number of REAR Controller, which can be increased for active/passive high availability.
70+
replicas: 1
71+
pod:
72+
# -- Annotations for the rear-controller pod.
73+
annotations: {}
74+
# -- Labels for the rear-controller pod.
75+
labels: {}
76+
# -- Extra arguments for the rear-controller pod.
77+
extraArgs: []
78+
# -- Resource requests and limits (https://kubernetes.io/docs/user-guide/compute-resources/) for the rear-controller pod.
79+
resources:
80+
limits: {}
81+
requests: {}
82+
imageName: "ghcr.io/fluidos-project/rear-controller"
83+
service:
84+
grpc:
85+
name: "grpc"
86+
# -- Kubernetes service used to expose the gRPC Server to liqo.
87+
type: "ClusterIP"
88+
# -- Annotations for the gRPC service.
89+
annotations: {}
90+
# -- Labels for the gRPC service.
91+
labels: {}
92+
# -- The gRPC port used by Liqo to connect with the Gateway of the rear-controller to obtain the Contract resources for a given consumer ClusterID.
93+
port: 2710
94+
# -- The target port used by the gRPC service.
95+
targetPort: 2710
96+
gateway:
97+
name: "gateway"
98+
# -- Kubernetes service to be used to expose the REAR gateway.
99+
type: "NodePort"
100+
# -- Annotations for the REAR gateway service.
101+
annotations: {}
102+
# -- Labels for the REAR gateway service.
103+
labels: {}
104+
# -- Options valid if service type is NodePort.
105+
nodePort:
106+
# -- Force the port used by the NodePort service.
107+
port: 30000
108+
# -- Options valid if service type is LoadBalancer.
109+
loadBalancer:
110+
# -- Override the IP here if service type is LoadBalancer and you want to use a specific IP address, e.g., because you want a static LB.
111+
ip: ""
112+
# -- The port used by the rear-controller to expose the REAR Gateway.
113+
port: 3004
114+
# -- The target port used by the REAR Gateway service.
115+
targetPort: 3004
116+
117+
networkManager:
118+
# -- The number of Network Manager, which can be increased for active/passive high availability.
119+
replicas: 1
120+
pod:
121+
# -- Annotations for the network-manager pod.
122+
annotations: {}
123+
# -- Labels for the network-manager pod.
124+
labels: {}
125+
# -- Extra arguments for the network-manager pod.
126+
extraArgs: []
127+
# -- Resource requests and limits (https://kubernetes.io/docs/user-guide/compute-resources/) for the network-manager pod.
128+
resources:
129+
limits: {}
130+
requests: {}
131+
# -- The resource image to be used by the network-manager pod.
132+
imageName: "ghcr.io/fluidos/network-manager"
133+
configMaps:
134+
providers:
135+
# -- The name of the ConfigMap containing the list of the FLUIDOS Providers and the default FLUIDOS Provider (SuperNode or Catalogue).
136+
name: "fluidos-network-manager-config"
137+
# -- The IP List of Local knwon FLUIDOS Nodes separated by commas.
138+
local:
139+
# -- The IP List of Remote known FLUIDOS Nodes separated by commas.
140+
remote:
141+
# -- The IP List of SuperNodes separated by commas.
142+
default:
143+
nodeIdentity:
144+
# -- The name of the ConfigMap containing the FLUIDOS Node identity info.
145+
name: "fluidos-network-manager-identity"
146+
# -- The domain name of the FLUIDOS closed domani: It represents for instance the Enterprise and it is used to generate the FQDN of the owned FLUIDOS Nodes
147+
domain: "fluidos.eu"
148+
# -- The IP address of the FLUIDOS Node. It can be public or private, depending on the network configuration and it corresponds to the IP address to reach the Network Manager from the outside of the cluster.
149+
ip:
150+
# -- The NodeID is a UUID that identifies the FLUIDOS Node. It is used to generate the FQDN of the owned FLUIDOS Nodes and it is unique in the FLUIDOS closed domain
151+
nodeID:

‎quickstart/utils/consumer-values.yaml‎

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
# Default values for fluidos-node.
2+
# This is a YAML-formatted file.
3+
# Declare variables to be passed into your templates.
4+
5+
# -- Images' tag to select a development version of fluidos-node instead of a release
6+
tag: ""
7+
# -- The pullPolicy for fluidos-node pods.
8+
pullPolicy: "IfNotPresent"
9+
10+
common:
11+
# -- NodeSelector for all fluidos-node pods
12+
nodeSelector: {
13+
node-role.fluidos.eu/worker: "true"
14+
}
15+
# -- Tolerations for all fluidos-node pods
16+
tolerations: []
17+
# -- Affinity for all fluidos-node pods
18+
affinity: {}
19+
# -- Extra arguments for all fluidos-node pods
20+
extraArgs: []
21+
22+
localResourceManager:
23+
# -- The number of REAR Controller, which can be increased for active/passive high availability.
24+
replicas: 1
25+
pod:
26+
# -- Annotations for the local-resource-manager pod.
27+
annotations: {}
28+
# -- Labels for the local-resource-manager pod.
29+
labels: {}
30+
# -- Extra arguments for the local-resource-manager pod.
31+
extraArgs: []
32+
# -- Resource requests and limits (https://kubernetes.io/docs/user-guide/compute-resources/) for the local-resource-manager pod.
33+
resources:
34+
limits: {}
35+
requests: {}
36+
imageName: "ghcr.io/fluidos-project/local-resource-manager"
37+
config:
38+
# -- Label used to identify the nodes from which resources are collected.
39+
nodeResourceLabel: "node-role.fluidos.eu/resources"
40+
# -- This flag defines the resource type of the generated flavours.
41+
resourceType: "k8s-fluidos"
42+
flavour:
43+
# -- The minimum number of CPUs that can be requested to purchase a flavour.
44+
cpuMin: "0"
45+
# -- The minimum amount of memory that can be requested to purchase a flavour.
46+
memoryMin: "0"
47+
# -- The CPU step that must be respected when requesting a flavour through a Flavour Selector.
48+
cpuStep: "1000m"
49+
# -- The memory step that must be respected when requesting a flavour through a Flavour Selector.
50+
memoryStep: "100Mi"
51+
52+
rearManager:
53+
# -- The number of REAR Manager, which can be increased for active/passive high availability.
54+
replicas: 1
55+
pod:
56+
# -- Annotations for the rear-manager pod.
57+
annotations: {}
58+
# -- Labels for the rear-manager pod.
59+
labels: {}
60+
# -- Extra arguments for the rear-manager pod.
61+
extraArgs: []
62+
# -- Resource requests and limits (https://kubernetes.io/docs/user-guide/compute-resources/) for the rear-manager pod.
63+
resources:
64+
limits: {}
65+
requests: {}
66+
imageName: "ghcr.io/fluidos-project/rear-manager"
67+
68+
rearController:
69+
# -- The number of REAR Controller, which can be increased for active/passive high availability.
70+
replicas: 1
71+
pod:
72+
# -- Annotations for the rear-controller pod.
73+
annotations: {}
74+
# -- Labels for the rear-controller pod.
75+
labels: {}
76+
# -- Extra arguments for the rear-controller pod.
77+
extraArgs: []
78+
# -- Resource requests and limits (https://kubernetes.io/docs/user-guide/compute-resources/) for the rear-controller pod.
79+
resources:
80+
limits: {}
81+
requests: {}
82+
imageName: "ghcr.io/fluidos-project/rear-controller"
83+
service:
84+
grpc:
85+
name: "grpc"
86+
# -- Kubernetes service used to expose the gRPC Server to liqo.
87+
type: "ClusterIP"
88+
# -- Annotations for the gRPC service.
89+
annotations: {}
90+
# -- Labels for the gRPC service.
91+
labels: {}
92+
# -- The gRPC port used by Liqo to connect with the Gateway of the rear-controller to obtain the Contract resources for a given consumer ClusterID.
93+
port: 2710
94+
# -- The target port used by the gRPC service.
95+
targetPort: 2710
96+
gateway:
97+
name: "gateway"
98+
# -- Kubernetes service to be used to expose the REAR gateway.
99+
type: "NodePort"
100+
# -- Annotations for the REAR gateway service.
101+
annotations: {}
102+
# -- Labels for the REAR gateway service.
103+
labels: {}
104+
# -- Options valid if service type is NodePort.
105+
nodePort:
106+
# -- Force the port used by the NodePort service.
107+
port: 30000
108+
# -- Options valid if service type is LoadBalancer.
109+
loadBalancer:
110+
# -- Override the IP here if service type is LoadBalancer and you want to use a specific IP address, e.g., because you want a static LB.
111+
ip: ""
112+
# -- The port used by the rear-controller to expose the REAR Gateway.
113+
port: 3004
114+
# -- The target port used by the REAR Gateway service.
115+
targetPort: 3004
116+
117+
networkManager:
118+
# -- The number of Network Manager, which can be increased for active/passive high availability.
119+
replicas: 1
120+
pod:
121+
# -- Annotations for the network-manager pod.
122+
annotations: {}
123+
# -- Labels for the network-manager pod.
124+
labels: {}
125+
# -- Extra arguments for the network-manager pod.
126+
extraArgs: []
127+
# -- Resource requests and limits (https://kubernetes.io/docs/user-guide/compute-resources/) for the network-manager pod.
128+
resources:
129+
limits: {}
130+
requests: {}
131+
# -- The resource image to be used by the network-manager pod.
132+
imageName: "ghcr.io/fluidos/network-manager"
133+
configMaps:
134+
providers:
135+
# -- The name of the ConfigMap containing the list of the FLUIDOS Providers and the default FLUIDOS Provider (SuperNode or Catalogue).
136+
name: "fluidos-network-manager-config"
137+
# -- The IP List of Local knwon FLUIDOS Nodes separated by commas.
138+
local:
139+
# -- The IP List of Remote known FLUIDOS Nodes separated by commas.
140+
remote:
141+
# -- The IP List of SuperNodes separated by commas.
142+
default:
143+
nodeIdentity:
144+
# -- The name of the ConfigMap containing the FLUIDOS Node identity info.
145+
name: "fluidos-network-manager-identity"
146+
# -- The domain name of the FLUIDOS closed domani: It represents for instance the Enterprise and it is used to generate the FQDN of the owned FLUIDOS Nodes
147+
domain: "fluidos.eu"
148+
# -- The IP address of the FLUIDOS Node. It can be public or private, depending on the network configuration and it corresponds to the IP address to reach the Network Manager from the outside of the cluster.
149+
ip:
150+
# -- The NodeID is a UUID that identifies the FLUIDOS Node. It is used to generate the FQDN of the owned FLUIDOS Nodes and it is unique in the FLUIDOS closed domain
151+
nodeID:

0 commit comments

Comments
 (0)