You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Compiled executable file will be in the `scripts` directory.
29
37
30
38
## 2. Config the Setup Tool
31
-
**Normally, just skip this section and use the default config files** which are located in the `configs/setup` directory inside the [vHive repo](https://github.com/vhive-serverless/vHive).
32
39
33
-
-`configs/setup/knative.json`: knative related configs (all the path in the config file should be relative path inside the vHive repo)
40
+
**Normally, just skip this section and use the default config files** which are located in the `configs/setup` directory
41
+
inside the [vHive repo](https://github.com/vhive-serverless/vHive).
42
+
43
+
-`configs/setup/knative.json`: knative related configs (all the path in the config file should be relative path inside
44
+
the vHive repo)
34
45
-`configs/setup/kube.json`: Kubernetes related configs
35
46
-`configs/setup/system.json`: system related configs
36
47
-`configs/setup/vhive.json`: vHive related configs
37
48
38
49
You can modify the config files on your demand and then place all of them in one directory for the later use.
39
50
40
51
## 3. Use of Setup Tool
52
+
41
53
### 3.1 General Usage
54
+
42
55
```bash
43
56
./setup_tool [options] <subcommand> [parameters]
44
57
```
58
+
45
59
use the `-h` or `--help` option to look for the help
60
+
46
61
### 3.2 Specify Config Files
47
-
By default, the setup_tool will use the config files in `configs/setup` directory inside the vHive repo.
62
+
63
+
By default, the setup_tool will use the config files in `configs/setup` directory inside the vHive repo.
48
64
49
65
To change the path of config files, use the `--setup-configs-dir` option to specify it.
If the current directory or the provided path is not a valid vHive repo, the setup_tool will [automatically clone the remote vHive repo and use it](#34-use-with-remote-vhive-repo).
82
+
If the current directory or the provided path is not a valid vHive repo, the setup_tool
83
+
will [automatically clone the remote vHive repo and use it](#34-use-with-remote-vhive-repo).
63
84
64
85
### 3.4 Use with Remote vHive Repo (Standalone Use)
65
-
When the setup_tool is directly downloaded or targeted for standalone use, the setup_tool will automatically clone the remote vHive repo to the temporary directory and then use it during the setup process.
66
86
67
-
To change the URL and branch of the [default remote vHive repo](https://github.com/vhive-serverless/vHive), use `--vhive-repo-url` and `--vhive-repo-branch` options to specify them.
87
+
When the setup_tool is directly downloaded or targeted for standalone use, the setup_tool will automatically clone the
88
+
remote vHive repo to the temporary directory and then use it during the setup process.
89
+
90
+
To change the URL and branch of the [default remote vHive repo](https://github.com/vhive-serverless/vHive),
91
+
use `--vhive-repo-url` and `--vhive-repo-branch` options to specify them.
Besides, when the current directory is a vHive repo or the `--vhive-repo-dir` option is valid, **the local repo will be prioritized for use**. **To force the setup_tool to clone and use the remote vHive repo**, provide `--force-remote` option to the setup_tool.
97
+
Besides, when the current directory is a vHive repo or the `--vhive-repo-dir` option is valid, **the local repo will be
98
+
prioritized for use**. **To force the setup_tool to clone and use the remote vHive repo**, provide `--force-remote`
99
+
option to the setup_tool.
100
+
73
101
```bash
74
102
./setup_tool --force-remote ...
75
103
```
76
104
77
-
78
105
### 3.5 Migrate from Legacy Shell Scripts
106
+
79
107
Just type the name of the original shell script and append corresponding parameters behind. For example:
**NOTICE**: Shell scripts in `scripts/stargz`, `scripts/self-hosted-kind`, and `scripts/github_runner`**are not supported to be invoked in this way at present**.
126
+
**NOTICE**: Shell scripts in `scripts/stargz`, `scripts/self-hosted-kind`, and `scripts/github_runner`**are not
127
+
supported to be invoked in this way at present**.
128
+
129
+
### 3.6 Kubernetes Control Plane High-Availability Mode
98
130
131
+
For fault tolerance purposes, Kubernetes control plane components can be replicated. This can be done by combining
132
+
instructions from
133
+
the following links - [#1](https://github.com/kubernetes/kubeadm/blob/main/docs/ha-considerations.md)
134
+
and [#2](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/high-availability/).
135
+
136
+
While executing these steps manually is complicated, [InVitro Loader](https://github.com/vhive-serverless/invitro)
137
+
provides an automatized way of creating a high-available control plane just by configuring `CONTROL_PLANE_REPLICAS`
138
+
parameter in `scripts/setup/setup.cfg` and then running `scripts/setup/create_multinode.sh`.
99
139
100
140
## 4. Logs
101
-
The log files will be named as `<subcommand>_common.log` and `<subcommand>_error.log`. All log files will be stored in the directory where the setup_tool is executed.
141
+
142
+
The log files will be named as `<subcommand>_common.log` and `<subcommand>_error.log`. All log files will be stored in
143
+
the directory where the setup_tool is executed.
102
144
103
145
-`<subcommand>_common.log`: all output originally writes to `stdout` will be redirected to this log file.
104
146
-`<subcommand>_error.log`: all output originally writes to `stderr` will be redirected to this log file.
105
147
106
148
## 5. Supported Platform
107
-
At present, only `Ubuntu 20.04 (amd64)` is officially tested. Other versions of `Ubuntu` may also work, but not guaranteed.
149
+
150
+
At present, only `Ubuntu 20.04 (amd64)` is officially tested. Other versions of `Ubuntu` may also work, but not
0 commit comments